Automate docs with eslint-doc-generator #243
Merged
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
force-pushed
the
eslint-doc-generator
branch
2 times, most recently
from
4688b0a
to
a5096cd
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
3 times, most recently
from
fe1b71d
to
25a8e12
Compare
|
@platinumazure I split out the lint job from the test job in CI so that we can run the lint job in only Node 18 (as you recommended in #242 (review)) as this tool requires Node >= 14. This is ready for review. |
bmish
force-pushed
the
eslint-doc-generator
branch
2 times, most recently
from
3b36298
to
3d9b936
Compare
platinumazure
requested changes
Oct 27, 2022
package.json
Outdated
| "preversion": "npm test", | ||
| "update": "node ./scripts/update-rules.js", | ||
| "report-coverage-html": "nyc report --reporter=html --report-dir build/coverage", | ||
| "test": "nyc mocha tests/**/*.js", |
There was a problem hiding this comment.
Would it be possible to have npm test still run linting and just configure CI to call unit-test and lint as appropriate?
I feel that most developers are used to having npm test do everything CI would do. And I don't think it would be a good experience for someone to push a branch and only have linting fail at that point.
There was a problem hiding this comment.
@platinumazure sounds good, I reverted to having npm test run testing and linting.
bmish
force-pushed
the
eslint-doc-generator
branch
2 times, most recently
from
7c5b18c
to
dcaa8b1
Compare
bmish
force-pushed
the
eslint-doc-generator
branch
from
dcaa8b1
to
9be0b57
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 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 our custom rules through better documentation and streamline the process of adding new rules).
This is a follow-up to the work I did to add the original notices in #106 #107. eslint-doc-generator is significantly more robust compared to the previous documentation generator script/tests which I have now removed. It has much more functionality (for example, the rules list legend is auto-generated, and the rules list will show additional columns of information when applicable) and 100% test coverage.
There are some discrepancies between the old docs and the new docs. Most of these are intentional and likely improvements. If you don't like any of the changes, let me know and I can tweak eslint-doc-generator or add a config option to support the desired behavior.
I adjusted CI so that we can run the lint job in only Node 18 (as recommended in #242 (review)) as this tool requires Node >= 14.