fix: Don't clone lvgl and Studio messages

Updated the west project filter to exclude lvgl and zmk-studio-messages,
since they aren't needed for discovering keyboards.

West commands now check the project filter and update it as necessary.
This required reworking West to be run in a subprocess, because the
command to read the value of a config property terminates the current
script if the property isn't set.

Author: joelspadin

zmk/repo.py

@@ -4,6 +4,7 @@
 
 import shutil
 import subprocess
+import sys
 from collections.abc import Generator
 from contextlib import redirect_stdout
 from io import StringIO
@@ -23,6 +24,13 @@
 _WEST_STAGING_PATH = ".zmk"
 _WEST_CONFIG_PATH = ".west/config"
 
+# Don't clone projects from ZMK's manifest that aren't needed for discovering keyboards
+_PROJECT_BLOCKLIST = [
+    "lvgl",
+    "zephyr",
+    "zmk-studio-messages",
+]
+
 
 def is_repo(path: Path) -> bool:
     """Get whether a path is a ZMK config repo."""
@@ -186,7 +194,9 @@ def ensure_west_ready(self) -> None:
         self._update_west_manifest()
 
         config_path = self.path / _WEST_STAGING_PATH / _WEST_CONFIG_PATH
-        if not config_path.exists():
+        if config_path.exists():
+            self._update_project_filter()
+        else:
             self._init_west_app()
 
         self._west_ready = True
@@ -201,14 +211,15 @@ def _run_west(self, *args: str, capture_output: Literal[True]) -> str: ...
     def _run_west(self, *args: str, capture_output: bool) -> str | None: ...
 
     def _run_west(self, *args: str, capture_output=False):
+        command = [sys.executable, "-m", "west", *args]
+
         if capture_output:
-            with redirect_stdout(StringIO()) as output:
-                self.run_west(*args, capture_output=False)
-                return output.getvalue()
+            return subprocess.check_output(
+                command, cwd=self.west_path, text=True, stderr=subprocess.STDOUT
+            )
 
-        with set_directory(self.west_path):
-            west_main(args)
-            return None
+        subprocess.check_call(command, cwd=self.west_path)
+        return None
 
     def _update_gitignore(self):
         gitignore = self.path / ".gitignore"
@@ -249,18 +260,23 @@ def _init_west_app(self):
         print("Initializing west application. This may take a while...")
         self._run_west("init", "-l", _CONFIG_DIR_NAME)
 
-        # Don't clone zephyr, because it's not necessary to discover keyboards.
-        self._run_west("config", "--local", "manifest.project-filter", " -zephyr")
-
+        self._update_project_filter()
         self._run_west("update")
 
+    def _get_project_filter(self):
+        try:
+            return self._run_west(
+                "config", "--local", "manifest.project-filter", capture_output=True
+            ).strip()
+        except subprocess.CalledProcessError:
+            return ""
 
-def _run_west(path: Path, args: list[str], capture_output=False):
-    if capture_output:
-        with redirect_stdout(StringIO()) as output:
-            _run_west(path, args, capture_output=False)
-            return output.getvalue()
+    def _update_project_filter(self):
+        current_filter = self._get_project_filter()
 
-    with set_directory(path):
-        west_main(args)
-        return None
+        new_filter = ",".join("-" + project for project in _PROJECT_BLOCKLIST)
+
+        if current_filter != new_filter:
+            self._run_west(
+                "config", "--local", "manifest.project-filter", "--", new_filter
+            )