Skip to content

Commit 9bf6098

Browse files
committed
chore(docs): Add legend on rules listing
1 parent 9edbf2f commit 9bf6098

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/rules/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ sidebarDepth: 0
66

77
# Available rules
88

9+
::: tip Legend
10+
:wrench: Indicates that the rule is fixable, and using `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the reported problems.
11+
:::
12+
13+
914
## Base Rules (Enabling Correct ESLint Parsing)
1015

1116
Enforce all the rules in this category, as well as all higher priority rules, with:

tools/update-docs-rules-index.js

+5
Original file line numberDiff line numberDiff line change
@@ -97,5 +97,10 @@ sidebarDepth: 0
9797
<!-- This file is automatically generated in tools/update-docs-rules-index.js, do not change! -->
9898
9999
# Available rules
100+
101+
::: tip Legend
102+
:wrench: Indicates that the rule is fixable, and using \`--fix\` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the reported problems.
103+
:::
104+
100105
${rulesTableContent}`
101106
)

0 commit comments

Comments
 (0)