feat: add eslint-doc-generator to plugin template #140
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
nzakas
approved these changes
Dec 14, 2022
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.
eslint-doc-generator is a CLI tool I built for automating the generation of the README rules list table and rule doc title/notices (e.g. auto-fixable, has suggestions, deprecated, etc) for ESLint plugins. It follows common documentation conventions from ESLint and top ESLint plugins and will help us standardize documentation across ESLint plugins (and generally improve the usability of custom rules through better documentation as well as streamline the process of adding new rules). It has 100% test coverage and is used in many of the top ESLint plugins already.
The primary change in this PR is to install the new dev-dependency and add the following scripts to the plugin template package.json:
npm run update:eslint-docsfor the plugin author to update their documentation whenever adding a rule or changing rule metadatanpm run lint:eslint-docswhich ensures the plugin's documentation is up-to-date (for running locally or during CI)