119 lines
4.2 KiB
Python
Executable File
119 lines
4.2 KiB
Python
Executable File
"""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, validate
|
|
from qmk.json_encoders import InfoJSONEncoder, KeymapJSONEncoder, UserspaceJSONEncoder, CommunityModuleJSONEncoder
|
|
from qmk.path import normpath
|
|
|
|
|
|
def _detect_json_format(file, json_data):
|
|
"""Detect the format of a json file.
|
|
"""
|
|
json_encoder = None
|
|
try:
|
|
validate(json_data, 'qmk.user_repo.v1_1')
|
|
json_encoder = UserspaceJSONEncoder
|
|
except ValidationError:
|
|
pass
|
|
|
|
if json_encoder is None:
|
|
try:
|
|
validate(json_data, 'qmk.user_repo.v1')
|
|
json_encoder = UserspaceJSONEncoder
|
|
except ValidationError:
|
|
pass
|
|
|
|
if json_encoder is None:
|
|
try:
|
|
validate(json_data, 'qmk.community_module.v1')
|
|
json_encoder = CommunityModuleJSONEncoder
|
|
except ValidationError:
|
|
pass
|
|
|
|
if json_encoder is None:
|
|
try:
|
|
validate(json_data, 'qmk.keyboard.v1')
|
|
json_encoder = InfoJSONEncoder
|
|
except ValidationError as e:
|
|
cli.log.warning('File %s did not validate as a keyboard info.json or userspace qmk.json:\n\t%s', file, e)
|
|
cli.log.info('Treating %s as a keymap file.', file)
|
|
json_encoder = KeymapJSONEncoder
|
|
|
|
return json_encoder
|
|
|
|
|
|
def _get_json_encoder(file, json_data):
|
|
"""Get the json encoder for a file.
|
|
"""
|
|
json_encoder = None
|
|
if cli.args.format == 'auto':
|
|
json_encoder = _detect_json_format(file, json_data)
|
|
elif cli.args.format == 'keyboard':
|
|
json_encoder = InfoJSONEncoder
|
|
elif cli.args.format == 'keymap':
|
|
json_encoder = KeymapJSONEncoder
|
|
elif cli.args.format == 'userspace':
|
|
json_encoder = UserspaceJSONEncoder
|
|
elif cli.args.format == 'community_module':
|
|
json_encoder = CommunityModuleJSONEncoder
|
|
else:
|
|
# This should be impossible
|
|
cli.log.error('Unknown format: %s', cli.args.format)
|
|
return json_encoder
|
|
|
|
|
|
@cli.argument('json_file', arg_only=True, type=normpath, help='JSON file to format')
|
|
@cli.argument('-f', '--format', choices=['auto', 'keyboard', 'keymap', 'userspace', 'community_module'], default='auto', arg_only=True, help='JSON formatter to use (Default: autodetect)')
|
|
@cli.argument('-i', '--inplace', action='store_true', arg_only=True, help='If set, will operate in-place on the input file')
|
|
@cli.argument('-p', '--print', action='store_true', arg_only=True, help='If set, will print the formatted json to stdout ')
|
|
@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_data = json_load(cli.args.json_file)
|
|
|
|
json_encoder = _get_json_encoder(cli.args.json_file, json_data)
|
|
if json_encoder is None:
|
|
return False
|
|
|
|
if json_encoder == KeymapJSONEncoder and 'layout' in json_data:
|
|
# Attempt to format the keycodes.
|
|
layout = json_data['layout']
|
|
info_data = info_json(json_data['keyboard'])
|
|
|
|
if layout in info_data.get('layout_aliases', {}):
|
|
layout = json_data['layout'] = info_data['layout_aliases'][layout]
|
|
|
|
if layout in info_data.get('layouts'):
|
|
for layer_num, layer in enumerate(json_data['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_data['layers'][layer_num] = current_layer
|
|
|
|
output = json.dumps(json_data, cls=json_encoder, sort_keys=True)
|
|
|
|
if cli.args.inplace:
|
|
with open(cli.args.json_file, 'w+', encoding='utf-8', newline='\n') as outfile:
|
|
outfile.write(output + '\n')
|
|
|
|
# Display the results if print was set
|
|
# We don't operate in-place by default, so also display to stdout
|
|
# if in-place is not set.
|
|
if cli.args.print or not cli.args.inplace:
|
|
print(output)
|