docs: update eslint-doc-generator to 0.15

jsx-eslint · Oct 26, 2022 · 147df5f · 147df5f
1 parent 8b0f8a9
commit 147df5f
Show file tree

Hide file tree

Showing 103 changed files with 162 additions and 152 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/rules/boolean-prop-naming.md b/docs/rules/boolean-prop-naming.md
@@ -1,6 +1,6 @@
 # Enforces consistent naming for boolean props (`react/boolean-prop-naming`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Allows you to enforce a consistent naming pattern for props which expect a boolean value.
 

diff --git a/docs/rules/button-has-type.md b/docs/rules/button-has-type.md
@@ -1,6 +1,6 @@
 # Disallow usage of `button` elements without an explicit `type` attribute (`react/button-has-type`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 The default value of `type` attribute for `button` HTML element is `"submit"` which is often not the desired behavior and may lead to unexpected page reloads.
 This rules enforces an explicit `type` attribute for all the `button` elements and checks that its value is valid per spec (i.e., is one of `"button"`, `"submit"`, and `"reset"`).

diff --git a/docs/rules/default-props-match-prop-types.md b/docs/rules/default-props-match-prop-types.md
@@ -1,6 +1,6 @@
 # Enforce all defaultProps have a corresponding non-required PropType (`react/default-props-match-prop-types`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This rule aims to ensure that any prop in `defaultProps` has a non-required type
 definition.

diff --git a/docs/rules/destructuring-assignment.md b/docs/rules/destructuring-assignment.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Rule can be set to either of `always` or `never`;
 

diff --git a/docs/rules/display-name.md b/docs/rules/display-name.md
@@ -1,8 +1,8 @@
 # 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).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 DisplayName allows you to name your component. This name is used by React in debugging messages.
 

diff --git a/docs/rules/forbid-component-props.md b/docs/rules/forbid-component-props.md
@@ -1,6 +1,6 @@
 # Disallow certain props on components (`react/forbid-component-props`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 By default this rule prevents passing of [props that add lots of complexity](https://medium.com/brigade-engineering/don-t-pass-css-classes-between-components-e9f7ab192785) (`className`, `style`) to Components. This rule only applies to Components (e.g. `<Foo />`) and not DOM nodes (e.g. `<div />`). The list of forbidden props can be customized with the `forbid` option.
 

diff --git a/docs/rules/forbid-dom-props.md b/docs/rules/forbid-dom-props.md
@@ -1,6 +1,6 @@
 # Disallow certain props on DOM Nodes (`react/forbid-dom-props`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This rule prevents passing of props to elements. This rule only applies to DOM Nodes (e.g. `<div />`) and not Components (e.g. `<Component />`).
 The list of forbidden props can be customized with the `forbid` option.

diff --git a/docs/rules/forbid-elements.md b/docs/rules/forbid-elements.md
@@ -1,6 +1,6 @@
 # Disallow certain elements (`react/forbid-elements`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 You may want to forbid usage of certain elements in favor of others, (e.g. forbid all `<div />` and use `<Box />` instead). This rule allows you to configure a list of forbidden elements and to specify their desired replacements.
 

diff --git a/docs/rules/forbid-foreign-prop-types.md b/docs/rules/forbid-foreign-prop-types.md
@@ -1,6 +1,6 @@
 # Disallow using another component's propTypes (`react/forbid-foreign-prop-types`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This rule forbids using another component's prop types unless they are explicitly imported/exported. This allows people who want to use [babel-plugin-transform-react-remove-prop-types](https://github.com/oliviertassinari/babel-plugin-transform-react-remove-prop-types) to remove propTypes from their components in production builds, to do so safely.
 

diff --git a/docs/rules/forbid-prop-types.md b/docs/rules/forbid-prop-types.md
@@ -1,6 +1,6 @@
 # Disallow certain propTypes (`react/forbid-prop-types`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 By default this rule prevents vague prop types with more specific alternatives available (`any`, `array`, `object`), but any prop type can be disabled if desired. The defaults are chosen because they have obvious replacements. `any` should be replaced with, well, anything. `array` and `object` can be replaced with `arrayOf` and `shape`, respectively.
 

diff --git a/docs/rules/function-component-definition.md b/docs/rules/function-component-definition.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This option enforces a specific function type for function components.
 

