-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: generate with eslint-doc-generator #275
Conversation
Codecov Report
@@ Coverage Diff @@
## main #275 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 15 15
Lines 575 575
Branches 165 165
=========================================
Hits 575 575 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Head branch was pushed to by a user without write access
58c699f
to
7485ab6
Compare
@@ -47,6 +47,10 @@ jobs: | |||
if: ${{ matrix.eslint == 8 }} | |||
run: npm run validate | |||
|
|||
- name: ▶️ Ensure docs are up-to-date | |||
if: ${{ matrix.eslint == 8 && matrix.node == 16 }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Attempting to fix CI by ensuring this check only runs on the latest Node version. No need to run on earlier versions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can someone approve CI to run?
🎉 This PR is included in version 4.0.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
What:
Add eslint-doc-generator and update docs with it.
Why:
eslint-doc-generator is a CLI tool I built 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 and is used in many of the top ESLint plugins already (including eslint-plugin-jest).
How:
generate-readme-table
scriptlint:generate-readme-table
to run on CIChecklist: