From c345278101b3882a2f33b078021ab31a6129120a Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Tue, 3 Jan 2023 03:15:29 +0000 Subject: [PATCH] Replace list_keyboards.sh with CLI calls (#19485) --- Makefile | 8 ++++---- lib/python/qmk/cli/list/keyboards.py | 3 ++- lib/python/qmk/keyboard.py | 10 +++++++--- util/list_keyboards.sh | 6 ------ 4 files changed, 13 insertions(+), 14 deletions(-) delete mode 100755 util/list_keyboards.sh diff --git a/Makefile b/Makefile index 8f7ad39b833..e10816aa78e 100644 --- a/Makefile +++ b/Makefile @@ -153,7 +153,7 @@ define PARSE_RULE $$(eval $$(call PARSE_TEST)) # If the rule starts with the name of a known keyboard, then continue # 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) $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM))) else @@ -246,7 +246,7 @@ endef # if we are going to compile all keyboards, match the rest of the rule # for each of them 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 # Prints a list of all known keymaps for the given keyboard @@ -443,11 +443,11 @@ git-submodules: git-submodule .PHONY: 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 generate-keyboards-file: - util/list_keyboards.sh | sort -u + $(QMK_BIN) list-keyboards --no-resolve-defaults .PHONY: clean clean: diff --git a/lib/python/qmk/cli/list/keyboards.py b/lib/python/qmk/cli/list/keyboards.py index 8b6c4516733..405b9210e4c 100644 --- a/lib/python/qmk/cli/list/keyboards.py +++ b/lib/python/qmk/cli/list/keyboards.py @@ -5,9 +5,10 @@ from milc import cli 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") def list_keyboards(cli): """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) diff --git a/lib/python/qmk/keyboard.py b/lib/python/qmk/keyboard.py index 6ddbba8fa57..0c980faf2b8 100644 --- a/lib/python/qmk/keyboard.py +++ b/lib/python/qmk/keyboard.py @@ -98,14 +98,18 @@ def keyboard_completer(prefix, action, parser, parsed_args): return list_keyboards() -def list_keyboards(): - """Returns a list of all keyboards. +def list_keyboards(resolve_defaults=True): + """Returns a list of all keyboards - optionally processing any DEFAULT_FOLDER. """ # We avoid pathlib here because this is performance critical code. 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] - 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): diff --git a/util/list_keyboards.sh b/util/list_keyboards.sh deleted file mode 100755 index 0d1dae888f2..00000000000 --- a/util/list_keyboards.sh +++ /dev/null @@ -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!'