aboutsummaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli
diff options
context:
space:
mode:
authorZach White <skullydazed@gmail.com>2021-03-25 04:38:10 -0700
committerGitHub <noreply@github.com>2021-03-25 22:38:10 +1100
commit3e60997edba46544557b3a775bdb1538e07c3edf (patch)
tree165923c2cd6b5eeee150c0285ce8ed9eff44eaee /lib/python/qmk/cli
parenta74846a0dbd5efbc7b993918f7f3122e1d620c24 (diff)
downloadqmk_firmware-3e60997edba46544557b3a775bdb1538e07c3edf.tar.gz
qmk_firmware-3e60997edba46544557b3a775bdb1538e07c3edf.zip
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 'lib/python/qmk/cli')
-rw-r--r--lib/python/qmk/cli/__init__.py1
-rw-r--r--lib/python/qmk/cli/c2json.py2
-rw-r--r--lib/python/qmk/cli/format/__init__.py1
-rwxr-xr-xlib/python/qmk/cli/format/json.py66
-rwxr-xr-xlib/python/qmk/cli/generate/api.py2
-rwxr-xr-xlib/python/qmk/cli/generate/info_json.py2
-rwxr-xr-xlib/python/qmk/cli/info.py2
-rwxr-xr-xlib/python/qmk/cli/kle2json.py2
8 files changed, 73 insertions, 5 deletions
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index a5f1f4767..1349e68a9 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -16,6 +16,7 @@ from . import docs
16from . import doctor 16from . import doctor
17from . import fileformat 17from . import fileformat
18from . import flash 18from . import flash
19from . import format
19from . import generate 20from . import generate
20from . import hello 21from . import hello
21from . import info 22from . import info
diff --git a/lib/python/qmk/cli/c2json.py b/lib/python/qmk/cli/c2json.py
index a97e21222..1fa833b64 100644
--- a/lib/python/qmk/cli/c2json.py
+++ b/lib/python/qmk/cli/c2json.py
@@ -6,7 +6,7 @@ from milc import cli
6 6
7import qmk.keymap 7import qmk.keymap
8import qmk.path 8import qmk.path
9from qmk.info_json_encoder import InfoJSONEncoder 9from qmk.json_encoders import InfoJSONEncoder
10from qmk.keyboard import keyboard_folder 10from qmk.keyboard import keyboard_folder
11 11
12 12
diff --git a/lib/python/qmk/cli/format/__init__.py b/lib/python/qmk/cli/format/__init__.py
new file mode 100644
index 000000000..741ec778b
--- /dev/null
+++ b/lib/python/qmk/cli/format/__init__.py
@@ -0,0 +1 @@
from . import json
diff --git a/lib/python/qmk/cli/format/json.py b/lib/python/qmk/cli/format/json.py
new file mode 100755
index 000000000..1358c70e7
--- /dev/null
+++ b/lib/python/qmk/cli/format/json.py
@@ -0,0 +1,66 @@
1"""JSON Formatting Script
2
3Spits out a JSON file formatted with one of QMK's formatters.
4"""
5import json
6
7from jsonschema import ValidationError
8from milc import cli
9
10from qmk.info import info_json
11from qmk.json_schema import json_load, keyboard_validate
12from qmk.json_encoders import InfoJSONEncoder, KeymapJSONEncoder
13from qmk.path import normpath
14
15
16@cli.argument('json_file', arg_only=True, type=normpath, help='JSON file to format')
17@cli.argument('-f', '--format', choices=['auto', 'keyboard', 'keymap'], default='auto', arg_only=True, help='JSON formatter to use (Default: autodetect)')
18@cli.subcommand('Generate an info.json file for a keyboard.', hidden=False if cli.config.user.developer else True)
19def format_json(cli):
20 """Format a json file.
21 """
22 json_file = json_load(cli.args.json_file)
23
24 if cli.args.format == 'auto':
25 try:
26 keyboard_validate(json_file)
27 json_encoder = InfoJSONEncoder
28
29 except ValidationError as e:
30 cli.log.warning('File %s did not validate as a keyboard:\n\t%s', cli.args.json_file, e)
31 cli.log.info('Treating %s as a keymap file.', cli.args.json_file)
32 json_encoder = KeymapJSONEncoder
33
34 elif cli.args.format == 'keyboard':
35 json_encoder = InfoJSONEncoder
36 elif cli.args.format == 'keymap':
37 json_encoder = KeymapJSONEncoder
38 else:
39 # This should be impossible
40 cli.log.error('Unknown format: %s', cli.args.format)
41 return False
42
43 if json_encoder == KeymapJSONEncoder and 'layout' in json_file:
44 # Attempt to format the keycodes.
45 layout = json_file['layout']
46 info_data = info_json(json_file['keyboard'])
47
48 if layout in info_data.get('layout_aliases', {}):
49 layout = json_file['layout'] = info_data['layout_aliases'][layout]
50
51 if layout in info_data.get('layouts'):
52 for layer_num, layer in enumerate(json_file['layers']):
53 current_layer = []
54 last_row = 0
55
56 for keymap_key, info_key in zip(layer, info_data['layouts'][layout]['layout']):
57 if last_row != info_key['y']:
58 current_layer.append('JSON_NEWLINE')
59 last_row = info_key['y']
60
61 current_layer.append(keymap_key)
62
63 json_file['layers'][layer_num] = current_layer
64
65 # Display the results
66 print(json.dumps(json_file, cls=json_encoder))
diff --git a/lib/python/qmk/cli/generate/api.py b/lib/python/qmk/cli/generate/api.py
index 290590834..70019428f 100755
--- a/lib/python/qmk/cli/generate/api.py
+++ b/lib/python/qmk/cli/generate/api.py
@@ -8,7 +8,7 @@ from milc import cli
8 8
9from qmk.datetime import current_datetime 9from qmk.datetime import current_datetime
10from qmk.info import info_json 10from qmk.info import info_json
11from qmk.info_json_encoder import InfoJSONEncoder 11from qmk.json_encoders import InfoJSONEncoder
12from qmk.json_schema import json_load 12from qmk.json_schema import json_load
13from qmk.keyboard import list_keyboards 13from qmk.keyboard import list_keyboards
14 14
diff --git a/lib/python/qmk/cli/generate/info_json.py b/lib/python/qmk/cli/generate/info_json.py
index 6c00ba7d8..1af7f0439 100755
--- a/lib/python/qmk/cli/generate/info_json.py
+++ b/lib/python/qmk/cli/generate/info_json.py
@@ -9,7 +9,7 @@ from milc import cli
9 9
10from qmk.decorators import automagic_keyboard, automagic_keymap 10from qmk.decorators import automagic_keyboard, automagic_keymap
11from qmk.info import info_json 11from qmk.info import info_json
12from qmk.info_json_encoder import InfoJSONEncoder 12from qmk.json_encoders import InfoJSONEncoder
13from qmk.json_schema import load_jsonschema 13from qmk.json_schema import load_jsonschema
14from qmk.keyboard import keyboard_folder 14from qmk.keyboard import keyboard_folder
15from qmk.path import is_keyboard 15from qmk.path import is_keyboard
diff --git a/lib/python/qmk/cli/info.py b/lib/python/qmk/cli/info.py
index 88b65686f..aac507c1a 100755
--- a/lib/python/qmk/cli/info.py
+++ b/lib/python/qmk/cli/info.py
@@ -7,7 +7,7 @@ import platform
7 7
8from milc import cli 8from milc import cli
9 9
10from qmk.info_json_encoder import InfoJSONEncoder 10from qmk.json_encoders import InfoJSONEncoder
11from qmk.constants import COL_LETTERS, ROW_LETTERS 11from qmk.constants import COL_LETTERS, ROW_LETTERS
12from qmk.decorators import automagic_keyboard, automagic_keymap 12from qmk.decorators import automagic_keyboard, automagic_keymap
13from qmk.keyboard import keyboard_folder, render_layouts, render_layout 13from qmk.keyboard import keyboard_folder, render_layouts, render_layout
diff --git a/lib/python/qmk/cli/kle2json.py b/lib/python/qmk/cli/kle2json.py
index 3bb744358..91499c9af 100755
--- a/lib/python/qmk/cli/kle2json.py
+++ b/lib/python/qmk/cli/kle2json.py
@@ -8,7 +8,7 @@ from milc import cli
8from kle2xy import KLE2xy 8from kle2xy import KLE2xy
9 9
10from qmk.converter import kle2qmk 10from qmk.converter import kle2qmk
11from qmk.info_json_encoder import InfoJSONEncoder 11from qmk.json_encoders import InfoJSONEncoder
12 12
13 13
14@cli.argument('filename', help='The KLE raw txt to convert') 14@cli.argument('filename', help='The KLE raw txt to convert')