arbitrary_source_item_ordering: Make alphabetic ordering in module item groups optional
#13718
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
…ult: off) From feedback to this lint after its inclusion in clippy 1.82, this has turned out to be the most requested improvement. With this improvement, it is possible to make the lint check certain top-level structural checks on modules (e.g. use statements and module inclusions at the top), but still leaving everything else up to the developer.
rustbot
added
the
S-waiting-on-review
y21
approved these changes
Nov 30, 2024
| @@ -676,6 +676,16 @@ The named groupings of different source item kinds within modules. | |||
| * [`arbitrary_source_item_ordering`](https://rust-lang.github.io/rust-clippy/master/index.html#arbitrary_source_item_ordering) | |||
|
|
|||
|
|
|||
| ## `module-items-ordered-within-groups` | |||
There was a problem hiding this comment.
Would it make sense for this configuration to accept an array of group names similar to how source-item-ordering lets you configure it for specific kinds of items and default to an empty array? Or do you think that's not needed and a simple boolean is enough?
There was a problem hiding this comment.
I was mostly thinking that the config is getting convoluted in either case, but I fully agree that it would make sense to go for higher granularity here. I would like to have an option for "all", but would need to investigate how to best express that in TOML.
Preferrably I'd have the options of:
module-items-ordered-within-groups = "none" (being the default)
module-items-ordered-within-groups = ["mod", "use", "my_custom_group", ...]
module-items-ordered-within-groups = "all"I'll put some thought into this in the coming days.
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.
From feedback to the
arbitrary_source_item_orderinglint after its inclusion in clippy 1.82, making alphabetic ordering within module item groups has turned out to be the most requested improvement. With this improvement, it is possible to make the lint perform certain top-level structural checks on modules (e.g. use statements and module inclusions at the top), but still leaving everything else up to the developer.Implements parts of the suggestions from #13675. A catch-all-group is still to be implemented.
changelog: [
arbitrary_source_item_ordering]: Make alphabetic ordering in module item groups optional (off by default)