Automate docs with eslint-doc-generator #324
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bmish
commented
Oct 26, 2022
| @@ -57,6 +57,9 @@ const create = Components.detect((context) => { | |||
|
|
|||
| module.exports = { | |||
| meta: { | |||
| docs: { | |||
| description: 'Detect `StyleSheet` rules and inline styles containing color literals instead of variables', | |||
There was a problem hiding this comment.
Moved rule descriptions inside the standard meta.docs.description field in rules. This allows tooling like eslint-doc-generator to utilize these descriptions.
bmish
force-pushed
the
eslint-doc-generator
branch
6 times, most recently
from
cf9be9b
to
e56c50a
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
from
e56c50a
to
45a5672
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
from
45a5672
to
bdb1452
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
from
bdb1452
to
1a27c87
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
from
1a27c87
to
5209eaa
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
bmish
force-pushed
the
eslint-doc-generator
branch
from
5209eaa
to
ae2578b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I built this CLI tool eslint-doc-generator for automating the generation of the README rules list table and rule doc title/notices for ESLint plugins. It follows common documentation conventions from this and other top ESLint plugins and will help us standardize documentation across ESLint plugins (and generally improve the usability of custom rules through better documentation and streamline the process of adding new rules). It has 100% test coverage.