Skip to content

Commit

Permalink
Docs: Add URL to rule documentation to the metadata (#10)
Browse files Browse the repository at this point in the history
ESLint v4.15.0 added an official location for rules to store a URL to
their documentation in the rule metadata in eslint/eslint#9788. This
adds the URL to all the existing rules so anything consuming them can
know where their documentation is without having to resort to external
packages to guess.
  • Loading branch information
Arcanemagus authored and mysticatea committed Jan 8, 2018
1 parent 9df52a3 commit 6cc5229
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions lib/rules/disable-enable-pair.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ module.exports = {
description: "requires a `eslint-enable` comment for every `eslint-disable` comment",
category: "Best Practices",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/disable-enable-pair.md",
},
fixable: false,
schema: [{
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-aggregating-enable.js
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ module.exports = {
description: "disallows `eslint-enable` comments for multiple `eslint-disable` comments",
category: "Best Practices",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-aggregating-enable.md",
},
fixable: false,
schema: [],
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-duplicate-disable.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ module.exports = {
description: "disallows duplicate `eslint-disable` comments",
category: "Best Practices",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-duplicate-disable.md",
},
fixable: false,
schema: [],
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-restricted-disable.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ module.exports = {
description: "disallows `eslint-disable` comments about specific rules",
category: "Stylistic Issues",
recommended: false,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-restricted-disable.md",
},
fixable: false,
schema: {
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-unlimited-disable.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ module.exports = {
description: "disallows `eslint-disable` comments without rule names",
category: "Best Practices",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-unlimited-disable.md",
},
fixable: false,
schema: [],
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-unused-disable.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ module.exports = {
description: "disallows unused `eslint-disable` comments",
category: "Best Practices",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-unused-disable.md",
},
fixable: false,
schema: [],
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-unused-enable.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ module.exports = {
description: "disallows unused `eslint-enable` comments",
category: "Best Practices",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-unused-enable.md",
},
fixable: false,
schema: [],
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-use.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ module.exports = {
description: "disallows ESLint directive-comments",
category: "Stylistic Issues",
recommended: false,
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-use.md",
},
fixable: false,
schema: [{
Expand Down

0 comments on commit 6cc5229

Please sign in to comment.