diff options
| author | Philip Dubé <159546+serprex@users.noreply.github.com> | 2026-08-14 22:03:44 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-08-14 22:03:44 +0000 |
| commit | afcfe4f7bf7f5fd1e4314ea21d123756cd772195 (patch) | |
| tree | 6529022a4acc9fdbcffd0307e20a0f5db7db5385 /docs | |
| parent | fa5172a58b1a7e9fca162c5d96a2655ce8cf63e6 (diff) | |
Format JSON, include CI check (#7071)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/FORMATTING.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/FORMATTING.md b/docs/FORMATTING.md index 2208c3b3d..48605b512 100644 --- a/docs/FORMATTING.md +++ b/docs/FORMATTING.md @@ -54,11 +54,21 @@ gives you a 14.x binary: - **Homebrew (macOS or Linux)**: `brew install llvm@14` and use its `clang-format`, or use one of the cross-platform options above. +## JSON assets + +JSON in `soh/assets/custom` checked by CI with: + +```sh +./scripts/lint-json.sh # check +./scripts/lint-json.sh --fix # reformat in place +``` + ## Optional: format on commit The repo ships a [pre-commit](https://pre-commit.com/) config (`.pre-commit-config.yaml`) that auto-formats staged C/C++ with a pinned 14.x -before each commit, so you never get caught by the CI check. With pre-commit +and runs the JSON lint on staged assets before each commit, so you never get +caught by the CI checks. With pre-commit [installed](https://pre-commit.com/#install), enable it once: ```bash |