feat: Sort JSON keys in configuration file for better version control support (closes #816) #819
Conversation
This file contains hidden or 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
… management (closes linearmouse#816) Added `.sortedKeys` option to `JSONEncoder` in the `dump` function to ensure that the keys in the configuration file (`linearmouse.json`) are written in a consistent, alphabetically sorted order. This change improves readability and ensures that the JSON key order remains stable, which is especially helpful when using version control systems like Git, as it reduces unnecessary diffs caused by random key ordering.
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.
Summary
This PR improves the consistency of the configuration file (
linearmouse.json) by ensuring that the JSON keys are always written in a sorted, predictable order.Previously, the keys were written in a random or non-deterministic order, which caused unnecessary changes in version control systems (like Git) when no actual settings were modified. This behaviour could result in cluttered diffs and make it harder to track changes effectively.
Changes
dumpmethod inConfiguration.swiftto use.sortedKeysas an option inJSONEncoder.outputFormatting.Benefits
linearmouse.jsonfile.Testing
The change has been tested to ensure that:
Thanks for considering this contribution! I believe this will enhance the developer experience for users managing their configuration files in version control systems.