[Docs] update eslint-doc-generator to v1.0.0

jsx-eslint · Nov 29, 2022 · 0a2f6b7 · 0a2f6b7
1 parent a522476
commit 0a2f6b7
Show file tree

Hide file tree

Showing 27 changed files with 135 additions and 129 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -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

diff --git a/README.md b/README.md
diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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
@@ -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 -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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
@@ -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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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
@@ -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 -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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).
 
 <!-- end auto-generated rule header -->
 

diff --git 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",