This repository has been archived by the owner on Aug 31, 2023. It is now read-only.
fix(xtask): enforce a stable ordering for the generated imports of lint rules #2695
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.
Summary
The
cargo codegen analyzer
command automatically generates imports for all the files in theanalyzers
andassists
directories, but the ordering of the imports in the generated files depends on the order they are returned by the underlying filesystem. This order isn't stable and may change depending on the operating system, which leads to unnecessary merge conflicts for pull requests that add lint rules as the auto-generated files get modified every time the codegen script is run. This PR fixes the issue by modifying the script to sort the lint rules by their name in the resulting generated code.