poz/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Align 'qmk lint' argument handling (#23297)

Browse source
This commit is contained in:
Joel Challis 2024-05-01 02:52:34 +01:00 committed by GitHub
parent 7b9a1ac4be
commit 54c1ae55bf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 17 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
lib/python/qmk/cli/lint.py
View file

@ -6,9 +6,9 @@ from milc import cli
from qmk.decorators import automagic_keyboard, automagic_keymap from qmk.decorators import automagic_keyboard, automagic_keymap
from qmk.info import info_json from qmk.info import info_json
from qmk.keyboard import keyboard_completer, list_keyboards from qmk.keyboard import keyboard_completer, keyboard_folder_or_all, is_all_keyboards, list_keyboards
from qmk.keymap import locate_keymap, list_keymaps from qmk.keymap import locate_keymap, list_keymaps
from qmk.path import is_keyboard, keyboard from qmk.path import keyboard
from qmk.git import git_get_ignored_files from qmk.git import git_get_ignored_files
from qmk.c_parse import c_source_files from qmk.c_parse import c_source_files
@ -198,39 +198,34 @@ def keyboard_check(kb):
@cli.argument('--strict', action='store_true', help='Treat warnings as errors') @cli.argument('--strict', action='store_true', help='Treat warnings as errors')
@cli.argument('-kb', '--keyboard', completer=keyboard_completer, help='Comma separated list of keyboards to check') @cli.argument('-kb', '--keyboard', action='append', type=keyboard_folder_or_all, completer=keyboard_completer, help='Keyboard to check. May be passed multiple times.')
@cli.argument('-km', '--keymap', help='The keymap to check') @cli.argument('-km', '--keymap', help='The keymap to check')
@cli.argument('--all-kb', action='store_true', arg_only=True, help='Check all keyboards')
@cli.argument('--all-km', action='store_true', arg_only=True, help='Check all keymaps')
@cli.subcommand('Check keyboard and keymap for common mistakes.') @cli.subcommand('Check keyboard and keymap for common mistakes.')
@automagic_keyboard @automagic_keyboard
@automagic_keymap @automagic_keymap
def lint(cli): def lint(cli):
"""Check keyboard and keymap for common mistakes. """Check keyboard and keymap for common mistakes.
""" """
failed = []
# Determine our keyboard list # Determine our keyboard list
if cli.args.all_kb: if not cli.config.lint.keyboard:
if cli.args.keyboard: cli.log.error('Missing required arguments: --keyboard')
cli.log.warning('Both --all-kb and --keyboard passed, --all-kb takes precedence.')
keyboard_list = list_keyboards()
elif not cli.config.lint.keyboard:
cli.log.error('Missing required arguments: --keyboard or --all-kb')
cli.print_help() cli.print_help()
return False return False
if isinstance(cli.config.lint.keyboard, str):
# if provided via config - string not array
keyboard_list = [cli.config.lint.keyboard]
elif is_all_keyboards(cli.args.keyboard[0]):
keyboard_list = list_keyboards()
else: else:
keyboard_list = cli.config.lint.keyboard.split(',') keyboard_list = cli.config.lint.keyboard
failed = []
# Lint each keyboard # Lint each keyboard
for kb in keyboard_list: for kb in keyboard_list:
if not is_keyboard(kb):
cli.log.error('No such keyboard: %s', kb)
continue
# Determine keymaps to also check # Determine keymaps to also check
if cli.args.all_km: if cli.args.keymap == 'all':
keymaps = list_keymaps(kb) keymaps = list_keymaps(kb)
elif cli.config.lint.keymap: elif cli.config.lint.keymap:
keymaps = {cli.config.lint.keymap} keymaps = {cli.config.lint.keymap}

2
lib/python/qmk/keyboard.py
View file

@ -99,6 +99,8 @@ def find_keyboard_from_dir():
keymap_index = len(current_path.parts) - current_path.parts.index('keymaps') - 1 keymap_index = len(current_path.parts) - current_path.parts.index('keymaps') - 1
current_path = current_path.parents[keymap_index] current_path = current_path.parents[keymap_index]
current_path = resolve_keyboard(current_path)
if qmk.path.is_keyboard(current_path): if qmk.path.is_keyboard(current_path):
return str(current_path) return str(current_path)