Skip to content

Commit db2865a

Browse files
authored
Docs: Improve README headers (#208)
1 parent 92131e3 commit db2865a

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,10 @@ An ESLint plugin for linting ESLint plugins. Rules written in CJS, ESM, and Type
55
<!-- vscode-markdown-toc -->
66
* [Installation](#Installation)
77
* [Usage](#Usage)
8-
* [Supported Rules](#SupportedRules)
9-
* [Supported Presets](#SupportedPresets)
8+
* [Rules](#Rules)
9+
* [Presets](#Presets)
10+
* [Semantic versioning policy](#Semanticversioningpolicy)
11+
* [Preset usage](#Presetusage)
1012

1113
<!-- vscode-markdown-toc-config
1214
numbering=false
@@ -50,7 +52,7 @@ Then configure the rules you want to use under the rules section.
5052
}
5153
```
5254

53-
## <a name='SupportedRules'></a>Supported Rules
55+
## <a name='Rules'></a>Rules
5456

5557
* ✔️ if the rule belongs to the `recommended` configuration
5658
* 🛠 if some problems reported by the rule are automatically fixable by the `--fix` [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) option
@@ -85,7 +87,7 @@ Name | ✔️ | 🛠 | 💡 | Description
8587
[test-case-shorthand-strings](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-shorthand-strings.md) | | 🛠 | | enforce consistent usage of shorthand strings for test cases with no options
8688
<!-- __END AUTOGENERATED TABLE__ -->
8789

88-
## <a name='SupportedPresets'></a>Supported Presets
90+
## <a name='Presets'></a>Presets
8991

9092
| | Name | Description |
9193
|:--|:-----|:------------|
@@ -96,8 +98,12 @@ Name | ✔️ | 🛠 | 💡 | Description
9698
| | `rules` | enables all rules that are aimed at linting ESLint rule files |
9799
| | `tests` | enables all rules that are aimed at linting ESLint test files |
98100

101+
### <a name='Semanticversioningpolicy'></a>Semantic versioning policy
102+
99103
The list of recommended rules will only change in a major release of this plugin. However, new non-recommended rules might be added in a minor release of this plugin. Therefore, the using the `all`, `rules`, and `tests` presets is **not recommended for production use**, because the addition of new rules in a minor release could break your build.
100104

105+
### <a name='Presetusage'></a>Preset usage
106+
101107
Presets are enabled by adding a line to the `extends` list in your config file. For example, to enable the `recommended` preset, use:
102108

103109
```json

0 commit comments

Comments
 (0)