summaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/compile.py
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2023-09-28 20:48:58 +1000
committerGitHub <noreply@github.com>2023-09-28 11:48:58 +0100
commitfb0c64a567b6dd2536aae0c2df56a915ffa72404 (patch)
tree71b94d52b854a803d726d80fb7c20d0ddc363805 /lib/python/qmk/cli/compile.py
parent0ecb03ad47a1ec1871537cd9fa3ea39cc60f52aa (diff)
Allow inline generation of compile_commands.json while doing a `qmk compile`, using `--compiledb` (#21549)
Diffstat (limited to 'lib/python/qmk/cli/compile.py')
-rwxr-xr-xlib/python/qmk/cli/compile.py16
1 files changed, 16 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/compile.py b/lib/python/qmk/cli/compile.py
index 3d632e74a9..2478ea1fed 100755
--- a/lib/python/qmk/cli/compile.py
+++ b/lib/python/qmk/cli/compile.py
@@ -7,10 +7,12 @@ from argcomplete.completers import FilesCompleter
from milc import cli
import qmk.path
+from qmk.constants import QMK_FIRMWARE
from qmk.decorators import automagic_keyboard, automagic_keymap
from qmk.commands import compile_configurator_json, create_make_command, parse_configurator_json, build_environment
from qmk.keyboard import keyboard_completer, keyboard_folder_or_all, is_all_keyboards
from qmk.keymap import keymap_completer, locate_keymap
+from qmk.cli.generate.compilation_database import write_compilation_database
def _is_keymap_target(keyboard, keymap):
@@ -30,6 +32,7 @@ def _is_keymap_target(keyboard, keymap):
@cli.argument('-j', '--parallel', type=int, default=1, help="Set the number of parallel make jobs; 0 means unlimited.")
@cli.argument('-e', '--env', arg_only=True, action='append', default=[], help="Set a variable to be passed to make. May be passed multiple times.")
@cli.argument('-c', '--clean', arg_only=True, action='store_true', help="Remove object files before compiling.")
+@cli.argument('--compiledb', arg_only=True, action='store_true', help="Generates the clang compile_commands.json file during build. Implies --clean.")
@cli.subcommand('Compile a QMK Firmware.')
@automagic_keyboard
@automagic_keymap
@@ -53,6 +56,9 @@ def compile(cli):
# Determine the compile command
commands = []
+ current_keyboard = None
+ current_keymap = None
+
if cli.args.filename:
# If a configurator JSON was provided generate a keymap and compile it
user_keymap = parse_configurator_json(cli.args.filename)
@@ -69,11 +75,21 @@ def compile(cli):
commands.append(create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap, 'clean', **envs))
commands.append(create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap, parallel=cli.config.compile.parallel, **envs))
+ current_keyboard = cli.config.compile.keyboard
+ current_keymap = cli.config.compile.keymap
+
if not commands:
cli.log.error('You must supply a configurator export, both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.')
cli.print_help()
return False
+ if cli.args.compiledb:
+ if current_keyboard is None or current_keymap is None:
+ cli.log.error('You must supply both `--keyboard` and `--keymap` or be in a directory with a keymap to generate a compile_commands.json file.')
+ cli.print_help()
+ return False
+ write_compilation_database(current_keyboard, current_keymap, QMK_FIRMWARE / 'compile_commands.json')
+
cli.log.info('Compiling keymap with {fg_cyan}%s', ' '.join(commands[-1]))
if not cli.args.dry_run:
cli.echo('\n')