@vltpkg/cli-sdk 0.0.0-10

package/LICENSE

@@ -0,0 +1,15 @@
+Copyright (c) vlt technology, Inc.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+   Subject to the terms and conditions of this license, each copyright holder and contributor hereby grants to those receiving rights under this license a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except for failure to satisfy the conditions of this license) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer this software, where such license applies only to those patent claims, already acquired or hereafter acquired, licensable by such copyright holder or contributor that are necessarily infringed by:
+
+(a) their Contribution(s) (the licensed copyrights of copyright holders and non-copyrightable additions of contributors, in source or binary form) alone; or
+(b) combination of their Contribution(s) with the work of authorship to which such Contribution(s) was added by such copyright holder or contributor, if, at the time the Contribution is added, such addition causes such combination to be necessarily infringed. The patent license shall not apply to any other combinations which include the Contribution.
+Except as expressly stated above, no rights or licenses from any copyright holder or contributor is granted under this license, whether expressly, by implication, estoppel or otherwise.
+
+DISCLAIMER
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,23 @@
+![vlt](https://github.com/user-attachments/assets/345949ff-7150-4b97-856d-c7e42c2a4db5)
+
+# @vltpkg/cli-sdk
+
+The SDK for the `vlt` command line interface.
+
+## Usage
+
+```ts
+import vlt from '@vltpkg/cli-sdk'
+process.argv.splice(2, 0, '--version')
+await vlt()
+```
+
+```ts
+import vlt from '@vltpkg/cli-sdk'
+process.chdir('/some/vlt/project')
+process.argv.splice(2, 0, 'install')
+await vlt()
+```
+
+Visit [docs.vlt.sh](https://docs.vlt.sh) to see the full
+documentation.

package/dist/esm/commands/cache.d.ts

@@ -0,0 +1,65 @@
+import { CacheEntry } from '@vltpkg/registry-client';
+import type { LoadedConfig } from '../config/index.ts';
+import type { CommandFn, CommandUsage } from '../index.ts';
+import type { ViewOptions, Views } from '../view.ts';
+import { ViewClass } from '../view.ts';
+export type CacheMap = Record<string, ReturnType<CacheEntry['toJSON']>>;
+export type CacheSubcommands = keyof (typeof usageDef)['subcommands'];
+export declare class CacheView extends ViewClass {
+    constructor(options: ViewOptions, conf: LoadedConfig);
+    stdout(...args: unknown[]): void;
+}
+export declare const views: Views<void | CacheMap>;
+declare const usageDef: {
+    readonly command: "cache";
+    readonly usage: "<command> [flags]";
+    readonly description: "Work with vlt cache folders";
+    readonly subcommands: {
+        readonly add: {
+            readonly usage: "<package-spec> [<package-spec>...]";
+            readonly description: "Resolve the referenced package identifiers and ensure they\n                    are cached.";
+        };
+        readonly ls: {
+            readonly usage: "[<key>...]";
+            readonly description: "Show cache entries. If no keys are provided, then a list of\n                    available keys will be printed. If one or more keys are\n                    provided, then details will be shown for the specified\n                    items.";
+        };
+        readonly info: {
+            readonly usage: "<key>";
+            readonly description: "Print metadata details for the specified cache key to\n                    stderr, and the response body to stdout.";
+        };
+        readonly clean: {
+            readonly usage: "[<key>...]";
+            readonly description: "Purge expired cache entries. If one or more keys are\n                    provided, then only those cache entries will be\n                    considered.";
+        };
+        readonly delete: {
+            readonly usage: "<key> [<key>...]";
+            readonly description: "Purge items explicitly, whether expired or not.  If one or\n                    more keys are provided, then only those cache entries will\n                    be considered.";
+        };
+        readonly 'delete-before': {
+            readonly usage: "<date>";
+            readonly description: "Purge all cache items from before a given date. Date can be\n                    provided in any format that JavaScript can parse.";
+        };
+        readonly 'delete-all': {
+            readonly usage: "";
+            readonly description: "Delete the entire cache folder to make vlt slower.";
+        };
+    };
+    readonly examples: {
+        readonly 'vlt cache ls https://registry.npmjs.org/typescript': {
+            readonly description: "Show cache metadata for a given registry URL";
+        };
+        readonly 'vlt cache add eslint@latest': {
+            readonly description: "Add a given package specifier to the cache by fetching\n                    its resolved value.";
+        };
+        readonly 'vlt cache info https://registry.npmjs.org/eslint/-/eslint-9.25.1.tgz > eslint.tgz': {
+            readonly description: "Print the cache metadata to stderr, and write the tarball\n                    on stdout, redirecting to a file.";
+        };
+        readonly 'vlt cache delete-before 2025-01-01': {
+            readonly description: "Delete all entries created before Jan 1, 2025";
+        };
+    };
+};
+export declare const usage: CommandUsage;
+export declare const command: CommandFn<void | CacheMap>;
+export {};
+//# sourceMappingURL=cache.d.ts.map

package/dist/esm/commands/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../../../src/commands/cache.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAIpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGtD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1D,OAAO,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,MAAM,MAAM,QAAQ,GAAG,MAAM,CAC3B,MAAM,EACN,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CACjC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,OAAO,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAA;AAGrE,qBAAa,SAAU,SAAQ,SAAS;gBAC1B,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY;IAIpD,MAAM,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;CAG1B;AAED,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,QAAQ,CAExC,CAAA;AAED,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoE6B,CAAA;AAE3C,eAAO,MAAM,KAAK,EAAE,YAA2C,CAAA;AAE/D,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,IAAI,GAAG,QAAQ,CAgC9C,CAAA"}

package/dist/esm/commands/cache.js

@@ -0,0 +1,256 @@
+import { error } from '@vltpkg/error-cause';
+import { CacheEntry } from '@vltpkg/registry-client';
+import { Spec } from '@vltpkg/spec';
+import { mkdir, rm } from 'node:fs/promises';
+import prettyBytes from 'pretty-bytes';
+import { commandUsage } from "../config/usage.js";
+import { stderr, stdout } from "../output.js";
+import { ViewClass } from "../view.js";
+let view;
+export class CacheView extends ViewClass {
+    constructor(options, conf) {
+        super(options, conf);
+        view = this;
+    }
+    stdout(...args) {
+        stdout(...args);
+    }
+}
+export const views = {
+    human: CacheView,
+};
+const usageDef = {
+    command: 'cache',
+    usage: '<command> [flags]',
+    description: 'Work with vlt cache folders',
+    subcommands: {
+        add: {
+            usage: '<package-spec> [<package-spec>...]',
+            description: `Resolve the referenced package identifiers and ensure they
+                    are cached.`,
+        },
+        ls: {
+            usage: '[<key>...]',
+            description: `Show cache entries. If no keys are provided, then a list of
+                    available keys will be printed. If one or more keys are
+                    provided, then details will be shown for the specified
+                    items.`,
+        },
+        info: {
+            usage: '<key>',
+            description: `Print metadata details for the specified cache key to
+                    stderr, and the response body to stdout.`,
+        },
+        clean: {
+            usage: '[<key>...]',
+            description: `Purge expired cache entries. If one or more keys are
+                    provided, then only those cache entries will be
+                    considered.`,
+        },
+        delete: {
+            usage: '<key> [<key>...]',
+            description: `Purge items explicitly, whether expired or not.  If one or
+                    more keys are provided, then only those cache entries will
+                    be considered.`,
+        },
+        'delete-before': {
+            usage: '<date>',
+            description: `Purge all cache items from before a given date. Date can be
+                    provided in any format that JavaScript can parse.`,
+        },
+        'delete-all': {
+            usage: '',
+            description: `Delete the entire cache folder to make vlt slower.`,
+        },
+    },
+    examples: {
+        'vlt cache ls https://registry.npmjs.org/typescript': {
+            description: `Show cache metadata for a given registry URL`,
+        },
+        'vlt cache add eslint@latest': {
+            description: `Add a given package specifier to the cache by fetching
+                    its resolved value.`,
+        },
+        'vlt cache info https://registry.npmjs.org/eslint/-/eslint-9.25.1.tgz > eslint.tgz': {
+            description: `Print the cache metadata to stderr, and write the tarball
+                    on stdout, redirecting to a file.`,
+        },
+        'vlt cache delete-before 2025-01-01': {
+            description: 'Delete all entries created before Jan 1, 2025',
+        },
+    },
+};
+export const usage = () => commandUsage(usageDef);
+export const command = async (conf) => {
+    const [sub, ...args] = conf.positionals;
+    switch (sub) {
+        case 'ls':
+            return ls(conf, args, view);
+        case 'info':
+            return info(conf, args, view);
+        case 'add':
+            return add(conf, args, view);
+        case 'clean':
+            return clean(conf, args, view);
+        case 'delete':
+            return deleteKeys(conf, args, view);
+        case 'delete-before':
+            return deleteBefore(conf, args, view);
+        case 'delete-all':
+            return deleteAll(conf, args, view);
+        default: {
+            throw error('Unrecognized cache command', {
+                code: 'EUSAGE',
+                found: sub,
+                validOptions: Object.keys(usageDef.subcommands),
+            });
+        }
+    }
+};
+const ls = async (conf, keys, view) => keys.length ?
+    await fetchKeys(conf, keys, (entry, key) => {
+        view?.stdout(key.includes(' ') ? JSON.stringify(key) : key, entry);
+        return true;
+    }, view)
+    : await fetchAll(conf, (_, key) => {
+        view?.stdout(key.includes(' ') ? JSON.stringify(key) : key);
+        return true;
+    });
+const info = async (conf, keys, view) => {
+    const [key] = keys;
+    if (keys.length !== 1 || !key) {
+        throw error('Must provide exactly one cache key', {
+            code: 'EUSAGE',
+        });
+    }
+    await fetchKeys(conf, [key], (entry, key) => {
+        stderr(
+        /* c8 ignore next */
+        key.includes(' ') ? JSON.stringify(key) : key, entry);
+        if (entry.isJSON) {
+            stdout(JSON.stringify(entry.body, null, 2));
+            /* c8 ignore start - annoying to test, corrupts TAP output */
+        }
+        else {
+            process.stdout.write(entry.body);
+        }
+        /* c8 ignore stop */
+        return true;
+    }, view);
+};
+const fetchAll = async (conf, test) => {
+    const rc = conf.options.packageInfo.registryClient;
+    const { cache } = rc;
+    const map = {};
+    for await (const [key, val] of cache) {
+        const entry = CacheEntry.decode(val);
+        if (!test(entry, key, val))
+            continue;
+        map[key] = entry.toJSON();
+    }
+    return map;
+};
+const fetchKeys = async (conf, keys, test, view) => {
+    const rc = conf.options.packageInfo.registryClient;
+    const { cache } = rc;
+    const map = {};
+    const results = await Promise.all(keys.map(async (key) => {
+        return [key, await cache.fetch(key)];
+    }));
+    for (const [key, val] of results) {
+        if (!val) {
+            view?.stdout('Not found:', key);
+        }
+        else {
+            const entry = CacheEntry.decode(val);
+            if (!test(entry, key, val))
+                continue;
+            map[key] = entry.toJSON();
+        }
+    }
+    return map;
+};
+const deleteEntries = async (conf, keys, test, view) => {
+    const rc = conf.options.packageInfo.registryClient;
+    const { cache } = rc;
+    let count = 0;
+    let size = 0;
+    const testAction = (entry, key, val) => {
+        if (!test(entry)) {
+            return false;
+        }
+        count++;
+        const s = val.byteLength + key.length;
+        cache.delete(key, true, entry.integrity);
+        const k = key.includes(' ') ? JSON.stringify(key) : key;
+        view?.stdout('-', k, s);
+        size += s;
+        return true;
+    };
+    const map = await (keys.length ?
+        fetchKeys(conf, keys, testAction, view)
+        : fetchAll(conf, testAction));
+    const pb = prettyBytes(size, { binary: true });
+    const s = count === 1 ? '' : 's';
+    await cache.promise();
+    view?.stdout(`Removed ${count} item${s} totalling ${pb}`);
+    return map;
+};
+const clean = async (conf, keys, view) => deleteEntries(conf, keys, entry => !entry.valid, view);
+const deleteBefore = async (conf, args, view) => {
+    if (!args.length) {
+        throw error('Must provide a date to delete before', {
+            code: 'EUSAGE',
+        });
+    }
+    const now = new Date();
+    const before = new Date(args.join(' '));
+    if (before >= now) {
+        throw error('Cannot delete cache entries from the future', {
+            code: 'EUSAGE',
+            found: before,
+        });
+    }
+    return deleteEntries(conf, [], entry => !!entry.date && entry.date < before, view);
+};
+const deleteKeys = async (conf, keys, view) => {
+    if (!keys.length) {
+        throw error('Must provide cache keys to delete', {
+            code: 'EUSAGE',
+        });
+    }
+    return deleteEntries(conf, keys, () => true, view);
+};
+const deleteAll = async (conf, _, view) => {
+    const { cache } = conf.options.packageInfo.registryClient;
+    await rm(cache.path(), { recursive: true, force: true });
+    await mkdir(cache.path(), { recursive: true });
+    view?.stdout('Deleted all cache entries.');
+};
+const add = async (conf, specs, view) => {
+    if (!specs.length) {
+        throw error('Must provide specs to add to the cache', {
+            code: 'EUSAGE',
+        });
+    }
+    const { packageInfo } = conf.options;
+    const promises = [];
+    for (const spec of specs) {
+        const p = packageInfo
+            .resolve(Spec.parseArgs(spec, conf.options), {
+            staleWhileRevalidate: false,
+        })
+            .then(async (r) => {
+            const { resolved, integrity } = r;
+            await packageInfo.registryClient.request(resolved, {
+                ...conf.options,
+                integrity,
+                staleWhileRevalidate: false,
+            });
+            view?.stdout('+', spec, r.resolved);
+        });
+        promises.push(p);
+    }
+    await Promise.all(promises);
+};
+//# sourceMappingURL=cache.js.map

package/dist/esm/commands/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../../../src/commands/cache.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AACpD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,kBAAkB,CAAA;AAC5C,OAAO,WAAW,MAAM,cAAc,CAAA;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAE7C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAStC,IAAI,IAAe,CAAA;AACnB,MAAM,OAAO,SAAU,SAAQ,SAAS;IACtC,YAAY,OAAoB,EAAE,IAAkB;QAClD,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;QACpB,IAAI,GAAG,IAAI,CAAA;IACb,CAAC;IACD,MAAM,CAAC,GAAG,IAAe;QACvB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAA;IACjB,CAAC;CACF;AAED,MAAM,CAAC,MAAM,KAAK,GAA2B;IAC3C,KAAK,EAAE,SAAS;CACjB,CAAA;AAED,MAAM,QAAQ,GAAG;IACf,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,6BAA6B;IAE1C,WAAW,EAAE;QACX,GAAG,EAAE;YACH,KAAK,EAAE,oCAAoC;YAC3C,WAAW,EAAE;gCACa;SAC3B;QAED,EAAE,EAAE;YACF,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE;;;2BAGQ;SACtB;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,OAAO;YACd,WAAW,EAAE;6DAC0C;SACxD;QAED,KAAK,EAAE;YACL,KAAK,EAAE,YAAY;YACnB,WAAW,EAAE;;gCAEa;SAC3B;QAED,MAAM,EAAE;YACN,KAAK,EAAE,kBAAkB;YACzB,WAAW,EAAE;;mCAEgB;SAC9B;QAED,eAAe,EAAE;YACf,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE;sEACmD;SACjE;QAED,YAAY,EAAE;YACZ,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,oDAAoD;SAClE;KACF;IACD,QAAQ,EAAE;QACR,oDAAoD,EAAE;YACpD,WAAW,EAAE,8CAA8C;SAC5D;QACD,6BAA6B,EAAE;YAC7B,WAAW,EAAE;wCACqB;SACnC;QACD,mFAAmF,EACjF;YACE,WAAW,EAAE;sDACiC;SAC/C;QACH,oCAAoC,EAAE;YACpC,WAAW,EAAE,+CAA+C;SAC7D;KACF;CACwC,CAAA;AAE3C,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;AAE/D,MAAM,CAAC,MAAM,OAAO,GAA+B,KAAK,EAAC,IAAI,EAAC,EAAE;IAC9D,MAAM,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,WAAW,CAAA;IACvC,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,IAAI;YACP,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAE7B,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAE/B,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAE9B,KAAK,OAAO;YACV,OAAO,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAEhC,KAAK,QAAQ;YACX,OAAO,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAErC,KAAK,eAAe;YAClB,OAAO,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAEvC,KAAK,YAAY;YACf,OAAO,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAA;QAEpC,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,KAAK,CAAC,4BAA4B,EAAE;gBACxC,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG;gBACV,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC;aAChD,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,EAAE,GAAG,KAAK,EACd,IAAkB,EAClB,IAAc,EACd,IAAgB,EACG,EAAE,CACrB,IAAI,CAAC,MAAM,CAAC,CAAC;IACX,MAAM,SAAS,CACb,IAAI,EACJ,IAAI,EACJ,CAAC,KAAiB,EAAE,GAAW,EAAE,EAAE;QACjC,IAAI,EAAE,MAAM,CACV,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAC7C,KAAK,CACN,CAAA;QACD,OAAO,IAAI,CAAA;IACb,CAAC,EACD,IAAI,CACL;IACH,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE;QAC9B,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QAC3D,OAAO,IAAI,CAAA;IACb,CAAC,CAAC,CAAA;AAEN,MAAM,IAAI,GAAG,KAAK,EAChB,IAAkB,EAClB,IAAc,EACd,IAAgB,EACD,EAAE;IACjB,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAClB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QAC9B,MAAM,KAAK,CAAC,oCAAoC,EAAE;YAChD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,SAAS,CACb,IAAI,EACJ,CAAC,GAAG,CAAC,EACL,CAAC,KAAiB,EAAE,GAAW,EAAE,EAAE;QACjC,MAAM;QACJ,oBAAoB;QACpB,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAC7C,KAAK,CACN,CAAA;QACD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;YAC3C,6DAA6D;QAC/D,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAc,CAAC,CAAA;QAC5C,CAAC;QACD,oBAAoB;QACpB,OAAO,IAAI,CAAA;IACb,CAAC,EACD,IAAI,CACL,CAAA;AACH,CAAC,CAAA;AAED,MAAM,QAAQ,GAAG,KAAK,EACpB,IAAkB,EAClB,IAA8D,EAC9D,EAAE;IACF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IAClD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IACpB,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,IAAI,KAAK,EAAE,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACpC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC;YAAE,SAAQ;QACpC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAA;IAC3B,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,KAAK,EACrB,IAAkB,EAClB,IAAc,EACd,IAA8D,EAC9D,IAAgB,EAChB,EAAE;IACF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IAClD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IACpB,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,MAAM,OAAO,GAAmC,MAAM,OAAO,CAAC,GAAG,CAC/D,IAAI,CAAC,GAAG,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE;QACnB,OAAO,CAAC,GAAG,EAAE,MAAM,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;IACtC,CAAC,CAAC,CACH,CAAA;IACD,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,OAAO,EAAE,CAAC;QACjC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,IAAI,EAAE,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;QACjC,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;YACpC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC;gBAAE,SAAQ;YACpC,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAA;QAC3B,CAAC;IACH,CAAC;IAED,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,aAAa,GAAG,KAAK,EACzB,IAAkB,EAClB,IAAc,EACd,IAAoC,EACpC,IAAgB,EAChB,EAAE;IACF,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IAClD,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,CAAA;IAEpB,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,IAAI,IAAI,GAAG,CAAC,CAAA;IACZ,MAAM,UAAU,GAAG,CACjB,KAAiB,EACjB,GAAW,EACX,GAAW,EACX,EAAE;QACF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACjB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,KAAK,EAAE,CAAA;QACP,MAAM,CAAC,GAAG,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,MAAM,CAAA;QACrC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;QACxC,MAAM,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAA;QACvD,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QACvB,IAAI,IAAI,CAAC,CAAA;QACT,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC9B,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC;QACzC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAA;IAE7B,MAAM,EAAE,GAAG,WAAW,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;IAE9C,MAAM,CAAC,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;IAChC,MAAM,KAAK,CAAC,OAAO,EAAE,CAAA;IACrB,IAAI,EAAE,MAAM,CAAC,WAAW,KAAK,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC,CAAA;IACzD,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED,MAAM,KAAK,GAAG,KAAK,EACjB,IAAkB,EAClB,IAAc,EACd,IAAgB,EAChB,EAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;AAE3D,MAAM,YAAY,GAAG,KAAK,EACxB,IAAkB,EAClB,IAAc,EACd,IAAgB,EAChB,EAAE;IACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,KAAK,CAAC,sCAAsC,EAAE;YAClD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;IACtB,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IACvC,IAAI,MAAM,IAAI,GAAG,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,6CAA6C,EAAE;YACzD,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,MAAM;SACd,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,aAAa,CAClB,IAAI,EACJ,EAAE,EACF,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,GAAG,MAAM,EAC5C,IAAI,CACL,CAAA;AACH,CAAC,CAAA;AAED,MAAM,UAAU,GAAG,KAAK,EACtB,IAAkB,EAClB,IAAc,EACd,IAAgB,EAChB,EAAE;IACF,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,MAAM,KAAK,CAAC,mCAAmC,EAAE;YAC/C,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;AACpD,CAAC,CAAA;AAED,MAAM,SAAS,GAAG,KAAK,EACrB,IAAkB,EAClB,CAAW,EACX,IAAgB,EAChB,EAAE;IACF,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,cAAc,CAAA;IACzD,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACxD,MAAM,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC9C,IAAI,EAAE,MAAM,CAAC,4BAA4B,CAAC,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EACf,IAAkB,EAClB,KAAe,EACf,IAAgB,EAChB,EAAE;IACF,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,wCAAwC,EAAE;YACpD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,OAAO,CAAA;IACpC,MAAM,QAAQ,GAAoB,EAAE,CAAA;IAEpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,GAAG,WAAW;aAClB,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;YAC3C,oBAAoB,EAAE,KAAK;SAC5B,CAAC;aACD,IAAI,CAAC,KAAK,EAAC,CAAC,EAAC,EAAE;YACd,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,CAAC,CAAA;YACjC,MAAM,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACjD,GAAG,IAAI,CAAC,OAAO;gBACf,SAAS;gBACT,oBAAoB,EAAE,KAAK;aAC5B,CAAC,CAAA;YACF,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;QAEJ,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAClB,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;AAC7B,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { CacheEntry } from '@vltpkg/registry-client'\nimport { Spec } from '@vltpkg/spec'\nimport { mkdir, rm } from 'node:fs/promises'\nimport prettyBytes from 'pretty-bytes'\nimport type { LoadedConfig } from '../config/index.ts'\nimport type { CommandUsageDefinition } from '../config/usage.ts'\nimport { commandUsage } from '../config/usage.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\nimport { stderr, stdout } from '../output.ts'\nimport type { ViewOptions, Views } from '../view.ts'\nimport { ViewClass } from '../view.ts'\n\nexport type CacheMap = Record<\n  string,\n  ReturnType<CacheEntry['toJSON']>\n>\n\nexport type CacheSubcommands = keyof (typeof usageDef)['subcommands']\n\nlet view: CacheView\nexport class CacheView extends ViewClass {\n  constructor(options: ViewOptions, conf: LoadedConfig) {\n    super(options, conf)\n    view = this\n  }\n  stdout(...args: unknown[]) {\n    stdout(...args)\n  }\n}\n\nexport const views: Views<void | CacheMap> = {\n  human: CacheView,\n}\n\nconst usageDef = {\n  command: 'cache',\n  usage: '<command> [flags]',\n  description: 'Work with vlt cache folders',\n\n  subcommands: {\n    add: {\n      usage: '<package-spec> [<package-spec>...]',\n      description: `Resolve the referenced package identifiers and ensure they\n                    are cached.`,\n    },\n\n    ls: {\n      usage: '[<key>...]',\n      description: `Show cache entries. If no keys are provided, then a list of\n                    available keys will be printed. If one or more keys are\n                    provided, then details will be shown for the specified\n                    items.`,\n    },\n\n    info: {\n      usage: '<key>',\n      description: `Print metadata details for the specified cache key to\n                    stderr, and the response body to stdout.`,\n    },\n\n    clean: {\n      usage: '[<key>...]',\n      description: `Purge expired cache entries. If one or more keys are\n                    provided, then only those cache entries will be\n                    considered.`,\n    },\n\n    delete: {\n      usage: '<key> [<key>...]',\n      description: `Purge items explicitly, whether expired or not.  If one or\n                    more keys are provided, then only those cache entries will\n                    be considered.`,\n    },\n\n    'delete-before': {\n      usage: '<date>',\n      description: `Purge all cache items from before a given date. Date can be\n                    provided in any format that JavaScript can parse.`,\n    },\n\n    'delete-all': {\n      usage: '',\n      description: `Delete the entire cache folder to make vlt slower.`,\n    },\n  },\n  examples: {\n    'vlt cache ls https://registry.npmjs.org/typescript': {\n      description: `Show cache metadata for a given registry URL`,\n    },\n    'vlt cache add eslint@latest': {\n      description: `Add a given package specifier to the cache by fetching\n                    its resolved value.`,\n    },\n    'vlt cache info https://registry.npmjs.org/eslint/-/eslint-9.25.1.tgz > eslint.tgz':\n      {\n        description: `Print the cache metadata to stderr, and write the tarball\n                    on stdout, redirecting to a file.`,\n      },\n    'vlt cache delete-before 2025-01-01': {\n      description: 'Delete all entries created before Jan 1, 2025',\n    },\n  },\n} as const satisfies CommandUsageDefinition\n\nexport const usage: CommandUsage = () => commandUsage(usageDef)\n\nexport const command: CommandFn<void | CacheMap> = async conf => {\n  const [sub, ...args] = conf.positionals\n  switch (sub) {\n    case 'ls':\n      return ls(conf, args, view)\n\n    case 'info':\n      return info(conf, args, view)\n\n    case 'add':\n      return add(conf, args, view)\n\n    case 'clean':\n      return clean(conf, args, view)\n\n    case 'delete':\n      return deleteKeys(conf, args, view)\n\n    case 'delete-before':\n      return deleteBefore(conf, args, view)\n\n    case 'delete-all':\n      return deleteAll(conf, args, view)\n\n    default: {\n      throw error('Unrecognized cache command', {\n        code: 'EUSAGE',\n        found: sub,\n        validOptions: Object.keys(usageDef.subcommands),\n      })\n    }\n  }\n}\n\nconst ls = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n): Promise<CacheMap> =>\n  keys.length ?\n    await fetchKeys(\n      conf,\n      keys,\n      (entry: CacheEntry, key: string) => {\n        view?.stdout(\n          key.includes(' ') ? JSON.stringify(key) : key,\n          entry,\n        )\n        return true\n      },\n      view,\n    )\n  : await fetchAll(conf, (_, key) => {\n      view?.stdout(key.includes(' ') ? JSON.stringify(key) : key)\n      return true\n    })\n\nconst info = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n): Promise<void> => {\n  const [key] = keys\n  if (keys.length !== 1 || !key) {\n    throw error('Must provide exactly one cache key', {\n      code: 'EUSAGE',\n    })\n  }\n  await fetchKeys(\n    conf,\n    [key],\n    (entry: CacheEntry, key: string) => {\n      stderr(\n        /* c8 ignore next */\n        key.includes(' ') ? JSON.stringify(key) : key,\n        entry,\n      )\n      if (entry.isJSON) {\n        stdout(JSON.stringify(entry.body, null, 2))\n        /* c8 ignore start - annoying to test, corrupts TAP output */\n      } else {\n        process.stdout.write(entry.body as Buffer)\n      }\n      /* c8 ignore stop */\n      return true\n    },\n    view,\n  )\n}\n\nconst fetchAll = async (\n  conf: LoadedConfig,\n  test: (entry: CacheEntry, key: string, val: Buffer) => boolean,\n) => {\n  const rc = conf.options.packageInfo.registryClient\n  const { cache } = rc\n  const map: CacheMap = {}\n  for await (const [key, val] of cache) {\n    const entry = CacheEntry.decode(val)\n    if (!test(entry, key, val)) continue\n    map[key] = entry.toJSON()\n  }\n  return map\n}\n\nconst fetchKeys = async (\n  conf: LoadedConfig,\n  keys: string[],\n  test: (entry: CacheEntry, key: string, buf: Buffer) => boolean,\n  view?: CacheView,\n) => {\n  const rc = conf.options.packageInfo.registryClient\n  const { cache } = rc\n  const map: CacheMap = {}\n  const results: [string, Buffer | undefined][] = await Promise.all(\n    keys.map(async key => {\n      return [key, await cache.fetch(key)]\n    }),\n  )\n  for (const [key, val] of results) {\n    if (!val) {\n      view?.stdout('Not found:', key)\n    } else {\n      const entry = CacheEntry.decode(val)\n      if (!test(entry, key, val)) continue\n      map[key] = entry.toJSON()\n    }\n  }\n\n  return map\n}\n\nconst deleteEntries = async (\n  conf: LoadedConfig,\n  keys: string[],\n  test: (entry: CacheEntry) => boolean,\n  view?: CacheView,\n) => {\n  const rc = conf.options.packageInfo.registryClient\n  const { cache } = rc\n\n  let count = 0\n  let size = 0\n  const testAction = (\n    entry: CacheEntry,\n    key: string,\n    val: Buffer,\n  ) => {\n    if (!test(entry)) {\n      return false\n    }\n    count++\n    const s = val.byteLength + key.length\n    cache.delete(key, true, entry.integrity)\n    const k = key.includes(' ') ? JSON.stringify(key) : key\n    view?.stdout('-', k, s)\n    size += s\n    return true\n  }\n\n  const map = await (keys.length ?\n    fetchKeys(conf, keys, testAction, view)\n  : fetchAll(conf, testAction))\n\n  const pb = prettyBytes(size, { binary: true })\n\n  const s = count === 1 ? '' : 's'\n  await cache.promise()\n  view?.stdout(`Removed ${count} item${s} totalling ${pb}`)\n  return map\n}\n\nconst clean = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n) => deleteEntries(conf, keys, entry => !entry.valid, view)\n\nconst deleteBefore = async (\n  conf: LoadedConfig,\n  args: string[],\n  view?: CacheView,\n) => {\n  if (!args.length) {\n    throw error('Must provide a date to delete before', {\n      code: 'EUSAGE',\n    })\n  }\n  const now = new Date()\n  const before = new Date(args.join(' '))\n  if (before >= now) {\n    throw error('Cannot delete cache entries from the future', {\n      code: 'EUSAGE',\n      found: before,\n    })\n  }\n  return deleteEntries(\n    conf,\n    [],\n    entry => !!entry.date && entry.date < before,\n    view,\n  )\n}\n\nconst deleteKeys = async (\n  conf: LoadedConfig,\n  keys: string[],\n  view?: CacheView,\n) => {\n  if (!keys.length) {\n    throw error('Must provide cache keys to delete', {\n      code: 'EUSAGE',\n    })\n  }\n  return deleteEntries(conf, keys, () => true, view)\n}\n\nconst deleteAll = async (\n  conf: LoadedConfig,\n  _: string[],\n  view?: CacheView,\n) => {\n  const { cache } = conf.options.packageInfo.registryClient\n  await rm(cache.path(), { recursive: true, force: true })\n  await mkdir(cache.path(), { recursive: true })\n  view?.stdout('Deleted all cache entries.')\n}\n\nconst add = async (\n  conf: LoadedConfig,\n  specs: string[],\n  view?: CacheView,\n) => {\n  if (!specs.length) {\n    throw error('Must provide specs to add to the cache', {\n      code: 'EUSAGE',\n    })\n  }\n  const { packageInfo } = conf.options\n  const promises: Promise<void>[] = []\n\n  for (const spec of specs) {\n    const p = packageInfo\n      .resolve(Spec.parseArgs(spec, conf.options), {\n        staleWhileRevalidate: false,\n      })\n      .then(async r => {\n        const { resolved, integrity } = r\n        await packageInfo.registryClient.request(resolved, {\n          ...conf.options,\n          integrity,\n          staleWhileRevalidate: false,\n        })\n        view?.stdout('+', spec, r.resolved)\n      })\n\n    promises.push(p)\n  }\n\n  await Promise.all(promises)\n}\n"]}

package/dist/esm/commands/config.d.ts

@@ -0,0 +1,5 @@
+import type { RecordPairs } from '../config/index.ts';
+import type { CommandFn, CommandUsage } from '../index.ts';
+export declare const usage: CommandUsage;
+export declare const command: CommandFn<string | number | boolean | void | string[] | RecordPairs>;
+//# sourceMappingURL=config.d.ts.map

package/dist/esm/commands/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../../src/commands/config.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAGV,WAAW,EACZ,MAAM,oBAAoB,CAAA;AAE3B,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1D,eAAO,MAAM,KAAK,EAAE,YA8ChB,CAAA;AAEJ,eAAO,MAAM,OAAO,EAAE,SAAS,CAC7B,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,EAAE,GAAG,WAAW,CA+B1D,CAAA"}

package/dist/esm/commands/config.js

@@ -0,0 +1,153 @@
+import { error } from '@vltpkg/error-cause';
+import { spawnSync } from 'node:child_process';
+import { definition, isRecordField, pairsToRecords, recordsToPairs, } from "../config/index.js";
+import { commandUsage } from "../config/usage.js";
+export const usage = () => commandUsage({
+    command: 'config',
+    usage: '<command> [flags]',
+    description: 'Work with vlt configuration',
+    subcommands: {
+        get: {
+            usage: '<key> [<key> ...]',
+            description: 'Print the named config value',
+        },
+        list: {
+            description: 'Print all configuration settings currently in effect',
+        },
+        set: {
+            usage: '<key>=<value> [<key>=<value> ...] [--config=<user | project>]',
+            description: `Set config values. By default, these are
+                      written to the project config file, \`vlt.json\`
+                      in the root of the project. To set things for all
+                      projects, run with \`--config=user\``,
+        },
+        del: {
+            usage: '<key> [<key> ...] [--config=<user | project>]',
+            description: `Delete the named config fields. If no values remain in
+                      the config file, delete the file as well. By default,
+                      operates on the \`vlt.json\` file in the root of the
+                      current project. To delete a config field from the user
+                      config file, specify \`--config=user\`.`,
+        },
+        edit: {
+            usage: '[--config=<user | project>]',
+            description: 'Edit the configuration file',
+        },
+        help: {
+            usage: '[field ...]',
+            description: `Get information about a config field, or show a list
+                      of known config field names.`,
+        },
+    },
+});
+export const command = async (conf) => {
+    const sub = conf.positionals[0];
+    switch (sub) {
+        case 'set':
+            return set(conf);
+        case 'get':
+            return get(conf);
+        case 'ls':
+        case 'list':
+            return list(conf);
+        case 'edit':
+            return edit(conf);
+        case 'help':
+            return help(conf);
+        case 'del':
+            return del(conf);
+        default: {
+            throw error('Unrecognized config command', {
+                code: 'EUSAGE',
+                found: sub,
+                validOptions: ['set', 'get', 'list', 'edit', 'help', 'del'],
+            });
+        }
+    }
+};
+const help = (conf) => {
+    const j = definition.toJSON();
+    const fields = conf.positionals.slice(1);
+    if (!fields.length) {
+        return [
+            'Specify one or more options to see information:',
+            ...Object.keys(j)
+                .sort((a, b) => a.localeCompare(b, 'en'))
+                .map(c => `  ${c}`),
+        ].join('\n');
+    }
+    // TODO: some kind of fuzzy search?
+    const res = [];
+    for (const f of fields) {
+        const def = j[f];
+        if (!def) {
+            res.push(`unknown config field: ${f}`);
+        }
+        else {
+            const hint = def.hint ? `=<${def.hint}>` : '';
+            const type = isRecordField(f) ?
+                'Record<string, string>'
+                : def.type + (def.multiple ? '[]' : '');
+            res.push(`--${f}${hint}`);
+            res.push(`  type: ${type}`);
+            if (def.default) {
+                res.push(`  default: ${JSON.stringify(def.default)}`);
+            }
+            if (def.description) {
+                res.push(def.description);
+            }
+        }
+    }
+    return res.join('\n');
+};
+const list = (conf) => {
+    return recordsToPairs(conf.options);
+};
+const del = async (conf) => {
+    const fields = conf.positionals.slice(1);
+    if (!fields.length) {
+        throw error('At least one key is required', {
+            code: 'EUSAGE',
+        });
+    }
+    await conf.deleteConfigKeys(conf.get('config'), fields);
+};
+const get = async (conf) => {
+    const keys = conf.positionals.slice(1);
+    const k = keys[0];
+    if (!k || keys.length > 1) {
+        throw error('Exactly one key is required', {
+            code: 'EUSAGE',
+        });
+    }
+    return conf.get(k);
+};
+const edit = async (conf) => {
+    const [command, ...args] = conf.get('editor').split(' ');
+    if (!command) {
+        throw error(`editor is empty`);
+    }
+    await conf.editConfigFile(conf.get('config'), file => {
+        args.push(file);
+        const res = spawnSync(command, args, {
+            stdio: 'inherit',
+        });
+        if (res.status !== 0) {
+            throw error(`${command} command failed`, {
+                ...res,
+                command,
+                args,
+            });
+        }
+    });
+};
+const set = async (conf) => {
+    const pairs = conf.positionals.slice(1);
+    if (!pairs.length) {
+        throw error('At least one key=value pair is required', {
+            code: 'EUSAGE',
+        });
+    }
+    await conf.addConfigToFile(conf.get('config'), pairsToRecords(conf.jack.parseRaw(pairs.map(kv => `--${kv}`)).values));
+};
+//# sourceMappingURL=config.js.map

package/dist/esm/commands/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/commands/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EACL,UAAU,EACV,aAAa,EACb,cAAc,EACd,cAAc,GACf,MAAM,oBAAoB,CAAA;AAM3B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGjD,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CACtC,YAAY,CAAC;IACX,OAAO,EAAE,QAAQ;IACjB,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,6BAA6B;IAE1C,WAAW,EAAE;QACX,GAAG,EAAE;YACH,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,8BAA8B;SAC5C;QAED,IAAI,EAAE;YACJ,WAAW,EACT,sDAAsD;SACzD;QAED,GAAG,EAAE;YACH,KAAK,EACH,+DAA+D;YACjE,WAAW,EAAE;;;2DAGsC;SACpD;QAED,GAAG,EAAE;YACH,KAAK,EAAE,+CAA+C;YACtD,WAAW,EAAE;;;;8DAIyC;SACvD;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,6BAA6B;YACpC,WAAW,EAAE,6BAA6B;SAC3C;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE;mDAC8B;SAC5C;KACF;CACF,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,OAAO,GAEhB,KAAK,EAAC,IAAI,EAAC,EAAE;IACf,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,KAAK,IAAI,CAAC;QACV,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,KAAK,CAAC,6BAA6B,EAAE;gBACzC,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG;gBACV,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC;aAC5D,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,IAAkB,EAAE,EAAE;IAClC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAA;IAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO;YACL,iDAAiD;YACjD,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;iBACd,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;iBACxC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;SACtB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACd,CAAC;IAED,mCAAmC;IACnC,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAChB,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAA;QACxC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;YAC7C,MAAM,IAAI,GACR,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChB,wBAAwB;gBAC1B,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YAEzC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,CAAC,CAAA;YACzB,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;YAC3B,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;gBAChB,GAAG,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YACvD,CAAC;YACD,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACpB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACvB,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,IAAkB,EAAE,EAAE;IAClC,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACrC,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,KAAK,CAAC,8BAA8B,EAAE;YAC1C,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAA;AACzD,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACtC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,KAAK,CAAC,6BAA6B,EAAE;YACzC,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAA4B,CAAC,CAAA;AAC/C,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACxC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACxD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAChC,CAAC;IACD,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,EAAE;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACf,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE;YACnC,KAAK,EAAE,SAAS;SACjB,CAAC,CAAA;QACF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,KAAK,CAAC,GAAG,OAAO,iBAAiB,EAAE;gBACvC,GAAG,GAAG;gBACN,OAAO;gBACP,IAAI;aACL,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACvC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,yCAAyC,EAAE;YACrD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,eAAe,CACxB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAClB,cAAc,CACZ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CACtD,CACF,CAAA;AACH,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { spawnSync } from 'node:child_process'\nimport {\n  definition,\n  isRecordField,\n  pairsToRecords,\n  recordsToPairs,\n} from '../config/index.ts'\nimport type {\n  ConfigDefinitions,\n  LoadedConfig,\n  RecordPairs,\n} from '../config/index.ts'\nimport { commandUsage } from '../config/usage.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\n\nexport const usage: CommandUsage = () =>\n  commandUsage({\n    command: 'config',\n    usage: '<command> [flags]',\n    description: 'Work with vlt configuration',\n\n    subcommands: {\n      get: {\n        usage: '<key> [<key> ...]',\n        description: 'Print the named config value',\n      },\n\n      list: {\n        description:\n          'Print all configuration settings currently in effect',\n      },\n\n      set: {\n        usage:\n          '<key>=<value> [<key>=<value> ...] [--config=<user | project>]',\n        description: `Set config values. By default, these are\n                      written to the project config file, \\`vlt.json\\`\n                      in the root of the project. To set things for all\n                      projects, run with \\`--config=user\\``,\n      },\n\n      del: {\n        usage: '<key> [<key> ...] [--config=<user | project>]',\n        description: `Delete the named config fields. If no values remain in\n                      the config file, delete the file as well. By default,\n                      operates on the \\`vlt.json\\` file in the root of the\n                      current project. To delete a config field from the user\n                      config file, specify \\`--config=user\\`.`,\n      },\n\n      edit: {\n        usage: '[--config=<user | project>]',\n        description: 'Edit the configuration file',\n      },\n\n      help: {\n        usage: '[field ...]',\n        description: `Get information about a config field, or show a list\n                      of known config field names.`,\n      },\n    },\n  })\n\nexport const command: CommandFn<\n  string | number | boolean | void | string[] | RecordPairs\n> = async conf => {\n  const sub = conf.positionals[0]\n  switch (sub) {\n    case 'set':\n      return set(conf)\n\n    case 'get':\n      return get(conf)\n\n    case 'ls':\n    case 'list':\n      return list(conf)\n\n    case 'edit':\n      return edit(conf)\n\n    case 'help':\n      return help(conf)\n\n    case 'del':\n      return del(conf)\n\n    default: {\n      throw error('Unrecognized config command', {\n        code: 'EUSAGE',\n        found: sub,\n        validOptions: ['set', 'get', 'list', 'edit', 'help', 'del'],\n      })\n    }\n  }\n}\n\nconst help = (conf: LoadedConfig) => {\n  const j = definition.toJSON()\n  const fields = conf.positionals.slice(1)\n  if (!fields.length) {\n    return [\n      'Specify one or more options to see information:',\n      ...Object.keys(j)\n        .sort((a, b) => a.localeCompare(b, 'en'))\n        .map(c => `  ${c}`),\n    ].join('\\n')\n  }\n\n  // TODO: some kind of fuzzy search?\n  const res: string[] = []\n  for (const f of fields) {\n    const def = j[f]\n    if (!def) {\n      res.push(`unknown config field: ${f}`)\n    } else {\n      const hint = def.hint ? `=<${def.hint}>` : ''\n      const type =\n        isRecordField(f) ?\n          'Record<string, string>'\n        : def.type + (def.multiple ? '[]' : '')\n\n      res.push(`--${f}${hint}`)\n      res.push(`  type: ${type}`)\n      if (def.default) {\n        res.push(`  default: ${JSON.stringify(def.default)}`)\n      }\n      if (def.description) {\n        res.push(def.description)\n      }\n    }\n  }\n  return res.join('\\n')\n}\n\nconst list = (conf: LoadedConfig) => {\n  return recordsToPairs(conf.options)\n}\n\nconst del = async (conf: LoadedConfig) => {\n  const fields = conf.positionals.slice(1)\n  if (!fields.length) {\n    throw error('At least one key is required', {\n      code: 'EUSAGE',\n    })\n  }\n  await conf.deleteConfigKeys(conf.get('config'), fields)\n}\n\nconst get = async (conf: LoadedConfig) => {\n  const keys = conf.positionals.slice(1)\n  const k = keys[0]\n  if (!k || keys.length > 1) {\n    throw error('Exactly one key is required', {\n      code: 'EUSAGE',\n    })\n  }\n  return conf.get(k as keyof ConfigDefinitions)\n}\n\nconst edit = async (conf: LoadedConfig) => {\n  const [command, ...args] = conf.get('editor').split(' ')\n  if (!command) {\n    throw error(`editor is empty`)\n  }\n  await conf.editConfigFile(conf.get('config'), file => {\n    args.push(file)\n    const res = spawnSync(command, args, {\n      stdio: 'inherit',\n    })\n    if (res.status !== 0) {\n      throw error(`${command} command failed`, {\n        ...res,\n        command,\n        args,\n      })\n    }\n  })\n}\n\nconst set = async (conf: LoadedConfig) => {\n  const pairs = conf.positionals.slice(1)\n  if (!pairs.length) {\n    throw error('At least one key=value pair is required', {\n      code: 'EUSAGE',\n    })\n  }\n  await conf.addConfigToFile(\n    conf.get('config'),\n    pairsToRecords(\n      conf.jack.parseRaw(pairs.map(kv => `--${kv}`)).values,\n    ),\n  )\n}\n"]}

package/dist/esm/commands/exec-cache.d.ts

@@ -0,0 +1,49 @@
+import type { VlxInfo } from '@vltpkg/vlx';
+import type { LoadedConfig } from '../config/index.ts';
+import type { CommandFn, CommandUsage } from '../index.ts';
+import type { ViewOptions, Views } from '../view.ts';
+import { ViewClass } from '../view.ts';
+export type ExecCacheSubcommands = keyof (typeof usageDef)['subcommands'];
+export declare class ExecCacheView extends ViewClass {
+    constructor(options: ViewOptions, conf: LoadedConfig);
+    stdout(...args: unknown[]): void;
+}
+export declare const views: Views<void | string[] | VlxInfo[]>;
+declare const usageDef: {
+    readonly command: "exec-cache";
+    readonly usage: "<command> [flags]";
+    readonly description: "Work with vlt exec-cache folders";
+    readonly subcommands: {
+        readonly ls: {
+            readonly usage: "";
+            readonly description: "Show previously installed packages used for `vlt exec`.\n                    Key provided can be either the package name, or the full\n                    key.";
+        };
+        readonly delete: {
+            readonly usage: "[<key>...]";
+            readonly description: "Delete previously installed packages used for\n                    `vlt exec`. If no keys are provided, then all entries\n                    will be deleted.";
+        };
+        readonly info: {
+            readonly usage: "<key>";
+            readonly description: "Show extended information about a given `vlt exec`\n                    installation.";
+        };
+        readonly install: {
+            readonly usage: "<spec>...";
+            readonly description: "Install the specified package(s) in the `vlt exec`\n                    central cache location. Metadata info about each\n                    installation will be printed.";
+        };
+    };
+    readonly examples: {
+        readonly ls: {
+            readonly description: "Show all the keys for the installations in the `vlt exec`\n                    cache.";
+        };
+        readonly 'delete typescript': {
+            readonly description: "Delete all versions of typescript installed for vlt exec";
+        };
+        readonly 'info typescript-695bf962': {
+            readonly description: "Show extended info about a specific version of typescript";
+        };
+    };
+};
+export declare const usage: CommandUsage;
+export declare const command: CommandFn<string[] | VlxInfo[]>;
+export {};
+//# sourceMappingURL=exec-cache.d.ts.map

package/dist/esm/commands/exec-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exec-cache.d.ts","sourceRoot":"","sources":["../../../src/commands/exec-cache.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAG1C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGtD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1D,OAAO,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,MAAM,MAAM,oBAAoB,GAC9B,MAAM,CAAC,OAAO,QAAQ,CAAC,CAAC,aAAa,CAAC,CAAA;AAGxC,qBAAa,aAAc,SAAQ,SAAS;gBAC9B,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY;IAIpD,MAAM,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;CAG1B;AAED,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,IAAI,GAAG,MAAM,EAAE,GAAG,OAAO,EAAE,CAEpD,CAAA;AAED,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8C6B,CAAA;AAE3C,eAAO,MAAM,KAAK,EAAE,YAA2C,CAAA;AAE/D,eAAO,MAAM,OAAO,EAAE,SAAS,CAC7B,MAAM,EAAE,GAAG,OAAO,EAAE,CAwBrB,CAAA"}