From a025fd1254492eeeef8667c00a5afddd7357c7c5 Mon Sep 17 00:00:00 2001 From: Bryan Mishkin <698306+bmish@users.noreply.github.com> Date: Mon, 28 Nov 2022 09:52:55 -0500 Subject: [PATCH] docs: update eslint-doc-generator to 0.28 --- .eslint-doc-generatorrc.js | 6 ++++++ README.md | 4 ++-- docs/rules/consistent-output.md | 2 +- docs/rules/fixer-return.md | 2 +- docs/rules/no-deprecated-context-methods.md | 2 +- docs/rules/no-deprecated-report-api.md | 2 +- docs/rules/no-identical-tests.md | 2 +- docs/rules/no-missing-message-ids.md | 2 +- docs/rules/no-missing-placeholders.md | 2 +- docs/rules/no-only-tests.md | 2 +- docs/rules/no-unused-message-ids.md | 2 +- docs/rules/no-unused-placeholders.md | 2 +- docs/rules/no-useless-token-range.md | 2 +- docs/rules/prefer-message-ids.md | 2 +- docs/rules/prefer-object-rule.md | 2 +- docs/rules/prefer-output-null.md | 2 +- docs/rules/require-meta-fixable.md | 2 +- docs/rules/require-meta-has-suggestions.md | 2 +- docs/rules/require-meta-schema.md | 2 +- docs/rules/require-meta-type.md | 2 +- package.json | 4 ++-- 21 files changed, 28 insertions(+), 22 deletions(-) create mode 100644 .eslint-doc-generatorrc.js diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js new file mode 100644 index 00000000..126bdd6a --- /dev/null +++ b/.eslint-doc-generatorrc.js @@ -0,0 +1,6 @@ +/** @type {import('eslint-doc-generator').GenerateOptions} */ +module.exports = { + ignoreConfig: ['all', 'rules', 'rules-recommended', 'tests', 'tests-recommended'], + ruleDocSectionInclude: ['Rule Details'], + urlConfigs: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets', +}; diff --git a/README.md b/README.md index 028163c7..5e421374 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,8 @@ Here's an example ESLint configuration that: -💼 Configurations enabled in.\ -✅ Set in the `recommended` configuration.\ +💼 [Configurations](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets) enabled in.\ +✅ Set in the `recommended` [configuration](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).\ 🔧 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). diff --git a/docs/rules/consistent-output.md b/docs/rules/consistent-output.md index 82a45c33..aae5ca8d 100644 --- a/docs/rules/consistent-output.md +++ b/docs/rules/consistent-output.md @@ -1,6 +1,6 @@ # Enforce consistent use of `output` assertions in rule tests (`eslint-plugin/consistent-output`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/fixer-return.md b/docs/rules/fixer-return.md index 0fb35778..10978101 100644 --- a/docs/rules/fixer-return.md +++ b/docs/rules/fixer-return.md @@ -1,6 +1,6 @@ # Require fixer functions to return a fix (`eslint-plugin/fixer-return`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/no-deprecated-context-methods.md b/docs/rules/no-deprecated-context-methods.md index 88acb08b..16d999d6 100644 --- a/docs/rules/no-deprecated-context-methods.md +++ b/docs/rules/no-deprecated-context-methods.md @@ -1,6 +1,6 @@ # Disallow usage of deprecated methods on rule context objects (`eslint-plugin/no-deprecated-context-methods`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 🔧 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-deprecated-report-api.md b/docs/rules/no-deprecated-report-api.md index 4c9bd858..1bac7e94 100644 --- a/docs/rules/no-deprecated-report-api.md +++ b/docs/rules/no-deprecated-report-api.md @@ -1,6 +1,6 @@ # Disallow the version of `context.report()` with multiple arguments (`eslint-plugin/no-deprecated-report-api`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 🔧 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-identical-tests.md b/docs/rules/no-identical-tests.md index 1bab340c..62fe850a 100644 --- a/docs/rules/no-identical-tests.md +++ b/docs/rules/no-identical-tests.md @@ -1,6 +1,6 @@ # Disallow identical tests (`eslint-plugin/no-identical-tests`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 🔧 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-missing-message-ids.md b/docs/rules/no-missing-message-ids.md index ca7ff4b4..592d6d24 100644 --- a/docs/rules/no-missing-message-ids.md +++ b/docs/rules/no-missing-message-ids.md @@ -1,6 +1,6 @@ # Disallow `messageId`s that are missing from `meta.messages` (`eslint-plugin/no-missing-message-ids`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/no-missing-placeholders.md b/docs/rules/no-missing-placeholders.md index 7910cf0f..6e2ac6ca 100644 --- a/docs/rules/no-missing-placeholders.md +++ b/docs/rules/no-missing-placeholders.md @@ -1,6 +1,6 @@ # Disallow missing placeholders in rule report messages (`eslint-plugin/no-missing-placeholders`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/no-only-tests.md b/docs/rules/no-only-tests.md index 7a37e02b..d5db7dd0 100644 --- a/docs/rules/no-only-tests.md +++ b/docs/rules/no-only-tests.md @@ -1,6 +1,6 @@ # Disallow the test case property `only` (`eslint-plugin/no-only-tests`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions). diff --git a/docs/rules/no-unused-message-ids.md b/docs/rules/no-unused-message-ids.md index f9f12971..c691d67c 100644 --- a/docs/rules/no-unused-message-ids.md +++ b/docs/rules/no-unused-message-ids.md @@ -1,6 +1,6 @@ # Disallow unused `messageId`s in `meta.messages` (`eslint-plugin/no-unused-message-ids`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/no-unused-placeholders.md b/docs/rules/no-unused-placeholders.md index a00d4c1d..fb2df80f 100644 --- a/docs/rules/no-unused-placeholders.md +++ b/docs/rules/no-unused-placeholders.md @@ -1,6 +1,6 @@ # Disallow unused placeholders in rule report messages (`eslint-plugin/no-unused-placeholders`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/no-useless-token-range.md b/docs/rules/no-useless-token-range.md index da5364e7..e1bfaade 100644 --- a/docs/rules/no-useless-token-range.md +++ b/docs/rules/no-useless-token-range.md @@ -1,6 +1,6 @@ # Disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` (`eslint-plugin/no-useless-token-range`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 🔧 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/prefer-message-ids.md b/docs/rules/prefer-message-ids.md index 38aab30c..a0d52c01 100644 --- a/docs/rules/prefer-message-ids.md +++ b/docs/rules/prefer-message-ids.md @@ -1,6 +1,6 @@ # Require using `messageId` instead of `message` to report rule violations (`eslint-plugin/prefer-message-ids`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/prefer-object-rule.md b/docs/rules/prefer-object-rule.md index 21aa1242..a3a1b66a 100644 --- a/docs/rules/prefer-object-rule.md +++ b/docs/rules/prefer-object-rule.md @@ -1,6 +1,6 @@ # Disallow function-style rules (`eslint-plugin/prefer-object-rule`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 🔧 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/prefer-output-null.md b/docs/rules/prefer-output-null.md index b6cab58b..61a33ae7 100644 --- a/docs/rules/prefer-output-null.md +++ b/docs/rules/prefer-output-null.md @@ -1,6 +1,6 @@ # Disallow invalid RuleTester test cases where the `output` matches the `code` (`eslint-plugin/prefer-output-null`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 🔧 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/require-meta-fixable.md b/docs/rules/require-meta-fixable.md index 2755a121..28148a3e 100644 --- a/docs/rules/require-meta-fixable.md +++ b/docs/rules/require-meta-fixable.md @@ -1,6 +1,6 @@ # Require rules to implement a `meta.fixable` property (`eslint-plugin/require-meta-fixable`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/docs/rules/require-meta-has-suggestions.md b/docs/rules/require-meta-has-suggestions.md index dae11916..c64846f8 100644 --- a/docs/rules/require-meta-has-suggestions.md +++ b/docs/rules/require-meta-has-suggestions.md @@ -1,6 +1,6 @@ # Require suggestable rules to implement a `meta.hasSuggestions` property (`eslint-plugin/require-meta-has-suggestions`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 🔧 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/require-meta-schema.md b/docs/rules/require-meta-schema.md index b10ff117..066eb0ba 100644 --- a/docs/rules/require-meta-schema.md +++ b/docs/rules/require-meta-schema.md @@ -1,6 +1,6 @@ # Require rules to implement a `meta.schema` property (`eslint-plugin/require-meta-schema`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). 💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions). diff --git a/docs/rules/require-meta-type.md b/docs/rules/require-meta-type.md index b121f718..672fcb0d 100644 --- a/docs/rules/require-meta-type.md +++ b/docs/rules/require-meta-type.md @@ -1,6 +1,6 @@ # Require rules to implement a `meta.type` property (`eslint-plugin/require-meta-type`) -💼 This rule is enabled in the ✅ `recommended` config. +💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets). diff --git a/package.json b/package.json index 04fed356..f65aa396 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "lint:package-json": "npmPkgJsonLint .", "release": "release-it", "test": "nyc --all --check-coverage --include lib mocha tests --recursive", - "update:eslint-docs": "eslint-doc-generator --rule-doc-section-include \"Rule Detail\" --ignore-config all --ignore-config rules --ignore-config rules-recommended --ignore-config tests --ignore-config tests-recommended" + "update:eslint-docs": "eslint-doc-generator" }, "files": [ "lib/" @@ -56,7 +56,7 @@ "eslint": "^8.23.0", "eslint-config-not-an-aardvark": "^2.1.0", "eslint-config-prettier": "^8.5.0", - "eslint-doc-generator": "^0.19.0", + "eslint-doc-generator": "^0.28.0", "eslint-plugin-eslint-comments": "^3.2.0", "eslint-plugin-eslint-plugin": "file:./", "eslint-plugin-markdown": "^3.0.0",