Add pre-commit to auto-format JSON #106
Open
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
brettasmi
commented
Aug 24, 2021
| @@ -0,0 +1,6 @@ | |||
| repos: | |||
There was a problem hiding this comment.
pre-commit's configuration:
- sets the requirement to install prettier
- restricts prettier's domain to JSON
| @@ -0,0 +1,3 @@ | |||
| { | |||
There was a problem hiding this comment.
prettier's config setting indentation to 2 spaces. Other options here: https://prettier.io/docs/en/options.html
| @@ -1 +1,17 @@ | |||
| {"message": {"query_graph": {"nodes": {"n0": {"ids": ["MONDO:0014007"], "categories": ["biolink:Disease"]}, "n1": {"categories": ["biolink:Disease"]}}, "edges": {"e01": {"subject": "n0", "object": "n1", "predicates": ["biolink:correlated_with"]}}}}} | |||
There was a problem hiding this comment.
An example of what the prettier-formatted JSON looks like
| @@ -1,7 +1,8 @@ | |||
| biothings-explorer==1.0.2 | |||
There was a problem hiding this comment.
alphabetizes and adds pre-commit
andrewsu
approved these changes
Aug 27, 2021
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.
Last Friday, I embarrassingly failed to manually parse a JSON because I struggled with its formatting. The JSON in this repo varies in its formatting and can make some of these queries difficult to parse quickly. To help with this issue, this PR adds a pre-commit hook to auto-format any staged JSON using pre-commit and its prettier plugin
In practice it works as follows:
Since @MarkDWilliams is essentially the only person who commits to this repository, I thought it would be a good test case for translator to see if it could be adopted more widely (e.g. minihackathon repo) if a single-user repo is successful.
I will make comments on the individual files to explain their function.
Please feel free to reject this PR if you think it will inhibit your workflow. It's just a suggestion that I think could make life easier, but I understand it complicates a widely used repo.
@MarkDWilliams, if you choose to merge this PR, it might be a good idea to do the following on a formatting branch after setting up precommit per the README:
Bonus: you get a free dark green block on your git profile :)