Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Improve README headers #208

Merged
merged 1 commit into from
Oct 12, 2021
Merged

Docs: Improve README headers #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ An ESLint plugin for linting ESLint plugins. Rules written in CJS, ESM, and Type
<!-- vscode-markdown-toc -->
* [Installation](#Installation)
* [Usage](#Usage)
* [Supported Rules](#SupportedRules)
* [Supported Presets](#SupportedPresets)
* [Rules](#Rules)
* [Presets](#Presets)
* [Semantic versioning policy](#Semanticversioningpolicy)
* [Preset usage](#Presetusage)

<!-- vscode-markdown-toc-config
numbering=false
Expand Down Expand Up @@ -50,7 +52,7 @@ Then configure the rules you want to use under the rules section.
}
```

## <a name='SupportedRules'></a>Supported Rules
## <a name='Rules'></a>Rules

* ✔️ if the rule belongs to the `recommended` configuration
* 🛠 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
Expand Down Expand Up @@ -85,7 +87,7 @@ Name | ✔️ | 🛠 | 💡 | Description
[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
<!-- __END AUTOGENERATED TABLE__ -->

## <a name='SupportedPresets'></a>Supported Presets
## <a name='Presets'></a>Presets

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

### <a name='Semanticversioningpolicy'></a>Semantic versioning policy

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.

### <a name='Presetusage'></a>Preset usage

Presets are enabled by adding a line to the `extends` list in your config file. For example, to enable the `recommended` preset, use:

```json
Expand Down