locker98/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Replace list_keyboards.sh with CLI calls (#19485)

Browse Source
This commit is contained in:
Joel Challis 2023-01-03 03:15:29 +00:00 committed by GitHub
parent 44800f119d
commit c345278101
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Makefile
View File

@ -153,7 +153,7 @@ define PARSE_RULE
$$(eval $$(call PARSE_TEST)) $$(eval $$(call PARSE_TEST))
# If the rule starts with the name of a known keyboard, then continue # If the rule starts with the name of a known keyboard, then continue
# the parsing from PARSE_KEYBOARD # the parsing from PARSE_KEYBOARD
else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell util/list_keyboards.sh | sort -u)),true) else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(shell $(QMK_BIN) list-keyboards --no-resolve-defaults)),true)
KEYBOARD_RULE=$$(MATCHED_ITEM) KEYBOARD_RULE=$$(MATCHED_ITEM)
$$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM))) $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
else else
@ -246,7 +246,7 @@ endef
# if we are going to compile all keyboards, match the rest of the rule # if we are going to compile all keyboards, match the rest of the rule
# for each of them # for each of them
define PARSE_ALL_KEYBOARDS define PARSE_ALL_KEYBOARDS
$$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell util/list_keyboards.sh | sort -u))) $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(shell $(QMK_BIN) list-keyboards --no-resolve-defaults)))
endef endef
# Prints a list of all known keymaps for the given keyboard # Prints a list of all known keymaps for the given keyboard
@ -443,11 +443,11 @@ git-submodules: git-submodule
.PHONY: list-keyboards .PHONY: list-keyboards
list-keyboards: list-keyboards:
util/list_keyboards.sh | sort -u | tr '\n' ' ' $(QMK_BIN) list-keyboards --no-resolve-defaults | tr '\n' ' '
.PHONY: generate-keyboards-file .PHONY: generate-keyboards-file
generate-keyboards-file: generate-keyboards-file:
util/list_keyboards.sh | sort -u $(QMK_BIN) list-keyboards --no-resolve-defaults
.PHONY: clean .PHONY: clean
clean: clean:

3
lib/python/qmk/cli/list/keyboards.py
View File

@ -5,9 +5,10 @@ from milc import cli
import qmk.keyboard import qmk.keyboard
@cli.argument('--no-resolve-defaults', arg_only=True, action='store_false', help='Ignore any "DEFAULT_FOLDER" within keyboards rules.mk')
@cli.subcommand("List the keyboards currently defined within QMK") @cli.subcommand("List the keyboards currently defined within QMK")
def list_keyboards(cli): def list_keyboards(cli):
"""List the keyboards currently defined within QMK """List the keyboards currently defined within QMK
""" """
for keyboard_name in qmk.keyboard.list_keyboards(): for keyboard_name in qmk.keyboard.list_keyboards(cli.args.no_resolve_defaults):
print(keyboard_name) print(keyboard_name)

10
lib/python/qmk/keyboard.py
View File

@ -98,14 +98,18 @@ def keyboard_completer(prefix, action, parser, parsed_args):
return list_keyboards() return list_keyboards()
def list_keyboards(): def list_keyboards(resolve_defaults=True):
"""Returns a list of all keyboards. """Returns a list of all keyboards - optionally processing any DEFAULT_FOLDER.
""" """
# We avoid pathlib here because this is performance critical code. # We avoid pathlib here because this is performance critical code.
kb_wildcard = os.path.join(base_path, "**", "rules.mk") kb_wildcard = os.path.join(base_path, "**", "rules.mk")
paths = [path for path in glob(kb_wildcard, recursive=True) if os.path.sep + 'keymaps' + os.path.sep not in path] paths = [path for path in glob(kb_wildcard, recursive=True) if os.path.sep + 'keymaps' + os.path.sep not in path]
return sorted(set(map(resolve_keyboard, map(_find_name, paths)))) found = map(_find_name, paths)
if resolve_defaults:
found = map(resolve_keyboard, found)
return sorted(set(found))
def resolve_keyboard(keyboard): def resolve_keyboard(keyboard):

6
util/list_keyboards.sh
View File

@ -1,6 +0,0 @@
#!/bin/sh
# Temporary shell script to find keyboards
#
# This allows us to include DEFAULT_FOLDER targets.
find -L keyboards -type f -name rules.mk | grep -v keymaps | sed 's!keyboards/\(.*\)/rules.mk!\1!'