cleaning up command file. use existing qmk dir constant

lib/python/qmk/cli/compile.py

@@ -10,19 +10,12 @@
 import qmk.path
 from qmk.decorators import automagic_keyboard, automagic_keymap
 from qmk.commands import compile_configurator_json, create_make_command, parse_configurator_json
-from qmk.compile_commands_json import parse_make_n, qmk_dir
-import json
 
 
 @cli.argument('filename', nargs='?', arg_only=True, type=FileType('r'), help='The configurator export to compile')
 @cli.argument('-kb', '--keyboard', help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
 @cli.argument('-km', '--keymap', help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
 @cli.argument('-n', '--dry-run', arg_only=True, action='store_true', help="Don't actually build, just show the make command to be run.")
-@cli.argument('-c', '--compile-commands', arg_only=True, action='store_true',
-              help="Does a make clean, then a make -n for this target and uses the dry-run output to create "
-              "a compilation database (compile_commands.json). This file can help some IDEs and "
-              "IDE-like editors work better. For more information about this: "
-              "https://clang.llvm.org/docs/JSONCompilationDatabase.html")
 @cli.subcommand('Compile a QMK Firmware.')
 @automagic_keyboard
 @automagic_keymap
@@ -47,39 +40,19 @@ def compile(cli):
     else:
         if cli.config.compile.keyboard and cli.config.compile.keymap:
             # Generate the make command for a specific keyboard/keymap.
-            dry_run = cli.args.compile_commands
-            command = create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap, dry_run=dry_run)
+            command = create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap)
 
         elif not cli.config.compile.keyboard:
             cli.log.error('Could not determine keyboard!')
         elif not cli.config.compile.keymap:
             cli.log.error('Could not determine keymap!')
 
+    # Compile the firmware, if we're able to
     if command:
-        if cli.args.compile_commands:
-            cli.log.info('Making clean')
-            subprocess.run(['make', 'clean'], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
-
-            cli.log.info('Gathering build instructions')
-            proc = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
-            db = parse_make_n(proc.stdout)
-            res = proc.wait()
-            if res != 0:
-                raise RuntimeError(f"Got error from: {repr(command)}")
-
-            cli.log.info(f"Found {len(db)} compile commands")
-
-            dbpath = qmk_dir / 'compile_commands.json'
-
-            cli.log.info(f"Writing build database to {dbpath}")
-            dbpath.write_text(json.dumps(db, indent=4))
-
-        else:
-            # Compile the firmware, if we're able to
-            cli.log.info('Compiling keymap with {fg_cyan}%s', ' '.join(command))
-            if not cli.args.dry_run:
-                cli.echo('\n')
-                subprocess.run(command)
+        cli.log.info('Compiling keymap with {fg_cyan}%s', ' '.join(command))
+        if not cli.args.dry_run:
+            cli.echo('\n')
+            subprocess.run(command)
 
     else:
         cli.log.error('You must supply a configurator export, both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.')

lib/python/qmk/cli/compiledb.py

@@ -0,0 +1,61 @@
+"""Creates a compilation database for the given keyboard build.
+"""
+import subprocess
+from argparse import FileType
+
+from milc import cli
+
+from qmk.decorators import automagic_keyboard, automagic_keymap
+from qmk.commands import create_make_command
+from qmk.compile_commands_json import parse_make_n
+from qmk.constants import QMK_FIRMWARE
+import json
+
+
+@cli.argument('-kb', '--keyboard', help='The keyboard to build a firmware for. Ignored when a configurator export is supplied.')
+@cli.argument('-km', '--keymap', help='The keymap to build a firmware for. Ignored when a configurator export is supplied.')
+@cli.subcommand('Create a compilation database.')
+@automagic_keyboard
+@automagic_keymap
+def compile(cli):
+    """Creates a compilation database for the given keyboard build.
+
+    Does a make clean, then a make -n for this target and uses the dry-run output to create
+    a compilation database (compile_commands.json). This file can help some IDEs and
+    IDE-like editors work better. For more information about this:
+
+        https://clang.llvm.org/docs/JSONCompilationDatabase.html
+    """
+    command = None
+
+    if cli.config.compile.keyboard and cli.config.compile.keymap:
+        # Generate the make command for a specific keyboard/keymap.
+        command = create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap, dry_run=True)
+
+    elif not cli.config.compile.keyboard:
+        cli.log.error('Could not determine keyboard!')
+    elif not cli.config.compile.keymap:
+        cli.log.error('Could not determine keymap!')
+
+    if command:
+        cli.log.info('Making clean')
+        subprocess.run(['make', 'clean'], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
+
+        cli.log.info('Gathering build instructions')
+        proc = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
+        db = parse_make_n(proc.stdout)
+        res = proc.wait()
+        if res != 0:
+            raise RuntimeError(f"Got error from: {repr(command)}")
+
+        cli.log.info(f"Found {len(db)} compile commands")
+
+        dbpath = QMK_FIRMWARE / 'compile_commands.json'
+
+        cli.log.info(f"Writing build database to {dbpath}")
+        dbpath.write_text(json.dumps(db, indent=4))
+
+    else:
+        cli.log.error('You must supply both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.')
+        cli.echo('usage: qmk compiledb [-kb KEYBOARD] [-km KEYMAP]')
+        return False

lib/python/qmk/compile_commands_json.py

@@ -8,11 +8,10 @@
 from functools import lru_cache
 from subprocess import check_output
 
+from qmk.constants import QMK_FIRMWARE
 
 from typing import TextIO, List, Dict
 
-qmk_dir = Path(__file__).parent.parent.parent.parent
-
 
 @lru_cache(maxsize=10)
 def system_libs(binary: str):
@@ -56,7 +55,7 @@ def parse_make_n(f: TextIO) -> List[Dict[str, str]]:
                 args = shlex.split(this_cmd)
                 args += ['-I%s' % s for s in system_libs(args[0])]
                 new_cmd = ' '.join(shlex.quote(s) for s in args if s != '-mno-thumb-interwork')
-                records.append({"directory": str(qmk_dir), "command": new_cmd, "file": this_file})
+                records.append({"directory": str(QMK_FIRMWARE.resolve()), "command": new_cmd, "file": this_file})
                 state = 'start'
 
     return records