diff --git a/docs/rules/hook-use-state.md b/docs/rules/hook-use-state.md
@@ -2,7 +2,7 @@
 
 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 💡 This rule provides editor [suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
 

diff --git a/docs/rules/iframe-missing-sandbox.md b/docs/rules/iframe-missing-sandbox.md
@@ -1,6 +1,6 @@
 # Enforce sandbox attribute on iframe elements (`react/iframe-missing-sandbox`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 The sandbox attribute enables an extra set of restrictions for the content in the iframe. Using sandbox attribute is considered a good security practice.
 

diff --git a/docs/rules/jsx-boolean-value.md b/docs/rules/jsx-boolean-value.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 [When using a boolean attribute in JSX](https://facebook.github.io/react/docs/jsx-in-depth.html#boolean-attributes), you can set the attribute value to `true` or omit the value.
 

diff --git a/docs/rules/jsx-child-element-spacing.md b/docs/rules/jsx-child-element-spacing.md
@@ -1,6 +1,6 @@
 # Enforce or disallow spaces inside of curly braces in JSX attributes and expressions (`react/jsx-child-element-spacing`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/jsx-closing-bracket-location.md b/docs/rules/jsx-closing-bracket-location.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Enforce the closing bracket location for JSX multiline elements.
 

diff --git a/docs/rules/jsx-closing-tag-location.md b/docs/rules/jsx-closing-tag-location.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Enforce the closing tag location for multiline JSX elements.
 

diff --git a/docs/rules/jsx-curly-brace-presence.md b/docs/rules/jsx-curly-brace-presence.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This rule allows you to enforce curly braces or disallow unnecessary curly braces in JSX props and/or children.
 

diff --git a/docs/rules/jsx-curly-newline.md b/docs/rules/jsx-curly-newline.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Many style guides require or disallow newlines inside of jsx curly expressions.
 

diff --git a/docs/rules/jsx-curly-spacing.md b/docs/rules/jsx-curly-spacing.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 While formatting preferences are very personal, a number of style guides require or disallow spaces between curly braces.
 

diff --git a/docs/rules/jsx-equals-spacing.md b/docs/rules/jsx-equals-spacing.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Some style guides require or disallow spaces around equal signs.
 

diff --git a/docs/rules/jsx-filename-extension.md b/docs/rules/jsx-filename-extension.md
@@ -1,6 +1,6 @@
 # Disallow file extensions that may contain JSX (`react/jsx-filename-extension`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/jsx-first-prop-new-line.md b/docs/rules/jsx-first-prop-new-line.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Ensure correct position of the first property.
 

diff --git a/docs/rules/jsx-fragments.md b/docs/rules/jsx-fragments.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 In JSX, a React [fragment] is created either with `<React.Fragment>...</React.Fragment>`, or, using the shorthand syntax, `<>...</>`.
 

diff --git a/docs/rules/jsx-handler-names.md b/docs/rules/jsx-handler-names.md
@@ -1,6 +1,6 @@
 # Enforce event handler naming conventions in JSX (`react/jsx-handler-names`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Ensures that any component or prop methods used to handle events are correctly prefixed.
 

diff --git a/docs/rules/jsx-indent-props.md b/docs/rules/jsx-indent-props.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This option validates a specific indentation style for props.
 

diff --git a/docs/rules/jsx-indent.md b/docs/rules/jsx-indent.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This option validates a specific indentation style for JSX.
 

diff --git a/docs/rules/jsx-key.md b/docs/rules/jsx-key.md
@@ -1,8 +1,8 @@
 # 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).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Warn if an element that likely requires a `key` prop--namely, one present in an
 array literal or an arrow function expression.

diff --git a/docs/rules/jsx-max-depth.md b/docs/rules/jsx-max-depth.md
@@ -1,6 +1,6 @@
 # Enforce JSX maximum depth (`react/jsx-max-depth`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This option validates a specific depth for JSX.
 

diff --git a/docs/rules/jsx-max-props-per-line.md b/docs/rules/jsx-max-props-per-line.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Limiting the maximum of props on a single line can improve readability.
 

diff --git a/docs/rules/jsx-newline.md b/docs/rules/jsx-newline.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/jsx-no-bind.md b/docs/rules/jsx-no-bind.md
@@ -1,6 +1,6 @@
 # Disallow `.bind()` or arrow functions in JSX props (`react/jsx-no-bind`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 A `bind` call or [arrow function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions) in a JSX prop will create a brand new function on every single render. This is bad for performance, as it may cause unnecessary re-renders if a brand new function is passed as a prop to a component that uses reference equality check on the prop to determine if it should update.
 

diff --git a/docs/rules/jsx-no-comment-textnodes.md b/docs/rules/jsx-no-comment-textnodes.md
@@ -1,8 +1,8 @@
 # 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).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This rule prevents comment strings (e.g. beginning with `//` or `/*`) from being accidentally
 injected as a text node in JSX statements.

diff --git a/docs/rules/jsx-no-constructed-context-values.md b/docs/rules/jsx-no-constructed-context-values.md
@@ -1,6 +1,6 @@
 # Disallows JSX context provider values from taking values that will cause needless rerenders (`react/jsx-no-constructed-context-values`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This rule prevents non-stable values (i.e. object identities) from being used as a value for `Context.Provider`.
 

diff --git a/docs/rules/jsx-no-duplicate-props.md b/docs/rules/jsx-no-duplicate-props.md
@@ -1,8 +1,8 @@
 # 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).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Creating JSX elements with duplicate props can cause unexpected behavior in your application.
 

diff --git a/docs/rules/jsx-no-leaked-render.md b/docs/rules/jsx-no-leaked-render.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Using the `&&` operator to render some element conditionally in JSX can cause unexpected values being rendered, or even crashing the rendering.
 

diff --git a/docs/rules/jsx-no-literals.md b/docs/rules/jsx-no-literals.md
@@ -1,6 +1,6 @@
 # Disallow usage of string literals in JSX (`react/jsx-no-literals`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 There are a few scenarios where you want to avoid string literals in JSX. You may want to enforce consistency, reduce syntax highlighting issues, or ensure that strings are part of a translation system.
 

diff --git a/docs/rules/jsx-no-script-url.md b/docs/rules/jsx-no-script-url.md
@@ -1,6 +1,6 @@
 # Disallow usage of `javascript:` URLs (`react/jsx-no-script-url`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 **In React 16.9** any URLs starting with `javascript:` [scheme](https://wiki.whatwg.org/wiki/URL_schemes#javascript:_URLs) log a warning.
 React considers the pattern as a dangerous attack surface, see [details](https://reactjs.org/blog/2019/08/08/react-v16.9.0.html#deprecating-javascript-urls).

diff --git a/docs/rules/jsx-no-target-blank.md b/docs/rules/jsx-no-target-blank.md
@@ -1,10 +1,10 @@
 # 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).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 When creating a JSX element that has an `a` tag, it is often desired to have the link open in a new tab using the `target='_blank'` attribute. Using this attribute unaccompanied by `rel='noreferrer'`, however, is a severe security vulnerability (see [noreferrer docs](https://html.spec.whatwg.org/multipage/links.html#link-type-noreferrer) and [noopener docs](https://html.spec.whatwg.org/multipage/links.html#link-type-noopener) for more details)
 This rules requires that you accompany `target='_blank'` attributes with `rel='noreferrer'`.

diff --git a/docs/rules/jsx-no-undef.md b/docs/rules/jsx-no-undef.md
@@ -1,8 +1,8 @@
 # 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).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This rule helps locate potential ReferenceErrors resulting from misspellings or missing components.
 

diff --git a/docs/rules/jsx-no-useless-fragment.md b/docs/rules/jsx-no-useless-fragment.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 A fragment is redundant if it contains only one child, or if it is the child of a html element, and is not a [keyed fragment](https://reactjs.org/docs/fragments.html#keyed-fragments).
 

diff --git a/docs/rules/jsx-one-expression-per-line.md b/docs/rules/jsx-one-expression-per-line.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 This option limits every line in JSX to one expression each.
 

diff --git a/docs/rules/jsx-pascal-case.md b/docs/rules/jsx-pascal-case.md
@@ -1,6 +1,6 @@
 # Enforce PascalCase for user-defined JSX components (`react/jsx-pascal-case`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Enforces coding style that user-defined JSX components are defined and referenced in PascalCase.
 

diff --git a/docs/rules/jsx-props-no-multi-spaces.md b/docs/rules/jsx-props-no-multi-spaces.md
@@ -2,7 +2,7 @@
 
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Enforces that there is exactly one space between all attributes and after tag name and the first attribute in the same line.
 

diff --git a/docs/rules/jsx-props-no-spreading.md b/docs/rules/jsx-props-no-spreading.md
@@ -1,6 +1,6 @@
 # Disallow JSX prop spreading (`react/jsx-props-no-spreading`)
 
-<!-- end rule header -->
+<!-- end auto-generated rule header -->
 
 Enforces that there is no spreading for any JSX attribute. This enhances readability of code by being more explicit about what props are received by the component. It is also good for maintainability by avoiding passing unintentional extra props and allowing react to emit warnings when invalid HTML props are passed to HTML elements.