Adds ability to sort keys alphabetically and preserve comments #39
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
|
We really need this 🙏 |
cristicalin
force-pushed
the
add_key_sorting
branch
3 times, most recently
from
ede2a21 to
9da50f4
Compare
This has the ability to preserve comments. Added CI coverage for the sorting feature.
cristicalin
force-pushed
the
add_key_sorting
branch
from
9da50f4 to
7e5b5cb
Compare
cristicalin
changed the title
|
/cc @jumanjiman |
|
I'm also interested in this feature! Not sure if the author is accepting PRs at the moment. @cristicalin one thought on a trivial addition - I'd be interested in a "top keys" option, which allows certain keys to retain priority during sort. Happy to contribute this if you're still working on this feature. |
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.
This PR adds the ability to sort yaml keys (
-k/--sort_keyscommand line) while retaining some comments. A CI test is also added illustrating the retention of comments.When keys need to be moved around, some comments may be mistakenly left in their place, for example see https://stackoverflow.com/questions/53849036/how-to-keep-comments-in-ruamel which explains why the comments may be dissociated.
Fixes: #40