Skip to content

Commit 6cc5229

Browse files
Arcanemagusmysticatea
authored andcommitted
Docs: Add URL to rule documentation to the metadata (#10)
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.
1 parent 9df52a3 commit 6cc5229

8 files changed

+8
-0
lines changed

lib/rules/disable-enable-pair.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module.exports = {
2222
description: "requires a `eslint-enable` comment for every `eslint-disable` comment",
2323
category: "Best Practices",
2424
recommended: true,
25+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/disable-enable-pair.md",
2526
},
2627
fixable: false,
2728
schema: [{

lib/rules/no-aggregating-enable.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ module.exports = {
5151
description: "disallows `eslint-enable` comments for multiple `eslint-disable` comments",
5252
category: "Best Practices",
5353
recommended: true,
54+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-aggregating-enable.md",
5455
},
5556
fixable: false,
5657
schema: [],

lib/rules/no-duplicate-disable.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module.exports = {
2222
description: "disallows duplicate `eslint-disable` comments",
2323
category: "Best Practices",
2424
recommended: true,
25+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-duplicate-disable.md",
2526
},
2627
fixable: false,
2728
schema: [],

lib/rules/no-restricted-disable.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ module.exports = {
5858
description: "disallows `eslint-disable` comments about specific rules",
5959
category: "Stylistic Issues",
6060
recommended: false,
61+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-restricted-disable.md",
6162
},
6263
fixable: false,
6364
schema: {

lib/rules/no-unlimited-disable.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ module.exports = {
3030
description: "disallows `eslint-disable` comments without rule names",
3131
category: "Best Practices",
3232
recommended: true,
33+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-unlimited-disable.md",
3334
},
3435
fixable: false,
3536
schema: [],

lib/rules/no-unused-disable.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module.exports = {
2222
description: "disallows unused `eslint-disable` comments",
2323
category: "Best Practices",
2424
recommended: true,
25+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-unused-disable.md",
2526
},
2627
fixable: false,
2728
schema: [],

lib/rules/no-unused-enable.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module.exports = {
2222
description: "disallows unused `eslint-enable` comments",
2323
category: "Best Practices",
2424
recommended: true,
25+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-unused-enable.md",
2526
},
2627
fixable: false,
2728
schema: [],

lib/rules/no-use.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ module.exports = {
3030
description: "disallows ESLint directive-comments",
3131
category: "Stylistic Issues",
3232
recommended: false,
33+
url: "https://github.com/mysticatea/eslint-plugin-eslint-comments/tree/master/docs/rules/no-use.md",
3334
},
3435
fixable: false,
3536
schema: [{

0 commit comments

Comments
 (0)