Add zephyr version pinning support

Signed-off-by: paulober <44974737+paulober@users.noreply.github.com>

Author: paulober

package.json

@@ -302,17 +302,24 @@
         "raspberry-pi-pico.cmakeAutoConfigure": {
           "type": "boolean",
           "default": true,
-          "markdownDescription": "Automatically run configure when opening a Pico project"
+          "description": "Automatically run configure when opening a Pico project"
         },
         "raspberry-pi-pico.useCmakeTools": {
           "type": "boolean",
           "default": false,
-          "markdownDescription": "Use the CMake Tools extension for CMake configuration, instead of this extension"
+          "description": "Use the CMake Tools extension for CMake configuration, instead of this extension"
         },
         "raspberry-pi-pico.githubToken": {
           "type": "string",
           "default": "",
           "markdownDescription": "A GitHub personal access token (classic) with the `public_repo` scope. Used to check GitHub for available versions of the Pico SDK and other tools."
+        },
+        "raspberry-pi-pico.zephyrVersion": {
+          "type": "string",
+          "default": "",
+          "pattern": "^(?:main|v?\\d+\\.\\d+\\.\\d+(?:-rc\\d+)?)?$",
+          "scope": "resource",
+          "description": "Pin a Zephyr version (e.g. v4.2.0 or 4.2.0) for you project. Leave empty to always use the current system version."
         }
       }
     },

src/commands/switchSDK.mts

@@ -44,6 +44,7 @@ import { SDK_REPOSITORY_URL } from "../utils/sharedConstants.mjs";
 import State from "../state.mjs";
 import { compare, compareGe } from "../utils/semverUtil.mjs";
 import { updateZephyrVersion } from "../utils/setupZephyr.mjs";
+import Settings, { SettingsKey } from "../settings.mjs";
 
 const DEFAULT_PICOTOOL_VERSION = "2.2.0-a4";
 
