[Docs] Improve legibility of lists of available rules in readme #2908
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.
The README contains three different lists of rules (basic rules, JSX-specific ones, recommended ones). I've found that looking through those lists to find out what rule is part of the recommended ruleset is not as simple as it could be.
This PR replaces the lists of available rules with tables containing indicators for whether a rule is enabled in the recommended ruleset and if it is fixable (just like the official ESLint page does).
I have removed the list of the recommended rules entirely as the information can now be found in the tables mentioned above, but I can undo that change if you prefer to keep that list in (or transform it into a table as well).
The result looks like this:
β: Enabled in the
recommended
configuration.π§: Fixable with
eslint --fix
.