Automate docs with eslint-doc-generator #242
Closed
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
|
Looks like this is blocked until we drop Node 12 support (#222). |
There was a problem hiding this comment.
I don't see why we couldn't proceed with this. All we would need to do is not run the lint:docs step on Node 12 or lower in CI. In package.json, you're only adding devDependencies, so the end user experience shouldn't be affected. I have no problem requiring a higher version of Node to develop this plugin than to run it.
Am I missing something?
|
@platinumazure good point, I'll try to update CI to support that in my new PR #243. |
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 and the title/notices in each rule doc. It follows common documentation conventions from this and other top ESLint plugins. The goal is to improve the usability of our custom rules through better documentation and make it easier to add new rules by automating more of the process. I was also able to remove a documentation generator script and tests that are now redundant.