vercel-vm-factory 0.9.8 → 0.11.8

package/README.md

@@ -78,10 +78,12 @@ Choosing bash or zsh adds the matching package to the generated Dockerfile when
 
 Generated shell setup examples:
 
-- Alpine + `/bin/zsh`: installs `zsh curl git`, then installs oh-my-zsh unattended.
+- Alpine + `/bin/zsh`: installs `zsh curl git`, installs oh-my-zsh unattended, and writes `/root/.zshrc`.
 - Ubuntu/Debian + `/bin/bash`: installs `bash` with `apt-get`.
 - `/bin/sh`: no extra shell package is installed.
 
+The generated Dockerfile sets `HOME=/root` and `SHELL` to the selected shell path.
+
 Preinstall tools:
 
 - `nodejs`

package/deploy-vm.mjs

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 import { mkdir, readFile, rm, stat, writeFile } from "node:fs/promises";
 import { spawn } from "node:child_process";
-import { createInterface } from "node:readline/promises";
 import { stdin as input, stdout as output } from "node:process";
 import { homedir } from "node:os";
 import path from "node:path";
+import * as p from "@clack/prompts";
 
 const defaultWsShellImage = "ghcr.io/v1xingyue/ws-shell:v1.8.alpine";
 
@@ -187,43 +187,30 @@ async function main() {
       )
     : "";
 
-  await writeDefaults(defaultsPath, {
-    ...defaults,
-    "vm-image": vmImageName,
-    scope: scope || undefined,
-    project,
-    from: wsShellImage,
-    shell,
-    tools,
-    "auth-mode": authMode,
-    "auth-user": authUsername,
-    "auth-password": authPassword,
-    "client-id": githubClientId,
-    "client-secret": githubClientSecret,
-    "github-userid": allowedUserIds,
-  });
-
-  const commonArgs = [];
-  if (args.token) commonArgs.push("--token", args.token);
-  if (scope) commonArgs.push("--scope", scope);
+  let activeScope = scope;
+  const commonArgs = () => makeCommonArgs(activeScope);
 
   if (!skipLink) {
     step("Linking Vercel project");
-    await runNoUrl("vercel", [
-      "link",
-      "--yes",
-      "--project",
-      project,
-      "--cwd",
-      appDir,
-      ...commonArgs,
-    ]);
+    await withScopeFallback(activeScope, async () =>
+      runNoUrl("vercel", [
+        "link",
+        "--yes",
+        "--project",
+        project,
+        "--cwd",
+        appDir,
+        ...commonArgs(),
+      ]),
+    );
   } else {
     warn("skip-link enabled; using existing .vercel/project.json");
   }
 
   step("Setting project framework=container");
-  await setContainerFramework(appDir, commonArgs);
+  await withScopeFallback(activeScope, async () =>
+    setContainerFramework(appDir, commonArgs()),
+  );
 
   const vercelArgs = ["deploy", appDir, "--yes", "--logs"];
 
