Add support for different Ninja setups

Author: Magpie Embedded

src/utils/setupZephyr.mts

@@ -9,6 +9,7 @@ import type { Progress as GotProgress } from "got";
 
 import {
   buildCMakePath,
+  buildNinjaPath,
   buildZephyrWorkspacePath,
   downloadAndInstallArchive,
   downloadAndInstallCmake,
@@ -50,10 +51,14 @@ interface ZephyrSetupValue {
   cmakeMode: number;
   cmakePath: string;
   cmakeVersion: string;
+  ninjaMode: number;
+  ninjaPath: string;
+  ninjaVersion: string;
 }
 
 interface ZephyrSetupOutputs {
   cmakeExecutable: string;
+  ninjaExecutable: string;
 }
 
 function _runCommand(
@@ -89,7 +94,7 @@ export async function setupZephyr(
     return;
   }
 
-  let output: ZephyrSetupOutputs = { cmakeExecutable: "" };
+  let output: ZephyrSetupOutputs = { cmakeExecutable: "", ninjaExecutable: "" };
 
   let python3Path = "";
   let isWindows = false;
@@ -214,6 +219,89 @@ export async function setupZephyr(
 
           return;
       }
+
+      switch (data.ninjaMode) {
+        case 0:
+        // eslint-disable-next-line no-fallthrough
+        case 2:
+          installedSuccessfully = false;
+          prog2LastState = 0;
+          await window.withProgress(
+            {
+              location: ProgressLocation.Notification,
+              title: "Download and install Ninja",
+              cancellable: false,
+            },
+            async progress2 => {
+              if (
+                await downloadAndInstallNinja(
+                  data.ninjaVersion,
+                  (prog: GotProgress) => {
+                    const per = prog.percent * 100;
+                    progress2.report({
+                      increment: per - prog2LastState,
+                    });
+                    prog2LastState = per;
+                  }
+                )
+              ) {
+                progress2.report({
+                  message: "Successfully downloaded and installed Ninja.",
+                  increment: 100,
+                });
+
+                installedSuccessfully = true;
+              } else {
+                installedSuccessfully = false;
+                progress2.report({
+                  message: "Failed",
+                  increment: 100,
+                });
+              }
+            }
+          );
+
+          if (!installedSuccessfully) {
+            progress.report({
+              message: "Failed",
+              increment: 100,
+            });
+            void window.showErrorMessage(
+              "Failed to download and install ninja. \
+              Make sure all requirements are met."
+            );
+
+            return;
+          } else {
+            output.ninjaExecutable = joinPosix(
+              buildNinjaPath(data.ninjaVersion),
+              "ninja"
+            );
+          }
+          break;
+        case 1:
+          output.ninjaExecutable = "ninja";
+          break;
+        case 3:
+          // normalize path returned by the os selector to posix path for the settings json
+          // and cross platform compatibility
+          output.ninjaExecutable =
+            process.platform === "win32"
+              ? joinPosix(...data.ninjaPath.split("\\"))
+              : data.ninjaPath;
+          break;
+
+        default:
+          progress.report({
+            message: "Failed",
+            increment: 100,
+          });
+          void window.showErrorMessage("Unknown ninja selection.");
+
+          return;
+      }
+
+      // Handle ninja install
       await window.withProgress(
         {
           location: ProgressLocation.Notification,
@@ -528,15 +616,10 @@ export async function setupZephyr(
 
       const customPath = [
         dirname(output.cmakeExecutable.replaceAll("\\", "/")),
+        dirname(output.ninjaExecutable.replaceAll("\\", "/")),
         joinPosix(homedir().replaceAll("\\", "/"), ".pico-sdk", "dtc", "bin"),
         joinPosix(homedir().replaceAll("\\", "/"), ".pico-sdk", "git", "cmd"),
         joinPosix(homedir().replaceAll("\\", "/"), ".pico-sdk", "gperf", "bin"),
-        joinPosix(
-          homedir().replaceAll("\\", "/"),
-          ".pico-sdk",
-          "ninja",
-          "v1.12.1"
-        ),
         joinPosix(
           homedir().replaceAll("\\", "/"),
           ".pico-sdk",

src/webview/newZephyrProjectPanel.mts

@@ -15,6 +15,7 @@ import { homedir } from "os";
 import { join as joinPosix } from "path/posix";
 import Settings from "../settings.mjs";
 import Logger from "../logger.mjs";
+import { compare } from "../utils/semverUtil.mjs";
 import type { WebviewMessage } from "./newProjectPanel.mjs";
 import {
   getNonce,
@@ -28,7 +29,7 @@ import { PythonExtension } from "@vscode/python-extension";
 import { unknownErrorToString } from "../utils/errorHelper.mjs";
 import { buildZephyrWorkspacePath } from "../utils/download.mjs";
 import { setupZephyr, type ZephyrSetupOutputs } from "../utils/setupZephyr.mjs";
-import { getCmakeReleases } from "../utils/githubREST.mjs";
+import { getCmakeReleases, getNinjaReleases } from "../utils/githubREST.mjs";
 
 enum BoardType {
   pico = "pico",
@@ -49,6 +50,9 @@ interface SubmitMessageValue {
   wifiFeature: boolean;
   sensorFeature: boolean;
   shellFeature: boolean;
+  ninjaMode: number;
+  ninjaPath: string;
+  ninjaVersion: string;
   cmakeMode: number;
   cmakePath: string;
   cmakeVersion: string;
@@ -139,7 +143,8 @@ export class NewZephyrProjectPanel {
   // CMake, Ninja, Python, etc
   private static createSettingsJson(
     homePath: string,
-    cmakePath: string
+    cmakePath: string,
+    ninjaPath: string
   ): string {
     // Helper functions
     const getDirName = (s: string): string => dirname(joinPosix(s));
@@ -149,6 +154,11 @@ export class NewZephyrProjectPanel {
     );
     console.log(subbedCmakePath);
 
+    const subbedNinjaPath = getDirName(
+      ninjaPath.replace(homePath, "${userHome}")
+    );
+    console.log(subbedNinjaPath);
+
     const settingsJson = {
       /* eslint-disable @typescript-eslint/naming-convention */
       "cmake.options.statusBarVisibility": "hidden",
@@ -175,30 +185,35 @@ export class NewZephyrProjectPanel {
         Path:
           "${env:USERPROFILE}/.pico-sdk/toolchain/14_2_Rel1/bin;${env:USERPROFILE}/.pico-sdk/picotool/2.1.1/picotool;" +
           `${getDirName(cmakePath.replace(homePath, "${env:USERPROFILE}"))};` +
-          "${env:USERPROFILE}/.pico-sdk/ninja/v1.12.1;${env:PATH}",
+          `${getDirName(ninjaPath.replace(homePath, "${env:USERPROFILE}"))};` +
+          "${env:PATH}",
       },
       "terminal.integrated.env.osx": {
         PICO_SDK_PATH: "${env:HOME}/.pico-sdk/sdk/2.1.1",
         PICO_TOOLCHAIN_PATH: "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1",
         PATH:
           "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1/bin:${env:HOME}/.pico-sdk/picotool/2.1.1/picotool:" +
           `${getDirName(cmakePath.replace(homePath, "{env:HOME}"))}:` +
-          "${env:HOME}/.pico-sdk/ninja/v1.12.1:${env:PATH}",
+          `${getDirName(ninjaPath.replace(homePath, "{env:HOME}"))}:` +
+          "${env:PATH}",
       },
       "terminal.integrated.env.linux": {
         PICO_SDK_PATH: "${env:HOME}/.pico-sdk/sdk/2.1.1",
         PICO_TOOLCHAIN_PATH: "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1",
         PATH:
           "${env:HOME}/.pico-sdk/toolchain/14_2_Rel1/bin:${env:HOME}/.pico-sdk/picotool/2.1.1/picotool:" +
           `${getDirName(cmakePath.replace(homePath, "{env:HOME}"))}:` +
-          "${env:HOME}/.pico-sdk/ninja/v1.12.1:${env:PATH}",
+          `${getDirName(ninjaPath.replace(homePath, "{env:HOME}"))}:` +
+          "${env:PATH}",
       },
       "raspberry-pi-pico.cmakeAutoConfigure": true,
       "raspberry-pi-pico.useCmakeTools": false,
       "raspberry-pi-pico.cmakePath": `${getDirName(
         cmakePath.replace(homePath, "${HOME}")
       )};`,
-      "raspberry-pi-pico.ninjaPath": "${HOME}/.pico-sdk/ninja/v1.12.1/ninja",
+      "raspberry-pi-pico.ninjaPath": `${getDirName(
+        ninjaPath.replace(homePath, "${HOME}")
+      )};`,
     };
 
     /* eslint-enable @typescript-eslint/naming-convention */
@@ -478,6 +493,9 @@ export class NewZephyrProjectPanel {
       cmakeMode: data.cmakeMode,
       cmakePath: data.cmakePath,
       cmakeVersion: data.cmakeVersion,
+      ninjaMode: data.ninjaMode,
+      ninjaPath: data.ninjaPath,
+      ninjaVersion: data.ninjaVersion,
     });
 
     if (zephyrSetupOutputs === null) {
@@ -581,7 +599,8 @@ export class NewZephyrProjectPanel {
     // Create settings JSON and write to new folder
     const settingsJson = NewZephyrProjectPanel.createSettingsJson(
       homeDirectory.replaceAll("\\", "/"),
-      zephyrSetupOutputs?.cmakeExecutable || ""
+      zephyrSetupOutputs?.cmakeExecutable || "",
+      zephyrSetupOutputs?.ninjaExecutable || ""
     );
     await workspace.fs.writeFile(
       Uri.file(settingJsonFile),
@@ -693,6 +712,18 @@ export class NewZephyrProjectPanel {
     const knownEnvironments = environments?.known;
     const activeEnv = environments?.getActiveEnvironmentPath();
 
+    let ninjasHtml = "";
+    const ninjaReleases = await getNinjaReleases();
+    console.debug(ninjaReleases);
+    const latestNinjaRelease = ninjaReleases[0];
+    ninjaReleases
+      .sort((a, b) => compare(b.replace("v", ""), a.replace("v", "")))
+      .forEach(ninja => {
+        ninjasHtml += `<option ${
+          ninjasHtml.length === 0 ? "selected " : ""
+        }value="${ninja}">${ninja}</option>`;
+      });
+
     let cmakesHtml = "";
     const cmakeReleases = await getCmakeReleases();
     console.debug(cmakeReleases);
@@ -708,6 +739,9 @@ export class NewZephyrProjectPanel {
       (await which("python3", { nothrow: true })) !== null ||
       (await which("python", { nothrow: true })) !== null;
 
+    const isNinjaSystemAvailable =
+      (await which("ninja", { nothrow: true })) !== null;
+
     const isCmakeSystemAvailable =
       (await which("cmake", { nothrow: true })) !== null;
 
@@ -974,6 +1008,41 @@ export class NewZephyrProjectPanel {
             </div>
           </div>
 
+          <div class="col-span-2">
+            <label class="block mb-2 text-sm font-medium text-gray-900 dark:text-white">Ninja Version:</label>
+            ${
+              latestNinjaRelease !== undefined
+                ? `<div class="flex items-center mb-2">
+                    <input type="radio" id="ninja-radio-default-version" name="ninja-version-radio" value="0" class="mr-1 text-blue-500" checked="checked">
+                    <label id="ninja-radio-latest-version" name=${latestNinjaRelease} for="ninja-radio-default-version" class="text-gray-900 dark:text-white">Default version</label>
+                  </div>`
+                : ""
+            }
+
+            ${
+              isNinjaSystemAvailable
+                ? `<div class="flex items-center mb-2" >
+                    <input type="radio" id="ninja-radio-system-version" name="ninja-version-radio" value="1" class="mr-1 text-blue-500">
+                    <label for="ninja-radio-system-version" class="text-gray-900 dark:text-white">Use system version</label>
+                  </div>`
+                : ""
+            }
+
+            <div class="flex items-center mb-2">
+              <input type="radio" id="ninja-radio-select-version" name="ninja-version-radio" value="2" class="mr-1 text-blue-500">
+              <label for="ninja-radio-select-version" class="text-gray-900 dark:text-white">Select version:</label>
+              <select id="sel-ninja" class="ml-2 bg-gray-50 border border-gray-300 text-gray-900 text-sm rounded-lg focus:ring-blue-500 focus:border-blue-500 block p-2.5 dark:bg-gray-700 dark:border-gray-600 dark:placeholder-gray-400 dark:text-white dark:focus:ring-blue-500 dark:focus:border-blue-500">
+                ${ninjasHtml}
+              </select>
+            </div>
+
+            <div class="flex items-center mb-2">
+              <input type="radio" id="ninja-radio-path-executable" name="ninja-version-radio" value="3" class="mr-1 text-blue-500">
+              <label for="ninja-radio-path-executable" class="text-gray-900 dark:text-white">Path to executable:</label>
+              <input type="file" id="ninja-path-executable" multiple="false" class="bg-gray-50 border border-gray-300 text-gray-900 text-sm rounded-lg focus:ring-blue-500 focus:border-blue-500 block p-2.5 dark:bg-gray-700 dark:border-gray-600 dark:placeholder-gray-400 dark:text-white dark:focus:ring-blue-500 dark:focus:border-blue-500 ms-2">
+            </div>
+          </div>
+
           <div class="bottom-3 mt-8 mb-12 w-full flex justify-end">
               <button id="btn-cancel" class="focus:outline-none bg-transparent ring-2 focus:ring-4 ring-red-400 dark:ring-red-700 font-medium rounded-lg text-lg px-4 py-2 mr-4 hover:bg-red-500 dark:hover:bg-red-700 focus:ring-red-600 dark:focus:ring-red-800">Cancel</button>
               <button id="btn-create" class="focus:outline-none bg-transparent ring-2 focus:ring-4 ring-green-400 dark:ring-green-700 font-medium rounded-lg text-lg px-4 py-2 mr-2 hover:bg-green-500 dark:hover:bg-green-700 focus:ring-green-600 dark:focus:ring-green-800">

web/zephyr/main.js

@@ -173,6 +173,70 @@ var submitted = false;
       "shell-features-cblist"
     ).checked;
 
+    // Handle Ninja version
+    // selected ninja version
+    const ninjaVersionRadio = document.getElementsByName("ninja-version-radio");
+    let ninjaMode = null;
+    let ninjaPath = null;
+    let ninjaVersion = null;
+    for (let i = 0; i < ninjaVersionRadio.length; i++) {
+      if (ninjaVersionRadio[i].checked) {
+        ninjaMode = Number(ninjaVersionRadio[i].value);
+        break;
+      }
+    }
+    if (ninjaVersionRadio.length === 0) {
+      // default to ninja mode 1 == System version
+      ninjaMode = 1;
+    }
+
+    // if ninja version is null or not a number, smaller than 0 or bigger than 3, set it to 0
+    if (
+      ninjaMode === null ||
+      isNaN(ninjaMode) ||
+      ninjaMode < 0 ||
+      ninjaMode > 4
+    ) {
+      ninjaMode = 0;
+      console.debug("Invalid ninja version value: " + ninjaMode.toString());
+      vscode.postMessage({
+        command: CMD_ERROR,
+        value: "Please select a valid ninja version.",
+      });
+      submitted = false;
+
+      return;
+    }
+
+    if (ninjaMode === 0) {
+      const ninjaLatestElement = document.getElementById(
+        "ninja-radio-latest-version"
+      );
+      ninjaVersion = ninjaLatestElement.getAttribute("name");
+    } else if (ninjaMode === 2) {
+      ninjaVersion = document.getElementById("sel-ninja").value;
+    } else if (ninjaMode == 3) {
+      const files = document.getElementById("ninja-path-executable").files;
+
+      if (files.length === 1) {
+        ninjaPath = files[0].name;
+      } else {
+        console.debug("Please select a valid ninja executable file");
+        vscode.postMessage({
+          command: CMD_ERROR,
+          value: "Please select a valid ninja executable file.",
+        });
+        submitted = false;
+
+        return;
+      }
+    }
+
+    console.log(
+      `Ninja Mode: ${ninjaMode}, path: ${ninjaPath}, version: ${ninjaVersion}`
+    );
+
+    // Handle CMake Version
     const cmakeVersionRadio = document.getElementsByName("cmake-version-radio");
     let cmakeMode = null;
     let cmakePath = null;
@@ -253,6 +317,9 @@ var submitted = false;
         cmakeMode: Number(cmakeMode),
         cmakePath: cmakePath,
         cmakeVersion: cmakeVersion,
+        ninjaMode: Number(ninjaMode),
+        ninjaPath: ninjaPath,
+        ninjaVersion: ninjaVersion,
       },
     });
   };