mirror of
https://github.com/qmk/qmk_firmware
synced 2024-11-11 22:44:56 +00:00
d569f08771
* Rework how bin/qmk handles subcommands * qmk config wip * Code to show all configs * Fully working `qmk config` command * Mark some CLI arguments so they don't pollute the config file * Fleshed out config support, nicer subcommand support * sync with installable cli * pyformat * Add a test for subcommand_modules * Documentation for the `qmk config` command * split config_token on space so qmk config is more predictable * Rework how subcommands are imported * Document `arg_only` * Document deleting from CLI * Document how multiple operations work * Add cli config to the doc index * Add tests for the cli commands * Make running the tests more reliable * Be more selective about building all default keymaps * Update new-keymap to fit the new subcommand style * Add documentation about writing CLI scripts * Document new-keyboard * Update docs/cli_configuration.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update docs/cli_development.md Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Address yan's comments. * Apply suggestions from code review suggestions from @noahfrederick Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Apply suggestions from code review Co-Authored-By: Noah Frederick <code@noahfrederick.com> * Remove pip3 from the test runner
53 lines
2.1 KiB
Python
Executable file
53 lines
2.1 KiB
Python
Executable file
"""Compile a QMK Firmware.
|
|
|
|
You can compile a keymap already in the repo or using a QMK Configurator export.
|
|
"""
|
|
import json
|
|
import os
|
|
import sys
|
|
import subprocess
|
|
from argparse import FileType
|
|
|
|
from milc import cli
|
|
|
|
import qmk.keymap
|
|
import qmk.path
|
|
|
|
|
|
@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.subcommand('Compile a QMK Firmware.')
|
|
def compile(cli):
|
|
"""Compile a QMK Firmware.
|
|
|
|
If a Configurator export is supplied this command will create a new keymap, overwriting an existing keymap if one exists.
|
|
|
|
FIXME(skullydazed): add code to check and warn if the keymap already exists
|
|
|
|
If --keyboard and --keymap are provided this command will build a firmware based on that.
|
|
|
|
"""
|
|
if cli.args.filename:
|
|
# Parse the configurator json
|
|
user_keymap = json.load(cli.args.filename)
|
|
|
|
# Generate the keymap
|
|
keymap_path = qmk.path.keymap(user_keymap['keyboard'])
|
|
cli.log.info('Creating {fg_cyan}%s{style_reset_all} keymap in {fg_cyan}%s', user_keymap['keymap'], keymap_path)
|
|
qmk.keymap.write(user_keymap['keyboard'], user_keymap['keymap'], user_keymap['layout'], user_keymap['layers'])
|
|
cli.log.info('Wrote keymap to {fg_cyan}%s/%s/keymap.c', keymap_path, user_keymap['keymap'])
|
|
|
|
# Compile the keymap
|
|
command = ['make', ':'.join((user_keymap['keyboard'], user_keymap['keymap']))]
|
|
|
|
elif cli.config.compile.keyboard and cli.config.compile.keymap:
|
|
# Generate the make command for a specific keyboard/keymap.
|
|
command = ['make', ':'.join((cli.config.compile.keyboard, cli.config.compile.keymap))]
|
|
|
|
else:
|
|
cli.log.error('You must supply a configurator export or both `--keyboard` and `--keymap`.')
|
|
return False
|
|
|
|
cli.log.info('Compiling keymap with {fg_cyan}%s\n\n', ' '.join(command))
|
|
subprocess.run(command)
|