Add json formatter to pre-commit #571
Merged
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
Codecov Report
@@ Coverage Diff @@
## main #571 +/- ##
=======================================
Coverage 96.49% 96.49%
=======================================
Files 45 45
Lines 2484 2484
=======================================
Hits 2397 2397
Misses 87 87
Flags with carried forward coverage won't be shown. Click here to find out more. |
emmastephenson
requested review from
robertmitchellv,
nickclyde and
BradySkylight
emmastephenson
commented
May 11, 2023
| hooks: | ||
| - id: pretty-format-json | ||
| args: [ --autofix, --no-sort-keys ] | ||
| exclude: ".*valid.*" |
There was a problem hiding this comment.
Review note: we have a couple of intentionally invalid JSON for tests. This makes sure they won't be flagged in future commits, as they conveniently both have valid in the filename (invalid_json and not_valid_json_test, IIRC)
robertmitchellv
approved these changes
May 11, 2023
BradySkylight
approved these changes
May 12, 2023
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.
PULL REQUEST
Summary
Add JSON formatter to our pre-commit hooks.
Related Issue
n/a
Additional Information
Note to reviewers: The only new code is in
.pre-commit-config.yaml. Everything else is linting updates!We have a lot of JSON files floating around (mostly test FHIR bundles, but a couple configs and schemas too) and it would be nice not to need to manually format them.
As far as I can tell, we don't already have a JSON linter on this repository, so I just defaulted to the one
pre-commitoffers (pretty-format-json).I also ran this on all the files in the repository to make sure our existing JSON files are formatted. (
pre-commit run --all-files, for the curious)Once this merges, folks may need to run
pre-commit autoupdateto get the hook working - at least, I needed to run it for some reason.