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

Sort 'All linter rules' alphabetically #5124

Closed
alexeyinkin opened this issue Aug 18, 2023 · 3 comments · Fixed by #5126
Closed

Sort 'All linter rules' alphabetically #5124

alexeyinkin opened this issue Aug 18, 2023 · 3 comments · Fixed by #5126
Assignees
Labels
e0-minutes Can complete in < 60 minutes of normal, not dedicated, work fix.bug Needs fix of incorrect copy, code, or visual from.page-issue Reported in a reader-filed concern p1-high Major but not urgent concern: Resolve in months. Update each month. st.triage.ltw Indicates Lead Tech Writer has triaged t.diagnostics Relates to diagnostics, analysis, or linting of code

Comments

@alexeyinkin
Copy link

Page URL

https://dart.dev/tools/linter-rules/all.html

Page source

https://github.com/dart-lang/site-www/tree/main/src/tools/linter-rules/all.md

Describe the problem

Lints should be sorted alphabetically to simplify diffing when upgrading to a newer SDK.
Lints were sorted on the older page that was here: https://dart-lang.github.io/linter/lints/options/options.html

Expected fix

No response

Additional context

No response

@parlough parlough added t.diagnostics Relates to diagnostics, analysis, or linting of code fix.bug Needs fix of incorrect copy, code, or visual p1-high Major but not urgent concern: Resolve in months. Update each month. e0-minutes Can complete in < 60 minutes of normal, not dedicated, work labels Aug 18, 2023
@parlough
Copy link
Member

Thanks for reporting this! It makes sense for them to be alphabetical, but I never considered this way of determining what lints are new.

My hope is they are consistently documented in the SDK changelog. We've also been discussing introducing a new index/discovery page for lints and that could perhaps have a way to sort by release (among other options).

@parlough parlough self-assigned this Aug 18, 2023
@alexeyinkin
Copy link
Author

I believe the older page did suggest to copy the entire list to analysis_options.yaml and then remove unwanted ones. That's the reason it was and still is a piece of valid YAML, and not just a list.

I have the same workflow of copying it. So this impacts someone like me.

@parlough
Copy link
Member

parlough commented Aug 18, 2023

I really appreciate that feedback and insight! If you have any other feedback on linter rules, discovering them, or their documentation please let us know. We're beginning to plan work around improving the linter docs currently :)

Until the fix (#5126) is approved and merged, the staged version of the change should have what you're looking for.

For additional reference, I believe the two new lints in Dart 3.1 are no_wildcard_variable_uses and no_self_assignments. Thanks again!

@atsansone atsansone added the from.page-issue Reported in a reader-filed concern label Aug 21, 2023
@atsansone atsansone changed the title [PAGE ISSUE]: 'All linter rules' are not sorted alphabetically Sort 'All linter rules' alphabetically Aug 21, 2023
@atsansone atsansone added the st.triage.ltw Indicates Lead Tech Writer has triaged label Aug 21, 2023
rmacnak-google pushed a commit to rmacnak-google/site-www that referenced this issue Sep 5, 2023
atsansone pushed a commit to atsansone/site-www that referenced this issue Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
e0-minutes Can complete in < 60 minutes of normal, not dedicated, work fix.bug Needs fix of incorrect copy, code, or visual from.page-issue Reported in a reader-filed concern p1-high Major but not urgent concern: Resolve in months. Update each month. st.triage.ltw Indicates Lead Tech Writer has triaged t.diagnostics Relates to diagnostics, analysis, or linting of code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants