schemas: Indent .lock.json for readability - #231
Draft
Bham06 wants to merge 1 commit into
Draft
Conversation
The schema lock file (.lock.json) was written on a single line, making it hard to read and prone to merge conflicts whenever more than one dependency changed. Write it with json.MarshalIndent (two-space indent) and a trailing newline so each dependency is on its own line. Reads are unaffected; getLock decodes the file with a json.Decoder and indented JSON remains valid. Fixes crossplane#168 Signed-off-by: Bham06 <heu319@student.bham.ac.uk>
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
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.
Description of your changes
schemas/.lock.jsonwas written on a single line, which is hard to read andcauses avoidable merge conflicts whenever more than one dependency changes.
This writes the lock file with
json.MarshalIndent(two-space indent) plus atrailing newline, so each dependency is on its own line. Reads are unaffected:
getLockdecodes with ajson.Decoder, and indented JSON is still valid. Mapkeys marshal in sorted order, so the output is deterministic.
Fixes #168
I have:
RunRan./nix.sh flake checkto ensure this PR is ready for review.go test ./internal/schemas/manager/... ./internal/dependency/...,go vet, andgofmt, and reviewed the change against.golangci.yml; relied on CI for the full flake check.TestUpdateLockIsIndented.)Linked a PR or a docs tracking issue to document this change.Internal on-disk lock file format; no user-facing docs.AddedMinor readability change; left to maintainer discretion.backport release-x.ylabels to auto-backport this PR.