From 3e60997edba46544557b3a775bdb1538e07c3edf Mon Sep 17 00:00:00 2001
From: Zach White <skullydazed@gmail.com>
Date: Thu, 25 Mar 2021 04:38:10 -0700
Subject: 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
---
 docs/cli_commands.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'docs')

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.
-- 
cgit v1.2.3