Skip to content

Commit

Permalink
Docs: Add URL to rule documentation to the metadata (#102)
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 846e677 commit 27ac4a8
Show file tree
Hide file tree
Showing 13 changed files with 13 additions and 0 deletions.
1 change: 1 addition & 0 deletions lib/rules/exports-style.js
Expand Up @@ -293,6 +293,7 @@ module.exports = {
description: "enforce either `module.exports` or `exports`",
category: "Stylistic Issues",
recommended: false,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/exports-style.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-deprecated-api.js
Expand Up @@ -566,6 +566,7 @@ module.exports = {
description: "disallow deprecated APIs",
category: "Best Practices",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-deprecated-api.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-extraneous-import.js
Expand Up @@ -53,6 +53,7 @@ module.exports = {
description: "disallow `import` declarations of extraneous packages",
category: "Possible Errors",
recommended: false,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-extraneous-import.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-extraneous-require.js
Expand Up @@ -53,6 +53,7 @@ module.exports = {
description: "disallow `require()` expressions of extraneous packages",
category: "Possible Errors",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-extraneous-require.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-hide-core-modules.js
Expand Up @@ -106,6 +106,7 @@ module.exports = {
description: "disallow third-party modules which are hiding core modules",
category: "Possible Errors",
recommended: false,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-hide-core-modules.md",
},
deprecated: true,
fixable: false,
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-missing-import.js
Expand Up @@ -52,6 +52,7 @@ module.exports = {
description: "disallow `import` declarations of missing files",
category: "Possible Errors",
recommended: false,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-missing-import.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-missing-require.js
Expand Up @@ -52,6 +52,7 @@ module.exports = {
description: "disallow `require()` expressions of missing files",
category: "Possible Errors",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-missing-require.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-unpublished-bin.js
Expand Up @@ -99,6 +99,7 @@ module.exports = {
description: "disallow 'bin' files which are ignored by npm",
category: "Possible Errors",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unpublished-bin.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-unpublished-import.js
Expand Up @@ -54,6 +54,7 @@ module.exports = {
description: "disallow `import` declarations of private things",
category: "Possible Errors",
recommended: false,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unpublished-import.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-unpublished-require.js
Expand Up @@ -54,6 +54,7 @@ module.exports = {
description: "disallow `require()` expressions of private things",
category: "Possible Errors",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unpublished-require.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/no-unsupported-features.js
Expand Up @@ -673,6 +673,7 @@ module.exports = {
description: "disallow unsupported ECMAScript features on the specified version",
category: "Possible Errors",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/no-unsupported-features.md",
},
fixable: false,
schema: [
Expand Down
1 change: 1 addition & 0 deletions lib/rules/process-exit-as-throw.js
Expand Up @@ -147,6 +147,7 @@ module.exports = {
description: "make `process.exit()` expressions the same code path as `throw`",
category: "Possible Errors",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/process-exit-as-throw.md",
},
fixable: false,
schema: [],
Expand Down
1 change: 1 addition & 0 deletions lib/rules/shebang.js
Expand Up @@ -146,6 +146,7 @@ module.exports = {
description: "enforce the correct usage of shebang",
category: "Possible Errors",
recommended: true,
url: "https://github.com/mysticatea/eslint-plugin-node/tree/master/docs/rules/shebang.md",
},
fixable: "code",
schema: [
Expand Down

0 comments on commit 27ac4a8

Please sign in to comment.