diff --git a/README.md b/README.md index ed19f91a..e45bd634 100644 --- a/README.md +++ b/README.md @@ -60,34 +60,34 @@ Here's an example ESLint configuration that: πŸ”§ 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 | βœ… | πŸ”§ | πŸ’‘ | -| :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :-- | :-- | :-- | -| [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 | βœ… | | | -| [meta-property-ordering](docs/rules/meta-property-ordering.md) | enforce the order of meta properties | | πŸ”§ | | -| [no-deprecated-context-methods](docs/rules/no-deprecated-context-methods.md) | disallow usage of deprecated methods on rule context objects | βœ… | πŸ”§ | | -| [no-deprecated-report-api](docs/rules/no-deprecated-report-api.md) | disallow the version of `context.report()` with multiple arguments | βœ… | πŸ”§ | | -| [no-identical-tests](docs/rules/no-identical-tests.md) | disallow identical tests | βœ… | πŸ”§ | | -| [no-missing-message-ids](docs/rules/no-missing-message-ids.md) | disallow `messageId`s that are missing from `meta.messages` | βœ… | | | -| [no-missing-placeholders](docs/rules/no-missing-placeholders.md) | disallow missing placeholders in rule report messages | βœ… | | | -| [no-only-tests](docs/rules/no-only-tests.md) | disallow the test case property `only` | βœ… | | πŸ’‘ | -| [no-unused-message-ids](docs/rules/no-unused-message-ids.md) | disallow unused `messageId`s in `meta.messages` | βœ… | | | -| [no-unused-placeholders](docs/rules/no-unused-placeholders.md) | disallow unused placeholders in rule report messages | βœ… | | | -| [no-useless-token-range](docs/rules/no-useless-token-range.md) | disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` | βœ… | πŸ”§ | | -| [prefer-message-ids](docs/rules/prefer-message-ids.md) | require using `messageId` instead of `message` to report rule violations | βœ… | | | -| [prefer-object-rule](docs/rules/prefer-object-rule.md) | disallow function-style rules | βœ… | πŸ”§ | | -| [prefer-output-null](docs/rules/prefer-output-null.md) | disallow invalid RuleTester test cases where the `output` matches the `code` | βœ… | πŸ”§ | | -| [prefer-placeholders](docs/rules/prefer-placeholders.md) | require using placeholders for dynamic report messages | | | | -| [prefer-replace-text](docs/rules/prefer-replace-text.md) | require using `replaceText()` instead of `replaceTextRange()` | | | | -| [report-message-format](docs/rules/report-message-format.md) | enforce a consistent format for rule report messages | | | | -| [require-meta-docs-description](docs/rules/require-meta-docs-description.md) | require rules to implement a `meta.docs.description` property with the correct format | | | | -| [require-meta-docs-url](docs/rules/require-meta-docs-url.md) | require rules to implement a `meta.docs.url` property | | πŸ”§ | | -| [require-meta-fixable](docs/rules/require-meta-fixable.md) | require rules to implement a `meta.fixable` property | βœ… | | | -| [require-meta-has-suggestions](docs/rules/require-meta-has-suggestions.md) | require suggestable rules to implement a `meta.hasSuggestions` property | βœ… | πŸ”§ | | -| [require-meta-schema](docs/rules/require-meta-schema.md) | require rules to implement a `meta.schema` property | βœ… | | πŸ’‘ | -| [require-meta-type](docs/rules/require-meta-type.md) | require rules to implement a `meta.type` property | βœ… | | | -| [test-case-property-ordering](docs/rules/test-case-property-ordering.md) | require the properties of a test case to be placed in a consistent order | | πŸ”§ | | -| [test-case-shorthand-strings](docs/rules/test-case-shorthand-strings.md) | enforce consistent usage of shorthand strings for test cases with no options | | πŸ”§ | | +| 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 | βœ… | | | +| [meta-property-ordering](docs/rules/meta-property-ordering.md) | enforce the order of meta properties | | πŸ”§ | | +| [no-deprecated-context-methods](docs/rules/no-deprecated-context-methods.md) | disallow usage of deprecated methods on rule context objects | βœ… | πŸ”§ | | +| [no-deprecated-report-api](docs/rules/no-deprecated-report-api.md) | disallow the version of `context.report()` with multiple arguments | βœ… | πŸ”§ | | +| [no-identical-tests](docs/rules/no-identical-tests.md) | disallow identical tests | βœ… | πŸ”§ | | +| [no-missing-message-ids](docs/rules/no-missing-message-ids.md) | disallow `messageId`s that are missing from `meta.messages` | βœ… | | | +| [no-missing-placeholders](docs/rules/no-missing-placeholders.md) | disallow missing placeholders in rule report messages | βœ… | | | +| [no-only-tests](docs/rules/no-only-tests.md) | disallow the test case property `only` | βœ… | | πŸ’‘ | +| [no-unused-message-ids](docs/rules/no-unused-message-ids.md) | disallow unused `messageId`s in `meta.messages` | βœ… | | | +| [no-unused-placeholders](docs/rules/no-unused-placeholders.md) | disallow unused placeholders in rule report messages | βœ… | | | +| [no-useless-token-range](docs/rules/no-useless-token-range.md) | disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` | βœ… | πŸ”§ | | +| [prefer-message-ids](docs/rules/prefer-message-ids.md) | require using `messageId` instead of `message` to report rule violations | βœ… | | | +| [prefer-object-rule](docs/rules/prefer-object-rule.md) | disallow function-style rules | βœ… | πŸ”§ | | +| [prefer-output-null](docs/rules/prefer-output-null.md) | disallow invalid RuleTester test cases where the `output` matches the `code` | βœ… | πŸ”§ | | +| [prefer-placeholders](docs/rules/prefer-placeholders.md) | require using placeholders for dynamic report messages | | | | +| [prefer-replace-text](docs/rules/prefer-replace-text.md) | require using `replaceText()` instead of `replaceTextRange()` | | | | +| [report-message-format](docs/rules/report-message-format.md) | enforce a consistent format for rule report messages | | | | +| [require-meta-docs-description](docs/rules/require-meta-docs-description.md) | require rules to implement a `meta.docs.description` property with the correct format | | | | +| [require-meta-docs-url](docs/rules/require-meta-docs-url.md) | require rules to implement a `meta.docs.url` property | | πŸ”§ | | +| [require-meta-fixable](docs/rules/require-meta-fixable.md) | require rules to implement a `meta.fixable` property | βœ… | | | +| [require-meta-has-suggestions](docs/rules/require-meta-has-suggestions.md) | require suggestable rules to implement a `meta.hasSuggestions` property | βœ… | πŸ”§ | | +| [require-meta-schema](docs/rules/require-meta-schema.md) | require rules to implement a `meta.schema` property | βœ… | | πŸ’‘ | +| [require-meta-type](docs/rules/require-meta-type.md) | require rules to implement a `meta.type` property | βœ… | | | +| [test-case-property-ordering](docs/rules/test-case-property-ordering.md) | require the properties of a test case to be placed in a consistent order | | πŸ”§ | | +| [test-case-shorthand-strings](docs/rules/test-case-shorthand-strings.md) | enforce consistent usage of shorthand strings for test cases with no options | | πŸ”§ | | diff --git a/package.json b/package.json index 292d50e9..aa3214f8 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.15.0", + "eslint-doc-generator": "^0.18.2", "eslint-plugin-eslint-comments": "^3.2.0", "eslint-plugin-eslint-plugin": "file:./", "eslint-plugin-markdown": "^3.0.0",