diff options
| author | Zach White <skullydazed@gmail.com> | 2021-03-25 04:38:10 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-25 22:38:10 +1100 |
| commit | 3e60997edba46544557b3a775bdb1538e07c3edf (patch) | |
| tree | 165923c2cd6b5eeee150c0285ce8ed9eff44eaee /docs | |
| parent | a74846a0dbd5efbc7b993918f7f3122e1d620c24 (diff) | |
Add a `qmk format-json` command that will format JSON files (#12372)
* Add a command to format json files
* change to work after rebase
* add test for qmk format-json
* add documentation for qmk format-json
* Update lib/python/qmk/cli/format/json.py
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli_commands.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index bb5df89968..6498b28b88 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -131,6 +131,16 @@ Check your environment and report problems only: qmk doctor -n +## `qmk format-json` + +Formats a JSON file in a (mostly) human-friendly way. Will usually correctly detect the format of the JSON (info.json or keymap.json) but you can override this with `--format` if neccesary. + +**Usage**: + +``` +qmk format-json [-f FORMAT] <json_file> +``` + ## `qmk info` Displays information about keyboards and keymaps in QMK. You can use this to get information about a keyboard, show the layouts, display the underlying key matrix, or to pretty-print JSON keymaps. |