Skip to content

Commit 7fe7182

Browse files
committed
chore: re-gen eslint docs
1 parent 20a090c commit 7fe7182

28 files changed

+67
-49
lines changed

README.md

+31-31
Large diffs are not rendered by default.

docs/rules/consistent-output.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Enforce consistent use of `output` assertions in rule tests (`eslint-plugin/consistent-output`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/tests`, `flat/tests-recommended`, ✅ `recommended`.
44

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

docs/rules/fixer-return.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Require fixer functions to return a fix (`eslint-plugin/fixer-return`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/meta-property-ordering.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Enforce the order of meta properties (`eslint-plugin/meta-property-ordering`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/rules`.
4+
35
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
46

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

docs/rules/no-deprecated-context-methods.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow usage of deprecated methods on rule context objects (`eslint-plugin/no-deprecated-context-methods`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/no-deprecated-report-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow the version of `context.report()` with multiple arguments (`eslint-plugin/no-deprecated-report-api`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/no-identical-tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow identical tests (`eslint-plugin/no-identical-tests`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/tests`, `flat/tests-recommended`, ✅ `recommended`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/no-missing-message-ids.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow `messageId`s that are missing from `meta.messages` (`eslint-plugin/no-missing-message-ids`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/no-missing-placeholders.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow missing placeholders in rule report messages (`eslint-plugin/no-missing-placeholders`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/no-only-tests.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow the test case property `only` (`eslint-plugin/no-only-tests`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/tests`, `flat/tests-recommended`, ✅ `recommended`.
44

55
💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
66

docs/rules/no-property-in-node.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Disallow using `in` to narrow node types instead of looking at properties (`eslint-plugin/no-property-in-node`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all-type-checked`, `flat/rules`.
4+
35
💭 This rule requires [type information](https://typescript-eslint.io/linting/typed-linting).
46

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

docs/rules/no-unused-message-ids.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow unused `messageId`s in `meta.messages` (`eslint-plugin/no-unused-message-ids`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/no-unused-placeholders.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow unused placeholders in rule report messages (`eslint-plugin/no-unused-placeholders`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/no-useless-token-range.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` (`eslint-plugin/no-useless-token-range`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/prefer-message-ids.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Require using `messageId` instead of `message` or `desc` to report rule violations (`eslint-plugin/prefer-message-ids`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/prefer-object-rule.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow function-style rules (`eslint-plugin/prefer-object-rule`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/prefer-output-null.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Disallow invalid RuleTester test cases where the `output` matches the `code` (`eslint-plugin/prefer-output-null`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/tests`, `flat/tests-recommended`, ✅ `recommended`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/prefer-placeholders.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Require using placeholders for dynamic report messages (`eslint-plugin/prefer-placeholders`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/rules`.
4+
35
<!-- end auto-generated rule header -->
46

57
Report messages in rules can have placeholders surrounded by curly brackets.

docs/rules/prefer-replace-text.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Require using `replaceText()` instead of `replaceTextRange()` (`eslint-plugin/prefer-replace-text`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/rules`.
4+
35
<!-- end auto-generated rule header -->
46

57
## Rule Details

docs/rules/report-message-format.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Enforce a consistent format for rule report messages (`eslint-plugin/report-message-format`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/rules`.
4+
35
<!-- end auto-generated rule header -->
46

57
It is sometimes desirable to maintain consistent formatting for all report messages. For example, you might want to mandate that all report messages begin with a capital letter and end with a period.

docs/rules/require-meta-docs-description.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Require rules to implement a `meta.docs.description` property with the correct format (`eslint-plugin/require-meta-docs-description`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/rules`.
4+
35
<!-- end auto-generated rule header -->
46

57
Defining a clear and consistent description for each rule helps developers understand what they're used for.

docs/rules/require-meta-docs-url.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Require rules to implement a `meta.docs.url` property (`eslint-plugin/require-meta-docs-url`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/rules`.
4+
35
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
46

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

docs/rules/require-meta-fixable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Require rules to implement a `meta.fixable` property (`eslint-plugin/require-meta-fixable`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/require-meta-has-suggestions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Require suggestable rules to implement a `meta.hasSuggestions` property (`eslint-plugin/require-meta-has-suggestions`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

55
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
66

docs/rules/require-meta-schema.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Require rules to implement a `meta.schema` property (`eslint-plugin/require-meta-schema`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

55
💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
66

docs/rules/require-meta-type.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Require rules to implement a `meta.type` property (`eslint-plugin/require-meta-type`)
22

3-
💼 This rule is enabled in the `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/recommended`, `flat/rules`, `flat/rules-recommended`, ✅ `recommended`.
44

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

docs/rules/test-case-property-ordering.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Require the properties of a test case to be placed in a consistent order (`eslint-plugin/test-case-property-ordering`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/tests`.
4+
35
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
46

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

docs/rules/test-case-shorthand-strings.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Enforce consistent usage of shorthand strings for test cases with no options (`eslint-plugin/test-case-shorthand-strings`)
22

3+
💼 This rule is enabled in the following [configs](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets): `flat/all`, `flat/all-type-checked`, `flat/tests`.
4+
35
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
46

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

0 commit comments

Comments
 (0)