write ordered and formatted project.json files #746
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
reduce conflicts by keeping a consistent project.json file structure. JSON fields are maintained in a stable order and the output JSON is formatted Signed-off-by: Tareq Sharafy <[email protected]> Change-Id: Ic3a9cd74163c43cb288a16050a6f503178f4d2c8
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What issues does this PR fix or reference?
The project meta-data file
.che/project.jsonare written each time a project configuration is updated. This file is currently written in a compact form with no whitespaces or any defined order. This causes every project update to rewrite the only line in the JSON file, making it hard for version control to track the changes or merge them without reporting conflicts.Previous Behavior
.che/poject.jsonis written in unordered compact form.New Behavior
.che/poject.jsonis written in formatted form, separating fields and nested data properly.project.jsonmaintain a stable order. They are written in the same order they were read in, placing new data in the end.project.jsonto benefit from its streaming-based JSON serialization.project.jsoninstead of relying on the environment.Signed-off-by: Tareq Sharafy [email protected]