From 8b0f8a9fea82e7dbf2b4eb24d125f7763a689556 Mon Sep 17 00:00:00 2001 From: Bryan Mishkin <698306+bmish@users.noreply.github.com> Date: Fri, 21 Oct 2022 10:02:55 -0400 Subject: [PATCH] docs: fix table formatting and configs links --- README.md | 208 ++++++++++++------------- 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-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/prop-types.md | 2 +- docs/rules/react-in-jsx-scope.md | 2 +- docs/rules/require-render-return.md | 2 +- package.json | 2 +- 23 files changed, 126 insertions(+), 126 deletions(-) diff --git a/README.md b/README.md index 4d9b0ad2e4..85776d198b 100644 --- a/README.md +++ b/README.md @@ -281,114 +281,114 @@ module.exports = [ -💼 [Configurations](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/README.md#shareable-configs) enabled in.\ -✅ Enabled in the `recommended` [configuration](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/README.md#shareable-configs).\ +💼 [Configurations](https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs) enabled in.\ +✅ Enabled 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 | ✅ | | | | +| [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 | | | | | diff --git a/docs/rules/display-name.md b/docs/rules/display-name.md index 62a8f188a6..731b5390fa 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/blob/master/README.md#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 1eb1c220b2..56119be36a 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/blob/master/README.md#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 cea8be4783..6fba84b64e 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/blob/master/README.md#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 a0c447644c..effd04e241 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/blob/master/README.md#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 7c0efdebbc..a294dc06bf 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/blob/master/README.md#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 92869c9251..c90c030e20 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/blob/master/README.md#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-uses-react.md b/docs/rules/jsx-uses-react.md index 8ae6d1239b..6a95a60e12 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/blob/master/README.md#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-uses-vars.md b/docs/rules/jsx-uses-vars.md index cf88cb9108..8f4f43d3d2 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/blob/master/README.md#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 f84d99ed20..7d9128a948 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/blob/master/README.md#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 7362293a37..b388a27478 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/blob/master/README.md#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 4cae2491e2..2b0ea86777 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/blob/master/README.md#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 d31ade08a7..42d0dd8588 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/blob/master/README.md#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 58660a1676..d4b713842f 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/blob/master/README.md#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 4b49aa98e6..4b81846af2 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/blob/master/README.md#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 59749d6b38..029efcbe71 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/blob/master/README.md#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 d92b225446..8a5c2b0e88 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/blob/master/README.md#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 89b733bb09..12238eecc7 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/blob/master/README.md#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 87460c869c..7cf679b0a7 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/blob/master/README.md#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/prop-types.md b/docs/rules/prop-types.md index c84e93f6fd..ef3d1c03ff 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/blob/master/README.md#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 13ec6478f2..229b9346eb 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/blob/master/README.md#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/require-render-return.md b/docs/rules/require-render-return.md index 4f98284f6c..6838564ba5 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/blob/master/README.md#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 0b68000884..1e70ae15ef 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 --url-configs \"https://github.com/jsx-eslint/eslint-plugin-react/blob/master/README.md#shareable-configs\"" + "update:eslint-docs": "eslint-doc-generator --ignore-config all --url-configs \"https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs\"" }, "repository": { "type": "git",