Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update eslint-doc-generator to v1.0.0 #3499

Merged
merged 1 commit into from
Nov 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange

### Changed
* [Docs] [`jsx-no-leaked-render`]: Remove mentions of empty strings for React 18 ([#3468][] @karlhorky)
* [Docs] update `eslint-doc-generator` to v1.0.0 ([#3499][] @bmish)

[#3499]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3499
[#3494]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3494
[#3493]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3493
[#3488]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3488
Expand Down
210 changes: 107 additions & 103 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/rules/display-name.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-key.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-comment-textnodes.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-duplicate-props.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-target-blank.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-no-undef.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-sort-default-props.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-space-before-closing.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-uses-react.md
Original file line number Diff line number Diff line change
@@ -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).
bmish marked this conversation as resolved.
Show resolved Hide resolved

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/jsx-uses-vars.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-children-prop.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-danger-with-children.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-deprecated.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-direct-mutation-state.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-find-dom-node.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-is-mounted.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-render-return-value.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-string-refs.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-unescaped-entities.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-unknown-property.md
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/no-unsafe.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prop-types.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/react-in-jsx-scope.md
Original file line number Diff line number Diff line change
@@ -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).
bmish marked this conversation as resolved.
Show resolved Hide resolved

<!-- end auto-generated rule header -->

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/require-render-return.md
Original file line number Diff line number Diff line change
@@ -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).

<!-- end auto-generated rule header -->

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down