summaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/format
diff options
context:
space:
mode:
authorDrashna Jael're <drashna@live.com>2021-06-29 12:23:03 -0700
committerDrashna Jael're <drashna@live.com>2021-06-29 12:24:07 -0700
commitacf2c323e2927f6007b17ded577cf49fd86fec6c (patch)
tree8334dc5c71e6ab9bf33c76143eac7bb0e60159b0 /lib/python/qmk/cli/format
parentec7a7beeed3046e9144d4c4ce0ef3b2c4f9e4341 (diff)
parentf55e39e8a2246f6f96fd5d4a84a866e2615cde7b (diff)
Merge upstream QMK Firmware at '0.12.52~1'
Diffstat (limited to 'lib/python/qmk/cli/format')
-rw-r--r--lib/python/qmk/cli/format/__init__.py1
-rwxr-xr-xlib/python/qmk/cli/format/json.py66
2 files changed, 67 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/format/__init__.py b/lib/python/qmk/cli/format/__init__.py
new file mode 100644
index 0000000000..741ec778b1
--- /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 0000000000..1358c70e7a
--- /dev/null
+++ b/lib/python/qmk/cli/format/json.py
@@ -0,0 +1,66 @@
+"""JSON Formatting Script
+
+Spits out a JSON file formatted with one of QMK's formatters.
+"""
+import json
+
+from jsonschema import ValidationError
+from milc import cli
+
+from qmk.info import info_json
+from qmk.json_schema import json_load, keyboard_validate
+from qmk.json_encoders import InfoJSONEncoder, KeymapJSONEncoder
+from qmk.path import normpath
+
+
+@cli.argument('json_file', arg_only=True, type=normpath, help='JSON file to format')
+@cli.argument('-f', '--format', choices=['auto', 'keyboard', 'keymap'], default='auto', arg_only=True, help='JSON formatter to use (Default: autodetect)')
+@cli.subcommand('Generate an info.json file for a keyboard.', hidden=False if cli.config.user.developer else True)
+def format_json(cli):
+ """Format a json file.
+ """
+ json_file = json_load(cli.args.json_file)
+
+ if cli.args.format == 'auto':
+ try:
+ keyboard_validate(json_file)
+ json_encoder = InfoJSONEncoder
+
+ except ValidationError as e:
+ cli.log.warning('File %s did not validate as a keyboard:\n\t%s', cli.args.json_file, e)
+ cli.log.info('Treating %s as a keymap file.', cli.args.json_file)
+ json_encoder = KeymapJSONEncoder
+
+ elif cli.args.format == 'keyboard':
+ json_encoder = InfoJSONEncoder
+ elif cli.args.format == 'keymap':
+ json_encoder = KeymapJSONEncoder
+ else:
+ # This should be impossible
+ cli.log.error('Unknown format: %s', cli.args.format)
+ return False
+
+ if json_encoder == KeymapJSONEncoder and 'layout' in json_file:
+ # Attempt to format the keycodes.
+ layout = json_file['layout']
+ info_data = info_json(json_file['keyboard'])
+
+ if layout in info_data.get('layout_aliases', {}):
+ layout = json_file['layout'] = info_data['layout_aliases'][layout]
+
+ if layout in info_data.get('layouts'):
+ for layer_num, layer in enumerate(json_file['layers']):
+ current_layer = []
+ last_row = 0
+
+ for keymap_key, info_key in zip(layer, info_data['layouts'][layout]['layout']):
+ if last_row != info_key['y']:
+ current_layer.append('JSON_NEWLINE')
+ last_row = info_key['y']
+
+ current_layer.append(keymap_key)
+
+ json_file['layers'][layer_num] = current_layer
+
+ # Display the results
+ print(json.dumps(json_file, cls=json_encoder))