Skip to content
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] Improve legibility of lists of available rules in readme #2908

Merged
merged 1 commit into from Jan 30, 2021

Conversation

motato1
Copy link
Contributor

@motato1 motato1 commented Jan 27, 2021

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.

βœ” πŸ”§ Rule Description
βœ” react/display-name Prevent missing displayName in a React component definition
πŸ”§ react/function-component-definition Standardize the way function component get defined
react/forbid-component-props Forbid certain props on components

@motato1 motato1 changed the title [Docs] Replace lists of rules with tables in readme [Docs] Improve legibility of lists of available rules in readme Jan 29, 2021
Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks amazing, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants