Docs: add url to each of the rules (refs #6582) (#9788)

* Docs: add url to each of the rules (refs #6582) Code mod: export default function transformer(file, api) { const j = api.jscodeshift; const name = file.path.split('/').pop().replace(/.js$/, ''); return j(file.source) .find(j.ObjectExpression) .filter(path => path.parentPath.node.key && path.parentPath.node.key.name === 'docs') .forEach(path => { const prop = j.property('init', j.identifier('url'), j.literal(`https://eslint.org/docs/rules/${name}`)); j(path).replaceWith(j.objectExpression([...path.node.properties, prop])); }) .toSource({lineTerminator: '\n'}); } * New: internal-rules/consistent-docs-url (refs #6582) Add a lint rule to ensure that each rule has a meta.docs.url property with the correct value.
eslint · Jan 5, 2018 · fc7f404 · fc7f404
1 parent fc44da9
commit fc7f404
Show file tree

Hide file tree

Showing 263 changed files with 706 additions and 259 deletions.
diff --git a/lib/rules/.eslintrc.yml b/lib/rules/.eslintrc.yml
@@ -1,3 +1,4 @@
 rules:
     rulesdir/no-invalid-meta: "error"
     rulesdir/consistent-docs-description: "error"
+    rulesdir/consistent-docs-url: "error"
diff --git a/lib/rules/accessor-pairs.js b/lib/rules/accessor-pairs.js
@@ -75,7 +75,8 @@ module.exports = {
         docs: {
             description: "enforce getter and setter pairs in objects",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/accessor-pairs"
         },
         schema: [{
             type: "object",

diff --git a/lib/rules/array-bracket-newline.js b/lib/rules/array-bracket-newline.js
@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "enforce linebreaks after opening and before closing array brackets",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/array-bracket-newline"
         },
         fixable: "whitespace",
         schema: [

diff --git a/lib/rules/array-bracket-spacing.js b/lib/rules/array-bracket-spacing.js
@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing inside array brackets",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/array-bracket-spacing"
         },
         fixable: "whitespace",
         schema: [

diff --git a/lib/rules/array-callback-return.js b/lib/rules/array-callback-return.js
@@ -142,7 +142,8 @@ module.exports = {
         docs: {
             description: "enforce `return` statements in callbacks of array methods",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/array-callback-return"
         },
 
         schema: [

diff --git a/lib/rules/array-element-newline.js b/lib/rules/array-element-newline.js
@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "enforce line breaks after each array element",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/array-element-newline"
         },
         fixable: "whitespace",
         schema: [

diff --git a/lib/rules/arrow-body-style.js b/lib/rules/arrow-body-style.js
@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "require braces around arrow function bodies",
             category: "ECMAScript 6",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/arrow-body-style"
         },
 
         schema: {

diff --git a/lib/rules/arrow-parens.js b/lib/rules/arrow-parens.js
@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "require parentheses around arrow function arguments",
             category: "ECMAScript 6",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/arrow-parens"
         },
 
         fixable: "code",

diff --git a/lib/rules/arrow-spacing.js b/lib/rules/arrow-spacing.js
@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing before and after the arrow in arrow functions",
             category: "ECMAScript 6",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/arrow-spacing"
         },
 
         fixable: "whitespace",

diff --git a/lib/rules/block-scoped-var.js b/lib/rules/block-scoped-var.js
@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "enforce the use of variables within the scope they are defined",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/block-scoped-var"
         },
 
         schema: []

diff --git a/lib/rules/block-spacing.js b/lib/rules/block-spacing.js
@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "disallow or enforce spaces inside of blocks after opening block and before closing block",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/block-spacing"
         },
 
         fixable: "whitespace",

diff --git a/lib/rules/brace-style.js b/lib/rules/brace-style.js
@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "enforce consistent brace style for blocks",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/brace-style"
         },
 
         schema: [

diff --git a/lib/rules/callback-return.js b/lib/rules/callback-return.js
@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "require `return` statements after callbacks",
             category: "Node.js and CommonJS",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/callback-return"
         },
 
         schema: [{

diff --git a/lib/rules/camelcase.js b/lib/rules/camelcase.js
@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "enforce camelcase naming convention",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/camelcase"
         },
 
         schema: [

diff --git a/lib/rules/capitalized-comments.js b/lib/rules/capitalized-comments.js
@@ -113,7 +113,8 @@ module.exports = {
         docs: {
             description: "enforce or disallow capitalization of the first letter of a comment",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/capitalized-comments"
         },
         fixable: "code",
         schema: [

diff --git a/lib/rules/class-methods-use-this.js b/lib/rules/class-methods-use-this.js
@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "enforce that class methods utilize `this`",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/class-methods-use-this"
         },
         schema: [{
             type: "object",

diff --git a/lib/rules/comma-dangle.js b/lib/rules/comma-dangle.js
@@ -79,7 +79,8 @@ module.exports = {
         docs: {
             description: "require or disallow trailing commas",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/comma-dangle"
         },
         fixable: "code",
         schema: {

diff --git a/lib/rules/comma-spacing.js b/lib/rules/comma-spacing.js
@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing before and after commas",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/comma-spacing"
         },
 
         fixable: "whitespace",

diff --git a/lib/rules/comma-style.js b/lib/rules/comma-style.js
@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "enforce consistent comma style",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/comma-style"
         },
         fixable: "code",
         schema: [

diff --git a/lib/rules/complexity.js b/lib/rules/complexity.js
@@ -23,7 +23,8 @@ module.exports = {
         docs: {
             description: "enforce a maximum cyclomatic complexity allowed in a program",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/complexity"
         },
 
         schema: [

diff --git a/lib/rules/computed-property-spacing.js b/lib/rules/computed-property-spacing.js
@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing inside computed property brackets",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/computed-property-spacing"
         },
 
         fixable: "whitespace",

diff --git a/lib/rules/consistent-return.js b/lib/rules/consistent-return.js
@@ -56,7 +56,8 @@ module.exports = {
         docs: {
             description: "require `return` statements to either always or never specify values",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/consistent-return"
         },
 
         schema: [{

diff --git a/lib/rules/consistent-this.js b/lib/rules/consistent-this.js
@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "enforce consistent naming when capturing the current execution context",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/consistent-this"
         },
 
         schema: {

diff --git a/lib/rules/constructor-super.js b/lib/rules/constructor-super.js
@@ -95,7 +95,8 @@ module.exports = {
         docs: {
             description: "require `super()` calls in constructors",
             category: "ECMAScript 6",
-            recommended: true
+            recommended: true,
+            url: "https://eslint.org/docs/rules/constructor-super"
         },
 
         schema: []

diff --git a/lib/rules/curly.js b/lib/rules/curly.js
@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "enforce consistent brace style for all control statements",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/curly"
         },
 
         schema: {

diff --git a/lib/rules/default-case.js b/lib/rules/default-case.js
@@ -15,7 +15,8 @@ module.exports = {
         docs: {
             description: "require `default` cases in `switch` statements",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/default-case"
         },
 
         schema: [{

diff --git a/lib/rules/dot-location.js b/lib/rules/dot-location.js
@@ -16,7 +16,8 @@ module.exports = {
         docs: {
             description: "enforce consistent newlines before and after dots",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/dot-location"
         },
 
         schema: [

diff --git a/lib/rules/dot-notation.js b/lib/rules/dot-notation.js
@@ -22,7 +22,8 @@ module.exports = {
         docs: {
             description: "enforce dot notation whenever possible",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/dot-notation"
         },
 
         schema: [

diff --git a/lib/rules/eol-last.js b/lib/rules/eol-last.js
@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "require or disallow newline at the end of files",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/eol-last"
         },
         fixable: "whitespace",
         schema: [

diff --git a/lib/rules/eqeqeq.js b/lib/rules/eqeqeq.js
@@ -20,7 +20,8 @@ module.exports = {
         docs: {
             description: "require the use of `===` and `!==`",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/eqeqeq"
         },
 
         schema: {

diff --git a/lib/rules/for-direction.js b/lib/rules/for-direction.js
@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "enforce \"for\" loop update clause moving the counter in the right direction.",
             category: "Possible Errors",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/for-direction"
         },
         fixable: null,
         schema: []

diff --git a/lib/rules/func-call-spacing.js b/lib/rules/func-call-spacing.js
@@ -20,7 +20,8 @@ module.exports = {
         docs: {
             description: "require or disallow spacing between function identifiers and their invocations",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-call-spacing"
         },
 
         fixable: "whitespace",

diff --git a/lib/rules/func-name-matching.js b/lib/rules/func-name-matching.js
@@ -70,7 +70,8 @@ module.exports = {
         docs: {
             description: "require function names to match the name of the variable or property to which they are assigned",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-name-matching"
         },
 
         schema: {

diff --git a/lib/rules/func-names.js b/lib/rules/func-names.js
@@ -29,7 +29,8 @@ module.exports = {
         docs: {
             description: "require or disallow named `function` expressions",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-names"
         },
 
         schema: [

diff --git a/lib/rules/func-style.js b/lib/rules/func-style.js
@@ -13,7 +13,8 @@ module.exports = {
         docs: {
             description: "enforce the consistent use of either `function` declarations or expressions",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/func-style"
         },
 
         schema: [

diff --git a/lib/rules/function-paren-newline.js b/lib/rules/function-paren-newline.js
@@ -19,7 +19,8 @@ module.exports = {
         docs: {
             description: "enforce consistent line breaks inside function parentheses",
             category: "Stylistic Issues",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/function-paren-newline"
         },
         fixable: "whitespace",
         schema: [

diff --git a/lib/rules/generator-star-spacing.js b/lib/rules/generator-star-spacing.js
@@ -30,7 +30,8 @@ module.exports = {
         docs: {
             description: "enforce consistent spacing around `*` operators in generator functions",
             category: "ECMAScript 6",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/generator-star-spacing"
         },
 
         fixable: "whitespace",

diff --git a/lib/rules/getter-return.js b/lib/rules/getter-return.js
@@ -47,7 +47,8 @@ module.exports = {
         docs: {
             description: "enforce `return` statements in getters",
             category: "Possible Errors",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/getter-return"
         },
         fixable: null,
         schema: [

diff --git a/lib/rules/global-require.js b/lib/rules/global-require.js
@@ -51,7 +51,8 @@ module.exports = {
         docs: {
             description: "require `require()` calls to be placed at top-level module scope",
             category: "Node.js and CommonJS",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/global-require"
         },
 
         schema: []

diff --git a/lib/rules/guard-for-in.js b/lib/rules/guard-for-in.js
@@ -14,7 +14,8 @@ module.exports = {
         docs: {
             description: "require `for-in` loops to include an `if` statement",
             category: "Best Practices",
-            recommended: false
+            recommended: false,
+            url: "https://eslint.org/docs/rules/guard-for-in"
         },
 
         schema: []