[Docs]: Recategorize rules in readme

jsx-eslint · Feb 28, 2022 · a189556 · a189556
1 parent e972bd7
commit a189556
Show file tree

Hide file tree

Showing 97 changed files with 174 additions and 149 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: 'suggestion',
       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: 'suggestion',
       recommended: false,
       url: docsUrl('button-has-type'),
     },

diff --git a/lib/rules/default-props-match-prop-types.js b/lib/rules/default-props-match-prop-types.js
@@ -23,7 +23,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce all defaultProps are defined and not "required" in propTypes.',
-      category: 'Best Practices',
+      category: 'suggestion',
       url: docsUrl('default-props-match-prop-types'),
     },
 

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: 'suggestion',
       recommended: false,
       url: docsUrl('destructuring-assignment'),
     },

diff --git a/lib/rules/display-name.js b/lib/rules/display-name.js
@@ -25,7 +25,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevent missing displayName in a React component definition',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: true,
       url: docsUrl('display-name'),
     },

diff --git a/lib/rules/forbid-component-props.js b/lib/rules/forbid-component-props.js
@@ -26,7 +26,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Forbid certain props on components',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('forbid-component-props'),
     },

diff --git a/lib/rules/forbid-dom-props.js b/lib/rules/forbid-dom-props.js
@@ -26,7 +26,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Forbid certain props on DOM Nodes',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('forbid-dom-props'),
     },

diff --git a/lib/rules/forbid-elements.js b/lib/rules/forbid-elements.js
@@ -23,7 +23,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Forbid certain elements',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('forbid-elements'),
     },

diff --git a/lib/rules/forbid-foreign-prop-types.js b/lib/rules/forbid-foreign-prop-types.js
@@ -17,7 +17,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Forbid using another component\'s propTypes',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('forbid-foreign-prop-types'),
     },

diff --git a/lib/rules/forbid-prop-types.js b/lib/rules/forbid-prop-types.js
@@ -29,7 +29,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Forbid certain propTypes',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('forbid-prop-types'),
     },

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: 'suggestion',
       recommended: false,
       url: docsUrl('function-component-definition'),
     },

diff --git a/lib/rules/hook-use-state.js b/lib/rules/hook-use-state.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Ensure symmetric naming of useState hook value and setter variables',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('hook-use-state'),
     },

diff --git a/lib/rules/iframe-missing-sandbox.js b/lib/rules/iframe-missing-sandbox.js
@@ -113,7 +113,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce sandbox attribute on iframe elements',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('iframe-missing-sandbox'),
     },

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: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-boolean-value'),
     },

diff --git a/lib/rules/jsx-child-element-spacing.js b/lib/rules/jsx-child-element-spacing.js
@@ -48,7 +48,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Ensures inline tags are not rendered without spaces between them',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-child-element-spacing'),
     },

diff --git a/lib/rules/jsx-closing-bracket-location.js b/lib/rules/jsx-closing-bracket-location.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Validate closing bracket location in JSX',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-closing-bracket-location'),
     },

diff --git a/lib/rules/jsx-closing-tag-location.js b/lib/rules/jsx-closing-tag-location.js
@@ -22,7 +22,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Validate closing tag location for multiline JSX',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-closing-tag-location'),
     },

diff --git a/lib/rules/jsx-curly-brace-presence.js b/lib/rules/jsx-curly-brace-presence.js
@@ -40,7 +40,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Disallow unnecessary JSX expressions when literals alone are sufficient or enfore JSX expressions on literals in JSX children or attributes',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-curly-brace-presence'),
     },

diff --git a/lib/rules/jsx-curly-newline.js b/lib/rules/jsx-curly-newline.js
@@ -47,7 +47,7 @@ module.exports = {
 
     docs: {
       description: 'Enforce consistent line breaks inside jsx curly',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-curly-newline'),
     },

diff --git a/lib/rules/jsx-curly-spacing.js b/lib/rules/jsx-curly-spacing.js
@@ -38,7 +38,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce or disallow spaces inside of curly braces in JSX attributes',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-curly-spacing'),
     },

diff --git a/lib/rules/jsx-equals-spacing.js b/lib/rules/jsx-equals-spacing.js
@@ -23,7 +23,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Disallow or enforce spaces around equal signs in JSX attributes',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-equals-spacing'),
     },

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: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-filename-extension'),
     },

diff --git a/lib/rules/jsx-first-prop-new-line.js b/lib/rules/jsx-first-prop-new-line.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Ensure proper position of the first property in JSX',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-first-prop-new-line'),
     },

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: 'suggestion',
       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: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-handler-names'),
     },

