Add autogenerated rules table to README #110
Merged
+101
−144
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
docs-rules-table
branch
from
2dbeec0 to
e93e41b
Compare
bmish
force-pushed
the
docs-rules-table
branch
3 times, most recently
from
c74dc96 to
38e7fa3
Compare
This change redesigns the rules and configurations sections in the README. The rules section is now an autogenerated table with the complete list of rules and emojis to indicate: * What configuration (recommended or two) each rule belongs to * Whether each rule is autofixable A new script `yarn update` will automatically regenerate the rules table. I have also added a CI test to ensure the rules table is always correct and up-to-date (replacing the previous README tests). The configurations section has also been converted into a table directly above the rules table for easy reference. This README design and script is based on the same ones used by [eslint-plugin-ember](https://github.com/ember-cli/eslint-plugin-ember) and [ember-template-lint](https://github.com/ember-template-lint/ember-template-lint).
bmish
force-pushed
the
docs-rules-table
branch
from
38e7fa3 to
624a64b
Compare
|
@platinumazure reverted that unrelated spacing change. My editor has markdownlint set to autofix violations on save which is why it was included. (we can consider adding markdownlint in the future). |
platinumazure
approved these changes
Aug 30, 2020
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 change redesigns the rules and configurations sections in the README.
The rules section is now an autogenerated table with the complete list of rules and emojis to indicate:
A new script
yarn updatewill automatically regenerate the rules table. I have also added a CI test to ensure the rules table is always correct and up-to-date (replacing the previous README tests).The configurations section has also been converted into a table directly above the rules table for easy reference.
This README design and script is based on the same ones used by eslint-plugin-ember and ember-template-lint.