@@ -238,13 +225,40 @@ async function main() {
   if (allowedUserIds)
     vercelArgs.push("--env", `ALLOWED_USER_IDS=${allowedUserIds}`);
   if (prod) vercelArgs.push("--prod");
-  vercelArgs.push(...commonArgs);
 
   step("Deploying");
-  const deploymentUrl = await run("vercel", vercelArgs);
+  const deploymentUrl = await withScopeFallback(activeScope, async () =>
+    run("vercel", [...vercelArgs, ...commonArgs()]),
+  );
+  await writeDefaults(defaultsPath, {
+    ...defaults,
+    "vm-image": vmImageName,
+    scope: activeScope || undefined,
+    project,
+    from: wsShellImage,
+    shell,
+    tools,
+    "auth-mode": authMode,
+    "auth-user": authUsername,
+    "auth-password": authPassword,
+    "client-id": githubClientId,
+    "client-secret": githubClientSecret,
+    "github-userid": allowedUserIds,
+  });
   console.log(
     `\n${color.green("Deployment URL:")} ${color.bold(deploymentUrl)}`,
   );
+
+  async function withScopeFallback(scopeValue, action) {
+    try {
+      return await action();
+    } catch (error) {
+      if (!scopeValue || !isMissingScope(error)) throw error;
+      warn(`scope "${scopeValue}" not found; retrying with default Vercel scope`);
+      activeScope = "";
+      return action();
+    }
+  }
 }
 
 async function setContainerFramework(appDir, commonArgs) {
@@ -294,15 +308,14 @@ async function installVercelCli() {
     );
 
   const install = await choosePackageInstall();
-  const answer = (
-    await askText(
-      `Vercel CLI is not installed. Install with ${install.command} ${install.args.join(" ")}?`,
-      "N",
-    )
-  ).toLowerCase();
+  const answer = await promptResult(
+    p.confirm({
+      message: `Vercel CLI is not installed. Install with ${install.command} ${install.args.join(" ")}?`,
+      initialValue: false,
+    }),
+  );
 
-  if (answer !== "y" && answer !== "yes")
-    throw new Error("Vercel CLI is required. Exiting.");
+  if (!answer) throw new Error("Vercel CLI is required. Exiting.");
 
   step(`Installing Vercel CLI with ${install.command}`);
   await runNoUrl(install.command, install.args);
@@ -367,7 +380,13 @@ function makeDockerfile({ shell, tools, vmImage, vmImageName, wsShellImage }) {
   const shellInstall = makeShellInstall({ shell, vmImageName });
   const ohMyZshInstall =
     path.basename(shell) === "zsh"
-      ? `RUN RUNZSH=no CHSH=no KEEP_ZSHRC=yes sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended`
+      ? `RUN RUNZSH=no CHSH=no KEEP_ZSHRC=no sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" "" --unattended \\
+    && printf '%s\\n' \\
+      'export ZSH="$HOME/.oh-my-zsh"' \\
+      'ZSH_THEME="robbyrussell"' \\
+      'plugins=(git)' \\
+      'source "$ZSH/oh-my-zsh.sh"' \\
+      > /root/.zshrc`
       : "";
   const toolInstall = makeToolInstall({ tools, vmImageName });
   const shellSetup = [shellInstall, ohMyZshInstall, toolInstall]
@@ -384,6 +403,8 @@ COPY --from=ws-shell /app/bin/wsterm /app/bin/wsterm
 
 WORKDIR /app
 ENV ENABLE_SSL=false
+ENV HOME=/root
+ENV SHELL=${shell}
 EXPOSE 80
 CMD ["/app/bin/wsterm","-bind",":80","-fork","${shell}"]
 `;
@@ -468,7 +489,7 @@ async function secret(name, question, fallback) {
   if (!input.isTTY) return fallback || "";
 
   const placeholder = fallback ? mask(fallback) : "skip";
-  const answer = await askText(question, placeholder);
+  const answer = await askSecret(question, placeholder);
   return answer || fallback || "";
 }
 
@@ -513,22 +534,18 @@ async function chooseAuthMode(fallback) {
   }
   if (!input.isTTY) return modes.has(fallback) ? fallback : "basic";
 
-  printChoices("Authentication", [
-    ["1", "basic", "username/password"],
-    ["2", "github", "GitHub OAuth"],
-    ["3", "both", "basic + GitHub OAuth"],
-    ["4", "none", "no app auth"],
-  ]);
-
-  const answer = await askText("Authentication", fallback);
-
-  if (!answer) return modes.has(fallback) ? fallback : "basic";
-  if (modes.has(answer)) return answer;
-  if (answer === "1") return "basic";
-  if (answer === "2") return "github";
-  if (answer === "3") return "both";
-  if (answer === "4") return "none";
-  throw new Error("Authentication must be basic, github, both, or none");
+  return promptResult(
+    p.select({
+      message: "Authentication",
+      initialValue: modes.has(fallback) ? fallback : "basic",
+      options: [
+        { value: "basic", label: "Basic", hint: "username/password" },
+        { value: "github", label: "GitHub OAuth" },
+        { value: "both", label: "Basic + GitHub OAuth" },
+        { value: "none", label: "None", hint: "no app auth" },
+      ],
+    }),
+  );
 }
 
 function usesBasicAuth(mode) {
@@ -545,25 +562,23 @@ async function chooseVmImage(fallback) {
   if (!input.isTTY) return fallback;
 
   const names = Object.keys(vmImages);
-  printChoices(
-    "VM image",
-    names.map((name, index) => [
-      String(index + 1),
-      name,
-      vmImages[name],
-    ]).concat([["4", "custom", "enter a full image name"]]),
+  const answer = await promptResult(
+    p.select({
+      message: "VM image",
+      initialValue: vmImages[fallback] ? fallback : "custom",
+      options: names
+        .map((name) => ({ value: name, label: name, hint: vmImages[name] }))
+        .concat([
+          { value: "custom", label: "Custom", hint: "enter a full image name" },
+        ]),
+    }),
   );
 
-  const answer = await askText("VM image", fallback);
-
-  if (!answer) return fallback;
-  if (vmImages[answer]) return answer;
-  if (/^[1-3]$/.test(answer)) return names[Number(answer) - 1];
-  if (answer === "4")
+  if (answer === "custom")
     return value(
       "custom-vm-image",
       "Custom VM image",
-      defaults["custom-vm-image"],
+      vmImages[fallback] ? defaults["custom-vm-image"] : fallback,
     );
   return answer;
 }
@@ -572,21 +587,17 @@ async function chooseShell(fallback) {
   if (args.shell) return args.shell;
   if (!input.isTTY) return fallback;
 
-  printChoices(
-    "Shell",
-    shells.map((shell, index) => [
-      String(index + 1),
-      shell,
-      index === shells.length - 1 ? "default" : "",
-    ]),
+  return promptResult(
+    p.select({
+      message: "Shell",
+      initialValue: shells.includes(fallback) ? fallback : "/bin/sh",
+      options: shells.map((shell, index) => ({
+        value: shell,
+        label: shell,
+        hint: index === shells.length - 1 ? "default" : undefined,
+      })),
+    }),
   );
-
-  const answer = await askText("Shell", fallback);
-
-  if (!answer) return fallback;
-  if (shells.includes(answer)) return answer;
-  if (/^[1-3]$/.test(answer)) return shells[Number(answer) - 1];
-  return answer;
 }
 
 async function chooseTools(fallback) {
@@ -594,17 +605,20 @@ async function chooseTools(fallback) {
   if (!input.isTTY) return parseTools(fallback).join(",");
 
   const names = Object.keys(toolChoices);
-  printChoices(
-    "Preinstall tools",
-    names.map((name, index) => [
-      String(index + 1),
-      name,
-      toolChoices[name],
-    ]).concat([["0", "none", "default"]]),
+  const selected = await promptResult(
+    p.multiselect({
+      message: "Preinstall tools",
+      required: false,
+      initialValues: parseTools(fallback),
+      options: names.map((name) => ({
+        value: name,
+        label: name,
+        hint: toolChoices[name],
+      })),
+    }),
   );
 
-  const answer = await askText("Tools (comma separated)", fallback || "none");
-  return parseTools(answer || fallback).join(",");
+  return selected.join(",");
 }
 
 function parseTools(value) {
@@ -713,23 +727,37 @@ function parseCommand(argv) {
   return { command: "create", args: parseArgs(argv) };
 }
 
+function makeCommonArgs(scope) {
+  const commonArgs = [];
+  if (args.token) commonArgs.push("--token", args.token);
+  if (scope) commonArgs.push("--scope", scope);
+  return commonArgs;
+}
+
+function isMissingScope(error) {
+  return String(error?.message || error).includes("scope does not exist");
+}
+
 function run(command, commandArgs) {
   return new Promise((resolve, reject) => {
     let seenUrl = "";
+    let text = "";
     const child = spawn(command, commandArgs, {
       stdio: ["inherit", "pipe", "pipe"],
     });
 
     child.stdout.on("data", (chunk) => {
-      const text = chunk.toString();
-      output.write(text);
-      seenUrl = findLastUrl(text) || seenUrl;
+      const chunkText = chunk.toString();
+      text += chunkText;
+      output.write(chunkText);
+      seenUrl = findLastUrl(chunkText) || seenUrl;
     });
 
     child.stderr.on("data", (chunk) => {
-      const text = chunk.toString();
-      output.write(text);
-      seenUrl = findLastUrl(text) || seenUrl;
+      const chunkText = chunk.toString();
+      text += chunkText;
+      output.write(chunkText);
+      seenUrl = findLastUrl(chunkText) || seenUrl;
     });
 
     child.on("error", reject);
@@ -737,7 +765,7 @@ function run(command, commandArgs) {
       if (code === 0 && seenUrl) resolve(seenUrl);
       else if (code === 0)
         reject(new Error("vercel finished but no deployment url was found"));
-      else reject(new Error(`vercel exited with code ${code}`));
+      else reject(new Error(text.trim() || `vercel exited with code ${code}`));
     });
   });
 }
@@ -765,11 +793,24 @@ function runCapture(command, commandArgs) {
 
 function runNoUrl(command, commandArgs) {
   return new Promise((resolve, reject) => {
-    const child = spawn(command, commandArgs, { stdio: "inherit" });
+    let text = "";
+    const child = spawn(command, commandArgs, {
+      stdio: ["inherit", "pipe", "pipe"],
+    });
+    child.stdout.on("data", (chunk) => {
+      const chunkText = chunk.toString();
+      text += chunkText;
+      output.write(chunkText);
+    });
+    child.stderr.on("data", (chunk) => {
+      const chunkText = chunk.toString();
+      text += chunkText;
+      output.write(chunkText);
+    });
     child.on("error", reject);
     child.on("close", (code) => {
       if (code === 0) resolve();
-      else reject(new Error(`${command} exited with code ${code}`));
+      else reject(new Error(text.trim() || `${command} exited with code ${code}`));
     });
   });
 }
@@ -779,6 +820,10 @@ function findLastUrl(text) {
 }
 
 function printHeader() {
+  if (input.isTTY) {
+    p.intro("Vercel VM Factory");
+    return;
+  }
   console.log("");
   console.log(color.cyan(" __     ____  __   _____           _                   "));
   console.log(color.cyan(" \\ \\   / /  \\/  | |  ___|_ _  ___| |_ ___  _ __ _   _ "));
@@ -830,25 +875,35 @@ function printKeyValue(key, value) {
 }
 
 async function askText(question, fallback = "") {
-  const suffix = fallback ? color.dim(` [${fallback}]`) : "";
-  const rl = createInterface({ input, output });
-  const answer = (
-    await rl.question(
-      `${color.cyan("?")} ${color.bold(question)}${suffix}\n${color.dim("> ")} `,
-    )
+  return String(
+    await promptResult(
+      p.text({
+        message: question,
+        placeholder: fallback || undefined,
+      }),
+    ),
   ).trim();
-  rl.close();
-  return answer;
 }
 
-function printChoices(title, choices) {
-  console.log("");
-  console.log(color.bold(title));
-  for (const [key, label, detail] of choices) {
-    const hint = detail ? ` ${color.dim(detail)}` : "";
-    console.log(`  ${color.cyan(key)}  ${label}${hint}`);
+async function askSecret(question, fallback = "") {
+  return String(
+    await promptResult(
+      p.password({
+        message: question,
+        mask: "*",
+        placeholder: fallback || undefined,
+      }),
+    ),
+  ).trim();
+}
+
+async function promptResult(resultPromise) {
+  const result = await resultPromise;
+  if (p.isCancel(result)) {
+    p.cancel("Operation cancelled.");
+    process.exit(0);
   }
-  console.log("");
+  return result;
 }
 
 function step(text) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vercel-vm-factory",
-  "version": "0.9.8",
+  "version": "0.11.8",
   "description": "Create Vercel Container deployments for ws-shell from selectable VM images.",
   "license": "MIT",
   "type": "module",
@@ -12,6 +12,9 @@
     "deploy-vm.mjs",
     "README.md"
   ],
+  "dependencies": {
+    "@clack/prompts": "^0.11.0"
+  },
   "scripts": {
     "deploy": "node deploy-vm.mjs create",
     "doctor": "node deploy-vm.mjs doctor",