summaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/generate/api.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/generate/api.py')
-rwxr-xr-xlib/python/qmk/cli/generate/api.py35
1 files changed, 33 insertions, 2 deletions
diff --git a/lib/python/qmk/cli/generate/api.py b/lib/python/qmk/cli/generate/api.py
index 8d8ca3cd41..a98a12b628 100755
--- a/lib/python/qmk/cli/generate/api.py
+++ b/lib/python/qmk/cli/generate/api.py
@@ -11,12 +11,40 @@ from qmk.info import info_json
from qmk.json_encoders import InfoJSONEncoder
from qmk.json_schema import json_load
from qmk.keyboard import find_readme, list_keyboards
+from qmk.keycodes import load_spec, list_versions
DATA_PATH = Path('data')
TEMPLATE_PATH = DATA_PATH / 'templates/api/'
BUILD_API_PATH = Path('.build/api_data/')
+def _resolve_keycode_specs(output_folder):
+ """To make it easier for consumers, publish pre-merged spec files
+ """
+ for version in list_versions():
+ overall = load_spec(version)
+
+ output_file = output_folder / f'constants/keycodes_{version}.json'
+ output_file.write_text(json.dumps(overall, indent=4), encoding='utf-8')
+
+ # Purge files consumed by 'load_spec'
+ shutil.rmtree(output_folder / 'constants/keycodes/')
+
+
+def _filtered_copy(src, dst):
+ src = Path(src)
+ dst = Path(dst)
+
+ if dst.suffix == '.hjson':
+ data = json_load(src)
+
+ dst = dst.with_suffix('.json')
+ dst.write_text(json.dumps(data, indent=4), encoding='utf-8')
+ return dst
+
+ return shutil.copy2(src, dst)
+
+
def _filtered_keyboard_list():
"""Perform basic filtering of list_keyboards
"""
@@ -47,7 +75,7 @@ def generate_api(cli):
shutil.rmtree(BUILD_API_PATH)
shutil.copytree(TEMPLATE_PATH, BUILD_API_PATH)
- shutil.copytree(DATA_PATH, v1_dir)
+ shutil.copytree(DATA_PATH, v1_dir, copy_function=_filtered_copy)
# Filter down when required
keyboard_list = _filtered_keyboard_list()
@@ -87,7 +115,7 @@ def generate_api(cli):
# Generate data for the global files
keyboard_list = sorted(kb_all)
- keyboard_aliases = json_load(Path('data/mappings/keyboard_aliases.json'))
+ keyboard_aliases = json_load(Path('data/mappings/keyboard_aliases.hjson'))
keyboard_metadata = {
'last_updated': current_datetime(),
'keyboards': keyboard_list,
@@ -95,6 +123,9 @@ def generate_api(cli):
'usb': usb_list,
}
+ # Feature specific handling
+ _resolve_keycode_specs(v1_dir)
+
# Write the global JSON files
keyboard_all_json = json.dumps({'last_updated': current_datetime(), 'keyboards': kb_all}, cls=InfoJSONEncoder)
usb_json = json.dumps({'last_updated': current_datetime(), 'usb': usb_list}, cls=InfoJSONEncoder)