qmk_firmware

commit: e27dd0f26faa3cbe787e539b2435450fffa3709a
parent 6624671a603c783e60719792ab02c890966d1b6c
Author: Joel Challis <git@zvecr.com>
Date:   Fri, 11 Apr 2025 13:19:02 +0100

Exclude external userspace from lint checking (#24680)


Diffstat:
M
lib/python/qmk/cli/lint.py
2
+-
M
lib/python/qmk/keymap.py
11
++++++++---

2 files changed, 9 insertions(+), 4 deletions(-)
diff --git a/lib/python/qmk/cli/lint.py b/lib/python/qmk/cli/lint.py
@@ -26,7 +26,7 @@ def _list_defaultish_keymaps(kb):
     defaultish.extend(INVALID_KM_NAMES)
 
     keymaps = set()
-    for x in list_keymaps(kb):
+    for x in list_keymaps(kb, include_userspace=False):
         if x in defaultish or x.startswith('default'):
             keymaps.add(x)
 
diff --git a/lib/python/qmk/keymap.py b/lib/python/qmk/keymap.py
@@ -399,7 +399,7 @@ def is_keymap_target(keyboard, keymap):
     return False
 
 
-def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=False):
+def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=False, include_userspace=True):
     """List the available keymaps for a keyboard.
 
     Args:
@@ -418,14 +418,19 @@ def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=Fa
         fullpath
             When set to True the full path of the keymap relative to the `qmk_firmware` root will be provided.
 
+        include_userspace
+            When set to True, also search userspace for available keymaps
+
     Returns:
         a sorted list of valid keymap names.
     """
     names = set()
 
+    has_userspace = HAS_QMK_USERSPACE and include_userspace
+
     # walk up the directory tree until keyboards_dir
     # and collect all directories' name with keymap.c file in it
-    for search_dir in [QMK_FIRMWARE, QMK_USERSPACE] if HAS_QMK_USERSPACE else [QMK_FIRMWARE]:
+    for search_dir in [QMK_FIRMWARE, QMK_USERSPACE] if has_userspace else [QMK_FIRMWARE]:
         keyboards_dir = search_dir / Path('keyboards')
         kb_path = keyboards_dir / keyboard
 
@@ -443,7 +448,7 @@ def list_keymaps(keyboard, c=True, json=True, additional_files=None, fullpath=Fa
     info = info_json(keyboard)
 
     community_parents = list(Path('layouts').glob('*/'))
-    if HAS_QMK_USERSPACE and (Path(QMK_USERSPACE) / "layouts").exists():
+    if has_userspace and (Path(QMK_USERSPACE) / "layouts").exists():
         community_parents.append(Path(QMK_USERSPACE) / "layouts")
 
     for community_parent in community_parents: