@vltpkg/cli-sdk 1.4.0 → 1.6.0

package/dist/shell.js

@@ -0,0 +1,110 @@
+import { existsSync } from 'node:fs';
+import { homedir } from 'node:os';
+const shells = new Map([
+    ['bash', 'bash'],
+    ['zsh', 'zsh'],
+    ['fish', 'fish'],
+    ['nu', 'nu'],
+    ['pwsh', 'pwsh'],
+    ['powershell', 'pwsh'],
+    ['sh', 'sh'],
+    ['dash', 'sh'],
+    ['ksh', 'sh'],
+    ['mksh', 'sh'],
+    ['ash', 'sh'],
+]);
+const isSep = (c, win32) => c === '/' || (win32 && c === '\\');
+// rest of `path` after `home`: '' for home itself, undefined outside
+const homeRest = (path, home, win32) => !home ? undefined
+    : path === home ? ''
+        : path.startsWith(home) && isSep(path[home.length], win32) ?
+            path.slice(home.length)
+            : undefined;
+/** `~/x` for a path under the home dir */
+export const prettyPath = (path, home = homedir(), win32 = process.platform === 'win32') => {
+    const rest = homeRest(path, home, win32);
+    return rest === undefined ? path : `~${rest}`;
+};
+/** the user's shell, from `SHELL`, or a guess on win32 */
+export const detectShell = (env = process.env, platform = process.platform) => {
+    const { SHELL } = env;
+    if (SHELL) {
+        const name = SHELL.replace(/^.*[\\/]/, '')
+            .replace(/\.exe$/i, '')
+            .toLowerCase();
+        return shells.get(name) ?? 'unknown';
+    }
+    if (platform !== 'win32')
+        return 'unknown';
+    // set machine-wide, PowerShell adds the user module dir
+    const mods = (env.PSModulePath ?? '').split(';').filter(Boolean);
+    return mods.length >= 3 ? 'pwsh' : 'cmd';
+};
+const opts = ({ env = process.env, platform = process.platform, home = homedir(), }) => ({
+    env,
+    platform,
+    home,
+    win32: platform === 'win32',
+});
+const escape = (s, chars, esc = '\\') => s.replace(chars, c => esc + c);
+// `$HOME/x`, or the path, `/c/x` style on win32
+const posixInner = (dir, o, chars) => {
+    const { home, win32 } = opts(o);
+    const slash = (p) => (win32 ? p.replace(/\\/g, '/') : p);
+    const rest = homeRest(dir, home, win32);
+    if (rest !== undefined)
+        return '$HOME' + escape(slash(rest), chars);
+    const p = win32 ?
+        slash(dir).replace(/^([a-z]):/i, (_, d) => `/${d.toLowerCase()}`)
+        : dir;
+    return escape(p, chars);
+};
+const shChars = /[\\"$`]/g;
+/** `dir` double-quoted for a POSIX shell, `$HOME` late-bound */
+export const posixPath = (dir, o = {}) => `"${posixInner(dir, o, shChars)}"`;
+/** `dir` double-quoted for fish, `$HOME` late-bound */
+export const fishPath = (dir, o = {}) => `"${posixInner(dir, o, /[\\"$]/g)}"`;
+/** the line that adds `dir` to the `PATH` in `shell` */
+export const shellPathCommand = (shell, dir, o = {}) => {
+    const { home, win32 } = opts(o);
+    const rest = homeRest(dir, home, win32);
+    switch (shell) {
+        case 'fish':
+            return `fish_add_path ${fishPath(dir, o)}`;
+        case 'nu':
+            return `$env.PATH = ($env.PATH | prepend "${escape(dir, /[\\"]/g)}")`;
+        case 'pwsh': {
+            const p = rest === undefined ?
+                escape(dir, /[`"$]/g, '`')
+                : '$HOME' + escape(rest, /[`"$]/g, '`');
+            return `$env:PATH += "${win32 ? ';' : ':'}${p}"`;
+        }
+        case 'cmd':
+            return `set "PATH=%PATH%;${rest === undefined ? dir : '%USERPROFILE%' + rest}"`;
+        default:
+            return `export PATH="${posixInner(dir, o, shChars)}:$PATH"`;
+    }
+};
+/** rc file to add the `PATH` line to, for display */
+export const shellRcFile = (shell, o = {}) => {
+    const { env, platform, home, win32 } = opts(o);
+    switch (shell) {
+        case 'zsh':
+            return prettyPath(`${env.ZDOTDIR || home}/.zshrc`, home, win32);
+        case 'bash': {
+            const has = (f) => existsSync(`${home}/${f}`);
+            // like `vlt setup --path`: never a new .bashrc
+            if (platform !== 'darwin' && has('.bashrc'))
+                return '~/.bashrc';
+            // a new .bash_profile would shadow .profile
+            const f = ['.bash_profile', '.bash_login'].find(has);
+            return `~/${f ?? '.profile'}`;
+        }
+        case 'sh':
+            return env.ENV ? prettyPath(env.ENV, home, win32) : '~/.profile';
+        case 'pwsh':
+            return '$PROFILE';
+        default:
+            return undefined;
+    }
+};

package/dist/skills-prompt.d.ts

@@ -0,0 +1,28 @@
+/** Streams to prompt on; default stdin and stdout. */
+export type PromptStreams = {
+    input?: NodeJS.ReadableStream;
+    output?: NodeJS.WritableStream;
+};
+/** Prompts can be answered: stdin is a TTY. */
+export declare const interactive: () => boolean;
+/**
+ * `[y/N]` question: true on `y`/`yes` (any case), else false. Closed
+ * input (EOF, ctrl+C/D): undefined (cancel).
+ */
+export declare const confirm: (question: string, s?: PromptStreams) => Promise<boolean | undefined>;
+export type EditQueryOptions = PromptStreams & {
+    /** stored query, shown above the prompt; unset: nothing stored */
+    current?: string;
+    /** editable answer */
+    prefill: string;
+    /**
+     * throws on an invalid query: its message is printed and the
+     * question asked again
+     */
+    check: (q: string) => Promise<unknown>;
+};
+/**
+ * Ask for a new `allow-skills`, prefilled. Empty answer or closed
+ * input: undefined (cancel).
+ */
+export declare const editQuery: ({ current, prefill, check, ...s }: EditQueryOptions) => Promise<string | undefined>;

package/dist/skills-prompt.js

@@ -0,0 +1,78 @@
+import { createInterface } from 'node:readline/promises';
+import { asError } from '@vltpkg/types';
+import { styleTextStdout } from "./output.js";
+/** Prompts can be answered: stdin is a TTY. */
+export const interactive = () => process.stdin.isTTY;
+const open = (s) => {
+    const rl = createInterface({
+        input: s.input ?? process.stdin,
+        output: s.output ?? process.stdout,
+        // prefill and line editing
+        terminal: true,
+    });
+    // ctrl+C cancels
+    rl.on('SIGINT', () => rl.close());
+    let done = false;
+    const closed = new Promise(r => rl.once('close', () => {
+        done = true;
+        r(undefined);
+    }));
+    // the answer; undefined once the input is closed (EOF, ctrl+C/D)
+    const ask = async (query, prefill) => {
+        if (done)
+            return undefined;
+        const q = rl.question(query).catch(() => undefined);
+        if (prefill)
+            rl.write(prefill);
+        return Promise.race([q, closed]);
+    };
+    return { rl, ask };
+};
+/**
+ * `[y/N]` question: true on `y`/`yes` (any case), else false. Closed
+ * input (EOF, ctrl+C/D): undefined (cancel).
+ */
+export const confirm = async (question, s = {}) => {
+    const { rl, ask } = open(s);
+    try {
+        const a = await ask(question);
+        return a === undefined ? undefined : /^y(es)?$/i.test(a.trim());
+    }
+    finally {
+        rl.close();
+    }
+};
+/**
+ * Ask for a new `allow-skills`, prefilled. Empty answer or closed
+ * input: undefined (cancel).
+ */
+export const editQuery = async ({ current, prefill, check, ...s }) => {
+    const output = s.output ?? process.stdout;
+    if (current !== undefined) {
+        output.write('\n⚠️ The new allow-skills replaces the current one. Make sure it still\n' +
+            'selects every skill you want: skills it no longer selects are unlinked.\n\n' +
+            styleTextStdout('yellow', `Current allow-skills: ${current}`) +
+            '\n');
+    }
+    const prompt = styleTextStdout('cyan', 'New allow-skills: ');
+    const { rl, ask } = open(s);
+    try {
+        let fill = prefill;
+        for (;;) {
+            const a = (await ask(prompt, fill))?.trim();
+            if (!a)
+                return undefined;
+            try {
+                await check(a);
+                return a;
+            }
+            catch (e) {
+                output.write(`${asError(e).message}\n`);
+                fill = a;
+            }
+        }
+    }
+    finally {
+        rl.close();
+    }
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vltpkg/cli-sdk",
   "description": "The source for the vlt CLI",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vltpkg/vltpkg.git",
@@ -14,33 +14,35 @@
   },
   "dependencies": {
     "@resvg/resvg-wasm": "^2.6.2",
-    "@vltpkg/config": "1.4.0",
-    "@vltpkg/dep-id": "1.4.0",
-    "@vltpkg/dot-prop": "1.4.0",
-    "@vltpkg/error-cause": "1.4.0",
-    "@vltpkg/git": "1.4.0",
-    "@vltpkg/graph": "1.4.0",
-    "@vltpkg/graph-run": "1.4.0",
-    "@vltpkg/init": "1.4.0",
-    "@vltpkg/output": "1.4.0",
-    "@vltpkg/package-info": "1.4.0",
-    "@vltpkg/package-json": "1.4.0",
-    "@vltpkg/pick-manifest": "1.4.0",
-    "@vltpkg/promise-spawn": "1.4.0",
-    "@vltpkg/query": "1.4.0",
-    "@vltpkg/registry-client": "1.4.0",
-    "@vltpkg/rollback-remove": "1.4.0",
-    "@vltpkg/run": "1.4.0",
-    "@vltpkg/security-archive": "1.4.0",
-    "@vltpkg/semver": "1.4.0",
-    "@vltpkg/spec": "1.4.0",
-    "@vltpkg/tar": "1.4.0",
-    "@vltpkg/types": "1.4.0",
-    "@vltpkg/url-open": "1.4.0",
-    "@vltpkg/vlt-json": "1.4.0",
-    "@vltpkg/vlx": "1.4.0",
-    "@vltpkg/workspaces": "1.4.0",
-    "@vltpkg/xdg": "1.4.0",
+    "@vltpkg/cmd-shim": "1.6.0",
+    "@vltpkg/config": "1.6.0",
+    "@vltpkg/dep-id": "1.6.0",
+    "@vltpkg/dot-prop": "1.6.0",
+    "@vltpkg/error-cause": "1.6.0",
+    "@vltpkg/git": "1.6.0",
+    "@vltpkg/graph": "1.6.0",
+    "@vltpkg/graph-run": "1.6.0",
+    "@vltpkg/init": "1.6.0",
+    "@vltpkg/output": "1.6.0",
+    "@vltpkg/package-info": "1.6.0",
+    "@vltpkg/package-json": "1.6.0",
+    "@vltpkg/pick-manifest": "1.6.0",
+    "@vltpkg/promise-spawn": "1.6.0",
+    "@vltpkg/query": "1.6.0",
+    "@vltpkg/registry-client": "1.6.0",
+    "@vltpkg/rollback-remove": "1.6.0",
+    "@vltpkg/run": "1.6.0",
+    "@vltpkg/security-archive": "1.6.0",
+    "@vltpkg/semver": "1.6.0",
+    "@vltpkg/spec": "1.6.0",
+    "@vltpkg/tar": "1.6.0",
+    "@vltpkg/types": "1.6.0",
+    "@vltpkg/url-open": "1.6.0",
+    "@vltpkg/vlt-json": "1.6.0",
+    "@vltpkg/vlx": "1.6.0",
+    "@vltpkg/which": "1.6.0",
+    "@vltpkg/workspaces": "1.6.0",
+    "@vltpkg/xdg": "1.6.0",
     "ansi-to-pre": "^1.0.6",
     "beautiful-mermaid": "^1.1.3",
     "chalk": "^5.6.2",