[Docs] Auto-generate list of rules in README #2541
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
ybiquitous
force-pushed
the
auto-gen-list-of-rules
branch
from
2219bae
to
ecfccfb
Compare
ljharb
reviewed
Jan 13, 2020
package.json
Outdated
| @@ -11,7 +11,9 @@ | |||
| "pretest": "npm run lint", | |||
| "test": "npm run unit-test", | |||
| "type-check": "tsc", | |||
| "unit-test": "istanbul cover node_modules/mocha/bin/_mocha tests/lib/**/*.js tests/util/**/*.js tests/index.js" | |||
| "unit-test": "istanbul cover node_modules/mocha/bin/_mocha tests/lib/**/*.js tests/util/**/*.js tests/index.js", | |||
| "generate-list-of-rules": "./scripts/generate-list-of-rules.js README.md", | |||
There was a problem hiding this comment.
this would be great as a published package, so we can use it in eslint-plugin-react and eslint-plugin-jsx-a11y as well :-D (but we should wait until this PR lands to do that)
scripts/generate-list-of-rules.js
Outdated
| const TAG_BASIC_RULES = '<!-- BASIC_RULES_SECTION -->'; | ||
| const TAG_JSX_RULES = '<!-- JSX_RULES_SECTION -->'; | ||
|
|
||
| const newContent = targetFileContent.replace( |
There was a problem hiding this comment.
perhaps it would be worth using something like https://www.npmjs.com/package/markdown-magic rather than messing with regexes?
There was a problem hiding this comment.
Looks good! I will try it on this PR later, thanks! 👍
There was a problem hiding this comment.
I will try it with #1742.
|
I've synced this PR with #1742, so closing this. |
|
To be clear, i need both to stay open until both are merged :-) |
|
Sorry, I see 👍 |
ljharb
force-pushed
the
auto-gen-list-of-rules
branch
from
ecfccfb
to
182b045
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.
This adds a script to auto-generate the list of rules and embeds special tags to README.
Usage:
Check whether the auto-generated changes are committed:
See also #1742