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

Categorize rules in docs as one of Possible Problems, Suggestions, and Formatting #3216

Open
golopot opened this issue Feb 25, 2022 · 6 comments · May be fixed by #3226
Open

Categorize rules in docs as one of Possible Problems, Suggestions, and Formatting #3216

golopot opened this issue Feb 25, 2022 · 6 comments · May be fixed by #3226

Comments

@golopot
Copy link
Contributor

golopot commented Feb 25, 2022

These categories help readers find rules more quickly. A user interested in Possible Problems rules can look at Possible Problems rules. A user interested in formatting rules can look at formatting rules.

@ljharb
Copy link
Member

ljharb commented Feb 25, 2022

Why? All things are possible problems, including formatting rules.

@golopot
Copy link
Contributor Author

golopot commented Feb 25, 2022

Possible problems catches codes with bugs. I don't care about formatting rules because I use prettier.

@ljharb
Copy link
Member

ljharb commented Feb 25, 2022

Prettier doesn’t format everything, and anything it handles is disabled by eslint-config-prettier.

@golopot
Copy link
Contributor Author

golopot commented Feb 25, 2022

Yes but the categorization it is still useful for when I need to find a rule I need. For example, when I need to find a rule thats warns about unmemoized context value, I know it is a possible problem instead of a formatting issue, so in this case I only need to scan about 10 rules instead of 80 rules.

@golopot
Copy link
Contributor Author

golopot commented Feb 25, 2022

Suppose it is Friday, and the product would be released today, and you can only fix one of possible problems or formatting issue, which one will you choose?

@ljharb
Copy link
Member

ljharb commented Feb 25, 2022

Since formatting issues are autofixable, I can't conceive of when that would come up in the first place.

If we can automatically generate this information in the readme, I'd be happy to review a PR.

@golopot golopot linked a pull request Feb 28, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants