diff options
| author | Cody Bender <[email protected]> | 2020-02-07 13:48:37 -0700 | 
|---|---|---|
| committer | GitHub <[email protected]> | 2020-02-07 21:48:37 +0100 | 
| commit | e77188458f136da3e25ce066e80b21d38f6e8cdc (patch) | |
| tree | 1066504f2e5a1a27b068ce6383f75ede0e9c21de /lib/python | |
| parent | 774cbbf879eaec2149413917cb970054e4c1bf59 (diff) | |
| download | qmk_firmware-e77188458f136da3e25ce066e80b21d38f6e8cdc.tar.gz qmk_firmware-e77188458f136da3e25ce066e80b21d38f6e8cdc.zip | |
Add QMK Compile Context Sensitivity (#6884)0.7.142
* Add context sensitive compile, without config check
* Initial full working state. Plan to refactor
* Refactor loop for simplicity, add comments
* Update docs/cli.md with qmk compile examples
* Simplify path for keyboard derivation
* Update path to use path.join instead of concat
* Refactor keyboard path, the skully way
* Add in keymap folder support
* Add /layouts compile support
* Update docs/cli.md with empty compile in layouts
* Add comments to compile.py
* Update docs for clarity, and fix compile error typo
* Fix config option compile
* Fix layout compile and failure mode
* Add rules.mk check
* Fix variable names for global config
* Add in_layout priority
* Remove default fallback in favor of throw, update docs
* Add keymap folder context
* Fix formatting
* Add os import
* Convert to create_make_command
* Fix Travis lint errors
* Remove blank line with whitespace
* Add blank lines for readability
* Remove unnecessary config logic
* Update Docs to add flash
Co-Authored-By: skullydazed <[email protected]>
* Shift config precedence to MILC
Co-authored-by: skullydazed <[email protected]>
Diffstat (limited to 'lib/python')
| -rwxr-xr-x | lib/python/qmk/cli/compile.py | 75 | 
1 files changed, 72 insertions, 3 deletions
| diff --git a/lib/python/qmk/cli/compile.py b/lib/python/qmk/cli/compile.py index 8e2d0cdbf4..826b969ef6 100755 --- a/lib/python/qmk/cli/compile.py +++ b/lib/python/qmk/cli/compile.py @@ -3,6 +3,7 @@  You can compile a keymap already in the repo or using a QMK Configurator export.  """  import subprocess +import os  from argparse import FileType  from milc import cli @@ -28,6 +29,46 @@ def compile(cli):      If --keyboard and --keymap are provided this command will build a firmware based on that.      """ +    # Set CWD as directory command was issued from +    cwd = os.environ['ORIG_CWD'] +    qmk_path = os.getcwd() +    current_folder = os.path.basename(cwd) +    # Initialize boolean to check for being in a keyboard directory and initialize keyboard string +    in_keyboard = False +    in_layout = False +    keyboard = "" +    keymap = "" +    user_keymap = "" +    user_keyboard = "" + +    # Set path for '/keyboards/' directory +    keyboards_path = os.path.join(qmk_path, "keyboards") +    layouts_path = os.path.join(qmk_path, "layouts") + +    # If below 'keyboards' and not in 'keyboards' or 'keymaps', get current keyboard name +    if cwd.startswith(keyboards_path): +        if current_folder != "keyboards" and current_folder != "keymaps": +            if os.path.basename(os.path.abspath(os.path.join(cwd, ".."))) == "keymaps": +                # If in a keymap folder, set relative path, get everything before /keymaps, and the keymap name +                relative_path = cwd[len(keyboards_path):][1:] +                keyboard = str(relative_path).split("/keymaps", 1)[0] +                keymap = str(relative_path.rsplit("/", 1)[-1]) +            else: +                keyboard = str(cwd[len(keyboards_path):])[1:] + +            in_keyboard = True + +    # If in layouts dir +    if cwd.startswith(layouts_path): +        if current_folder != "layouts": +            in_layout = True + +    # If user keyboard/keymap or compile keyboard/keymap are supplied, assign those +    if cli.config.compile.keyboard: +        user_keyboard = cli.config.compile.keyboard +    if cli.config.compile.keymap and not in_layout: +        user_keymap = cli.config.compile.keymap +      if cli.args.filename:          # Parse the configurator json          user_keymap = parse_configurator_json(cli.args.filename) @@ -41,12 +82,40 @@ def compile(cli):          cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap']) -    elif cli.config.compile.keyboard and cli.config.compile.keymap: +    elif user_keyboard and user_keymap:          # Generate the make command for a specific keyboard/keymap. -        command = create_make_command(cli.config.compile.keyboard, cli.config.compile.keymap) +        command = create_make_command(user_keyboard, user_keymap) + +    elif in_keyboard: +        keyboard = user_keyboard if user_keyboard else keyboard +        keymap = user_keymap if user_keymap else keymap + +        if not os.path.exists(os.path.join(keyboards_path, keyboard, "rules.mk")): +            cli.log.error('This directory does not contain a rules.mk file. Change directory or supply --keyboard with optional --keymap') +            return False + +        # Get path for keyboard directory +        keymap_path = qmk.path.keymap(keyboard) + +        # Check for global keymap config first +        if keymap: +            command = create_make_command(keyboard, keymap) + +        else: +            # If no default keymap exists and none provided +            cli.log.error('This directory does not contain a keymap. Set one with `qmk config` or supply `--keymap` ') +            return False + +    elif in_layout: +        if user_keyboard: +            keymap = current_folder +            command = create_make_command(user_keyboard, keymap) +        else: +            cli.log.error('You must supply a keyboard to compile a layout keymap. Set one with `qmk config` or supply `--keyboard` ') +            return False      else: -        cli.log.error('You must supply a configurator export or both `--keyboard` and `--keymap`.') +        cli.log.error('You must supply a configurator export, both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.')          return False      cli.log.info('Compiling keymap with {fg_cyan}%s\n\n', ' '.join(command)) | 
