@rainbow-robotics/muscat-plugin-kit 1.10.1-dev.1 → 1.10.1

package/cli/src/type.mjs

@@ -1,141 +1,141 @@
-// muscat-pk type change — switch an existing plugin's backend type.
-//   python | cpp | ros2 (rclpy) | ros2-cpp (rclcpp).
-//   Adds the matching backend overlay; never deletes existing user code
-//   (e.g. ros2_ws/ or cpp/ are left in place when switching away).
-import { copyFileSync, existsSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { basename, join, resolve } from "node:path";
-import { findPluginRoot, log, prompt, templatesDir } from "./util.mjs";
-import {
-  TYPE_CHOICES,
-  applyTokens,
-  copyTemplate,
-  deriveNames,
-  overlayCpp,
-  overlayRos2,
-  prepareCppIde,
-  runtimeForChoice,
-} from "./new.mjs";
-
-const TYPES = Object.keys(TYPE_CHOICES);
-
-function readManifest(root) {
-  const path = resolve(root, "manifest.json");
-  if (!existsSync(path)) throw new Error(`manifest.json not found in ${root}`);
-  return { path, json: JSON.parse(readFileSync(path, "utf8")) };
-}
-
-// Derive the current `--type`-style key from a manifest runtime block.
-function currentTypeKey(runtime) {
-  if (runtime?.type === "ros2") return runtime.rosClient === "rclcpp" ? "ros2-cpp" : "ros2";
-  return runtime?.type ?? "python";
-}
-
-const isCpp = (key) => key === "cpp" || key === "ros2-cpp";
-
-async function offerReadme(root, toCpp, force, tokens) {
-  const lang = toCpp ? "C++" : "Python";
-  const answer = force ? "y" : await prompt(`Replace README.md with the ${lang} backend version? (current file kept as README.md.bak) [y/N]: `, "n");
-  if (!/^y/i.test(answer)) {
-    log.info(`README.md kept — to swap it later: muscat-pk type change --to <type> --readme`);
-    return;
-  }
-  const tmp = mkdtempSync(join(tmpdir(), "muscat-pk-readme-"));
-  try {
-    await copyTemplate(resolve(templatesDir, toCpp ? "readme-cpp" : "common"), tmp);
-    applyTokens(tmp, tokens);
-    const readme = resolve(root, "README.md");
-    if (existsSync(readme)) copyFileSync(readme, resolve(root, "README.md.bak"));
-    copyFileSync(join(tmp, "README.md"), readme);
-    log.ok(`README.md → ${lang} version${existsSync(resolve(root, "README.md.bak")) ? " (previous file: README.md.bak)" : ""}`);
-  } finally {
-    rmSync(tmp, { recursive: true, force: true });
-  }
-}
-
-export async function runType(args) {
-  // accept `type change`, `type`, `type --to ros2-cpp`
-  const sub = args[0];
-  const toFlagIdx = args.indexOf("--to");
-  let to = toFlagIdx >= 0 ? args[toFlagIdx + 1] : undefined;
-
-  const root = findPluginRoot();
-  const { path, json } = readManifest(root);
-  const current = currentTypeKey(json.runtime);
-
-  if (sub && sub !== "change") {
-    log.warn(`unknown subcommand '${sub}'. Usage: muscat-pk type change [--to python|cpp|ros2|ros2-cpp] [--readme]`);
-  }
-
-  if (!to) {
-    console.log(`\nCurrent type: ${current}`);
-    console.log("Select the new type:");
-    console.log("  1) Python");
-    console.log("  2) C++");
-    console.log("  3) ROS2 (rclpy / Python)");
-    console.log("  4) ROS2 (rclcpp / C++)");
-    const choice = await prompt("\nChoice [1/2/3/4]: ", "");
-    to = { "1": "python", "2": "cpp", "3": "ros2", "4": "ros2-cpp" }[choice];
-  }
-
-  if (!TYPES.includes(to)) {
-    throw new Error(`invalid type. choose python | cpp | ros2 | ros2-cpp.`);
-  }
-  if (to === current) {
-    log.info(`already '${current}' — nothing to change.`);
-    return;
-  }
-
-  const runtimeChoice = TYPE_CHOICES[to];
-  const { dir, slug, pluginName, pluginClass, pluginId } = deriveNames(root);
-
-  if (runtimeChoice.type === "ros2") {
-    if (existsSync(resolve(root, "ros2_ws"))) {
-      log.warn("ros2_ws/ already exists — keeping it, only flipping manifest type.");
-    } else {
-      log.step(`adding ros2_ws/ overlay (${runtimeChoice.rosClient})`);
-      await overlayRos2(root, slug, runtimeChoice.rosClient);
-      applyTokens(resolve(root, "ros2_ws"), {
-        __PLUGIN_ID__: pluginId,
-        __PLUGIN_NAME__: pluginName,
-        __PLUGIN_SLUG__: slug,
-        __PLUGIN_CLASS__: pluginClass,
-        __RUNTIME_TYPE__: "ros2",
-      });
-    }
-  } else if (runtimeChoice.type === "cpp") {
-    if (existsSync(resolve(root, "cpp"))) {
-      log.warn("cpp/ already exists — keeping it, only flipping manifest type.");
-    } else {
-      log.step("adding cpp/ overlay");
-      await overlayCpp(root);
-      applyTokens(resolve(root, "cpp"), {
-        __PLUGIN_ID__: pluginId,
-        __PLUGIN_NAME__: pluginName,
-        __PLUGIN_SLUG__: slug,
-        __PLUGIN_CLASS__: pluginClass,
-        __RUNTIME_TYPE__: "cpp",
-      });
-    }
-  } else {
-    // → python. Leave any ros2_ws/ or cpp/ in place (never delete user code).
-    if (existsSync(resolve(root, "ros2_ws")) || existsSync(resolve(root, "cpp"))) {
-      log.warn("existing backend dir left in place (not deleted). Remove it manually if unused.");
-    }
-  }
-
-  json.runtime = runtimeForChoice(runtimeChoice, slug);
-  writeFileSync(path, JSON.stringify(json, null, 2) + "\n");
-  log.ok(`${basename(root)} type: ${current} → ${to}`);
-  if (isCpp(to)) await prepareCppIde(root, runtimeChoice);
-
-  if (isCpp(current) !== isCpp(to)) {
-    await offerReadme(root, isCpp(to), args.includes("--readme"), {
-      __PLUGIN_ID__: pluginId,
-      __PLUGIN_NAME__: pluginName,
-      __PLUGIN_DIR__: dir,
-      __PLUGIN_SLUG__: slug,
-      __PLUGIN_CLASS__: pluginClass,
-    });
-  }
-}
+// muscat-pk type change — switch an existing plugin's backend type.
+//   python | cpp | ros2 (rclpy) | ros2-cpp (rclcpp).
+//   Adds the matching backend overlay; never deletes existing user code
+//   (e.g. ros2_ws/ or cpp/ are left in place when switching away).
+import { copyFileSync, existsSync, mkdtempSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { basename, join, resolve } from "node:path";
+import { findPluginRoot, log, prompt, templatesDir } from "./util.mjs";
+import {
+  TYPE_CHOICES,
+  applyTokens,
+  copyTemplate,
+  deriveNames,
+  overlayCpp,
+  overlayRos2,
+  prepareCppIde,
+  runtimeForChoice,
+} from "./new.mjs";
+
+const TYPES = Object.keys(TYPE_CHOICES);
+
+function readManifest(root) {
+  const path = resolve(root, "manifest.json");
+  if (!existsSync(path)) throw new Error(`manifest.json not found in ${root}`);
+  return { path, json: JSON.parse(readFileSync(path, "utf8")) };
+}
+
+// Derive the current `--type`-style key from a manifest runtime block.
+function currentTypeKey(runtime) {
+  if (runtime?.type === "ros2") return runtime.rosClient === "rclcpp" ? "ros2-cpp" : "ros2";
+  return runtime?.type ?? "python";
+}
+
+const isCpp = (key) => key === "cpp" || key === "ros2-cpp";
+
+async function offerReadme(root, toCpp, force, tokens) {
+  const lang = toCpp ? "C++" : "Python";
+  const answer = force ? "y" : await prompt(`Replace README.md with the ${lang} backend version? (current file kept as README.md.bak) [y/N]: `, "n");
+  if (!/^y/i.test(answer)) {
+    log.info(`README.md kept — to swap it later: muscat-pk type change --to <type> --readme`);
+    return;
+  }
+  const tmp = mkdtempSync(join(tmpdir(), "muscat-pk-readme-"));
+  try {
+    await copyTemplate(resolve(templatesDir, toCpp ? "readme-cpp" : "common"), tmp);
+    applyTokens(tmp, tokens);
+    const readme = resolve(root, "README.md");
+    if (existsSync(readme)) copyFileSync(readme, resolve(root, "README.md.bak"));
+    copyFileSync(join(tmp, "README.md"), readme);
+    log.ok(`README.md → ${lang} version${existsSync(resolve(root, "README.md.bak")) ? " (previous file: README.md.bak)" : ""}`);
+  } finally {
+    rmSync(tmp, { recursive: true, force: true });
+  }
+}
+
+export async function runType(args) {
+  // accept `type change`, `type`, `type --to ros2-cpp`
+  const sub = args[0];
+  const toFlagIdx = args.indexOf("--to");
+  let to = toFlagIdx >= 0 ? args[toFlagIdx + 1] : undefined;
+
+  const root = findPluginRoot();
+  const { path, json } = readManifest(root);
+  const current = currentTypeKey(json.runtime);
+
+  if (sub && sub !== "change") {
+    log.warn(`unknown subcommand '${sub}'. Usage: muscat-pk type change [--to python|cpp|ros2|ros2-cpp] [--readme]`);
+  }
+
+  if (!to) {
+    console.log(`\nCurrent type: ${current}`);
+    console.log("Select the new type:");
+    console.log("  1) Python");
+    console.log("  2) C++");
+    console.log("  3) ROS2 (rclpy / Python)");
+    console.log("  4) ROS2 (rclcpp / C++)");
+    const choice = await prompt("\nChoice [1/2/3/4]: ", "");
+    to = { "1": "python", "2": "cpp", "3": "ros2", "4": "ros2-cpp" }[choice];
+  }
+
+  if (!TYPES.includes(to)) {
+    throw new Error(`invalid type. choose python | cpp | ros2 | ros2-cpp.`);
+  }
+  if (to === current) {
+    log.info(`already '${current}' — nothing to change.`);
+    return;
+  }
+
+  const runtimeChoice = TYPE_CHOICES[to];
+  const { dir, slug, pluginName, pluginClass, pluginId } = deriveNames(root);
+
+  if (runtimeChoice.type === "ros2") {
+    if (existsSync(resolve(root, "ros2_ws"))) {
+      log.warn("ros2_ws/ already exists — keeping it, only flipping manifest type.");
+    } else {
+      log.step(`adding ros2_ws/ overlay (${runtimeChoice.rosClient})`);
+      await overlayRos2(root, slug, runtimeChoice.rosClient);
+      applyTokens(resolve(root, "ros2_ws"), {
+        __PLUGIN_ID__: pluginId,
+        __PLUGIN_NAME__: pluginName,
+        __PLUGIN_SLUG__: slug,
+        __PLUGIN_CLASS__: pluginClass,
+        __RUNTIME_TYPE__: "ros2",
+      });
+    }
+  } else if (runtimeChoice.type === "cpp") {
+    if (existsSync(resolve(root, "cpp"))) {
+      log.warn("cpp/ already exists — keeping it, only flipping manifest type.");
+    } else {
+      log.step("adding cpp/ overlay");
+      await overlayCpp(root);
+      applyTokens(resolve(root, "cpp"), {
+        __PLUGIN_ID__: pluginId,
+        __PLUGIN_NAME__: pluginName,
+        __PLUGIN_SLUG__: slug,
+        __PLUGIN_CLASS__: pluginClass,
+        __RUNTIME_TYPE__: "cpp",
+      });
+    }
+  } else {
+    // → python. Leave any ros2_ws/ or cpp/ in place (never delete user code).
+    if (existsSync(resolve(root, "ros2_ws")) || existsSync(resolve(root, "cpp"))) {
+      log.warn("existing backend dir left in place (not deleted). Remove it manually if unused.");
+    }
+  }
+
+  json.runtime = runtimeForChoice(runtimeChoice, slug);
+  writeFileSync(path, JSON.stringify(json, null, 2) + "\n");
+  log.ok(`${basename(root)} type: ${current} → ${to}`);
+  if (isCpp(to)) await prepareCppIde(root, runtimeChoice);
+
+  if (isCpp(current) !== isCpp(to)) {
+    await offerReadme(root, isCpp(to), args.includes("--readme"), {
+      __PLUGIN_ID__: pluginId,
+      __PLUGIN_NAME__: pluginName,
+      __PLUGIN_DIR__: dir,
+      __PLUGIN_SLUG__: slug,
+      __PLUGIN_CLASS__: pluginClass,
+    });
+  }
+}

package/cli/src/uninstall.mjs

@@ -1,81 +1,81 @@
-// muscat-pk uninstall - remove the installed CLI, whether npm-global or S3 binary.
-import { execSync, spawn, spawnSync } from "node:child_process";
-import { existsSync, rmSync } from "node:fs";
-import { dirname, join } from "node:path";
-import { KIT_PUBLISHED_NAME, isNpmGlobalInstall, log, parseArgs } from "./util.mjs";
-
-const isBinaryMode = typeof Bun !== "undefined";
-
-function uninstallNpmGlobal() {
-  log.step(`npm uninstall -g ${KIT_PUBLISHED_NAME}`);
-  execSync(`npm uninstall -g ${KIT_PUBLISHED_NAME}`, { stdio: "inherit" });
-  log.ok("Global npm package removed.");
-}
-
-function uninstallBinary() {
-  const execPath = process.execPath;
-  log.step(`Removing binary: ${execPath}`);
-
-  if (process.platform === "win32") {
-    const ps = `Start-Sleep -Milliseconds 500; Remove-Item -Force '${execPath}'`;
-    spawn("powershell", ["-NoProfile", "-Command", ps], {
-      detached: true,
-      stdio: "ignore",
-    }).unref();
-    log.ok("Binary will be removed after this process exits.");
-    return;
-  }
-
-  try {
-    rmSync(execPath, { force: true });
-  } catch (err) {
-    if (err?.code !== "EACCES" && err?.code !== "EPERM") throw err;
-    log.info("  sudo is required...");
-    const result = spawnSync("sudo", ["rm", "-f", execPath], { stdio: "inherit" });
-    if (result.status !== 0) throw new Error(`sudo rm failed: ${execPath}`);
-  }
-
-  const parent = dirname(execPath);
-  for (const shim of ["muscat-pk.cmd", "muscat-pk.ps1"]) {
-    rmSync(join(parent, shim), { force: true });
-  }
-
-  log.ok("Binary removed.");
-}
-
-export async function runUninstall(args = []) {
-  const opts = parseArgs(args, { booleans: ["help"] });
-
-  if (opts.help) {
-    log.info(
-      [
-        "Usage: muscat-pk uninstall",
-        "",
-        "Removes the installed muscat-pk CLI.",
-        "  npm global install  -> npm uninstall -g @rainbow-robotics/muscat-plugin-kit",
-        "  S3 binary install   -> remove the muscat-pk executable",
-      ].join("\n"),
-    );
-    return;
-  }
-
-  if (isBinaryMode) {
-    uninstallBinary();
-    return;
-  }
-
-  if (isNpmGlobalInstall()) {
-    uninstallNpmGlobal();
-    return;
-  }
-
-  const localBin = process.argv[1] || "";
-  if (localBin.includes(`${join("node_modules", ".bin")}`) || existsSync(join(process.cwd(), "package.json"))) {
-    log.warn("This muscat-pk appears to be running from a project/local install.");
-    log.warn("Remove it from the project package manager instead, for example:");
-    log.warn(`  npm uninstall ${KIT_PUBLISHED_NAME}`);
-    return;
-  }
-
-  throw new Error("Could not determine install mode. Remove muscat-pk manually from your PATH.");
-}
+// muscat-pk uninstall - remove the installed CLI, whether npm-global or S3 binary.
+import { execSync, spawn, spawnSync } from "node:child_process";
+import { existsSync, rmSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { KIT_PUBLISHED_NAME, isNpmGlobalInstall, log, parseArgs } from "./util.mjs";
+
+const isBinaryMode = typeof Bun !== "undefined";
+
+function uninstallNpmGlobal() {
+  log.step(`npm uninstall -g ${KIT_PUBLISHED_NAME}`);
+  execSync(`npm uninstall -g ${KIT_PUBLISHED_NAME}`, { stdio: "inherit" });
+  log.ok("Global npm package removed.");
+}
+
+function uninstallBinary() {
+  const execPath = process.execPath;
+  log.step(`Removing binary: ${execPath}`);
+
+  if (process.platform === "win32") {
+    const ps = `Start-Sleep -Milliseconds 500; Remove-Item -Force '${execPath}'`;
+    spawn("powershell", ["-NoProfile", "-Command", ps], {
+      detached: true,
+      stdio: "ignore",
+    }).unref();
+    log.ok("Binary will be removed after this process exits.");
+    return;
+  }
+
+  try {
+    rmSync(execPath, { force: true });
+  } catch (err) {
+    if (err?.code !== "EACCES" && err?.code !== "EPERM") throw err;
+    log.info("  sudo is required...");
+    const result = spawnSync("sudo", ["rm", "-f", execPath], { stdio: "inherit" });
+    if (result.status !== 0) throw new Error(`sudo rm failed: ${execPath}`);
+  }
+
+  const parent = dirname(execPath);
+  for (const shim of ["muscat-pk.cmd", "muscat-pk.ps1"]) {
+    rmSync(join(parent, shim), { force: true });
+  }
+
+  log.ok("Binary removed.");
+}
+
+export async function runUninstall(args = []) {
+  const opts = parseArgs(args, { booleans: ["help"] });
+
+  if (opts.help) {
+    log.info(
+      [
+        "Usage: muscat-pk uninstall",
+        "",
+        "Removes the installed muscat-pk CLI.",
+        "  npm global install  -> npm uninstall -g @rainbow-robotics/muscat-plugin-kit",
+        "  S3 binary install   -> remove the muscat-pk executable",
+      ].join("\n"),
+    );
+    return;
+  }
+
+  if (isBinaryMode) {
+    uninstallBinary();
+    return;
+  }
+
+  if (isNpmGlobalInstall()) {
+    uninstallNpmGlobal();
+    return;
+  }
+
+  const localBin = process.argv[1] || "";
+  if (localBin.includes(`${join("node_modules", ".bin")}`) || existsSync(join(process.cwd(), "package.json"))) {
+    log.warn("This muscat-pk appears to be running from a project/local install.");
+    log.warn("Remove it from the project package manager instead, for example:");
+    log.warn(`  npm uninstall ${KIT_PUBLISHED_NAME}`);
+    return;
+  }
+
+  throw new Error("Could not determine install mode. Remove muscat-pk manually from your PATH.");
+}