Skip to content

Commit 27ac4a8

Browse files
Arcanemagusmysticatea
authored andcommitted
Docs: Add URL to rule documentation to the metadata (eslint-community#102)
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 846e677 commit 27ac4a8

13 files changed

+13
-0
lines changed

lib/rules/exports-style.js

+1
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,7 @@ module.exports = {
293293
description: "enforce either `module.exports` or `exports`",
294294
category: "Stylistic Issues",
295295
recommended: false,
296+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/exports-style.md",
296297
},
297298
fixable: false,
298299
schema: [

lib/rules/no-deprecated-api.js

+1
Original file line numberDiff line numberDiff line change
@@ -566,6 +566,7 @@ module.exports = {
566566
description: "disallow deprecated APIs",
567567
category: "Best Practices",
568568
recommended: true,
569+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-deprecated-api.md",
569570
},
570571
fixable: false,
571572
schema: [

lib/rules/no-extraneous-import.js

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ module.exports = {
5353
description: "disallow `import` declarations of extraneous packages",
5454
category: "Possible Errors",
5555
recommended: false,
56+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-extraneous-import.md",
5657
},
5758
fixable: false,
5859
schema: [

lib/rules/no-extraneous-require.js

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ module.exports = {
5353
description: "disallow `require()` expressions of extraneous packages",
5454
category: "Possible Errors",
5555
recommended: true,
56+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-extraneous-require.md",
5657
},
5758
fixable: false,
5859
schema: [

lib/rules/no-hide-core-modules.js

+1
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ module.exports = {
106106
description: "disallow third-party modules which are hiding core modules",
107107
category: "Possible Errors",
108108
recommended: false,
109+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-hide-core-modules.md",
109110
},
110111
deprecated: true,
111112
fixable: false,

lib/rules/no-missing-import.js

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ module.exports = {
5252
description: "disallow `import` declarations of missing files",
5353
category: "Possible Errors",
5454
recommended: false,
55+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-missing-import.md",
5556
},
5657
fixable: false,
5758
schema: [

lib/rules/no-missing-require.js

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ module.exports = {
5252
description: "disallow `require()` expressions of missing files",
5353
category: "Possible Errors",
5454
recommended: true,
55+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-missing-require.md",
5556
},
5657
fixable: false,
5758
schema: [

lib/rules/no-unpublished-bin.js

+1
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ module.exports = {
9999
description: "disallow 'bin' files which are ignored by npm",
100100
category: "Possible Errors",
101101
recommended: true,
102+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unpublished-bin.md",
102103
},
103104
fixable: false,
104105
schema: [

lib/rules/no-unpublished-import.js

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ module.exports = {
5454
description: "disallow `import` declarations of private things",
5555
category: "Possible Errors",
5656
recommended: false,
57+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unpublished-import.md",
5758
},
5859
fixable: false,
5960
schema: [

lib/rules/no-unpublished-require.js

+1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ module.exports = {
5454
description: "disallow `require()` expressions of private things",
5555
category: "Possible Errors",
5656
recommended: true,
57+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unpublished-require.md",
5758
},
5859
fixable: false,
5960
schema: [

lib/rules/no-unsupported-features.js

+1
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,7 @@ module.exports = {
673673
description: "disallow unsupported ECMAScript features on the specified version",
674674
category: "Possible Errors",
675675
recommended: true,
676+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unsupported-features.md",
676677
},
677678
fixable: false,
678679
schema: [

lib/rules/process-exit-as-throw.js

+1
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ module.exports = {
147147
description: "make `process.exit()` expressions the same code path as `throw`",
148148
category: "Possible Errors",
149149
recommended: true,
150+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/process-exit-as-throw.md",
150151
},
151152
fixable: false,
152153
schema: [],

lib/rules/shebang.js

+1
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,7 @@ module.exports = {
146146
description: "enforce the correct usage of shebang",
147147
category: "Possible Errors",
148148
recommended: true,
149+
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/shebang.md",
149150
},
150151
fixable: "code",
151152
schema: [

0 commit comments

Comments
 (0)