chore(docs): Add legend on rules listing

vuejs · Jan 4, 2019 · 9bf6098 · 9bf6098
1 parent 9edbf2f
commit 9bf6098
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/rules/README.md b/docs/rules/README.md
@@ -6,6 +6,11 @@ sidebarDepth: 0
 
 # Available rules
 
+::: tip Legend
+  :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.
+:::
+
+
 ## Base Rules (Enabling Correct ESLint Parsing)
 
 Enforce all the rules in this category, as well as all higher priority rules, with:

diff --git a/tools/update-docs-rules-index.js b/tools/update-docs-rules-index.js
@@ -97,5 +97,10 @@ sidebarDepth: 0
 <!-- This file is automatically generated in tools/update-docs-rules-index.js, do not change! -->
 
 # Available rules
+
+::: tip Legend
+  :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.
+:::
+
 ${rulesTableContent}`
 )