@@ -441,6 +442,21 @@ export default class SwitchSDKCommand extends Command {
     const result = await updateZephyrVersion(selectedVersion.label);
     if (result) {
       this._ui.updateSDKVersion(selectedVersion.label.replace("v", ""));
+
+      const pinVersion = await window.showInformationMessage(
+        "Do you want to pin this Zephyr version for the current project?",
+        { modal: true },
+        "Yes",
+        "No"
+      );
+      if (pinVersion === "Yes") {
+        const settings = Settings.getInstance();
+        await settings?.update(
+          SettingsKey.zephyrVersion,
+          selectedVersion.label
+        );
+      }
+
       // for reload the window
       void commands.executeCommand("workbench.action.reloadWindow");
     } else {

src/extension.mts

@@ -113,7 +113,8 @@ import {
   getZephyrVersion,
   setupZephyr,
   updateZephyrCompilerPath,
-  zephyrVerifyCMakCache,
+  updateZephyrVersion,
+  zephyrVerifyCMakeCache,
 } from "./utils/setupZephyr.mjs";
 import { IMPORT_PROJECT } from "./commands/cmdIds.mjs";
 import {
@@ -400,6 +401,77 @@ export async function activate(context: ExtensionContext): Promise<void> {
         ninjaVersion = version;
       }
 
+      // check for pinned zephyr version in workspace settings
+      const pinnedVersion = settings.getString(SettingsKey.zephyrVersion);
+      if (pinnedVersion !== undefined && pinnedVersion.length > 0) {
+        const systemVersion = await getZephyrVersion();
+        if (systemVersion === undefined) {
+          Logger.error(
+            LoggerSource.extension,
+            "Failed to get system Zephyr version."
+          );
+          void window.showErrorMessage(
+            "Failed to get system Zephyr version. Cannot setup Zephyr project."
+          );
+          // TODO: instead reset zephyr workspace
+          await commands.executeCommand(
+            "setContext",
+            ContextKeys.isPicoProject,
+            false
+          );
+
+          return;
+        }
+
+        if (systemVersion !== pinnedVersion) {
+          // ask user to switch zephyr version
+          const switchVersion = await window.showInformationMessage(
+            `Project Zephyr version (${pinnedVersion}) differs from system ` +
+              `version (${systemVersion}). ` +
+              `Do you want to switch the system version?`,
+            { modal: true },
+            "Yes",
+            "No - Use system version",
+            "No - Pin to system version"
+          );
+
+          if (switchVersion === "Yes") {
+            const switchResult = await updateZephyrVersion(pinnedVersion);
+            if (!switchResult) {
+              void window.showErrorMessage(
+                `Failed to switch Zephyr version to ${pinnedVersion}. ` +
+                  "Cannot setup Zephyr project."
+              );
+              await commands.executeCommand(
+                "setContext",
+                ContextKeys.isPicoProject,
+                false
+              );
+
+              return;
+            } else {
+              void window.showInformationMessage(
+                `Switched Zephyr version to ${pinnedVersion}.`
+              );
+              Logger.info(
+                LoggerSource.extension,
+                `Switched Zephyr version to ${pinnedVersion}.`
+              );
+            }
+          } else if (switchVersion === "No - Pin to system version") {
+            // update workspace settings
+            await settings.update(SettingsKey.zephyrVersion, systemVersion);
+            void window.showInformationMessage(
+              `Pinned Zephyr version to ${systemVersion}.`
+            );
+            Logger.info(
+              LoggerSource.extension,
+              `Pinned Zephyr version to ${systemVersion}.`
+            );
+          }
+        }
+      }
+
       const result = await setupZephyr({
         extUri: context.extensionUri,
         cmakeMode: cmakeVersion !== "" ? 2 : 3,
@@ -463,8 +535,6 @@ export async function activate(context: ExtensionContext): Promise<void> {
         // TODO: maybe cancel activation
       }
 
-      await zephyrVerifyCMakCache(workspaceFolder.uri);
-
       // Update the board info if it can be found in tasks.json
       const tasksJsonFilePath = join(
         workspaceFolder.uri.fsPath,
@@ -489,6 +559,8 @@ export async function activate(context: ExtensionContext): Promise<void> {
         }
       }
 
+      await zephyrVerifyCMakeCache(workspaceFolder.uri);
+
       if (settings.getBoolean(SettingsKey.cmakeAutoConfigure)) {
         await cmakeSetupAutoConfigure(workspaceFolder, ui);
       } else {

src/settings.mts

@@ -13,6 +13,7 @@ export enum SettingsKey {
   cmakeAutoConfigure = "cmakeAutoConfigure",
   githubToken = "githubToken",
   useCmakeTools = "useCmakeTools",
+  zephyrVersion = "zephyrVersion",
 }
 
 /**

src/utils/setupZephyr.mts

@@ -1262,6 +1262,10 @@ export async function setupZephyr(
           message: "Failed",
           increment: 100,
         });
+        void window.showErrorMessage(
+          "Failed to install Zephyr SDK. Cannot continue Zephyr setup. " +
+            "See extension host output for more details."
+        );
 
         return false;
       }
@@ -1558,7 +1562,11 @@ export async function updateZephyrCompilerPath(
   }
 }
 
-export async function zephyrVerifyCMakCache(
+/**
+ * Checks if the current CMakeCache is using the current zephyr version.
+ * If not the build folder will be deleted.
+ */
+export async function zephyrVerifyCMakeCache(
   workspaceUri: Uri,
   zephyrVersion?: string
 ): Promise<void> {
@@ -1599,7 +1607,6 @@ export async function zephyrVerifyCMakCache(
     // drop build folder
     const buildDir = Uri.joinPath(workspaceUri, "build");
     try {
-      await workspace.fs.stat(buildDir);
       await workspace.fs.delete(buildDir, { recursive: true, useTrash: false });
       Logger.info(
         LoggerSource.zephyrSetup,
@@ -1608,16 +1615,6 @@ export async function zephyrVerifyCMakCache(
       void window.showInformationMessage(
         "Deleted build folder to clear old Zephyr CMake cache."
       );
-
-      if (await configureCmakeNinja(workspaceUri)) {
-        void window.showInformationMessage(
-          "Reconfigured CMake and Ninja for Zephyr project."
-        );
-      } else {
-        void window.showErrorMessage(
-          "Failed to reconfigure CMake and Ninja for Zephyr project."
-        );
-      }
     } catch {
       // does not exist
     }

src/utils/westConfig.mts

@@ -6,6 +6,7 @@ import { homedir } from "os";
 export interface ManifestSection {
   path?: string;
   file?: string;
+  ["project-filter"]?: string;
 }
 
 export interface ZephyrSection {
@@ -41,6 +42,29 @@ function parentUri(uri: Uri): Uri {
   return uri.with({ path });
 }
 
+/** Escape a string to be used as a literal regex */
+function escapeRegexLiteral(s: string): string {
+  return s.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+
+/** Split a project-filter string into normalized elements */
+function splitProjectFilter(value?: string): string[] {
+  if (!value) {
+    return [];
+  }
+
+  return value
+    .split(",")
+    .map(e => e.trim())
+    .filter(Boolean);
+}
+
+/** Keep only non-zephyr filter elements (so we can rebuild zephyr rules) */
+function keepNonZephyrFilters(elements: string[]): string[] {
+  // Remove any rule that targets zephyr-* (e.g., +zephyr-foo, -zephyr-.*)
+  return elements.filter(e => !/^[+-]\s*zephyr-/.test(e));
+}
+
 /** Read a text file, return undefined if not found */
 async function readTextFile(uri: Uri): Promise<string | undefined> {
   try {
@@ -78,6 +102,9 @@ export async function saveWestConfig(
   configUri: Uri,
   config: WestConfig
 ): Promise<void> {
+  if (config.zephyr === undefined || Object.keys(config.zephyr).length === 0) {
+    throw new Error("zephyr section is required");
+  }
   const text = ini.stringify(config, { whitespace: true });
   await writeTextFile(configUri, text);
 }
@@ -89,13 +116,67 @@ export async function getZephyrBase(): Promise<string | undefined> {
   return cfg.zephyr?.base;
 }
 
+/** Set `[manifest] project-filter` directly */
+export async function setManifestProjectFilter(value: string): Promise<void> {
+  const cfg = await loadWestConfig(WEST_CONFIG_URI);
+  if (!cfg.manifest) {
+    cfg.manifest = {};
+  }
+  cfg.manifest["project-filter"] = value;
+  await saveWestConfig(WEST_CONFIG_URI, cfg);
+}
+
+/** Get `[manifest] project-filter` */
+export async function getManifestProjectFilter(): Promise<string | undefined> {
+  const cfg = await loadWestConfig(WEST_CONFIG_URI);
+
+  return cfg.manifest?.["project-filter"];
+}
+
+/**
+ * Update `[manifest] project-filter` so that:
+ *  - all `zephyr-*` projects are deactivated, except the active one
+ *  - any non-zephyr rules are preserved
+ */
+function updateProjectFilterForZephyrBase(
+  cfg: WestConfig,
+  activeZephyrProjectName: string
+): void {
+  if (!cfg.manifest) {
+    cfg.manifest = {};
+  }
+
+  const current = cfg.manifest["project-filter"];
+  const existing = splitProjectFilter(current);
+  const kept = keepNonZephyrFilters(existing);
+
+  const escaped = escapeRegexLiteral(activeZephyrProjectName);
+
+  // Order matters; last rule wins.
+  // Deactivate all zephyr-* first, then explicitly re-activate the chosen one.
+  const rebuilt = [...kept, "-zephyr-.*", `+${escaped}`];
+
+  // dedupe while preserving order
+  const final = Array.from(new Set(rebuilt));
+
+  cfg.manifest["project-filter"] = final.join(",");
+}
+
 /** Set `[zephyr] base` */
-export async function updateZephyrBase(newBase: string): Promise<void> {
+export async function updateZephyrBase(
+  newBase: string,
+  updateProjectFilter: boolean = true
+): Promise<void> {
   const cfg = await loadWestConfig(WEST_CONFIG_URI);
   if (!cfg.zephyr) {
     cfg.zephyr = {};
   }
   cfg.zephyr.base = newBase;
+
+  if (updateProjectFilter) {
+    updateProjectFilterForZephyrBase(cfg, newBase);
+  }
+
   await saveWestConfig(WEST_CONFIG_URI, cfg);
 }