docs: generate with eslint-doc-generator #275
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
G-Rath
approved these changes
Nov 5, 2022
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 |
MichaelDeBoey
approved these changes
Nov 5, 2022
w3bdesign
approved these changes
Nov 6, 2022
auto-merge was automatically disabled
November 7, 2022 16:29
Head branch was pushed to by a user without write access
bmish
force-pushed
the
eslint-doc-generator
branch
from
58c699f
to
7485ab6
Compare
bmish
commented
Nov 7, 2022
| @@ -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.
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.
Can someone approve CI to run?
G-Rath
changed the title
G-Rath
approved these changes
Nov 8, 2022
|
🎉 This PR is included in version 4.0.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
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-tablescriptlint:generate-readme-tableto run on CIChecklist: