Breaking: remove meta.docs.category in core rules (fixes #13398) (#14594

) * Breaking: remove category in core rules (fixes #13398) chore: rm meta.cat from core rules chore: do not require meta.cat in internal rules chore: rename cat => ruletype Chore: rename conf/category-list.json => rule-type-list.json chore: update tools/update-rule-types chore: review suggestions Update conf/rule-type-list.json Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> Update Makefile.js Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * chore: remove unused files * fix: conflicts * remove missingMetaDocsDescription message Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
eslint · Aug 24, 2021 · 305e14a · 305e14a
1 parent a79c9f3
commit 305e14a
Show file tree

Hide file tree

Showing 289 changed files with 13 additions and 364 deletions.
diff --git a/Makefile.js b/Makefile.js
@@ -177,8 +177,8 @@ function generateFormatterExamples(formatterInfo, prereleaseVersion) {
  */
 function generateRuleIndexPage() {
     const outputFile = "../website/_data/rules.yml",
-        categoryList = "conf/category-list.json",
-        categoriesData = JSON.parse(cat(path.resolve(categoryList)));
+        ruleTypes = "conf/rule-type-list.json",
+        ruleTypesData = JSON.parse(cat(path.resolve(ruleTypes)));
 
     RULE_FILES
         .map(filename => [filename, path.basename(filename, ".js")])
@@ -189,7 +189,7 @@ function generateRuleIndexPage() {
             const rule = require(path.resolve(filename));
 
             if (rule.meta.deprecated) {
-                categoriesData.deprecated.rules.push({
+                ruleTypesData.deprecated.rules.push({
                     name: basename,
                     replacedBy: rule.meta.replacedBy || []
                 });
@@ -201,20 +201,20 @@ function generateRuleIndexPage() {
                         fixable: !!rule.meta.fixable,
                         hasSuggestions: !!rule.meta.hasSuggestions
                     },
-                    category = categoriesData.categories.find(c => c.name === rule.meta.docs.category);
+                    ruleType = ruleTypesData.types.find(c => c.name === rule.meta.type);
 
-                if (!category.rules) {
-                    category.rules = [];
+                if (!ruleType.rules) {
+                    ruleType.rules = [];
                 }
 
-                category.rules.push(output);
+                ruleType.rules.push(output);
             }
         });
 
     // `.rules` will be `undefined` if all rules in category are deprecated.
-    categoriesData.categories = categoriesData.categories.filter(category => !!category.rules);
+    ruleTypesData.types = ruleTypesData.types.filter(ruleType => !!ruleType.rules);
 
-    const output = yaml.dump(categoriesData, { sortKeys: true });
+    const output = yaml.dump(ruleTypesData, { sortKeys: true });
 
     output.to(outputFile);
 }

diff --git a/conf/category-list.json → conf/rule-type-list.json b/conf/category-list.json → conf/rule-type-list.json
@@ -1,11 +1,8 @@
 {
-    "categories": [
-        { "name": "Possible Errors", "description": "These rules relate to possible syntax or logic errors in JavaScript code:" },
-        { "name": "Best Practices", "description": "These rules relate to better ways of doing things to help you avoid problems:" },
-        { "name": "Strict Mode", "description": "These rules relate to strict mode directives:" },
-        { "name": "Variables", "description": "These rules relate to variable declarations:" },
-        { "name": "Stylistic Issues", "description": "These rules relate to style guidelines, and are therefore quite subjective:" },
-        { "name": "ECMAScript 6", "description": "These rules relate to ES6, also known as ES2015:" }
+    "types": [
+        { "name": "problem", "displayName": "Possible Problems", "description": "These rules relate to possible logic errors in code:" },
+        { "name": "suggestion", "displayName": "Suggestions", "description": "These rules suggest alternate ways of doing things:" },
+        { "name": "layout", "displayName": "Layout & Formatting", "description": "These rules care about how the code looks rather than how it executes:" }
     ],
     "deprecated": {
         "name": "Deprecated",

diff --git a/lib/rules/accessor-pairs.js b/lib/rules/accessor-pairs.js
@@ -140,7 +140,6 @@ module.exports = {
 
         docs: {
             description: "enforce getter and setter pairs in objects and classes",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/accessor-pairs"
         },

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

diff --git a/lib/rules/default-case-last.js b/lib/rules/default-case-last.js
@@ -15,7 +15,6 @@ module.exports = {
 
         docs: {
             description: "enforce default clauses in switch statements to be last",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/default-case-last"
         },

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

diff --git a/lib/rules/default-param-last.js b/lib/rules/default-param-last.js
@@ -11,7 +11,6 @@ module.exports = {
 
         docs: {
             description: "enforce default parameters to be last",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/default-param-last"
         },

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

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

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

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

diff --git a/lib/rules/for-direction.js b/lib/rules/for-direction.js
@@ -15,7 +15,6 @@ module.exports = {
 
         docs: {
             description: "enforce \"for\" loop update clause moving the counter in the right direction.",
-            category: "Possible Errors",
             recommended: true,
             url: "https://eslint.org/docs/rules/for-direction"
         },

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

diff --git a/lib/rules/func-name-matching.js b/lib/rules/func-name-matching.js
@@ -74,7 +74,6 @@ 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,
             url: "https://eslint.org/docs/rules/func-name-matching"
         },

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

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

diff --git a/lib/rules/function-call-argument-newline.js b/lib/rules/function-call-argument-newline.js
@@ -15,7 +15,6 @@ module.exports = {
 
         docs: {
             description: "enforce line breaks between arguments of a function call",
-            category: "Stylistic Issues",
             recommended: false,
             url: "https://eslint.org/docs/rules/function-call-argument-newline"
         },

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

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

diff --git a/lib/rules/getter-return.js b/lib/rules/getter-return.js
@@ -35,7 +35,6 @@ module.exports = {
 
         docs: {
             description: "enforce `return` statements in getters",
-            category: "Possible Errors",
             recommended: true,
             url: "https://eslint.org/docs/rules/getter-return"
         },

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

diff --git a/lib/rules/grouped-accessor-pairs.js b/lib/rules/grouped-accessor-pairs.js
@@ -96,7 +96,6 @@ module.exports = {
 
         docs: {
             description: "require grouped accessor pairs in object literals and classes",
-            category: "Best Practices",
             recommended: false,
             url: "https://eslint.org/docs/rules/grouped-accessor-pairs"
         },