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.
Description
This PR aims to align the formatting and key order of the JSON merged in the repository.
The formatting of the JSON follows the following rules:
These rules, in combination with the default formatter for JSON files found in VSCode and similar apps, introduce additional line usage, in cases like the following:
While this might reduce the final readability, it's far easier to have the auto-formatted as the base approved layout, rather than count on the auto-formatted to be modified again to have 1 liner again.
The key has been consolidated as follows:
This order allows for a better flow of information, as well as aligning all the JSON already merged in the repository to follow the same order. This order is the preferred and requested from now onwards, change the documentation to indicate the preferred order will be done after this PR.
Subsequently, the PR checklist will receive additional checks for code formatting and key order.