@vltpkg/cli-js 1.4.0 → 1.6.0

package/{setup-TFM4GJF7.js → setup-SYYUEHZL.js}

@@ -11,38 +11,60 @@ import {createRequire as _vlt_createRequire} from "node:module";
 var require = _vlt_createRequire(import.meta.filename);
 import {
   stdout
-} from "./chunk-FZUYGJZU.js";
-import "./chunk-QCSUWACA.js";
-import "./chunk-G2YT2GWF.js";
-import "./chunk-5Y4SYLJ2.js";
+} from "./chunk-KVWGMSPW.js";
+import "./chunk-LGQVZTYR.js";
+import "./chunk-EYGOEAJM.js";
+import {
+  commandUsage
+} from "./chunk-HT6FS4VB.js";
 import {
   configWriteTarget,
   registrySelectionFields
-} from "./chunk-5RHABCYI.js";
-import "./chunk-TO23PR7J.js";
+} from "./chunk-LP3ORD3D.js";
+import "./chunk-LCLRP64K.js";
 import "./chunk-SRWDPPLX.js";
-import "./chunk-WGDTG44V.js";
 import {
-  normalizeRegistryURL
-} from "./chunk-THSYN5EK.js";
+  applyPathSetup,
+  ask,
+  editPathHint,
+  pathSetupChanged,
+  pathSetupFiles,
+  pathSetupLines,
+  planPathSetup,
+  rcList,
+  resolveGlobalBinDir,
+  sourceCommand
+} from "./chunk-O6MQ7NN6.js";
 import {
-  commandUsage
-} from "./chunk-LHPEBLOU.js";
-import "./chunk-I7UMHYZX.js";
+  detectShell,
+  prettyPath,
+  shellPathCommand
+} from "./chunk-BH5CVXNY.js";
+import "./chunk-JV5XR5JQ.js";
+import "./chunk-EMTGRCSE.js";
+import "./chunk-TQQO2F56.js";
 import "./chunk-4KCU2KZL.js";
-import "./chunk-PLG3OYCX.js";
-import "./chunk-5IJTPZXP.js";
-import "./chunk-WF6KLKRN.js";
+import "./chunk-WGDTG44V.js";
+import "./chunk-E74WGW5C.js";
+import "./chunk-GCTREKA4.js";
+import "./chunk-MCDLJZXT.js";
+import {
+  normalizeRegistryURL
+} from "./chunk-7M2VTFLP.js";
+import "./chunk-EFHOWRKU.js";
+import "./chunk-CAV7FKWQ.js";
+import "./chunk-6D3QAFNZ.js";
 import "./chunk-HTOTG4TS.js";
 import {
   RegistryClient,
   getKC,
   normalizeRegistryKey
-} from "./chunk-OAJ3PO3Z.js";
-import "./chunk-APMYKJI2.js";
-import "./chunk-SR2VOY5J.js";
-import "./chunk-ZJMJ7MCT.js";
-import "./chunk-U7TEQCBN.js";
+} from "./chunk-44AWMA4F.js";
+import "./chunk-QNHBAGXQ.js";
+import "./chunk-GEQFMH5M.js";
+import "./chunk-4GMNWW4C.js";
+import "./chunk-SUU2WETN.js";
+import "./chunk-B6RIGNEO.js";
 import "./chunk-XNLSTHDK.js";
 import "./chunk-6IF3RJND.js";
 import "./chunk-PDWPFR5T.js";
@@ -52,7 +74,7 @@ import {
   defaultRegistries,
   isErrorWithCause,
   isObject
-} from "./chunk-FLH4YC6W.js";
+} from "./chunk-BF5DRGRZ.js";
 import {
   error
 } from "./chunk-WZWDS3W4.js";
@@ -88,8 +110,43 @@ var accountAuthError = (account, er) => isErrorWithCause(er) && isObject(er.caus
   ].join("\n"),
   { code: "ECONFIG", cause: er }
 ) : asError(er);