diff --git a/lib/rules/jsx-indent-props.js b/lib/rules/jsx-indent-props.js
@@ -46,7 +46,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Validate props indentation in JSX',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-indent-props'),
     },

diff --git a/lib/rules/jsx-indent.js b/lib/rules/jsx-indent.js
@@ -50,7 +50,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Validate JSX indentation',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-indent'),
     },

diff --git a/lib/rules/jsx-key.js b/lib/rules/jsx-key.js
@@ -35,7 +35,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Report missing `key` props in iterators/collection literals',
-      category: 'Possible Errors',
+      category: 'problem',
       recommended: true,
       url: docsUrl('jsx-key'),
     },

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: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-max-depth'),
     },

diff --git a/lib/rules/jsx-max-props-per-line.js b/lib/rules/jsx-max-props-per-line.js
@@ -27,7 +27,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Limit maximum of props on a single line in JSX',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-max-props-per-line'),
     },

diff --git a/lib/rules/jsx-newline.js b/lib/rules/jsx-newline.js
@@ -22,7 +22,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Require or prevent a new line after jsx elements and expressions.',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-newline'),
     },

diff --git a/lib/rules/jsx-no-bind.js b/lib/rules/jsx-no-bind.js
@@ -28,7 +28,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevents usage of Function.prototype.bind and arrow functions in React component props',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-no-bind'),
     },

diff --git a/lib/rules/jsx-no-comment-textnodes.js b/lib/rules/jsx-no-comment-textnodes.js
@@ -37,7 +37,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Comments inside children section of tag should be placed inside braces',
-      category: 'Possible Errors',
+      category: 'problem',
       recommended: true,
       url: docsUrl('jsx-no-comment-textnodes'),
     },

diff --git a/lib/rules/jsx-no-constructed-context-values.js b/lib/rules/jsx-no-constructed-context-values.js
@@ -132,7 +132,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevents JSX context provider values from taking values that will cause needless rerenders.',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-no-constructed-context-values'),
     },

diff --git a/lib/rules/jsx-no-duplicate-props.js b/lib/rules/jsx-no-duplicate-props.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Enforce no duplicate props',
-      category: 'Possible Errors',
+      category: 'problem',
       recommended: true,
       url: docsUrl('jsx-no-duplicate-props'),
     },

diff --git a/lib/rules/jsx-no-literals.js b/lib/rules/jsx-no-literals.js
@@ -28,7 +28,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevent using string literals in React component definition',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-no-literals'),
     },

diff --git a/lib/rules/jsx-no-script-url.js b/lib/rules/jsx-no-script-url.js
@@ -51,7 +51,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Forbid `javascript:` URLs',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-no-script-url'),
     },

diff --git a/lib/rules/jsx-no-target-blank.js b/lib/rules/jsx-no-target-blank.js
@@ -106,7 +106,7 @@ module.exports = {
     fixable: 'code',
     docs: {
       description: 'Forbid `target="_blank"` attribute without `rel="noreferrer"`',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: true,
       url: docsUrl('jsx-no-target-blank'),
     },

diff --git a/lib/rules/jsx-no-undef.js b/lib/rules/jsx-no-undef.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Disallow undeclared variables in JSX',
-      category: 'Possible Errors',
+      category: 'problem',
       recommended: true,
       url: docsUrl('jsx-no-undef'),
     },

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: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-no-useless-fragment'),
     },

diff --git a/lib/rules/jsx-one-expression-per-line.js b/lib/rules/jsx-one-expression-per-line.js
@@ -25,7 +25,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Limit to one expression per line in JSX',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-one-expression-per-line'),
     },

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: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-pascal-case'),
     },

diff --git a/lib/rules/jsx-props-no-multi-spaces.js b/lib/rules/jsx-props-no-multi-spaces.js
@@ -21,7 +21,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Disallow multiple spaces between inline JSX props',
-      category: 'Stylistic Issues',
+      category: 'layout',
       recommended: false,
       url: docsUrl('jsx-props-no-multi-spaces'),
     },

diff --git a/lib/rules/jsx-props-no-spreading.js b/lib/rules/jsx-props-no-spreading.js
@@ -42,7 +42,7 @@ module.exports = {
   meta: {
     docs: {
       description: 'Prevent JSX prop spreading',
-      category: 'Best Practices',
+      category: 'suggestion',
       recommended: false,
       url: docsUrl('jsx-props-no-spreading'),
     },