[Docs]: Recategorize rules in readme

jsx-eslint · Mar 5, 2022 · 793d537 · 793d537
1 parent 24bf594
commit 793d537
Show file tree

Hide file tree

Showing 23 changed files with 99 additions and 74 deletions.
diff --git a/README.md b/README.md
diff --git a/lib/rules/boolean-prop-naming.js b/lib/rules/boolean-prop-naming.js
@@ -22,7 +22,7 @@ const messages = {
 module.exports = {
   meta: {
     docs: {
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       description: 'Enforces consistent naming for boolean props',
       recommended: false,
       url: docsUrl('boolean-prop-naming'),

diff --git a/lib/rules/button-has-type.js b/lib/rules/button-has-type.js
@@ -32,7 +32,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Forbid "button" element without an explicit "type" attribute',
-      category: 'Possible Errors',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('button-has-type'),
     },

diff --git a/lib/rules/destructuring-assignment.js b/lib/rules/destructuring-assignment.js
@@ -56,7 +56,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce consistent usage of destructuring assignment of props, state, and context',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('destructuring-assignment'),
     },

diff --git a/lib/rules/function-component-definition.js b/lib/rules/function-component-definition.js
@@ -102,7 +102,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Standardize the way function component get defined',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('function-component-definition'),
     },

diff --git a/lib/rules/jsx-boolean-value.js b/lib/rules/jsx-boolean-value.js
@@ -58,7 +58,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce boolean attributes notation in JSX',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('jsx-boolean-value'),
     },

diff --git a/lib/rules/jsx-filename-extension.js b/lib/rules/jsx-filename-extension.js
@@ -31,7 +31,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Restrict file extensions that may contain JSX',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('jsx-filename-extension'),
     },

diff --git a/lib/rules/jsx-fragments.js b/lib/rules/jsx-fragments.js
@@ -31,7 +31,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce shorthand or standard form for React fragments',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('jsx-fragments'),
     },

diff --git a/lib/rules/jsx-handler-names.js b/lib/rules/jsx-handler-names.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce event handler naming conventions in JSX',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('jsx-handler-names'),
     },

diff --git a/lib/rules/jsx-max-depth.js b/lib/rules/jsx-max-depth.js
@@ -24,7 +24,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Validate JSX maximum depth',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('jsx-max-depth'),
     },

diff --git a/lib/rules/jsx-no-useless-fragment.js b/lib/rules/jsx-no-useless-fragment.js
@@ -89,7 +89,7 @@ module.exports = {
     fixable: 'code',
     docs: {
       description: 'Disallow unnecessary fragments',
-      category: 'Possible Errors',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('jsx-no-useless-fragment'),
     },

diff --git a/lib/rules/jsx-pascal-case.js b/lib/rules/jsx-pascal-case.js
@@ -80,7 +80,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce PascalCase for user-defined JSX components',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('jsx-pascal-case'),
     },

diff --git a/lib/rules/no-invalid-html-attribute.js b/lib/rules/no-invalid-html-attribute.js
@@ -533,7 +533,7 @@ module.exports = {
   meta: {
     fixable: 'code',
     docs: {
-      description: 'Forbid attribute with an invalid values`',
+      description: 'Forbid attribute with an invalid values',
       category: 'Possible Errors',
       url: docsUrl('no-invalid-html-attribute'),
     },

diff --git a/lib/rules/no-multi-comp.js b/lib/rules/no-multi-comp.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevent multiple component definition per file',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('no-multi-comp'),
     },

diff --git a/lib/rules/no-set-state.js b/lib/rules/no-set-state.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevent usage of setState',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('no-set-state'),
     },

diff --git a/lib/rules/no-typos.js b/lib/rules/no-typos.js
@@ -31,7 +31,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevent common typos',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('no-typos'),
     },

diff --git a/lib/rules/no-unstable-nested-components.js b/lib/rules/no-unstable-nested-components.js
@@ -270,7 +270,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevent creating unstable components inside components',
-      category: 'Possible Errors',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('no-unstable-nested-components'),
     },

diff --git a/lib/rules/prefer-es6-class.js b/lib/rules/prefer-es6-class.js
@@ -22,7 +22,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce ES5 or ES6 class for React Components',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('prefer-es6-class'),
     },

diff --git a/lib/rules/prefer-exact-props.js b/lib/rules/prefer-exact-props.js
@@ -24,7 +24,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prefer exact proptype definitions',
-      category: 'Possible Errors',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('prefer-exact-props'),
     },

diff --git a/lib/rules/prefer-read-only-props.js b/lib/rules/prefer-read-only-props.js
@@ -36,7 +36,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Require read-only props.',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('prefer-read-only-props'),
     },

diff --git a/lib/rules/prefer-stateless-function.js b/lib/rules/prefer-stateless-function.js
@@ -25,7 +25,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce stateless components to be written as a pure function',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('prefer-stateless-function'),
     },

diff --git a/lib/rules/state-in-constructor.js b/lib/rules/state-in-constructor.js
@@ -22,7 +22,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'State initialization in an ES6 class component should be in a constructor',
-      category: 'Stylistic Issues',
+      category: 'Best Practices',
       recommended: false,
       url: docsUrl('state-in-constructor'),
     },

diff --git a/markdown.config.js b/markdown.config.js
@@ -4,18 +4,16 @@
 
 const { rules } = require('./index');
 
-const ruleTableRows = Object.keys(rules)
-  .sort()
-  .map((id) => {
-    const { meta } = rules[id];
-    const { fixable, docs } = meta;
-    return [
-      docs.recommended ? '✔' : '',
-      fixable ? '🔧' : '',
-      `[react/${id}](docs/rules/${id}.md)`,
-      docs.description,
-    ].join(' | ');
-  });
+const buildRuleRow = (id) => {
+  const { meta } = rules[id];
+  const { fixable, docs } = meta;
+  return [
+    docs.recommended ? '✔' : '',
+    fixable ? '🔧' : '',
+    `[react/${id}](docs/rules/${id}.md)`,
+    docs.description,
+  ].join(' | ');
+};
 
 const buildRulesTable = (rows) => {
   const header = '✔ | 🔧 | Rule | Description';
@@ -26,13 +24,31 @@ const buildRulesTable = (rows) => {
     .join('\n');
 };
 
-const BASIC_RULES = () => buildRulesTable(ruleTableRows.filter((rule) => !rule.includes('react/jsx-')));
-const JSX_RULES = () => buildRulesTable(ruleTableRows.filter((rule) => rule.includes('react/jsx-')));
+const buildTableOfCategory = (category) => buildRulesTable(
+  Object.keys(rules)
+    .sort()
+    .filter((rule) => rules[rule].meta.docs.category === category)
+    .map((r) => buildRuleRow(r))
+);
+
+for (const rule in rules) {
+  if (
+    !['Possible Errors', 'Best Practices', 'Stylistic Issues'].includes(
+      rules[rule].meta.docs.category
+    )
+  ) {
+    console.error(
+      `Rule ${rule} has wrong category: ${rules[rule].meta.docs.category}`
+    );
+    process.exit(1);
+  }
+}
 
 module.exports = {
   transforms: {
-    BASIC_RULES,
-    JSX_RULES,
+    POSSIBLE_ERRORS_RULES: () => buildTableOfCategory('Possible Errors'),
+    BEST_PRACTICES_RULES: () => buildTableOfCategory('Best Practices'),
+    STYLISTIC_ISSUES_RULES: () => buildTableOfCategory('Stylistic Issues'),
   },
   callback: () => {
     console.log('The auto-generating of rules finished!');