keyboard stuff
auri.ee
1# Copyright 2023-2024 Nick Brassel (@tzarc)
2# SPDX-License-Identifier: GPL-2.0-or-later
3from pathlib import Path
4from milc import cli
5
6from qmk.commands import parse_env_vars
7from qmk.constants import QMK_USERSPACE, HAS_QMK_USERSPACE
8from qmk.keyboard import keyboard_completer, keyboard_folder_or_all
9from qmk.keymap import keymap_completer, is_keymap_target
10from qmk.userspace import UserspaceDefs
11
12
13@cli.argument('builds', nargs='*', arg_only=True, help="List of builds in form <keyboard>:<keymap>, or path to a keymap JSON file.")
14@cli.argument('-kb', '--keyboard', type=keyboard_folder_or_all, completer=keyboard_completer, help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
15@cli.argument('-km', '--keymap', completer=keymap_completer, help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
16@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Extra variables to set during build. May be passed multiple times.")
17@cli.subcommand('Adds a build target to userspace `qmk.json`.')
18def userspace_add(cli):
19 if not HAS_QMK_USERSPACE:
20 cli.log.error('Could not determine QMK userspace location. Please run `qmk doctor` or `qmk userspace-doctor` to diagnose.')
21 return False
22
23 build_env = None if len(cli.args.env) == 0 else parse_env_vars(cli.args.env)
24
25 userspace = UserspaceDefs(QMK_USERSPACE / 'qmk.json')
26
27 if len(cli.args.builds) > 0:
28 json_like_targets = list([Path(p) for p in filter(lambda e: Path(e).exists() and Path(e).suffix == '.json', cli.args.builds)])
29 make_like_targets = list(filter(lambda e: Path(e) not in json_like_targets, cli.args.builds))
30
31 for e in json_like_targets:
32 userspace.add_target(json_path=e)
33
34 for e in make_like_targets:
35 s = e.split(':')
36 userspace.add_target(keyboard=s[0], keymap=s[1])
37
38 else:
39 failed = False
40 try:
41 if not is_keymap_target(cli.args.keyboard, cli.args.keymap):
42 failed = True
43 except KeyError:
44 failed = True
45
46 if failed:
47 from qmk.cli.new.keymap import new_keymap
48 cli.config.new_keymap.keyboard = cli.args.keyboard
49 cli.config.new_keymap.keymap = cli.args.keymap
50 cli.args.skip_converter = True
51 if new_keymap(cli) is not False:
52 userspace.add_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap, build_env=build_env)
53 else:
54 userspace.add_target(keyboard=cli.args.keyboard, keymap=cli.args.keymap, build_env=build_env)
55
56 return userspace.save()