diff --git a/README.md b/README.md index e45bd634..028163c7 100644 --- a/README.md +++ b/README.md @@ -56,11 +56,12 @@ Here's an example ESLint configuration that: -✅ Enabled in the `recommended` configuration.\ +💼 Configurations enabled in.\ +✅ Set in the `recommended` configuration.\ 🔧 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). -| Name                          | Description | ✅ | 🔧 | 💡 | +| Name                          | Description | 💼 | 🔧 | 💡 | | :--------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :- | :- | :- | | [consistent-output](docs/rules/consistent-output.md) | enforce consistent use of `output` assertions in rule tests | ✅ | | | | [fixer-return](docs/rules/fixer-return.md) | require fixer functions to return a fix | ✅ | | | diff --git a/docs/rules/consistent-output.md b/docs/rules/consistent-output.md index 47b7c64d..82a45c33 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. diff --git a/docs/rules/fixer-return.md b/docs/rules/fixer-return.md index 13ee0713..0fb35778 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. diff --git a/docs/rules/no-deprecated-context-methods.md b/docs/rules/no-deprecated-context-methods.md index 248490f6..88acb08b 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. 🔧 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 9864b063..4c9bd858 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. 🔧 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 b84128cc..1bab340c 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. 🔧 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 1498169d..ca7ff4b4 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. diff --git a/docs/rules/no-missing-placeholders.md b/docs/rules/no-missing-placeholders.md index 40e97888..7910cf0f 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. diff --git a/docs/rules/no-only-tests.md b/docs/rules/no-only-tests.md index c290aaa9..7a37e02b 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. 💡 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 baca22e6..f9f12971 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. diff --git a/docs/rules/no-unused-placeholders.md b/docs/rules/no-unused-placeholders.md index e0ff1462..a00d4c1d 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. diff --git a/docs/rules/no-useless-token-range.md b/docs/rules/no-useless-token-range.md index 5586aeba..da5364e7 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. 🔧 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 1e54cc0b..38aab30c 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. diff --git a/docs/rules/prefer-object-rule.md b/docs/rules/prefer-object-rule.md index 68d16de5..21aa1242 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. 🔧 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 35c63c8f..b6cab58b 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. 🔧 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 4218ee62..2755a121 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. diff --git a/docs/rules/require-meta-has-suggestions.md b/docs/rules/require-meta-has-suggestions.md index 478e4847..dae11916 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. 🔧 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 36086b45..b10ff117 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. 💡 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 8fb143b4..b121f718 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. diff --git a/package.json b/package.json index aa3214f8..486d063b 100644 --- a/package.json +++ b/package.json @@ -55,7 +55,7 @@ "eslint": "^8.23.0", "eslint-config-not-an-aardvark": "^2.1.0", "eslint-config-prettier": "^8.5.0", - "eslint-doc-generator": "^0.18.2", + "eslint-doc-generator": "^0.19.0", "eslint-plugin-eslint-comments": "^3.2.0", "eslint-plugin-eslint-plugin": "file:./", "eslint-plugin-markdown": "^3.0.0",