+var pathView = (r, wizard = false) => {
+  if (r.status === "failed") {
+    return `\u26A0\uFE0F  Could not add the global bin folder to your PATH: ${r.message}`;
+  }
+  const dir = prettyPath(r.dir);
+  const rcs = rcList(r.files);
+  const keep = process.platform === "win32" ? [`  To keep it: ${editPathHint}`] : [];
+  switch (r.status) {
+    case "added":
+      return pathSetupLines(r, r.source).join("\n");
+    case "unchanged":
+      return [
+        `\u2705 ${dir} is already added to your PATH in ${rcs}`,
+        `   Open a new terminal, or run: ${r.source}`
+      ].join("\n");
+    case "in-path":
+      return wizard ? "" : `\u2705 ${dir} is already on your PATH`;
+    case "disabled":
+      return [
+        `\u2139\uFE0F  no-modify-path is set, so nothing was changed. To add ${dir} to your PATH, run:`,
+        `  ${r.command}`,
+        ...keep
+      ].join("\n");
+    case "cancelled":
+      if (wizard) {
+        return `\u2139\uFE0F  Skipped. Run \`vlt setup --path\` later to add ${dir} to your PATH.`;
+      }
+      return [
+        `Nothing changed. To add ${dir} to your PATH, run:`,
+        `  ${r.command}`,
+        ...keep
+      ].join("\n");
+  }
+};
 var views = {
   human: (result) => {
+    if (!("account" in result)) return pathView(result.path);
     const lines = [
       `Configured ${Object.keys(result.registries).length} registry ${Object.keys(result.registries).length === 1 ? "alias" : "aliases"} for "${result.account}" in ${result.which} config:`
     ];
@@ -104,6 +161,8 @@ var views = {
         "to configure this project instead."
       );
     }
+    const path = result.path && pathView(result.path, true);
+    if (path) lines.push("", path);
     lines.push(
       "",
       "You can now install packages, e.g.:",
@@ -114,7 +173,10 @@ var views = {
 };
 var usage = () => commandUsage({
   command: "setup",
-  usage: "[<account>]",
+  usage: [
+    "[<account>]",
+    "--path [--yes] [--global-bin-dir=<path>]"
+  ],
   description: `Configure the registry aliases for your vlt.io account so
                   that \`vlt install\` and \`vlx\` work out of the box.
 
@@ -122,7 +184,19 @@ var usage = () => commandUsage({
                   authenticates against your account, stores the token
                   for both the \`npm\` and \`main\` registries, and writes
                   those aliases (and any additional aliases you add) to
-                  your user \`vlt.json\`.`,
+                  your user \`vlt.json\`.
+
+                  In a terminal, if the global bin folder isn't on
+                  your \`PATH\` or set up yet, it ends by asking
+                  \`Setup PATH for global installs? (Y/n)\`: yes adds
+                  it (same as \`--path\`), no skips it. Run
+                  \`vlt setup --path\` later to do just that step.
+
+                  With \`--path\`, add the global bin folder
+                  (\`--global-bin-dir\`) to your \`PATH\` instead: writes
+                  \`<global-dir>/env\` and a marked section that loads
+                  it into your shell config. On Windows it adds it to
+                  your user \`Path\` (\`HKCU\\Environment\`).`,
   options: {
     config: {
       value: "<user | project>",
@@ -133,15 +207,119 @@ var usage = () => commandUsage({
       description: "Additional registry aliases to stage non-interactively. Combine with `--yes` to run setup unattended."
     },
     yes: {
-      description: "Skip interactive prompts (requires <account> and does not open a browser for authentication)."
+      description: "Skip interactive prompts (requires <account> and does not open a browser for authentication). With --path: edit without asking. Without --path: skips the PATH prompt."
+    },
+    path: {
+      description: "Only add the global bin folder to your PATH via your shell config (user Path on Windows)."
+    },
+    "global-bin-dir": {
+      value: "<path>",
+      description: "The folder to add to your PATH."
     }
   }
 });
+var runPathSetup = async (o) => {
+  const root = o.globalDir;
+  const bin = await resolveGlobalBinDir({
+    projectRoot: root,
+    globalBinDir: o.globalBinDir
+  });
+  const shell = detectShell();
+  const base = {
+    dir: bin.dir,
+    shell,
+    files: [],
+    backups: [],
+    command: shellPathCommand(shell, bin.dir),
+    source: sourceCommand(shell, root, bin.dir)
+  };
+  if (bin.inPath) {
+    return { ...base, status: "in-path" };
+  }
+  if (o.noModifyPath) {
+    return { ...base, status: "disabled" };
+  }
+  const opts = { globalDir: root, dir: bin.dir, shell };
+  let plan = await planPathSetup(opts);
+  const files = pathSetupFiles(plan);
+  if (!pathSetupChanged(plan)) {
+    return { ...base, status: "unchanged", files };
+  }
+  if (!o.yes) {
+    if (!process.stdin.isTTY) {
+      throw error(
+        "Not a terminal: pass --yes to add it to your PATH",
+        {
+          code: "EUSAGE"
+        }
+      );
+    }
+    const answer = await (o.ask ?? ask)(
+      o.question({ dir: prettyPath(bin.dir), rcs: rcList(files) })
+    ).catch((er) => {
+      if (asError(er).name !== "AbortError") throw er;
+      process.stdout.write("\n");
+      return "n";
+    });
+    if (/^n/i.test(answer)) {
+      return { ...base, status: "cancelled", files };
+    }
+    plan = await planPathSetup(opts);
+  }
+  const r = await applyPathSetup(plan);
+  return {
+    ...base,
+    status: "added",
+    files: r.files,
+    backups: r.backups
+  };
+};
+var setupPath = async (conf, root) => {
+  if (conf.positionals.length) {
+    throw error("`vlt setup --path` takes no arguments", {
+      code: "EUSAGE",
+      found: conf.positionals[0]
+    });
+  }
+  return {
+    path: await runPathSetup({
+      globalDir: root,
+      globalBinDir: conf.globalBinDir,
+      yes: !!conf.get("yes"),
+      noModifyPath: !!conf.get("no-modify-path"),
+      question: ({ dir, rcs }) => `Add ${dir} to your PATH in ${rcs}? (Y/n) `
+    })
+  };
+};
+var offerPath = async (conf, yes, ask2) => {
+  if (yes || !process.stdin.isTTY || conf.get("no-modify-path")) {
+    return;
+  }
+  const g = conf.globalProject();
+  if (!g) return;
+  try {
+    return await runPathSetup({
+      globalDir: g.root,
+      globalBinDir: g.binDir,
+      question: () => "Setup PATH for global installs? (Y/n) ",
+      ask: ask2
+    });
+  } catch (er) {
+    const e = asError(er);
+    const found = isErrorWithCause(e) && isObject(e.cause) && typeof e.cause.found === "string" ? prettyPath(e.cause.found) : void 0;
+    return {
+      status: "failed",
+      message: found && !e.message.includes(found) ? `${e.message}: ${found}` : e.message
+    };
+  }
+};
 var command = async (conf) => {
+  const root = conf.globalRoot;
+  if (root) return setupPath(conf, root);
   const yes = !!conf.get("yes");
   const which = configWriteTarget(conf, "user");
   let rl;
-  const ask = async (question) => {
+  const ask2 = async (question) => {
     rl ??= createInterface(process.stdin, process.stdout);
     return (await rl.question(question)).trim();
   };
@@ -157,7 +335,7 @@ var command = async (conf) => {
           { code: "ECONFIG" }
         );
       }
-      account = await ask("vlt.io account or organization slug: ");
+      account = await ask2("vlt.io account or organization slug: ");
       if (!account) {
         throw error("No account slug provided.", { code: "ECONFIG" });
       }
@@ -180,7 +358,7 @@ var command = async (conf) => {
     }
     const rc = new RegistryClient(conf.options);
     if (!yes) {
-      const doAuth = await ask(
+      const doAuth = await ask2(
         "Authenticate with your vlt.io account now? (Y/n) "
       );
       if (!/^n/i.test(doAuth)) {
@@ -200,9 +378,9 @@ var command = async (conf) => {
         }
       }
       for (; ; ) {
-        const more = await ask("Add another registry alias? (y/N) ");
+        const more = await ask2("Add another registry alias? (y/N) ");
         if (!/^y/i.test(more)) break;
-        const name = await ask("  alias name: ");
+        const name = await ask2("  alias name: ");
         if (!name) {
           stdout("  alias name is required, skipping.");
           continue;
@@ -211,14 +389,14 @@ var command = async (conf) => {
           stdout(`  alias "${name}" is already staged, skipping.`);
           continue;
         }
-        const url = await ask("  registry url: ");
+        const url = await ask2("  registry url: ");
         if (!url) {
           stdout("  registry url is required, skipping.");
           continue;
         }
         const normalized = normalizeRegistryURL(url);
         registries[name] = normalized;
-        const auth = await ask(
+        const auth = await ask2(
           `  authenticate against "${name}" now? (y/N) `
         );
         if (/^y/i.test(auth)) {
@@ -231,11 +409,13 @@ var command = async (conf) => {
     const shadowedByProject = which === "user" && registrySelectionFields.some(
       (f) => f in (conf.layers.project ?? {})
     );
+    const path = await offerPath(conf, yes, ask2);
     return {
       account,
       which,
       registries,
-      ...shadowedByProject ? { shadowedByProject } : void 0
+      ...shadowedByProject ? { shadowedByProject } : void 0,
+      ...path ? { path } : void 0
     };
   } finally {
     if (rl) {