@rainbow-robotics/muscat-plugin-kit 0.1.2-dev.5 → 0.1.2-dev.50

package/cli/src/util.mjs

@@ -1,8 +1,10 @@
 // Shared helpers for muscat-pk.
 import { spawnSync } from "node:child_process";
-import { existsSync, readFileSync } from "node:fs";
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname, resolve } from "node:path";
+import { tmpdir } from "node:os";
 import { fileURLToPath } from "node:url";
+import { createInterface } from "node:readline/promises";
 
 /** True if an executable is on PATH (cross-platform). */
 export function hasBin(bin) {
@@ -37,6 +39,32 @@ export function venvPython(venvDir) {
     : resolve(venvDir, "bin", "python");
 }
 
+/**
+ * Create/refresh a local `.venv` with requirements.txt installed, for the
+ * editor/linter only (the backend actually runs in Docker). Uses `uv` if
+ * present, else the system Python. Returns true if the venv is ready.
+ */
+export function ensureIdeVenv(root) {
+  const venvDir = resolve(root, ".venv");
+  const py = venvPython(venvDir);
+
+  if (!existsSync(py)) {
+    let created;
+    if (hasBin("uv")) {
+      created = spawnSync("uv", ["venv", venvDir, "--python", "3.12", "--seed"], { cwd: root, stdio: "ignore" });
+    } else {
+      const { cmd } = detectPythonCmd();
+      created = spawnSync(cmd[0], [...cmd.slice(1), "-m", "venv", venvDir], { cwd: root, stdio: "ignore" });
+    }
+    if (created.status !== 0 || !existsSync(py)) return false;
+  }
+
+  const reqs = resolve(root, "requirements.txt");
+  const args = ["-m", "pip", "install", "-q"];
+  if (existsSync(reqs)) args.push("-r", reqs);
+  return spawnSync(py, args, { cwd: root, stdio: "ignore" }).status === 0;
+}
+
 /** Published install/CLI package name. Author imports use @rainbow-robotics/plugin-ui separately. */
 export const KIT_PUBLISHED_NAME = "@rainbow-robotics/muscat-plugin-kit";
 
@@ -65,6 +93,40 @@ export function parseArgs(args, { booleans = [] } = {}) {
   return out;
 }
 
+/** Prompt user for input. Returns trimmed answer or fallback (non-TTY or empty). */
+export async function prompt(question, fallback = "") {
+  if (!process.stdin.isTTY) return fallback;
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  const answer = (await rl.question(question)).trim();
+  rl.close();
+  return answer || fallback;
+}
+
+const LOCAL_HOSTS = new Set(["", "localhost", "127.0.0.1", "::1"]);
+
+/**
+ * Ask for robot IP (and token if remote). Returns { robotIp, robotToken }.
+ * Skips prompts if already set in process.env (from a parent command like `dev`).
+ * Supports --robot-ip / --robot-token flags for non-interactive use.
+ */
+export async function promptRobotConnection(args = []) {
+  const parsed = parseArgs(args);
+  const robotIp =
+    parsed["robot-ip"] ??
+    process.env.MUSCAT_ROBOT_HOST ??
+    (await prompt("  Robot IP (skip if no robot): "));
+
+  if (LOCAL_HOSTS.has(robotIp)) return { robotIp, robotToken: "" };
+
+  const robotToken =
+    parsed["robot-token"] ??
+    process.env.MUSCAT_ROBOT_TOKEN ??
+    (await prompt("  SDK Token (required for remote): "));
+
+  if (!robotToken) throw new Error("SDK token is required for remote robot connection.");
+  return { robotIp, robotToken };
+}
+
 /** Walk up from cwd to find the plugin project root (has manifest.json). */
 export function findPluginRoot(start = process.cwd()) {
   let dir = resolve(start);
@@ -79,19 +141,64 @@ export function findPluginRoot(start = process.cwd()) {
   );
 }
 
+const RED    = "\x1b[31m";
+const ORANGE = "\x1b[33m";
+const RESET  = "\x1b[0m";
+
 export const log = {
-  info: (...m) => console.log(...m),
-  step: (...m) => console.log("›", ...m),
-  ok: (...m) => console.log("✓", ...m),
-  warn: (...m) => console.warn("⚠", ...m),
+  info:  (...m) => console.log(...m),
+  step:  (...m) => console.log("›", ...m),
+  ok:    (...m) => console.log("✓", ...m),
+  warn:  (...m) => console.warn(`${ORANGE}⚠${RESET}`, ...m.map(s => `${ORANGE}${s}${RESET}`)),
+  error: (...m) => console.error(`${RED}✖${RESET}`, ...m.map(s => `${RED}${s}${RESET}`)),
 };
 
+// dev / dev:back / build run the plugin back end, the dev bridge, and cpp/ros2
+// compilation in Docker. Show a clear install hint when Docker is missing.
+export function ensureDocker() {
+  if (hasBin("docker")) return;
+  log.warn("Docker not found.");
+  log.warn("  muscat-pk runs the plugin back end, the dev bridge, and cpp/ros2 builds in Docker.");
+  log.warn("  Install Docker, then retry: https://docs.docker.com/get-docker/");
+  throw new Error("Docker is required for dev / dev:back / build.");
+}
+
+/**
+ * Remove dangling (untagged) muscat-pk images left behind after a rebuild.
+ * Uses label filter so only our images are touched — other Docker images are safe.
+ */
+export function pruneMuskatImages() {
+  spawnSync(
+    "docker",
+    ["image", "prune", "--force", "--filter", "label=com.rainbow-robotics.muscat-pk=true"],
+    { stdio: "ignore" },
+  );
+}
+
 export function humanSize(bytes) {
   if (bytes < 1024) return `${bytes} B`;
   if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
   return `${(bytes / (1024 * 1024)).toFixed(2)} MB`;
 }
 
+/**
+ * Return the on-disk path of a bundled Dockerfile.
+ * In npm-install mode the real file exists under cli/docker/.
+ * In compiled-binary mode it doesn't — extract from the embedded snapshot to tmpdir.
+ */
+export async function resolveDockerfile(name) {
+  const real = resolve(kitRoot, "cli/docker", name);
+  if (existsSync(real)) return real;
+  const { TEMPLATES } = await import("./templates-embedded.mjs");
+  const b64 = TEMPLATES[`docker/${name}`];
+  if (!b64) throw new Error(`Embedded Dockerfile missing: docker/${name}. Reinstall muscat-plugin-kit.`);
+  const dir = resolve(tmpdir(), "muscat-pk-docker");
+  mkdirSync(dir, { recursive: true });
+  const tmp = resolve(dir, name);
+  writeFileSync(tmp, Buffer.from(b64, "base64"));
+  return tmp;
+}
+
 /** This kit's installed version (from its package.json). */
 export function kitVersion() {
   try {
@@ -141,8 +248,8 @@ export async function checkKitUpdate({ timeoutMs = 2000 } = {}) {
         [
           "",
           line,
-          `  muscat-plugin-kit 새 버전이 있습니다: ${current} → ${latest}`,
-          `  업데이트:  muscat-pk update`,
+          `  muscat-plugin-kit update available: ${current} → ${latest}`,
+          `  Update:  muscat-pk update`,
           line,
           "",
         ].join("\n"),