From 192e9abe2d9081020fea76cd80754dec4b0b5504 Mon Sep 17 00:00:00 2001
From: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Date: Mon, 28 Nov 2022 19:18:36 -0500
Subject: [PATCH] chore: update eslint-doc-generator to v1.0.0
---
README.md | 210 +++++++++++++------------
docs/rules/display-name.md | 2 +-
docs/rules/jsx-key.md | 2 +-
docs/rules/jsx-no-comment-textnodes.md | 2 +-
docs/rules/jsx-no-duplicate-props.md | 2 +-
docs/rules/jsx-no-target-blank.md | 2 +-
docs/rules/jsx-no-undef.md | 2 +-
docs/rules/jsx-sort-default-props.md | 2 +-
docs/rules/jsx-space-before-closing.md | 2 +-
docs/rules/jsx-uses-react.md | 2 +-
docs/rules/jsx-uses-vars.md | 2 +-
docs/rules/no-children-prop.md | 2 +-
docs/rules/no-danger-with-children.md | 2 +-
docs/rules/no-deprecated.md | 2 +-
docs/rules/no-direct-mutation-state.md | 2 +-
docs/rules/no-find-dom-node.md | 2 +-
docs/rules/no-is-mounted.md | 2 +-
docs/rules/no-render-return-value.md | 2 +-
docs/rules/no-string-refs.md | 2 +-
docs/rules/no-unescaped-entities.md | 2 +-
docs/rules/no-unknown-property.md | 2 +-
docs/rules/no-unsafe.md | 2 +-
docs/rules/prop-types.md | 2 +-
docs/rules/react-in-jsx-scope.md | 2 +-
docs/rules/require-render-return.md | 2 +-
package.json | 4 +-
26 files changed, 133 insertions(+), 129 deletions(-)
diff --git a/README.md b/README.md
index 9bb7d2c9e8..f1c4b65fde 100644
--- a/README.md
+++ b/README.md
@@ -281,113 +281,115 @@ module.exports = [
-πΌ Enabled in the `recommended` [configuration](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).\
+πΌ [Configurations](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs) enabled in.\
+π« [Configurations](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs) disabled in.\
+βοΈ Set in the `recommended` [configuration](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).\
π§ Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
π‘ Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).\
β Deprecated.
-| Name | Description | πΌ | π§ | π‘ | β |
-| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- | :- | :- | :- | :- |
-| [boolean-prop-naming](docs/rules/boolean-prop-naming.md) | Enforces consistent naming for boolean props | | | | |
-| [button-has-type](docs/rules/button-has-type.md) | Disallow usage of `button` elements without an explicit `type` attribute | | | | |
-| [default-props-match-prop-types](docs/rules/default-props-match-prop-types.md) | Enforce all defaultProps have a corresponding non-required PropType | | | | |
-| [destructuring-assignment](docs/rules/destructuring-assignment.md) | Enforce consistent usage of destructuring assignment of props, state, and context | | π§ | | |
-| [display-name](docs/rules/display-name.md) | Disallow missing displayName in a React component definition | πΌ | | | |
-| [forbid-component-props](docs/rules/forbid-component-props.md) | Disallow certain props on components | | | | |
-| [forbid-dom-props](docs/rules/forbid-dom-props.md) | Disallow certain props on DOM Nodes | | | | |
-| [forbid-elements](docs/rules/forbid-elements.md) | Disallow certain elements | | | | |
-| [forbid-foreign-prop-types](docs/rules/forbid-foreign-prop-types.md) | Disallow using another component's propTypes | | | | |
-| [forbid-prop-types](docs/rules/forbid-prop-types.md) | Disallow certain propTypes | | | | |
-| [function-component-definition](docs/rules/function-component-definition.md) | Enforce a specific function type for function components | | π§ | | |
-| [hook-use-state](docs/rules/hook-use-state.md) | Ensure destructuring and symmetric naming of useState hook value and setter variables | | | π‘ | |
-| [iframe-missing-sandbox](docs/rules/iframe-missing-sandbox.md) | Enforce sandbox attribute on iframe elements | | | | |
-| [jsx-boolean-value](docs/rules/jsx-boolean-value.md) | Enforce boolean attributes notation in JSX | | π§ | | |
-| [jsx-child-element-spacing](docs/rules/jsx-child-element-spacing.md) | Enforce or disallow spaces inside of curly braces in JSX attributes and expressions | | | | |
-| [jsx-closing-bracket-location](docs/rules/jsx-closing-bracket-location.md) | Enforce closing bracket location in JSX | | π§ | | |
-| [jsx-closing-tag-location](docs/rules/jsx-closing-tag-location.md) | Enforce closing tag location for multiline JSX | | π§ | | |
-| [jsx-curly-brace-presence](docs/rules/jsx-curly-brace-presence.md) | Disallow unnecessary JSX expressions when literals alone are sufficient or enforce JSX expressions on literals in JSX children or attributes | | π§ | | |
-| [jsx-curly-newline](docs/rules/jsx-curly-newline.md) | Enforce consistent linebreaks in curly braces in JSX attributes and expressions | | π§ | | |
-| [jsx-curly-spacing](docs/rules/jsx-curly-spacing.md) | Enforce or disallow spaces inside of curly braces in JSX attributes and expressions | | π§ | | |
-| [jsx-equals-spacing](docs/rules/jsx-equals-spacing.md) | Enforce or disallow spaces around equal signs in JSX attributes | | π§ | | |
-| [jsx-filename-extension](docs/rules/jsx-filename-extension.md) | Disallow file extensions that may contain JSX | | | | |
-| [jsx-first-prop-new-line](docs/rules/jsx-first-prop-new-line.md) | Enforce proper position of the first property in JSX | | π§ | | |
-| [jsx-fragments](docs/rules/jsx-fragments.md) | Enforce shorthand or standard form for React fragments | | π§ | | |
-| [jsx-handler-names](docs/rules/jsx-handler-names.md) | Enforce event handler naming conventions in JSX | | | | |
-| [jsx-indent](docs/rules/jsx-indent.md) | Enforce JSX indentation | | π§ | | |
-| [jsx-indent-props](docs/rules/jsx-indent-props.md) | Enforce props indentation in JSX | | π§ | | |
-| [jsx-key](docs/rules/jsx-key.md) | Disallow missing `key` props in iterators/collection literals | πΌ | | | |
-| [jsx-max-depth](docs/rules/jsx-max-depth.md) | Enforce JSX maximum depth | | | | |
-| [jsx-max-props-per-line](docs/rules/jsx-max-props-per-line.md) | Enforce maximum of props on a single line in JSX | | π§ | | |
-| [jsx-newline](docs/rules/jsx-newline.md) | Require or prevent a new line after jsx elements and expressions. | | π§ | | |
-| [jsx-no-bind](docs/rules/jsx-no-bind.md) | Disallow `.bind()` or arrow functions in JSX props | | | | |
-| [jsx-no-comment-textnodes](docs/rules/jsx-no-comment-textnodes.md) | Disallow comments from being inserted as text nodes | πΌ | | | |
-| [jsx-no-constructed-context-values](docs/rules/jsx-no-constructed-context-values.md) | Disallows JSX context provider values from taking values that will cause needless rerenders | | | | |
-| [jsx-no-duplicate-props](docs/rules/jsx-no-duplicate-props.md) | Disallow duplicate properties in JSX | πΌ | | | |
-| [jsx-no-leaked-render](docs/rules/jsx-no-leaked-render.md) | Disallow problematic leaked values from being rendered | | π§ | | |
-| [jsx-no-literals](docs/rules/jsx-no-literals.md) | Disallow usage of string literals in JSX | | | | |
-| [jsx-no-script-url](docs/rules/jsx-no-script-url.md) | Disallow usage of `javascript:` URLs | | | | |
-| [jsx-no-target-blank](docs/rules/jsx-no-target-blank.md) | Disallow `target="_blank"` attribute without `rel="noreferrer"` | πΌ | π§ | | |
-| [jsx-no-undef](docs/rules/jsx-no-undef.md) | Disallow undeclared variables in JSX | πΌ | | | |
-| [jsx-no-useless-fragment](docs/rules/jsx-no-useless-fragment.md) | Disallow unnecessary fragments | | π§ | | |
-| [jsx-one-expression-per-line](docs/rules/jsx-one-expression-per-line.md) | Require one JSX element per line | | π§ | | |
-| [jsx-pascal-case](docs/rules/jsx-pascal-case.md) | Enforce PascalCase for user-defined JSX components | | | | |
-| [jsx-props-no-multi-spaces](docs/rules/jsx-props-no-multi-spaces.md) | Disallow multiple spaces between inline JSX props | | π§ | | |
-| [jsx-props-no-spreading](docs/rules/jsx-props-no-spreading.md) | Disallow JSX prop spreading | | | | |
-| [jsx-sort-default-props](docs/rules/jsx-sort-default-props.md) | Enforce defaultProps declarations alphabetical sorting | | | | β |
-| [jsx-sort-props](docs/rules/jsx-sort-props.md) | Enforce props alphabetical sorting | | π§ | | |
-| [jsx-space-before-closing](docs/rules/jsx-space-before-closing.md) | Enforce spacing before closing bracket in JSX | | π§ | | β |
-| [jsx-tag-spacing](docs/rules/jsx-tag-spacing.md) | Enforce whitespace in and around the JSX opening and closing brackets | | π§ | | |
-| [jsx-uses-react](docs/rules/jsx-uses-react.md) | Disallow React to be incorrectly marked as unused | πΌ | | | |
-| [jsx-uses-vars](docs/rules/jsx-uses-vars.md) | Disallow variables used in JSX to be incorrectly marked as unused | πΌ | | | |
-| [jsx-wrap-multilines](docs/rules/jsx-wrap-multilines.md) | Disallow missing parentheses around multiline JSX | | π§ | | |
-| [no-access-state-in-setstate](docs/rules/no-access-state-in-setstate.md) | Disallow when this.state is accessed within setState | | | | |
-| [no-adjacent-inline-elements](docs/rules/no-adjacent-inline-elements.md) | Disallow adjacent inline elements not separated by whitespace. | | | | |
-| [no-array-index-key](docs/rules/no-array-index-key.md) | Disallow usage of Array index in keys | | | | |
-| [no-arrow-function-lifecycle](docs/rules/no-arrow-function-lifecycle.md) | Lifecycle methods should be methods on the prototype, not class fields | | π§ | | |
-| [no-children-prop](docs/rules/no-children-prop.md) | Disallow passing of children as props | πΌ | | | |
-| [no-danger](docs/rules/no-danger.md) | Disallow usage of dangerous JSX properties | | | | |
-| [no-danger-with-children](docs/rules/no-danger-with-children.md) | Disallow when a DOM element is using both children and dangerouslySetInnerHTML | πΌ | | | |
-| [no-deprecated](docs/rules/no-deprecated.md) | Disallow usage of deprecated methods | πΌ | | | |
-| [no-did-mount-set-state](docs/rules/no-did-mount-set-state.md) | Disallow usage of setState in componentDidMount | | | | |
-| [no-did-update-set-state](docs/rules/no-did-update-set-state.md) | Disallow usage of setState in componentDidUpdate | | | | |
-| [no-direct-mutation-state](docs/rules/no-direct-mutation-state.md) | Disallow direct mutation of this.state | πΌ | | | |
-| [no-find-dom-node](docs/rules/no-find-dom-node.md) | Disallow usage of findDOMNode | πΌ | | | |
-| [no-invalid-html-attribute](docs/rules/no-invalid-html-attribute.md) | Disallow usage of invalid attributes | | | π‘ | |
-| [no-is-mounted](docs/rules/no-is-mounted.md) | Disallow usage of isMounted | πΌ | | | |
-| [no-multi-comp](docs/rules/no-multi-comp.md) | Disallow multiple component definition per file | | | | |
-| [no-namespace](docs/rules/no-namespace.md) | Enforce that namespaces are not used in React elements | | | | |
-| [no-object-type-as-default-prop](docs/rules/no-object-type-as-default-prop.md) | Disallow usage of referential-type variables as default param in functional component | | | | |
-| [no-redundant-should-component-update](docs/rules/no-redundant-should-component-update.md) | Disallow usage of shouldComponentUpdate when extending React.PureComponent | | | | |
-| [no-render-return-value](docs/rules/no-render-return-value.md) | Disallow usage of the return value of ReactDOM.render | πΌ | | | |
-| [no-set-state](docs/rules/no-set-state.md) | Disallow usage of setState | | | | |
-| [no-string-refs](docs/rules/no-string-refs.md) | Disallow using string references | πΌ | | | |
-| [no-this-in-sfc](docs/rules/no-this-in-sfc.md) | Disallow `this` from being used in stateless functional components | | | | |
-| [no-typos](docs/rules/no-typos.md) | Disallow common typos | | | | |
-| [no-unescaped-entities](docs/rules/no-unescaped-entities.md) | Disallow unescaped HTML entities from appearing in markup | πΌ | | | |
-| [no-unknown-property](docs/rules/no-unknown-property.md) | Disallow usage of unknown DOM property | πΌ | π§ | | |
-| [no-unsafe](docs/rules/no-unsafe.md) | Disallow usage of unsafe lifecycle methods | | | | |
-| [no-unstable-nested-components](docs/rules/no-unstable-nested-components.md) | Disallow creating unstable components inside components | | | | |
-| [no-unused-class-component-methods](docs/rules/no-unused-class-component-methods.md) | Disallow declaring unused methods of component class | | | | |
-| [no-unused-prop-types](docs/rules/no-unused-prop-types.md) | Disallow definitions of unused propTypes | | | | |
-| [no-unused-state](docs/rules/no-unused-state.md) | Disallow definitions of unused state | | | | |
-| [no-will-update-set-state](docs/rules/no-will-update-set-state.md) | Disallow usage of setState in componentWillUpdate | | | | |
-| [prefer-es6-class](docs/rules/prefer-es6-class.md) | Enforce ES5 or ES6 class for React Components | | | | |
-| [prefer-exact-props](docs/rules/prefer-exact-props.md) | Prefer exact proptype definitions | | | | |
-| [prefer-read-only-props](docs/rules/prefer-read-only-props.md) | Enforce that props are read-only | | π§ | | |
-| [prefer-stateless-function](docs/rules/prefer-stateless-function.md) | Enforce stateless components to be written as a pure function | | | | |
-| [prop-types](docs/rules/prop-types.md) | Disallow missing props validation in a React component definition | πΌ | | | |
-| [react-in-jsx-scope](docs/rules/react-in-jsx-scope.md) | Disallow missing React when using JSX | πΌ | | | |
-| [require-default-props](docs/rules/require-default-props.md) | Enforce a defaultProps definition for every prop that is not a required prop | | | | |
-| [require-optimization](docs/rules/require-optimization.md) | Enforce React components to have a shouldComponentUpdate method | | | | |
-| [require-render-return](docs/rules/require-render-return.md) | Enforce ES5 or ES6 class for returning value in render function | πΌ | | | |
-| [self-closing-comp](docs/rules/self-closing-comp.md) | Disallow extra closing tags for components without children | | π§ | | |
-| [sort-comp](docs/rules/sort-comp.md) | Enforce component methods order | | | | |
-| [sort-default-props](docs/rules/sort-default-props.md) | Enforce defaultProps declarations alphabetical sorting | | | | |
-| [sort-prop-types](docs/rules/sort-prop-types.md) | Enforce propTypes declarations alphabetical sorting | | π§ | | |
-| [state-in-constructor](docs/rules/state-in-constructor.md) | Enforce class component state initialization style | | | | |
-| [static-property-placement](docs/rules/static-property-placement.md) | Enforces where React component static properties should be positioned. | | | | |
-| [style-prop-object](docs/rules/style-prop-object.md) | Enforce style prop value is an object | | | | |
-| [void-dom-elements-no-children](docs/rules/void-dom-elements-no-children.md) | Disallow void DOM elements (e.g. ``, `
`) from receiving children | | | | |
+| NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β | Description | πΌ | π« | π§ | π‘ | β |
+| :----------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------- | :- | :--------------------- | :- | :- | :- |
+| [boolean-prop-naming](docs/rules/boolean-prop-naming.md) | Enforces consistent naming for boolean props | | | | | |
+| [button-has-type](docs/rules/button-has-type.md) | Disallow usage of `button` elements without an explicit `type` attribute | | | | | |
+| [default-props-match-prop-types](docs/rules/default-props-match-prop-types.md) | Enforce all defaultProps have a corresponding non-required PropType | | | | | |
+| [destructuring-assignment](docs/rules/destructuring-assignment.md) | Enforce consistent usage of destructuring assignment of props, state, and context | | | π§ | | |
+| [display-name](docs/rules/display-name.md) | Disallow missing displayName in a React component definition | βοΈ | | | | |
+| [forbid-component-props](docs/rules/forbid-component-props.md) | Disallow certain props on components | | | | | |
+| [forbid-dom-props](docs/rules/forbid-dom-props.md) | Disallow certain props on DOM Nodes | | | | | |
+| [forbid-elements](docs/rules/forbid-elements.md) | Disallow certain elements | | | | | |
+| [forbid-foreign-prop-types](docs/rules/forbid-foreign-prop-types.md) | Disallow using another component's propTypes | | | | | |
+| [forbid-prop-types](docs/rules/forbid-prop-types.md) | Disallow certain propTypes | | | | | |
+| [function-component-definition](docs/rules/function-component-definition.md) | Enforce a specific function type for function components | | | π§ | | |
+| [hook-use-state](docs/rules/hook-use-state.md) | Ensure destructuring and symmetric naming of useState hook value and setter variables | | | | π‘ | |
+| [iframe-missing-sandbox](docs/rules/iframe-missing-sandbox.md) | Enforce sandbox attribute on iframe elements | | | | | |
+| [jsx-boolean-value](docs/rules/jsx-boolean-value.md) | Enforce boolean attributes notation in JSX | | | π§ | | |
+| [jsx-child-element-spacing](docs/rules/jsx-child-element-spacing.md) | Enforce or disallow spaces inside of curly braces in JSX attributes and expressions | | | | | |
+| [jsx-closing-bracket-location](docs/rules/jsx-closing-bracket-location.md) | Enforce closing bracket location in JSX | | | π§ | | |
+| [jsx-closing-tag-location](docs/rules/jsx-closing-tag-location.md) | Enforce closing tag location for multiline JSX | | | π§ | | |
+| [jsx-curly-brace-presence](docs/rules/jsx-curly-brace-presence.md) | Disallow unnecessary JSX expressions when literals alone are sufficient or enforce JSX expressions on literals in JSX children or attributes | | | π§ | | |
+| [jsx-curly-newline](docs/rules/jsx-curly-newline.md) | Enforce consistent linebreaks in curly braces in JSX attributes and expressions | | | π§ | | |
+| [jsx-curly-spacing](docs/rules/jsx-curly-spacing.md) | Enforce or disallow spaces inside of curly braces in JSX attributes and expressions | | | π§ | | |
+| [jsx-equals-spacing](docs/rules/jsx-equals-spacing.md) | Enforce or disallow spaces around equal signs in JSX attributes | | | π§ | | |
+| [jsx-filename-extension](docs/rules/jsx-filename-extension.md) | Disallow file extensions that may contain JSX | | | | | |
+| [jsx-first-prop-new-line](docs/rules/jsx-first-prop-new-line.md) | Enforce proper position of the first property in JSX | | | π§ | | |
+| [jsx-fragments](docs/rules/jsx-fragments.md) | Enforce shorthand or standard form for React fragments | | | π§ | | |
+| [jsx-handler-names](docs/rules/jsx-handler-names.md) | Enforce event handler naming conventions in JSX | | | | | |
+| [jsx-indent](docs/rules/jsx-indent.md) | Enforce JSX indentation | | | π§ | | |
+| [jsx-indent-props](docs/rules/jsx-indent-props.md) | Enforce props indentation in JSX | | | π§ | | |
+| [jsx-key](docs/rules/jsx-key.md) | Disallow missing `key` props in iterators/collection literals | βοΈ | | | | |
+| [jsx-max-depth](docs/rules/jsx-max-depth.md) | Enforce JSX maximum depth | | | | | |
+| [jsx-max-props-per-line](docs/rules/jsx-max-props-per-line.md) | Enforce maximum of props on a single line in JSX | | | π§ | | |
+| [jsx-newline](docs/rules/jsx-newline.md) | Require or prevent a new line after jsx elements and expressions. | | | π§ | | |
+| [jsx-no-bind](docs/rules/jsx-no-bind.md) | Disallow `.bind()` or arrow functions in JSX props | | | | | |
+| [jsx-no-comment-textnodes](docs/rules/jsx-no-comment-textnodes.md) | Disallow comments from being inserted as text nodes | βοΈ | | | | |
+| [jsx-no-constructed-context-values](docs/rules/jsx-no-constructed-context-values.md) | Disallows JSX context provider values from taking values that will cause needless rerenders | | | | | |
+| [jsx-no-duplicate-props](docs/rules/jsx-no-duplicate-props.md) | Disallow duplicate properties in JSX | βοΈ | | | | |
+| [jsx-no-leaked-render](docs/rules/jsx-no-leaked-render.md) | Disallow problematic leaked values from being rendered | | | π§ | | |
+| [jsx-no-literals](docs/rules/jsx-no-literals.md) | Disallow usage of string literals in JSX | | | | | |
+| [jsx-no-script-url](docs/rules/jsx-no-script-url.md) | Disallow usage of `javascript:` URLs | | | | | |
+| [jsx-no-target-blank](docs/rules/jsx-no-target-blank.md) | Disallow `target="_blank"` attribute without `rel="noreferrer"` | βοΈ | | π§ | | |
+| [jsx-no-undef](docs/rules/jsx-no-undef.md) | Disallow undeclared variables in JSX | βοΈ | | | | |
+| [jsx-no-useless-fragment](docs/rules/jsx-no-useless-fragment.md) | Disallow unnecessary fragments | | | π§ | | |
+| [jsx-one-expression-per-line](docs/rules/jsx-one-expression-per-line.md) | Require one JSX element per line | | | π§ | | |
+| [jsx-pascal-case](docs/rules/jsx-pascal-case.md) | Enforce PascalCase for user-defined JSX components | | | | | |
+| [jsx-props-no-multi-spaces](docs/rules/jsx-props-no-multi-spaces.md) | Disallow multiple spaces between inline JSX props | | | π§ | | |
+| [jsx-props-no-spreading](docs/rules/jsx-props-no-spreading.md) | Disallow JSX prop spreading | | | | | |
+| [jsx-sort-default-props](docs/rules/jsx-sort-default-props.md) | Enforce defaultProps declarations alphabetical sorting | | | | | β |
+| [jsx-sort-props](docs/rules/jsx-sort-props.md) | Enforce props alphabetical sorting | | | π§ | | |
+| [jsx-space-before-closing](docs/rules/jsx-space-before-closing.md) | Enforce spacing before closing bracket in JSX | | | π§ | | β |
+| [jsx-tag-spacing](docs/rules/jsx-tag-spacing.md) | Enforce whitespace in and around the JSX opening and closing brackets | | | π§ | | |
+| [jsx-uses-react](docs/rules/jsx-uses-react.md) | Disallow React to be incorrectly marked as unused | βοΈ | ![badge-jsx-runtime][] | | | |
+| [jsx-uses-vars](docs/rules/jsx-uses-vars.md) | Disallow variables used in JSX to be incorrectly marked as unused | βοΈ | | | | |
+| [jsx-wrap-multilines](docs/rules/jsx-wrap-multilines.md) | Disallow missing parentheses around multiline JSX | | | π§ | | |
+| [no-access-state-in-setstate](docs/rules/no-access-state-in-setstate.md) | Disallow when this.state is accessed within setState | | | | | |
+| [no-adjacent-inline-elements](docs/rules/no-adjacent-inline-elements.md) | Disallow adjacent inline elements not separated by whitespace. | | | | | |
+| [no-array-index-key](docs/rules/no-array-index-key.md) | Disallow usage of Array index in keys | | | | | |
+| [no-arrow-function-lifecycle](docs/rules/no-arrow-function-lifecycle.md) | Lifecycle methods should be methods on the prototype, not class fields | | | π§ | | |
+| [no-children-prop](docs/rules/no-children-prop.md) | Disallow passing of children as props | βοΈ | | | | |
+| [no-danger](docs/rules/no-danger.md) | Disallow usage of dangerous JSX properties | | | | | |
+| [no-danger-with-children](docs/rules/no-danger-with-children.md) | Disallow when a DOM element is using both children and dangerouslySetInnerHTML | βοΈ | | | | |
+| [no-deprecated](docs/rules/no-deprecated.md) | Disallow usage of deprecated methods | βοΈ | | | | |
+| [no-did-mount-set-state](docs/rules/no-did-mount-set-state.md) | Disallow usage of setState in componentDidMount | | | | | |
+| [no-did-update-set-state](docs/rules/no-did-update-set-state.md) | Disallow usage of setState in componentDidUpdate | | | | | |
+| [no-direct-mutation-state](docs/rules/no-direct-mutation-state.md) | Disallow direct mutation of this.state | βοΈ | | | | |
+| [no-find-dom-node](docs/rules/no-find-dom-node.md) | Disallow usage of findDOMNode | βοΈ | | | | |
+| [no-invalid-html-attribute](docs/rules/no-invalid-html-attribute.md) | Disallow usage of invalid attributes | | | | π‘ | |
+| [no-is-mounted](docs/rules/no-is-mounted.md) | Disallow usage of isMounted | βοΈ | | | | |
+| [no-multi-comp](docs/rules/no-multi-comp.md) | Disallow multiple component definition per file | | | | | |
+| [no-namespace](docs/rules/no-namespace.md) | Enforce that namespaces are not used in React elements | | | | | |
+| [no-object-type-as-default-prop](docs/rules/no-object-type-as-default-prop.md) | Disallow usage of referential-type variables as default param in functional component | | | | | |
+| [no-redundant-should-component-update](docs/rules/no-redundant-should-component-update.md) | Disallow usage of shouldComponentUpdate when extending React.PureComponent | | | | | |
+| [no-render-return-value](docs/rules/no-render-return-value.md) | Disallow usage of the return value of ReactDOM.render | βοΈ | | | | |
+| [no-set-state](docs/rules/no-set-state.md) | Disallow usage of setState | | | | | |
+| [no-string-refs](docs/rules/no-string-refs.md) | Disallow using string references | βοΈ | | | | |
+| [no-this-in-sfc](docs/rules/no-this-in-sfc.md) | Disallow `this` from being used in stateless functional components | | | | | |
+| [no-typos](docs/rules/no-typos.md) | Disallow common typos | | | | | |
+| [no-unescaped-entities](docs/rules/no-unescaped-entities.md) | Disallow unescaped HTML entities from appearing in markup | βοΈ | | | | |
+| [no-unknown-property](docs/rules/no-unknown-property.md) | Disallow usage of unknown DOM property | βοΈ | | π§ | | |
+| [no-unsafe](docs/rules/no-unsafe.md) | Disallow usage of unsafe lifecycle methods | | βοΈ | | | |
+| [no-unstable-nested-components](docs/rules/no-unstable-nested-components.md) | Disallow creating unstable components inside components | | | | | |
+| [no-unused-class-component-methods](docs/rules/no-unused-class-component-methods.md) | Disallow declaring unused methods of component class | | | | | |
+| [no-unused-prop-types](docs/rules/no-unused-prop-types.md) | Disallow definitions of unused propTypes | | | | | |
+| [no-unused-state](docs/rules/no-unused-state.md) | Disallow definitions of unused state | | | | | |
+| [no-will-update-set-state](docs/rules/no-will-update-set-state.md) | Disallow usage of setState in componentWillUpdate | | | | | |
+| [prefer-es6-class](docs/rules/prefer-es6-class.md) | Enforce ES5 or ES6 class for React Components | | | | | |
+| [prefer-exact-props](docs/rules/prefer-exact-props.md) | Prefer exact proptype definitions | | | | | |
+| [prefer-read-only-props](docs/rules/prefer-read-only-props.md) | Enforce that props are read-only | | | π§ | | |
+| [prefer-stateless-function](docs/rules/prefer-stateless-function.md) | Enforce stateless components to be written as a pure function | | | | | |
+| [prop-types](docs/rules/prop-types.md) | Disallow missing props validation in a React component definition | βοΈ | | | | |
+| [react-in-jsx-scope](docs/rules/react-in-jsx-scope.md) | Disallow missing React when using JSX | βοΈ | ![badge-jsx-runtime][] | | | |
+| [require-default-props](docs/rules/require-default-props.md) | Enforce a defaultProps definition for every prop that is not a required prop | | | | | |
+| [require-optimization](docs/rules/require-optimization.md) | Enforce React components to have a shouldComponentUpdate method | | | | | |
+| [require-render-return](docs/rules/require-render-return.md) | Enforce ES5 or ES6 class for returning value in render function | βοΈ | | | | |
+| [self-closing-comp](docs/rules/self-closing-comp.md) | Disallow extra closing tags for components without children | | | π§ | | |
+| [sort-comp](docs/rules/sort-comp.md) | Enforce component methods order | | | | | |
+| [sort-default-props](docs/rules/sort-default-props.md) | Enforce defaultProps declarations alphabetical sorting | | | | | |
+| [sort-prop-types](docs/rules/sort-prop-types.md) | Enforce propTypes declarations alphabetical sorting | | | π§ | | |
+| [state-in-constructor](docs/rules/state-in-constructor.md) | Enforce class component state initialization style | | | | | |
+| [static-property-placement](docs/rules/static-property-placement.md) | Enforces where React component static properties should be positioned. | | | | | |
+| [style-prop-object](docs/rules/style-prop-object.md) | Enforce style prop value is an object | | | | | |
+| [void-dom-elements-no-children](docs/rules/void-dom-elements-no-children.md) | Disallow void DOM elements (e.g. ``, `
`) from receiving children | | | | | |
@@ -415,3 +417,5 @@ module.exports = [
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/jsx-eslint/eslint-plugin-react
[actions-url]: https://github.com/jsx-eslint/eslint-plugin-react/actions
+
+[badge-jsx-runtime]: https://img.shields.io/badge/-jsx--runtime-blue.svg
diff --git a/docs/rules/display-name.md b/docs/rules/display-name.md
index 6d0b57a092..e1c7dd6599 100644
--- a/docs/rules/display-name.md
+++ b/docs/rules/display-name.md
@@ -1,6 +1,6 @@
# Disallow missing displayName in a React component definition (`react/display-name`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/jsx-key.md b/docs/rules/jsx-key.md
index 0415b6df54..d9f2f3078b 100644
--- a/docs/rules/jsx-key.md
+++ b/docs/rules/jsx-key.md
@@ -1,6 +1,6 @@
# Disallow missing `key` props in iterators/collection literals (`react/jsx-key`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/jsx-no-comment-textnodes.md b/docs/rules/jsx-no-comment-textnodes.md
index 7f094db08d..f644c41ca5 100644
--- a/docs/rules/jsx-no-comment-textnodes.md
+++ b/docs/rules/jsx-no-comment-textnodes.md
@@ -1,6 +1,6 @@
# Disallow comments from being inserted as text nodes (`react/jsx-no-comment-textnodes`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/jsx-no-duplicate-props.md b/docs/rules/jsx-no-duplicate-props.md
index 68a2851cef..591887e57e 100644
--- a/docs/rules/jsx-no-duplicate-props.md
+++ b/docs/rules/jsx-no-duplicate-props.md
@@ -1,6 +1,6 @@
# Disallow duplicate properties in JSX (`react/jsx-no-duplicate-props`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/jsx-no-target-blank.md b/docs/rules/jsx-no-target-blank.md
index 22fcc0cbc7..54f478aa18 100644
--- a/docs/rules/jsx-no-target-blank.md
+++ b/docs/rules/jsx-no-target-blank.md
@@ -1,6 +1,6 @@
# Disallow `target="_blank"` attribute without `rel="noreferrer"` (`react/jsx-no-target-blank`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
π§ This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
diff --git a/docs/rules/jsx-no-undef.md b/docs/rules/jsx-no-undef.md
index 2a5101813b..560911342a 100644
--- a/docs/rules/jsx-no-undef.md
+++ b/docs/rules/jsx-no-undef.md
@@ -1,6 +1,6 @@
# Disallow undeclared variables in JSX (`react/jsx-no-undef`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/jsx-sort-default-props.md b/docs/rules/jsx-sort-default-props.md
index cdeef9196a..728d5f2fb2 100644
--- a/docs/rules/jsx-sort-default-props.md
+++ b/docs/rules/jsx-sort-default-props.md
@@ -1,6 +1,6 @@
# Enforce defaultProps declarations alphabetical sorting (`react/jsx-sort-default-props`)
-β This rule is deprecated. It was replaced by [`sort-default-props`](sort-default-props.md).
+β This rule is deprecated. It was replaced by [`react/sort-default-props`](../../docs/rules/sort-default-props.md).
diff --git a/docs/rules/jsx-space-before-closing.md b/docs/rules/jsx-space-before-closing.md
index da48d3b2b1..c5151de99b 100644
--- a/docs/rules/jsx-space-before-closing.md
+++ b/docs/rules/jsx-space-before-closing.md
@@ -1,6 +1,6 @@
# Enforce spacing before closing bracket in JSX (`react/jsx-space-before-closing`)
-β This rule is deprecated. It was replaced by [`jsx-tag-spacing`](jsx-tag-spacing.md).
+β This rule is deprecated. It was replaced by [`react/jsx-tag-spacing`](../../docs/rules/jsx-tag-spacing.md).
π§ This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
diff --git a/docs/rules/jsx-uses-react.md b/docs/rules/jsx-uses-react.md
index 3bbde16f21..6dcaa7bc5b 100644
--- a/docs/rules/jsx-uses-react.md
+++ b/docs/rules/jsx-uses-react.md
@@ -1,6 +1,6 @@
# Disallow React to be incorrectly marked as unused (`react/jsx-uses-react`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs). This rule is _disabled_ in the `jsx-runtime` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌπ« This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs). This rule is _disabled_ in the `jsx-runtime` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/jsx-uses-vars.md b/docs/rules/jsx-uses-vars.md
index bffc54d6ce..0620c50686 100644
--- a/docs/rules/jsx-uses-vars.md
+++ b/docs/rules/jsx-uses-vars.md
@@ -1,6 +1,6 @@
# Disallow variables used in JSX to be incorrectly marked as unused (`react/jsx-uses-vars`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-children-prop.md b/docs/rules/no-children-prop.md
index 954a898b4c..d9a3ff2721 100644
--- a/docs/rules/no-children-prop.md
+++ b/docs/rules/no-children-prop.md
@@ -1,6 +1,6 @@
# Disallow passing of children as props (`react/no-children-prop`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-danger-with-children.md b/docs/rules/no-danger-with-children.md
index 651866160d..168620fa3d 100644
--- a/docs/rules/no-danger-with-children.md
+++ b/docs/rules/no-danger-with-children.md
@@ -1,6 +1,6 @@
# Disallow when a DOM element is using both children and dangerouslySetInnerHTML (`react/no-danger-with-children`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-deprecated.md b/docs/rules/no-deprecated.md
index 27244d9b30..030efb870e 100644
--- a/docs/rules/no-deprecated.md
+++ b/docs/rules/no-deprecated.md
@@ -1,6 +1,6 @@
# Disallow usage of deprecated methods (`react/no-deprecated`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-direct-mutation-state.md b/docs/rules/no-direct-mutation-state.md
index 7d242de03c..5cbdc683c1 100644
--- a/docs/rules/no-direct-mutation-state.md
+++ b/docs/rules/no-direct-mutation-state.md
@@ -1,6 +1,6 @@
# Disallow direct mutation of this.state (`react/no-direct-mutation-state`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-find-dom-node.md b/docs/rules/no-find-dom-node.md
index 4bb47fc8fa..bf9cacd354 100644
--- a/docs/rules/no-find-dom-node.md
+++ b/docs/rules/no-find-dom-node.md
@@ -1,6 +1,6 @@
# Disallow usage of findDOMNode (`react/no-find-dom-node`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-is-mounted.md b/docs/rules/no-is-mounted.md
index a045244a52..e38be740bc 100644
--- a/docs/rules/no-is-mounted.md
+++ b/docs/rules/no-is-mounted.md
@@ -1,6 +1,6 @@
# Disallow usage of isMounted (`react/no-is-mounted`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-render-return-value.md b/docs/rules/no-render-return-value.md
index 0a83801201..2042ba9f57 100644
--- a/docs/rules/no-render-return-value.md
+++ b/docs/rules/no-render-return-value.md
@@ -1,6 +1,6 @@
# Disallow usage of the return value of ReactDOM.render (`react/no-render-return-value`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-string-refs.md b/docs/rules/no-string-refs.md
index f9615ae35f..7364d71580 100644
--- a/docs/rules/no-string-refs.md
+++ b/docs/rules/no-string-refs.md
@@ -1,6 +1,6 @@
# Disallow using string references (`react/no-string-refs`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-unescaped-entities.md b/docs/rules/no-unescaped-entities.md
index d105c9d5b7..2f6f8906b6 100644
--- a/docs/rules/no-unescaped-entities.md
+++ b/docs/rules/no-unescaped-entities.md
@@ -1,6 +1,6 @@
# Disallow unescaped HTML entities from appearing in markup (`react/no-unescaped-entities`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/no-unknown-property.md b/docs/rules/no-unknown-property.md
index 9a0b196d35..ac47ccac9d 100644
--- a/docs/rules/no-unknown-property.md
+++ b/docs/rules/no-unknown-property.md
@@ -1,6 +1,6 @@
# Disallow usage of unknown DOM property (`react/no-unknown-property`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
π§ This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
diff --git a/docs/rules/no-unsafe.md b/docs/rules/no-unsafe.md
index 0c99399338..18c13b8f3a 100644
--- a/docs/rules/no-unsafe.md
+++ b/docs/rules/no-unsafe.md
@@ -1,6 +1,6 @@
# Disallow usage of unsafe lifecycle methods (`react/no-unsafe`)
-πΌ This rule is _disabled_ in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+π« This rule is _disabled_ in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/prop-types.md b/docs/rules/prop-types.md
index 12fc8a49f9..81039965c4 100644
--- a/docs/rules/prop-types.md
+++ b/docs/rules/prop-types.md
@@ -1,6 +1,6 @@
# Disallow missing props validation in a React component definition (`react/prop-types`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/react-in-jsx-scope.md b/docs/rules/react-in-jsx-scope.md
index 952e50dc86..0b187a8bb5 100644
--- a/docs/rules/react-in-jsx-scope.md
+++ b/docs/rules/react-in-jsx-scope.md
@@ -1,6 +1,6 @@
# Disallow missing React when using JSX (`react/react-in-jsx-scope`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs). This rule is _disabled_ in the `jsx-runtime` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌπ« This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs). This rule is _disabled_ in the `jsx-runtime` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/docs/rules/require-render-return.md b/docs/rules/require-render-return.md
index d6f00c1fa7..6cbf2b802f 100644
--- a/docs/rules/require-render-return.md
+++ b/docs/rules/require-render-return.md
@@ -1,6 +1,6 @@
# Enforce ES5 or ES6 class for returning value in render function (`react/require-render-return`)
-πΌ This rule is enabled in the `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
+πΌ This rule is enabled in the βοΈ `recommended` [config](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs).
diff --git a/package.json b/package.json
index a5b5460d8a..c9bffd3750 100644
--- a/package.json
+++ b/package.json
@@ -16,7 +16,7 @@
"posttest": "aud --production",
"type-check": "tsc",
"unit-test": "istanbul cover node_modules/mocha/bin/_mocha tests/lib/**/*.js tests/util/**/*.js tests/index.js",
- "update:eslint-docs": "eslint-doc-generator --ignore-config all --config-emoji recommended,πΌ --url-configs \"https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs\""
+ "update:eslint-docs": "eslint-doc-generator --ignore-config all --config-emoji recommended,βοΈ --url-configs \"https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs\""
},
"repository": {
"type": "git",
@@ -56,7 +56,7 @@
"babel-eslint": "^8 || ^9 || ^10.1.0",
"eslint": "^3 || ^4 || ^5 || ^6 || ^7 || ^8",
"eslint-config-airbnb-base": "^15.0.0",
- "eslint-doc-generator": "^0.15.0",
+ "eslint-doc-generator": "^1.0.0",
"eslint-plugin-eslint-plugin": "^2.3.0 || ^3.5.3 || ^4.0.1 || ^5.0.5",
"eslint-plugin-import": "^2.26.0",
"eslint-remote-tester": "^3.0.0",