summaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli
diff options
context:
space:
mode:
authorDrashna Jael're <drashna@live.com>2022-03-25 16:19:22 -0700
committerDrashna Jael're <drashna@live.com>2022-03-25 16:19:22 -0700
commit53ff570bf068e04740f187163774327839dfa68b (patch)
tree5429e069fc593d484b0b479de422b51ac239be83 /lib/python/qmk/cli
parente8171efc7158ba4ebb24827680b19b775d366b1a (diff)
parentefc9c525b19b33c6e09057218ea64f07f45f9555 (diff)
Remerge 0.16.x' into firmware21
Diffstat (limited to 'lib/python/qmk/cli')
-rw-r--r--lib/python/qmk/cli/__init__.py1
-rwxr-xr-xlib/python/qmk/cli/cd.py3
-rw-r--r--lib/python/qmk/cli/doctor/check.py12
-rwxr-xr-xlib/python/qmk/cli/doctor/main.py8
-rwxr-xr-xlib/python/qmk/cli/generate/config_h.py60
-rwxr-xr-xlib/python/qmk/cli/generate/develop_pr_list.py15
-rw-r--r--lib/python/qmk/cli/generate/dfu_header.py18
-rw-r--r--lib/python/qmk/cli/generate/docs.py16
-rwxr-xr-xlib/python/qmk/cli/generate/keyboard_h.py18
-rwxr-xr-xlib/python/qmk/cli/generate/layouts.py37
-rwxr-xr-xlib/python/qmk/cli/generate/rules_mk.py16
-rw-r--r--lib/python/qmk/cli/generate/version_h.py39
-rwxr-xr-xlib/python/qmk/cli/json2c.py13
-rwxr-xr-xlib/python/qmk/cli/multibuild.py3
-rw-r--r--lib/python/qmk/cli/new/keyboard.py286
-rwxr-xr-xlib/python/qmk/cli/via2json.py145
16 files changed, 466 insertions, 224 deletions
diff --git a/lib/python/qmk/cli/__init__.py b/lib/python/qmk/cli/__init__.py
index c51eece955..5f65e677e5 100644
--- a/lib/python/qmk/cli/__init__.py
+++ b/lib/python/qmk/cli/__init__.py
@@ -69,6 +69,7 @@ subcommands = [
'qmk.cli.new.keymap',
'qmk.cli.pyformat',
'qmk.cli.pytest',
+ 'qmk.cli.via2json',
]
diff --git a/lib/python/qmk/cli/cd.py b/lib/python/qmk/cli/cd.py
index c62c3f56c6..ef03011f1f 100755
--- a/lib/python/qmk/cli/cd.py
+++ b/lib/python/qmk/cli/cd.py
@@ -2,6 +2,7 @@
"""
import sys
import os
+import subprocess
from milc import cli
@@ -41,6 +42,6 @@ def cd(cli):
# Set the prompt for the new shell
qmk_env['MSYS2_PS1'] = qmk_env['PS1']
# Start the new subshell
- cli.run([os.environ.get('SHELL', '/usr/bin/bash')], env=qmk_env)
+ subprocess.run([os.environ.get('SHELL', '/usr/bin/bash')], env=qmk_env)
else:
cli.log.info("Already within qmk_firmware directory.")
diff --git a/lib/python/qmk/cli/doctor/check.py b/lib/python/qmk/cli/doctor/check.py
index 2d691b64b0..8a0422ba72 100644
--- a/lib/python/qmk/cli/doctor/check.py
+++ b/lib/python/qmk/cli/doctor/check.py
@@ -7,7 +7,6 @@ from subprocess import DEVNULL
from milc import cli
from qmk import submodules
-from qmk.constants import QMK_FIRMWARE
class CheckStatus(Enum):
@@ -150,14 +149,3 @@ def is_executable(command):
cli.log.error("{fg_red}Can't run `%s %s`", command, version_arg)
return False
-
-
-def check_git_repo():
- """Checks that the .git directory exists inside QMK_HOME.
-
- This is a decent enough indicator that the qmk_firmware directory is a
- proper Git repository, rather than a .zip download from GitHub.
- """
- dot_git = QMK_FIRMWARE / '.git'
-
- return CheckStatus.OK if dot_git.exists() else CheckStatus.WARNING
diff --git a/lib/python/qmk/cli/doctor/main.py b/lib/python/qmk/cli/doctor/main.py
index ed20f46d3f..2898a9894c 100755
--- a/lib/python/qmk/cli/doctor/main.py
+++ b/lib/python/qmk/cli/doctor/main.py
@@ -11,7 +11,8 @@ from milc.questions import yesno
from qmk import submodules
from qmk.constants import QMK_FIRMWARE, QMK_FIRMWARE_UPSTREAM
from .check import CheckStatus, check_binaries, check_binary_versions, check_submodules
-from qmk.commands import git_check_repo, git_get_branch, git_is_dirty, git_get_remotes, git_check_deviation, in_virtualenv
+from qmk.git import git_check_repo, git_get_branch, git_get_tag, git_is_dirty, git_get_remotes, git_check_deviation
+from qmk.commands import in_virtualenv
def os_tests():
@@ -47,6 +48,11 @@ def git_tests():
git_branch = git_get_branch()
if git_branch:
cli.log.info('Git branch: %s', git_branch)
+
+ repo_version = git_get_tag()
+ if repo_version:
+ cli.log.info('Repo version: %s', repo_version)
+
git_dirty = git_is_dirty()
if git_dirty:
cli.log.warning('{fg_yellow}Git has unstashed/uncommitted changes.')
diff --git a/lib/python/qmk/cli/generate/config_h.py b/lib/python/qmk/cli/generate/config_h.py
index f16dca1de8..fdc76b23d4 100755
--- a/lib/python/qmk/cli/generate/config_h.py
+++ b/lib/python/qmk/cli/generate/config_h.py
@@ -9,7 +9,9 @@ from qmk.info import info_json
from qmk.json_schema import json_load, validate
from qmk.keyboard import keyboard_completer, keyboard_folder
from qmk.keymap import locate_keymap
+from qmk.commands import dump_lines
from qmk.path import normpath
+from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
def direct_pins(direct_pins, postfix):
@@ -21,18 +23,7 @@ def direct_pins(direct_pins, postfix):
cols = ','.join(map(str, [col or 'NO_PIN' for col in row]))
rows.append('{' + cols + '}')
- col_count = len(direct_pins[0])
- row_count = len(direct_pins)
-
return f"""
-#ifndef MATRIX_COLS{postfix}
-# define MATRIX_COLS{postfix} {col_count}
-#endif // MATRIX_COLS{postfix}
-
-#ifndef MATRIX_ROWS{postfix}
-# define MATRIX_ROWS{postfix} {row_count}
-#endif // MATRIX_ROWS{postfix}
-
#ifndef DIRECT_PINS{postfix}
# define DIRECT_PINS{postfix} {{ {", ".join(rows)} }}
#endif // DIRECT_PINS{postfix}
@@ -42,14 +33,9 @@ def direct_pins(direct_pins, postfix):
def pin_array(define, pins, postfix):
"""Return the config.h lines that set a pin array.
"""
- pin_num = len(pins)
pin_array = ', '.join(map(str, [pin or 'NO_PIN' for pin in pins]))
return f"""
-#ifndef {define}S{postfix}
-# define {define}S{postfix} {pin_num}
-#endif // {define}S{postfix}
-
#ifndef {define}_PINS{postfix}
# define {define}_PINS{postfix} {{ {pin_array} }}
#endif // {define}_PINS{postfix}
@@ -73,6 +59,24 @@ def matrix_pins(matrix_pins, postfix=''):
return '\n'.join(pins)
+def generate_matrix_size(kb_info_json, config_h_lines):
+ """Add the matrix size to the config.h.
+ """
+ if 'matrix_pins' in kb_info_json:
+ col_count = kb_info_json['matrix_size']['cols']
+ row_count = kb_info_json['matrix_size']['rows']
+
+ config_h_lines.append(f"""
+#ifndef MATRIX_COLS
+# define MATRIX_COLS {col_count}
+#endif // MATRIX_COLS
+
+#ifndef MATRIX_ROWS
+# define MATRIX_ROWS {row_count}
+#endif // MATRIX_ROWS
+""")
+
+
def generate_config_items(kb_info_json, config_h_lines):
"""Iterate through the info_config map to generate basic config values.
"""
@@ -108,6 +112,12 @@ def generate_config_items(kb_info_json, config_h_lines):
config_h_lines.append(f'#ifndef {key}')
config_h_lines.append(f'# define {key} {value}')
config_h_lines.append(f'#endif // {key}')
+ elif key_type == 'bcd_version':
+ (major, minor, revision) = config_value.split('.')
+ config_h_lines.append('')
+ config_h_lines.append(f'#ifndef {config_key}')
+ config_h_lines.append(f'# define {config_key} 0x{major.zfill(2)}{minor}{revision}')
+ config_h_lines.append(f'#endif // {config_key}')
else:
config_h_lines.append('')
config_h_lines.append(f'#ifndef {config_key}')
@@ -173,10 +183,12 @@ def generate_config_h(cli):
kb_info_json = dotty(info_json(cli.args.keyboard))
# Build the info_config.h file.
- config_h_lines = ['/* This file was generated by `qmk generate-config-h`. Do not edit or copy.', ' */', '', '#pragma once']
+ config_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
generate_config_items(kb_info_json, config_h_lines)
+ generate_matrix_size(kb_info_json, config_h_lines)
+
if 'matrix_pins' in kb_info_json:
config_h_lines.append(matrix_pins(kb_info_json['matrix_pins']))
@@ -184,16 +196,4 @@ def generate_config_h(cli):
generate_split_config(kb_info_json, config_h_lines)
# Show the results
- config_h = '\n'.join(config_h_lines)
-
- if cli.args.output:
- cli.args.output.parent.mkdir(parents=True, exist_ok=True)
- if cli.args.output.exists():
- cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
- cli.args.output.write_text(config_h)
-
- if not cli.args.quiet:
- cli.log.info('Wrote info_config.h to %s.', cli.args.output)
-
- else:
- print(config_h)
+ dump_lines(cli.args.output, config_h_lines, cli.args.quiet)
diff --git a/lib/python/qmk/cli/generate/develop_pr_list.py b/lib/python/qmk/cli/generate/develop_pr_list.py
index 07e46752a6..549db5b185 100755
--- a/lib/python/qmk/cli/generate/develop_pr_list.py
+++ b/lib/python/qmk/cli/generate/develop_pr_list.py
@@ -12,6 +12,15 @@ fix_expr = re.compile(r'fix', flags=re.IGNORECASE)
clean1_expr = re.compile(r'\[(develop|keyboard|keymap|core|cli|bug|docs|feature)\]', flags=re.IGNORECASE)
clean2_expr = re.compile(r'^(develop|keyboard|keymap|core|cli|bug|docs|feature):', flags=re.IGNORECASE)
+ignored_titles = ["Format code according to conventions"]
+
+
+def _is_ignored(title):
+ for ignore in ignored_titles:
+ if ignore in title:
+ return True
+ return False
+
def _get_pr_info(cache, gh, pr_num):
pull = cache.get(f'pull:{pr_num}')
@@ -81,7 +90,9 @@ def generate_develop_pr_list(cli):
else:
normal_collection.append(info)
- if "dependencies" in commit_info['pr_labels']:
+ if _is_ignored(commit_info['title']):
+ return
+ elif "dependencies" in commit_info['pr_labels']:
fix_or_normal(commit_info, pr_list_bugs, pr_list_dependencies)
elif "core" in commit_info['pr_labels']:
fix_or_normal(commit_info, pr_list_bugs, pr_list_core)
@@ -97,7 +108,7 @@ def generate_develop_pr_list(cli):
match = git_expr.search(line)
if match:
pr_info = _get_pr_info(cache, gh, match.group("pr"))
- commit_info = {'hash': match.group("hash"), 'title': match.group("title"), 'pr_num': int(match.group("pr")), 'pr_labels': [label.name for label in pr_info.labels.items]}
+ commit_info = {'hash': match.group("hash"), 'title': pr_info['title'], 'pr_num': int(match.group("pr")), 'pr_labels': [label.name for label in pr_info.labels.items]}
_categorise_commit(commit_info)
def _dump_commit_list(name, collection):
diff --git a/lib/python/qmk/cli/generate/dfu_header.py b/lib/python/qmk/cli/generate/dfu_header.py
index 7fb585fc7d..e873117387 100644
--- a/lib/python/qmk/cli/generate/dfu_header.py
+++ b/lib/python/qmk/cli/generate/dfu_header.py
@@ -7,6 +7,8 @@ from qmk.decorators import automagic_keyboard
from qmk.info import info_json
from qmk.path import is_keyboard, normpath
from qmk.keyboard import keyboard_completer
+from qmk.commands import dump_lines
+from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
@@ -30,7 +32,7 @@ def generate_dfu_header(cli):
# Build the Keyboard.h file.
kb_info_json = dotty(info_json(cli.config.generate_dfu_header.keyboard))
- keyboard_h_lines = ['/* This file was generated by `qmk generate-dfu-header`. Do not edit or copy.', ' */', '', '#pragma once']
+ keyboard_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
keyboard_h_lines.append(f'#define MANUFACTURER {kb_info_json["manufacturer"]}')
keyboard_h_lines.append(f'#define PRODUCT {kb_info_json["keyboard_name"]} Bootloader')
@@ -45,16 +47,4 @@ def generate_dfu_header(cli):
keyboard_h_lines.append(f'#define QMK_SPEAKER {kb_info_json["qmk_lufa_bootloader.speaker"]}')
# Show the results
- keyboard_h = '\n'.join(keyboard_h_lines)
-
- if cli.args.output:
- cli.args.output.parent.mkdir(parents=True, exist_ok=True)
- if cli.args.output.exists():
- cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
- cli.args.output.write_text(keyboard_h)
-
- if not cli.args.quiet:
- cli.log.info('Wrote Keyboard.h to %s.', cli.args.output)
-
- else:
- print(keyboard_h)
+ dump_lines(cli.args.output, keyboard_h_lines, cli.args.quiet)
diff --git a/lib/python/qmk/cli/generate/docs.py b/lib/python/qmk/cli/generate/docs.py
index 749336fea5..74112d834d 100644
--- a/lib/python/qmk/cli/generate/docs.py
+++ b/lib/python/qmk/cli/generate/docs.py
@@ -7,7 +7,9 @@ from subprocess import DEVNULL
from milc import cli
DOCS_PATH = Path('docs/')
-BUILD_PATH = Path('.build/docs/')
+BUILD_PATH = Path('.build/')
+BUILD_DOCS_PATH = BUILD_PATH / 'docs'
+DOXYGEN_PATH = BUILD_PATH / 'doxygen'
@cli.subcommand('Build QMK documentation.', hidden=False if cli.config.user.developer else True)
@@ -18,10 +20,12 @@ def generate_docs(cli):
* [ ] Add a real build step... something static docs
"""
- if BUILD_PATH.exists():
- shutil.rmtree(BUILD_PATH)
+ if BUILD_DOCS_PATH.exists():
+ shutil.rmtree(BUILD_DOCS_PATH)
+ if DOXYGEN_PATH.exists():
+ shutil.rmtree(DOXYGEN_PATH)
- shutil.copytree(DOCS_PATH, BUILD_PATH)
+ shutil.copytree(DOCS_PATH, BUILD_DOCS_PATH)
# When not verbose we want to hide all output
args = {
@@ -34,6 +38,6 @@ def generate_docs(cli):
# Generate internal docs
cli.run(['doxygen', 'Doxyfile'], **args)
- cli.run(['moxygen', '-q', '-a', '-g', '-o', BUILD_PATH / 'internals_%s.md', 'doxygen/xml'], **args)
+ cli.run(['moxygen', '-q', '-g', '-o', BUILD_DOCS_PATH / 'internals_%s.md', DOXYGEN_PATH / 'xml'], **args)
- cli.log.info('Successfully generated internal docs to %s.', BUILD_PATH)
+ cli.log.info('Successfully generated internal docs to %s.', BUILD_DOCS_PATH)
diff --git a/lib/python/qmk/cli/generate/keyboard_h.py b/lib/python/qmk/cli/generate/keyboard_h.py
index f05178cede..2058865cbf 100755
--- a/lib/python/qmk/cli/generate/keyboard_h.py
+++ b/lib/python/qmk/cli/generate/keyboard_h.py
@@ -3,8 +3,10 @@
from milc import cli
from qmk.info import info_json
+from qmk.commands import dump_lines
from qmk.keyboard import keyboard_completer, keyboard_folder
from qmk.path import normpath
+from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
def would_populate_layout_h(keyboard):
@@ -36,22 +38,10 @@ def generate_keyboard_h(cli):
has_layout_h = would_populate_layout_h(cli.args.keyboard)
# Build the layouts.h file.
- keyboard_h_lines = ['/* This file was generated by `qmk generate-keyboard-h`. Do not edit or copy.', ' */', '', '#pragma once', '#include "quantum.h"']
+ keyboard_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once', '#include "quantum.h"']
if not has_layout_h:
keyboard_h_lines.append('#pragma error("<keyboard>.h is only optional for data driven keyboards - kb.h == bad times")')
# Show the results
- keyboard_h = '\n'.join(keyboard_h_lines) + '\n'
-
- if cli.args.output:
- cli.args.output.parent.mkdir(parents=True, exist_ok=True)
- if cli.args.output.exists():
- cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
- cli.args.output.write_text(keyboard_h)
-
- if not cli.args.quiet:
- cli.log.info('Wrote keyboard_h to %s.', cli.args.output)
-
- else:
- print(keyboard_h)
+ dump_lines(cli.args.output, keyboard_h_lines, cli.args.quiet)
diff --git a/lib/python/qmk/cli/generate/layouts.py b/lib/python/qmk/cli/generate/layouts.py
index e44266e1c8..193633baf6 100755
--- a/lib/python/qmk/cli/generate/layouts.py
+++ b/lib/python/qmk/cli/generate/layouts.py
@@ -2,11 +2,12 @@
"""
from milc import cli
-from qmk.constants import COL_LETTERS, ROW_LETTERS
+from qmk.constants import COL_LETTERS, ROW_LETTERS, GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
from qmk.decorators import automagic_keyboard, automagic_keymap
from qmk.info import info_json
from qmk.keyboard import keyboard_completer, keyboard_folder
from qmk.path import is_keyboard, normpath
+from qmk.commands import dump_lines
usb_properties = {
'vid': 'VENDOR_ID',
@@ -38,18 +39,14 @@ def generate_layouts(cli):
kb_info_json = info_json(cli.config.generate_layouts.keyboard)
# Build the layouts.h file.
- layouts_h_lines = ['/* This file was generated by `qmk generate-layouts`. Do not edit or copy.', ' */', '', '#pragma once']
-
- if 'matrix_pins' in kb_info_json:
- if 'direct' in kb_info_json['matrix_pins']:
- col_num = len(kb_info_json['matrix_pins']['direct'][0])
- row_num = len(kb_info_json['matrix_pins']['direct'])
- elif 'cols' in kb_info_json['matrix_pins'] and 'rows' in kb_info_json['matrix_pins']:
- col_num = len(kb_info_json['matrix_pins']['cols'])
- row_num = len(kb_info_json['matrix_pins']['rows'])
- else:
- cli.log.error('%s: Invalid matrix config.', cli.config.generate_layouts.keyboard)
- return False
+ layouts_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
+
+ if 'matrix_size' not in kb_info_json:
+ cli.log.error('%s: Invalid matrix config.', cli.config.generate_layouts.keyboard)
+ return False
+
+ col_num = kb_info_json['matrix_size']['cols']
+ row_num = kb_info_json['matrix_size']['rows']
for layout_name in kb_info_json['layouts']:
if kb_info_json['layouts'][layout_name]['c_macro']:
@@ -90,16 +87,4 @@ def generate_layouts(cli):
layouts_h_lines.append('#endif')
# Show the results
- layouts_h = '\n'.join(layouts_h_lines) + '\n'
-
- if cli.args.output:
- cli.args.output.parent.mkdir(parents=True, exist_ok=True)
- if cli.args.output.exists():
- cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
- cli.args.output.write_text(layouts_h)
-
- if not cli.args.quiet:
- cli.log.info('Wrote info_config.h to %s.', cli.args.output)
-
- else:
- print(layouts_h)
+ dump_lines(cli.args.output, layouts_h_lines, cli.args.quiet)
diff --git a/lib/python/qmk/cli/generate/rules_mk.py b/lib/python/qmk/cli/generate/rules_mk.py
index 5d8d7cc8a7..29a1130f99 100755
--- a/lib/python/qmk/cli/generate/rules_mk.py
+++ b/lib/python/qmk/cli/generate/rules_mk.py
@@ -9,7 +9,9 @@ from qmk.info import info_json
from qmk.json_schema import json_load, validate
from qmk.keyboard import keyboard_completer, keyboard_folder
from qmk.keymap import locate_keymap
+from qmk.commands import dump_lines
from qmk.path import normpath
+from qmk.constants import GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE
def process_mapping_rule(kb_info_json, rules_key, info_dict):
@@ -29,7 +31,7 @@ def process_mapping_rule(kb_info_json, rules_key, info_dict):
if key_type in ['array', 'list']:
return f'{rules_key} ?= {" ".join(rules_value)}'
elif key_type == 'bool':
- return f'{rules_key} ?= {"on" if rules_value else "off"}'
+ return f'{rules_key} ?= {"yes" if rules_value else "no"}'
elif key_type == 'mapping':
return '\n'.join([f'{key} ?= {value}' for key, value in rules_value.items()])
@@ -55,7 +57,7 @@ def generate_rules_mk(cli):
kb_info_json = dotty(info_json(cli.args.keyboard))
info_rules_map = json_load(Path('data/mappings/info_rules.json'))
- rules_mk_lines = ['# This file was generated by `qmk generate-rules-mk`. Do not edit or copy.', '']
+ rules_mk_lines = [GPL2_HEADER_SH_LIKE, GENERATED_HEADER_SH_LIKE]
# Iterate through the info_rules map to generate basic rules
for rules_key, info_dict in info_rules_map.items():
@@ -83,14 +85,9 @@ def generate_rules_mk(cli):
rules_mk_lines.append('CUSTOM_MATRIX ?= yes')
# Show the results
- rules_mk = '\n'.join(rules_mk_lines) + '\n'
+ dump_lines(cli.args.output, rules_mk_lines)
if cli.args.output:
- cli.args.output.parent.mkdir(parents=True, exist_ok=True)
- if cli.args.output.exists():
- cli.args.output.replace(cli.args.output.parent / (cli.args.output.name + '.bak'))
- cli.args.output.write_text(rules_mk)
-
if cli.args.quiet:
if cli.args.escape:
print(cli.args.output.as_posix().replace(' ', '\\ '))
@@ -98,6 +95,3 @@ def generate_rules_mk(cli):
print(cli.args.output)
else:
cli.log.info('Wrote rules.mk to %s.', cli.args.output)
-
- else:
- print(rules_mk)
diff --git a/lib/python/qmk/cli/generate/version_h.py b/lib/python/qmk/cli/generate/version_h.py
index b8e52588c4..a75702c529 100644
--- a/lib/python/qmk/cli/generate/version_h.py
+++ b/lib/python/qmk/cli/generate/version_h.py
@@ -1,9 +1,15 @@
"""Used by the make system to generate version.h for use in code.
"""
+from time import strftime
+
from milc import cli
-from qmk.commands import create_version_h
from qmk.path import normpath
+from qmk.commands import dump_lines
+from qmk.git import git_get_version
+from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
+
+TIME_FMT = '%Y-%m-%d-%H:%M:%S'
@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
@@ -17,12 +23,29 @@ def generate_version_h(cli):
if cli.args.skip_all:
cli.args.skip_git = True
- version_h = create_version_h(cli.args.skip_git, cli.args.skip_all)
-
- if cli.args.output:
- cli.args.output.write_text(version_h)
+ if cli.args.skip_all:
+ current_time = "1970-01-01-00:00:00"
+ else:
+ current_time = strftime(TIME_FMT)
- if not cli.args.quiet:
- cli.log.info('Wrote version.h to %s.', cli.args.output)
+ if cli.args.skip_git:
+ git_version = "NA"
+ chibios_version = "NA"
+ chibios_contrib_version = "NA"
else:
- print(version_h)
+ git_version = git_get_version() or current_time
+ chibios_version = git_get_version("chibios", "os") or current_time
+ chibios_contrib_version = git_get_version("chibios-contrib", "os") or current_time
+
+ # Build the version.h file.
+ version_h_lines = [GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, '#pragma once']
+
+ version_h_lines.append(f"""
+#define QMK_VERSION "{git_version}"
+#define QMK_BUILDDATE "{current_time}"
+#define CHIBIOS_VERSION "{chibios_version}"
+#define CHIBIOS_CONTRIB_VERSION "{chibios_contrib_version}"
+""")
+
+ # Show the results
+ dump_lines(cli.args.output, version_h_lines, cli.args.quiet)
diff --git a/lib/python/qmk/cli/json2c.py b/lib/python/qmk/cli/json2c.py
index ae8248e6b7..2873a9bfd3 100755
--- a/lib/python/qmk/cli/json2c.py
+++ b/lib/python/qmk/cli/json2c.py
@@ -1,12 +1,11 @@
"""Generate a keymap.c from a configurator export.
"""
-import json
-
from argcomplete.completers import FilesCompleter
from milc import cli
import qmk.keymap
import qmk.path
+from qmk.commands import parse_configurator_json
@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
@@ -19,14 +18,8 @@ def json2c(cli):
This command uses the `qmk.keymap` module to generate a keymap.c from a configurator export. The generated keymap is written to stdout, or to a file if -o is provided.
"""
- try:
- # Parse the configurator from json file (or stdin)
- user_keymap = json.load(cli.args.filename)
-
- except json.decoder.JSONDecodeError as ex:
- cli.log.error('The JSON input does not appear to be valid.')
- cli.log.error(ex)
- return False
+ # Parse the configurator from json file (or stdin)
+ user_keymap = parse_configurator_json(cli.args.filename)
# Environment processing
if cli.args.output and cli.args.output.name == '-':
diff --git a/lib/python/qmk/cli/multibuild.py b/lib/python/qmk/cli/multibuild.py
index 85ed0fa1e9..dff8c88422 100755
--- a/lib/python/qmk/cli/multibuild.py
+++ b/lib/python/qmk/cli/multibuild.py
@@ -32,6 +32,7 @@ def _is_split(keyboard_name):
@cli.argument('-c', '--clean', arg_only=True, action='store_true', help="Remove object files before compiling.")
@cli.argument('-f', '--filter', arg_only=True, action='append', default=[], help="Filter the list of keyboards based on the supplied value in rules.mk. Supported format is 'SPLIT_KEYBOARD=yes'. May be passed multiple times.")
@cli.argument('-km', '--keymap', type=str, default='default', help="The keymap name to build. Default is 'default'.")
+@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.subcommand('Compile QMK Firmware for all keyboards.', hidden=False if cli.config.user.developer else True)
def multibuild(cli):
"""Compile QMK Firmware against all keyboards.
@@ -68,7 +69,7 @@ def multibuild(cli):
all: {keyboard_safe}_binary
{keyboard_safe}_binary:
@rm -f "{QMK_FIRMWARE}/.build/failed.log.{keyboard_safe}" || true
- +@$(MAKE) -C "{QMK_FIRMWARE}" -f "{QMK_FIRMWARE}/build_keyboard.mk" KEYBOARD="{keyboard_name}" KEYMAP="{cli.args.keymap}" REQUIRE_PLATFORM_KEY= COLOR=true SILENT=false \\
+ +@$(MAKE) -C "{QMK_FIRMWARE}" -f "{QMK_FIRMWARE}/builddefs/build_keyboard.mk" KEYBOARD="{keyboard_name}" KEYMAP="{cli.args.keymap}" REQUIRE_PLATFORM_KEY= COLOR=true SILENT=false {' '.join(cli.args.env)} \\
>>"{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}" 2>&1 \\
|| cp "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}" "{QMK_FIRMWARE}/.build/failed.log.{os.getpid()}.{keyboard_safe}"
@{{ grep '\[ERRORS\]' "{QMK_FIRMWARE}/.build/build.log.{os.getpid()}.{keyboard_safe}" >/dev/null 2>&1 && printf "Build %-64s \e[1;31m[ERRORS]\e[0m\\n" "{keyboard_name}:{cli.args.keymap}" ; }} \\
diff --git a/lib/python/qmk/cli/new/keyboard.py b/lib/python/qmk/cli/new/keyboard.py
index 4093b8c90d..1cdfe53206 100644
--- a/lib/python/qmk/cli/new/keyboard.py
+++ b/lib/python/qmk/cli/new/keyboard.py
@@ -1,15 +1,45 @@
"""This script automates the creation of new keyboard directories using a starter template.
"""
+import re
+import json
+import shutil
from datetime import date
from pathlib import Path
-import re
+from dotty_dict import dotty
-from qmk.commands import git_get_username
-import qmk.path
from milc import cli
from milc.questions import choice, question
-KEYBOARD_TYPES = ['avr', 'ps2avrgb']
+from qmk.git import git_get_username
+from qmk.json_schema import load_jsonschema
+from qmk.path import keyboard
+from qmk.json_encoders import InfoJSONEncoder
+from qmk.json_schema import deep_update
+from qmk.constants import MCU2BOOTLOADER
+
+COMMUNITY = Path('layouts/default/')
+TEMPLATE = Path('data/templates/keyboard/')
+
+# defaults
+schema = dotty(load_jsonschema('keyboard'))
+mcu_types = sorted(schema["properties.processor.enum"], key=str.casefold)
+available_layouts = sorted([x.name for x in COMMUNITY.iterdir() if x.is_dir()])
+
+
+def mcu_type(mcu):
+ """Callable for argparse validation.
+ """
+ if mcu not in mcu_types:
+ raise ValueError
+ return mcu
+
+
+def layout_type(layout):
+ """Callable for argparse validation.
+ """
+ if layout not in available_layouts:
+ raise ValueError
+ return layout
def keyboard_name(name):
@@ -27,113 +57,193 @@ def validate_keyboard_name(name):
return bool(regex.match(name))
-@cli.argument('-kb', '--keyboard', help='Specify the name for the new keyboard directory', arg_only=True, type=keyboard_name)
-@cli.argument('-t', '--type', help='Specify the keyboard type', arg_only=True, choices=KEYBOARD_TYPES)
-@cli.argument('-u', '--username', help='Specify your username (default from Git config)', arg_only=True)
-@cli.argument('-n', '--realname', help='Specify your real name if you want to use that. Defaults to username', arg_only=True)
-@cli.subcommand('Creates a new keyboard directory')
-def new_keyboard(cli):
- """Creates a new keyboard.
+def select_default_bootloader(mcu):
+ """Provide sane defaults for bootloader
"""
- cli.log.info('{style_bright}Generating a new QMK keyboard directory{style_normal}')
- cli.echo('')
+ return MCU2BOOTLOADER.get(mcu, "custom")
+
- # Get keyboard name
- new_keyboard_name = None
- while not new_keyboard_name:
- new_keyboard_name = cli.args.keyboard if cli.args.keyboard else question('Keyboard Name:')
- if not validate_keyboard_name(new_keyboard_name):
- cli.log.error('Keyboard names must contain only {fg_cyan}lowercase a-z{fg_reset}, {fg_cyan}0-9{fg_reset}, and {fg_cyan}_{fg_reset}! Please choose a different name.')
+def replace_placeholders(src, dest, tokens):
+ """Replaces the given placeholders in each template file.
+ """
+ content = src.read_text()
+ for key, value in tokens.items():
+ content = content.replace(f'%{key}%', value)
- # Exit if passed by arg
- if cli.args.keyboard:
- return False
+ dest.write_text(content)
- new_keyboard_name = None
- continue
- keyboard_path = qmk.path.keyboard(new_keyboard_name)
- if keyboard_path.exists():
- cli.log.error(f'Keyboard {{fg_cyan}}{new_keyboard_name}{{fg_reset}} already exists! Please choose a different name.')
+def augment_community_info(src, dest):
+ """Splice in any additional data into info.json
+ """
+ info = json.loads(src.read_text())
+ template = json.loads(dest.read_text())
- # Exit if passed by arg
- if cli.args.keyboard:
- return False
+ # merge community with template
+ deep_update(info, template)
- new_keyboard_name = None
+ # avoid assumptions on macro name by using the first available
+ first_layout = next(iter(info["layouts"].values()))["layout"]
- # Get keyboard type
- keyboard_type = cli.args.type if cli.args.type else choice('Keyboard Type:', KEYBOARD_TYPES, default=0)
+ # guess at width and height now its optional
+ width, height = (0, 0)
+ for item in first_layout:
+ width = max(width, int(item["x"]) + 1)
+ height = max(height, int(item["y"]) + 1)
- # Get username
- user_name = None
- while not user_name:
- user_name = question('Your GitHub User Name:', default=find_user_name())
+ info["matrix_pins"] = {
+ "cols": ["C2"] * width,
+ "rows": ["D1"] * height,
+ }
- if not user_name:
- cli.log.error('You didn\'t provide a username, and we couldn\'t find one set in your QMK or Git configs. Please try again.')
+ # assume a 1:1 mapping on matrix to electrical
+ for item in first_layout:
+ item["matrix"] = [int(item["y"]), int(item["x"])]
- # Exit if passed by arg
- if cli.args.username:
- return False
+ # finally write out the updated info.json
+ dest.write_text(json.dumps(info, cls=InfoJSONEncoder))
- real_name = None
- while not real_name:
- real_name = question('Your real name:', default=user_name)
- keyboard_basename = keyboard_path.name
- replacements = {
- "YEAR": str(date.today().year),
- "KEYBOARD": keyboard_basename,
- "USER_NAME": user_name,
- "YOUR_NAME": real_name,
- }
+def _question(*args, **kwargs):
+ """Ugly workaround until 'milc' learns to display a repromt msg
+ """
+ # TODO: Remove this once milc.questions.question handles reprompt messages
- template_dir = Path('data/templates')
- template_tree(template_dir / 'base', keyboard_path, replacements)
- template_tree(template_dir / keyboard_type, keyboard_path, replacements)
+ reprompt = kwargs["reprompt"]
+ del kwargs["reprompt"]
+ validate = kwargs["validate"]
+ del kwargs["validate"]
- cli.echo('')
- cli.log.info(f'{{fg_green}}Created a new keyboard called {{fg_cyan}}{new_keyboard_name}{{fg_green}}.{{fg_reset}}')
- cli.log.info(f'To start working on things, `cd` into {{fg_cyan}}{keyboard_path}{{fg_reset}},')
- cli.log.info('or open the directory in your preferred text editor.')
+ prompt = args[0]
+ ret = None
+ while not ret:
+ ret = question(prompt, **kwargs)
+ if not validate(ret):
+ ret = None
+ prompt = reprompt
+ return ret
-def find_user_name():
- if cli.args.username:
- return cli.args.username
- elif cli.config.user.name:
- return cli.config.user.name
- else:
- return git_get_username()
+def prompt_keyboard():
+ prompt = """{fg_yellow}Name Your Keyboard Project{style_reset_all}
+For more infomation, see:
+https://docs.qmk.fm/#/hardware_keyboard_guidelines?id=naming-your-keyboardproject
-def template_tree(src: Path, dst: Path, replacements: dict):
- """Recursively copy template and replace placeholders
+Keyboard Name? """
- Args:
- src (Path)
- The source folder to copy from
- dst (Path)
- The destination folder to copy to
- replacements (dict)
- a dictionary with "key":"value" pairs to replace.
+ errmsg = 'Keyboard already exists! Please choose a different name:'
- Raises:
- FileExistsError
- When trying to overwrite existing files
+ return _question(prompt, reprompt=errmsg, validate=lambda x: not keyboard(x).exists())
+
+
+def prompt_user():
+ prompt = """
+{fg_yellow}Attribution{style_reset_all}
+Used for maintainer, copyright, etc
+
+Your GitHub Username? """
+ return question(prompt, default=git_get_username())
+
+
+def prompt_name(def_name):
+ prompt = """
+{fg_yellow}More Attribution{style_reset_all}
+Used for maintainer, copyright, etc
+
+Your Real Name? """
+ return question(prompt, default=def_name)
+
+
+def prompt_layout():
+ prompt = """
+{fg_yellow}Pick Base Layout{style_reset_all}
+As a starting point, one of the common layouts can be used to bootstrap the process
+
+Default Layout? """
+ # avoid overwhelming user - remove some?
+ filtered_layouts = [x for x in available_layouts if not any(xs in x for xs in ['_split', '_blocker', '_tsangan', '_f13'])]
+ filtered_layouts.append("none of the above")
+
+ return choice(prompt, filtered_layouts, default=len(filtered_layouts) - 1)
+
+
+def prompt_mcu():
+ prompt = """
+{fg_yellow}What Powers Your Project{style_reset_all}
+For more infomation, see:
+https://docs.qmk.fm/#/compatible_microcontrollers
+
+MCU? """
+ # remove any options strictly used for compatibility
+ filtered_mcu = [x for x in mcu_types if not any(xs in x for xs in ['cortex', 'unknown'])]
+
+ return choice(prompt, filtered_mcu, default=filtered_mcu.index("atmega32u4"))
+
+
+@cli.argument('-kb', '--keyboard', help='Specify the name for the new keyboard directory', arg_only=True, type=keyboard_name)
+@cli.argument('-l', '--layout', help='Community layout to bootstrap with', arg_only=True, type=layout_type)
+@cli.argument('-t', '--type', help='Specify the keyboard MCU type', arg_only=True, type=mcu_type)
+@cli.argument('-u', '--username', help='Specify your username (default from Git config)', dest='name')
+@cli.argument('-n', '--realname', help='Specify your real name if you want to use that. Defaults to username', arg_only=True)
+@cli.subcommand('Creates a new keyboard directory')
+def new_keyboard(cli):
+ """Creates a new keyboard.
"""
+ cli.log.info('{style_bright}Generating a new QMK keyboard directory{style_normal}')
+ cli.echo('')
+
+ kb_name = cli.args.keyboard if cli.args.keyboard else prompt_keyboard()
+ user_name = cli.config.new_keyboard.name if cli.config.new_keyboard.name else prompt_user()
+ real_name = cli.args.realname or cli.config.new_keyboard.name if cli.args.realname or cli.config.new_keyboard.name else prompt_name(user_name)
+ default_layout = cli.args.layout if cli.args.layout else prompt_layout()
+ mcu = cli.args.type if cli.args.type else prompt_mcu()
+ bootloader = select_default_bootloader(mcu)
+
+ if not validate_keyboard_name(kb_name):
+ cli.log.error('Keyboard names must contain only {fg_cyan}lowercase a-z{fg_reset}, {fg_cyan}0-9{fg_reset}, and {fg_cyan}_{fg_reset}! Please choose a different name.')
+ return 1
+
+ if keyboard(kb_name).exists():
+ cli.log.error(f'Keyboard {{fg_cyan}}{kb_name}{{fg_reset}} already exists! Please choose a different name.')
+ return 1
+
+ tokens = { # Comment here is to force multiline formatting
+ 'YEAR': str(date.today().year),
+ 'KEYBOARD': kb_name,
+ 'USER_NAME': user_name,
+ 'REAL_NAME': real_name,
+ 'LAYOUT': default_layout,
+ 'MCU': mcu,
+ 'BOOTLOADER': bootloader
+ }
+
+ if cli.config.general.verbose:
+ cli.log.info("Creating keyboard with:")
+ for key, value in tokens.items():
+ cli.echo(f" {key.ljust(10)}: {value}")
- dst.mkdir(parents=True, exist_ok=True)
+ # TODO: detach community layout and rename to just "LAYOUT"
+ if default_layout == 'none of the above':
+ default_layout = "ortho_4x4"
- for child in src.iterdir():
- if child.is_dir():
- template_tree(child, dst / child.name, replacements=replacements)
+ # begin with making the deepest folder in the tree
+ keymaps_path = keyboard(kb_name) / 'keymaps/'
+ keymaps_path.mkdir(parents=True)
- if child.is_file():
- file_name = dst / (child.name % replacements)
+ # copy in keymap.c or keymap.json
+ community_keymap = Path(COMMUNITY / f'{default_layout}/default_{default_layout}/')
+ shutil.copytree(community_keymap, keymaps_path / 'default')
- with file_name.open(mode='x') as dst_f:
- with child.open() as src_f:
- template = src_f.read()
- dst_f.write(template % replacements)
+ # process template files
+ for file in list(TEMPLATE.iterdir()):
+ replace_placeholders(file, keyboard(kb_name) / file.name, tokens)
+
+ # merge in infos
+ community_info = Path(COMMUNITY / f'{default_layout}/info.json')
+ augment_community_info(community_info, keyboard(kb_name) / community_info.name)
+
+ cli.log.info(f'{{fg_green}}Created a new keyboard called {{fg_cyan}}{kb_name}{{fg_green}}.{{fg_reset}}')
+ cli.log.info(f'To start working on things, `cd` into {{fg_cyan}}keyboards/{kb_name}{{fg_reset}},')
+ cli.log.info('or open the directory in your preferred text editor.')
+ cli.log.info(f"And build with {{fg_yellow}}qmk compile -kb {kb_name} -km default{{fg_reset}}.")
diff --git a/lib/python/qmk/cli/via2json.py b/lib/python/qmk/cli/via2json.py
new file mode 100755
index 0000000000..6edc9dfbe5
--- /dev/null
+++ b/lib/python/qmk/cli/via2json.py
@@ -0,0 +1,145 @@
+"""Generate a keymap.c from a configurator export.
+"""
+import json
+import re
+
+from milc import cli
+
+import qmk.keyboard
+import qmk.path
+from qmk.info import info_json
+from qmk.json_encoders import KeymapJSONEncoder
+from qmk.commands import parse_configurator_json, dump_lines
+from qmk.keymap import generate_json, list_keymaps, locate_keymap, parse_keymap_c
+
+
+def _find_via_layout_macro(keyboard):
+ keymap_layout = None
+ if 'via' in list_keymaps(keyboard):
+ keymap_path = locate_keymap(keyboard, 'via')
+ if keymap_path.suffix == '.json':
+ keymap_layout = parse_configurator_json(keymap_path)['layout']
+ else:
+ keymap_layout = parse_keymap_c(keymap_path)['layers'][0]['layout']
+ return keymap_layout
+
+
+def _convert_macros(via_macros):
+ via_macros = list(filter(lambda f: bool(f), via_macros))
+ if len(via_macros) == 0:
+ return list()
+ split_regex = re.compile(r'(}\,)|(\,{)')
+ macros = list()
+ for via_macro in via_macros:
+ # Split VIA macro to its elements
+ macro = split_regex.split(via_macro)
+ # Remove junk elements (None, '},' and ',{')
+ macro = list(filter(lambda f: False if f in (None, '},', ',{') else True, macro))
+ macro_data = list()
+ for m in macro:
+ if '{' in m or '}' in m:
+ # Found keycode(s)
+ keycodes = m.split(',')
+ # Remove whitespaces and curly braces from around keycodes
+ keycodes = list(map(lambda s: s.strip(' {}'), keycodes))
+ # Remove the KC prefix
+ keycodes = list(map(lambda s: s.replace('KC_', ''), keycodes))
+ macro_data.append({"action": "tap", "keycodes": keycodes})
+ else:
+ # Found text
+ macro_data.append(m)
+ macros.append(macro_data)
+
+ return macros
+
+
+def _fix_macro_keys(keymap_data):
+ macro_no = re.compile(r'MACRO0?([0-9]{1,2})')
+ for i in range(0, len(keymap_data)):
+ for j in range(0, len(keymap_data[i])):
+ kc = keymap_data[i][j]
+ m = macro_no.match(kc)
+ if m:
+ keymap_data[i][j] = f'MACRO_{m.group(1)}'
+ return keymap_data
+
+
+def _via_to_keymap(via_backup, keyboard_data, keymap_layout):
+ # Check if passed LAYOUT is correct
+ layout_data = keyboard_data['layouts'].get(keymap_layout)
+ if not layout_data:
+ cli.log.error(f'LAYOUT macro {keymap_layout} is not a valid one for keyboard {cli.args.keyboard}!')
+ exit(1)
+
+ layout_data = layout_data['layout']
+ sorting_hat = list()
+ for index, data in enumerate(layout_data):
+ sorting_hat.append([index, data['matrix']])
+
+ sorting_hat.sort(key=lambda k: (k[1][0], k[1][1]))
+
+ pos = 0
+ for row_num in range(0, keyboard_data['matrix_size']['rows']):
+ for col_num in range(0, keyboard_data['matrix_size']['cols']):
+ if pos >= len(sorting_hat) or sorting_hat[pos][1][0] != row_num or sorting_hat[pos][1][1] != col_num:
+ sorting_hat.insert(pos, [None, [row_num, col_num]])
+ else:
+ sorting_hat.append([None, [row_num, col_num]])
+ pos += 1
+
+ keymap_data = list()
+ for layer in via_backup['layers']:
+ pos = 0
+ layer_data = list()
+ for key in layer:
+ if sorting_hat[pos][0] is not None:
+ layer_data.append([sorting_hat[pos][0], key])
+ pos += 1
+ layer_data.sort()
+ layer_data = [kc[1] for kc in layer_data]
+ keymap_data.append(layer_data)
+
+ return keymap_data
+
+
+@cli.argument('-o', '--output', arg_only=True, type=qmk.path.normpath, help='File to write to')
+@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
+@cli.argument('filename', type=qmk.path.FileType('r'), arg_only=True, help='VIA Backup JSON file')
+@cli.argument('-kb', '--keyboard', type=qmk.keyboard.keyboard_folder, completer=qmk.keyboard.keyboard_completer, arg_only=True, required=True, help='The keyboard\'s name')
+@cli.argument('-km', '--keymap', arg_only=True, default='via2json', help='The keymap\'s name')
+@cli.argument('-l', '--layout', arg_only=True, help='The keymap\'s layout')
+@cli.subcommand('Convert a VIA backup json to keymap.json format.')
+def via2json(cli):
+ """Convert a VIA backup json to keymap.json format.
+
+ This command uses the `qmk.keymap` module to generate a keymap.json from a VIA backup json. The generated keymap is written to stdout, or to a file if -o is provided.
+ """
+ # Find appropriate layout macro
+ keymap_layout = cli.args.layout if cli.args.layout else _find_via_layout_macro(cli.args.keyboard)
+ if not keymap_layout:
+ cli.log.error(f"Couldn't find LAYOUT macro for keyboard {cli.args.keyboard}. Please specify it with the '-l' argument.")
+ exit(1)
+
+ # Load the VIA backup json
+ with cli.args.filename.open('r') as fd:
+ via_backup = json.load(fd)
+
+ # Generate keyboard metadata
+ keyboard_data = info_json(cli.args.keyboard)
+
+ # Get keycode array
+ keymap_data = _via_to_keymap(via_backup, keyboard_data, keymap_layout)
+
+ # Convert macros
+ macro_data = list()
+ if via_backup.get('macros'):
+ macro_data = _convert_macros(via_backup['macros'])
+
+ # Replace VIA macro keys with JSON keymap ones
+ keymap_data = _fix_macro_keys(keymap_data)
+
+ # Generate the keymap.json
+ keymap_json = generate_json(cli.args.keymap, cli.args.keyboard, keymap_layout, keymap_data, macro_data)
+
+ keymap_lines = [json.dumps(keymap_json, cls=KeymapJSONEncoder)]
+ dump_lines(cli.args.output, keymap_lines, cli.args.quiet)