Force users to select the Pico kit when using the CMake Tools Extension Integration

This pops us the kit selection dialog, and a notification saying to select the Pico kit, and then throws an error and prompts the user to try again if they selected the wrong kit.

I think this is the closest we can get to actually specifying the kit in the CMake Tools extension

Author: will-v-pi

scripts/pico_project.py

@@ -1126,6 +1126,7 @@ def generateProjectFiles(
 
             # settings
             settings = f'''{{
+    "cmake.showSystemKits": false,
     "cmake.options.statusBarVisibility": "hidden",
     "cmake.options.advanced": {{
         "build": {{

src/commands/compileProject.mts

@@ -3,7 +3,7 @@ import { EventEmitter } from "events";
 import { CommandWithResult } from "./command.mjs";
 import Logger from "../logger.mjs";
 import Settings, { SettingsKey } from "../settings.mjs";
-
+import { cmakeToolsForcePicoKit } from "../utils/cmakeToolsUtil.mjs";
 export default class CompileProjectCommand extends CommandWithResult<boolean> {
   private _logger: Logger = new Logger("CompileProjectCommand");
 
@@ -24,6 +24,9 @@ export default class CompileProjectCommand extends CommandWithResult<boolean> {
       settings !== undefined &&
       settings.getBoolean(SettingsKey.useCmakeTools)
     ) {
+      // Ensure the Pico kit is selected
+      await cmakeToolsForcePicoKit();
+
       // Compile with CMake Tools
       await commands.executeCommand("cmake.launchTargetPath");
 

src/commands/launchTargetPath.mts

@@ -3,6 +3,7 @@ import { CommandWithResult } from "./command.mjs";
 import { commands, window, workspace } from "vscode";
 import { join } from "path";
 import Settings, { SettingsKey } from "../settings.mjs";
+import { cmakeToolsForcePicoKit } from "../utils/cmakeToolsUtil.mjs";
 
 export default class LaunchTargetPathCommand extends CommandWithResult<string> {
   constructor() {
@@ -66,6 +67,9 @@ export default class LaunchTargetPathCommand extends CommandWithResult<string> {
       settings !== undefined &&
       settings.getBoolean(SettingsKey.useCmakeTools)
     ) {
+      // Ensure the Pico kit is selected
+      await cmakeToolsForcePicoKit();
+
       // Compile with CMake Tools
       const path: string = await commands.executeCommand(
         "cmake.launchTargetPath"

src/extension.mts

@@ -82,7 +82,7 @@ import FlashProjectSWDCommand from "./commands/flashProjectSwd.mjs";
 import { NewMicroPythonProjectPanel } from "./webview/newMicroPythonProjectPanel.mjs";
 import type { Progress as GotProgress } from "got";
 import findPython, { showPythonNotFoundError } from "./utils/pythonHelper.mjs";
-
+import { cmakeToolsForcePicoKit } from "./utils/cmakeToolsUtil.mjs";
 export async function activate(context: ExtensionContext): Promise<void> {
   Logger.info(LoggerSource.extension, "Extension activation triggered");
 
@@ -811,6 +811,9 @@ export async function activate(context: ExtensionContext): Promise<void> {
         );
       }
     });
+  } else if (settings.getBoolean(SettingsKey.useCmakeTools)) {
+    // Ensure the Pico kit is selected
+    await cmakeToolsForcePicoKit();
   } else {
     Logger.info(
       LoggerSource.extension,

src/utils/cmakeToolsUtil.mts

@@ -0,0 +1,47 @@
+import { commands, window, ProgressLocation } from "vscode";
+
+
+export async function cmakeToolsForcePicoKit(): Promise<void> {
+  let cmakeToolsKit = await commands.executeCommand(
+    "cmake.buildKit"
+  );
+  if (cmakeToolsKit === "Pico") {
+    return;
+  }
+
+  await window.withProgress({
+    location: ProgressLocation.Notification,
+    title: "Select the Pico kit in the dialog at the top of the window",
+    cancellable: false,
+  }, async progress => {
+    let i = 0;
+    while (cmakeToolsKit !== "Pico") {
+      if (i >= 2) {
+        const result = await window.showErrorMessage(
+          "You did not select the Pico kit - " +
+          "you must select the Pico kit in the dialog, " +
+          "else this extension will not work",
+          "Try again",
+          "Cancel"
+        );
+
+        if (result === "Try again") {
+          i = 0;
+          continue;
+        }
+
+        progress.report({increment: 100});
+
+        return;
+      }
+      await commands.executeCommand("cmake.selectKit");
+      cmakeToolsKit = await commands.executeCommand(
+        "cmake.buildKit"
+      );
+      i++;
+    }
+    progress.report({increment: 100});
+
+    return;
+  });
+}