Skip to content

Commit aa47f17

Browse files
authored
Merge pull request #190 from bmish/readme-eslint-plugin
2 parents a0c7bf3 + 097d902 commit aa47f17

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ Used by popular ESLint plugins like:
1717

1818
- [eslint-plugin-ava](https://github.com/avajs/eslint-plugin-ava#rules)
1919
- [eslint-plugin-ember](https://github.com/ember-cli/eslint-plugin-ember#-rules)
20+
- [eslint-plugin-eslint-plugin](https://github.com/eslint-community/eslint-plugin-eslint-plugin#rules)
21+
- [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y#supported-rules)
22+
- [eslint-plugin-qunit](https://github.com/platinumazure/eslint-plugin-qunit#rules)
2023
- [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react#list-of-supported-rules)
2124
- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn#rules)
2225

@@ -61,6 +64,12 @@ Delete any old rules list from your `README.md`. A new one will be automatically
6164

6265
Delete any old recommended/fixable/etc. notices from your rule docs. A new title and notices will be automatically added to the top of each rule doc (along with a marker comment if it doesn't exist yet).
6366

67+
```md
68+
<!-- end auto-generated rule header -->
69+
```
70+
71+
And be sure to enable the `recommended` rules from [eslint-plugin-eslint-plugin](https://github.com/eslint-community/eslint-plugin-eslint-plugin) as well as [eslint-plugin/require-meta-docs-description](https://github.com/eslint-community/eslint-plugin-eslint-plugin/blob/main/docs/rules/require-meta-docs-description.md) to ensure your rules have consistent descriptions for use in the generated docs.
72+
6473
## Usage
6574

6675
Run the script from `package.json` to start out or any time you add a rule or update rule metadata in your plugin:

0 commit comments

Comments
 (0)