@vltpkg/cli-sdk 0.0.0-8 → 1.0.0-rc.1

package/dist/esm/config/definition.js

@@ -1,40 +1,67 @@
+import { error } from '@vltpkg/error-cause';
 import { XDG } from '@vltpkg/xdg';
 import { jack } from 'jackspeak';
-export const defaultView = process.stdout.isTTY ? 'human' : 'json';
+export const defaultView = 
+// If stdout is a TTY, use human output
+process.stdout.isTTY ? 'human'
+    // If its not a TTY but is a CI environment, use human output
+    // TODO: make a better view option for CI environments
+    : process.env.CI ? 'human'
+        // Otherwise, use json output
+        : 'json';
+export const defaultEditor = () => process.env.EDITOR ||
+    process.env.VISUAL ||
+    (process.platform === 'win32' ?
+        `${process.env.SYSTEMROOT}\\notepad.exe`
+        : 'vi');
 const canonicalCommands = {
+    build: 'build',
+    cache: 'cache',
+    ci: 'ci',
     config: 'config',
+    docs: 'docs',
     exec: 'exec',
-    gui: 'gui',
+    'exec-local': 'exec-local',
     help: 'help',
     init: 'init',
-    'install-exec': 'install-exec',
     install: 'install',
     login: 'login',
     logout: 'logout',
     list: 'list',
     ls: 'ls',
+    pack: 'pack',
     pkg: 'pkg',
+    publish: 'publish',
     query: 'query',
     'run-exec': 'run-exec',
     run: 'run',
+    serve: 'serve',
     token: 'token',
     uninstall: 'uninstall',
+    update: 'update',
+    'exec-cache': 'exec-cache',
+    version: 'version',
     whoami: 'whoami',
 };
 const aliases = {
     i: 'install',
     add: 'install',
     rm: 'uninstall',
-    u: 'uninstall',
+    u: 'update',
+    p: 'pkg',
+    pub: 'publish',
+    q: 'query',
+    b: 'build',
     r: 'run',
     'run-script': 'run',
     rx: 'run-exec',
+    s: 'serve',
     x: 'exec',
+    xl: 'exec-local',
     h: 'help',
     '?': 'help',
-    conf: 'config',
-    ix: 'install-exec',
     ls: 'list',
+    xc: 'exec-cache',
 };
 /**
  * Command aliases mapped to their canonical names
@@ -67,13 +94,14 @@ export const recordFields = [
     'registries',
     'git-host-archives',
     'scope-registries',
+    'jsr-registries',
 ];
 export const isRecordField = (s) => recordFields.includes(s);
 const stopParsingCommands = [
     'run',
     'run-exec',
+    'exec-local',
     'exec',
-    'install-exec',
 ];
 let stopParsing = undefined;
 const j = jack({
@@ -188,6 +216,24 @@ export const definition = j
                     However, custom registry aliases are not supported by other
                     package managers.`,
     },
+    'jsr-registries': {
+        hint: 'name=url',
+        description: `Map alias names to JSR.io registry urls.
+
+                    For example,
+                    \`--jsr-registries acme=https://jsr.acme.io/\` would
+                    tell vlt to fetch any packages with the \`acme:\` registry
+                    prefix from the \`https://jsr.acme.io/\` registry, using
+                    the "npm Compatibility" translation. So for example,
+                    the package \`acme:@foo/bar\` would fetch the
+                    \`@jsr/foo__bar\` package from the \`jsr.acme.io\`
+                    registry.
+
+                    By default the \`jsr\` alias is always mapped to
+                    \`https://npm.jsr.io/\`, so existing \`jsr:\` packages will
+                    be fetched from the public \`jsr\` registry appropriately.
+                   `,
+    },
     'git-hosts': {
         hint: `name=template`,
         short: 'G',
@@ -225,7 +271,7 @@ export const definition = j
         default: cacheDir,
     },
     tag: {
-        description: `Default \`dist-tag\` to install`,
+        description: `Default \`dist-tag\` to install or publish`,
         default: 'latest',
     },
     before: {
@@ -338,6 +384,31 @@ export const definition = j
         description: `Specify named workspace group names to load and operate on
                     when doing recursive operations on workspaces.`,
     },
+})
+    .opt({
+    scope: {
+        short: 's',
+        hint: 'query',
+        description: 'Set to filter the scope of an operation using a DSS Query.',
+    },
+    target: {
+        short: 't',
+        hint: 'query',
+        description: 'Set to select packages using a DSS Query selector.',
+    },
+})
+    .flag({
+    'if-present': {
+        description: `When running scripts across multiple packages,
+                    only include packages that have the script.
+
+                    If this is not set, then the run will fail if any
+                    packages do not have the script.
+
+                    This will default to true if --scope, --workspace,
+                    --workspace-group, or --recursive is set. Otherwise,
+                    it will default to false.`,
+    },
 })
     .flag({
     recursive: {
@@ -363,11 +434,16 @@ export const definition = j
 })
     .opt({
     config: {
-        hint: 'user | project',
-        description: `Specify whether to operate on user-level or project-level
-                    configuration files when running \`vlt config\` commands.`,
-        validOptions: ['user', 'project'],
-        default: 'project',
+        hint: 'all | user | project',
+        description: `Specify which configuration to show or operate on when running
+                    \`vlt config\` commands. For read operations (get, pick, list):
+                    \`all\` shows merged configuration from both user and project
+                    files (default). For write operations (set, delete, edit):
+                    defaults to \`project\`. \`user\` shows/modifies only user-level
+                    configuration, \`project\` shows/modifies only project-level
+                    configuration.`,
+        validOptions: ['all', 'user', 'project'],
+        default: 'all',
     },
     editor: {
         hint: 'program',
@@ -377,23 +453,23 @@ export const definition = j
 
                     Defaults to the \`EDITOR\` or \`VISUAL\` env if set, or
                     \`notepad.exe\` on Windows, or \`vi\` elsewhere.`,
-        default: process.env.EDITOR ||
-            process.env.VISUAL ||
-            (process.platform === 'win32' ?
-                `${process.env.SYSTEMROOT}\\notepad.exe`
-                : 'vi'),
+        default: defaultEditor(),
     },
     'script-shell': {
         hint: 'program',
-        description: `The shell to use when executing \`package.json#scripts\`
-                    (either as lifecycle scripts or explicitly with
-                    \`vlt run\`) and \`vlt exec\`.
-
-                    If not set, defaults to \`/bin/sh\` on POSIX systems,
-                    and \`cmd.exe\` on Windows.
-
-                    When no argument is provided to \`vlt exec\`, the \`SHELL\`
-                    environment variable takes precedence if set.`,
+        description: `The shell to use when executing \`package.json#scripts\`.
+
+                    For \`vlt exec\` and \`vlt exec-local\`, this is never set,
+                    meaning that command arguments are run exactly as provided.
+
+                    For \`vlt run\` (and other things that run lifecycle
+                    scripts in \`package.json#scripts\`), the entire command
+                    with all arguments is provided as a single string, meaning
+                    that some value must be provided for shell interpretation,
+                    and so for these contexts, the \`script-shell\` value will
+                    default to \`/bin/sh\` on POSIX systems or \`cmd.exe\` on
+                    Windows.
+      `,
     },
     'fallback-command': {
         hint: 'command',
@@ -411,10 +487,10 @@ export const definition = j
     .opt({
     package: {
         hint: 'p',
-        description: `When running \`vlt install-exec\`, this allows you to
-                    explicitly set the package to search for bins. If not
-                    provided, then vlt will interpret the first argument as
-                    the package, and attempt to run the default executable.`,
+        description: `When running \`vlt exec\`, this allows you to explicitly
+                    set the package to search for bins. If not provided, then
+                    vlt will interpret the first argument as the package, and
+                    attempt to run the default executable.`,
     },
 })
     .opt({
@@ -435,6 +511,7 @@ export const definition = j
                       commands.)
                     - mermaid: Output mermaid diagramming syntax. (Only
                       relevant for certain commands.)
+                    - silent: Suppress all output to stdout.
 
                     If the requested view format is not supported for the
                     current command, or if no option is provided, then it
@@ -446,13 +523,14 @@ export const definition = j
             'mermaid',
             'gui',
             'inspect',
+            'silent',
         ],
     },
 })
     .optList({
     'dashboard-root': {
         hint: 'path',
-        description: `The root directory to use for the dashboard GUI.
+        description: `The root directory to use for the dashboard browser-based UI.
                     If not set, the user home directory is used.`,
     },
 })
@@ -478,17 +556,102 @@ export const definition = j
                     devDependencies or optionalDependencies, but you want to
                     move it to be a non-optional production dependency.`,
     },
+})
+    .opt({
+    'expect-results': {
+        hint: 'value',
+        validate: (v) => typeof v === 'string' && /^([<>]=?)?[0-9]+$/.test(v),
+        description: `When running \`vlt query\`, this option allows you to
+                    set a expected number of resulting items.
+
+                    Accepted values are numbers and strings.
+
+                    Strings starting with \`>\`, \`<\`, \`>=\` or \`<=\`
+                    followed by a number can be used to check if the result
+                    is greater than or less than a specific number.`,
+    },
 })
     .flag({
+    'dry-run': {
+        description: 'Run command without making any changes',
+    },
+    'expect-lockfile': {
+        description: 'Fail if lockfile is missing or out of date. Used by ci command to enforce lockfile integrity.',
+    },
+    'frozen-lockfile': {
+        description: 'Fail if lockfile is missing or out of sync with package.json. Prevents any lockfile modifications.',
+    },
+    'lockfile-only': {
+        description: 'Only update the lockfile (vlt-lock.json) and package.json files, skip all node_modules operations including package extraction and filesystem changes.',
+    },
+})
+    .opt({
+    'allow-scripts': {
+        hint: 'query',
+        description: `Filter which packages are allowed to run lifecycle scripts using DSS query syntax.
+                    When provided, only packages matching the query will execute their
+                    install, preinstall, postinstall, prepare, preprepare, and postprepare scripts.
+                    Defaults to ':not(*)' which means no scripts will be run.
+                    
+                    Example: --allow-scripts=":root > *, #my-package"
+                    Runs scripts only for direct dependencies of the current project and any occurrences
+                    of a specific dependency with the name "my-package" anywhere in the dependency graph.`,
+    },
+})
+    .opt({
+    access: {
+        description: 'Set the access level of the package',
+        validOptions: ['public', 'restricted'],
+        default: 'public',
+    },
+})
+    .opt({
+    otp: {
+        description: `Provide an OTP to use when publishing a package.`,
+    },
+    'publish-directory': {
+        hint: 'path',
+        description: `Directory to use for pack and publish operations instead of the current directory.
+                    The directory must exist and nothing will be copied to it.`,
+    },
+    port: {
+        hint: 'number',
+        description: `Port for the browser-based UI server when using vlt serve command (default: 8000).`,
+    },
+    'registry-port': {
+        hint: 'number',
+        description: `Port for the VSR registry when using vlt serve command (default: 1337).`,
+    },
+})
+    .flag({
+    yes: {
+        short: 'y',
+        description: `Automatically accept any confirmation prompts`,
+    },
     version: {
         short: 'v',
         description: 'Print the version',
     },
-})
-    .flag({
     help: {
         short: 'h',
         description: 'Print helpful information',
     },
+    all: {
+        short: 'a',
+        description: 'Show all commands, bins, and flags',
+    },
 });
+export const getSortedCliOptions = () => {
+    const defs = definition.toJSON();
+    return getSortedKeys().map((k) => {
+        const def = defs[k];
+        /* c8 ignore next */
+        if (!def)
+            throw error('invalid key found', { found: k });
+        if (def.type === 'boolean')
+            return `--${k}`;
+        return `--${k}=<${def.hint ?? k}>`;
+    });
+};
+export const getSortedKeys = () => Object.keys(definition.toJSON()).sort((a, b) => a.localeCompare(b));
 //# sourceMappingURL=definition.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../src/config/definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEhC,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAA;AAElE,MAAM,iBAAiB,GAAG;IACxB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,cAAc,EAAE,cAAc;IAC9B,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,EAAE,EAAE,IAAI;IACR,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,UAAU;IACtB,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAA;AAEV,MAAM,OAAO,GAAG;IACd,CAAC,EAAE,SAAS;IACZ,GAAG,EAAE,SAAS;IACd,EAAE,EAAE,WAAW;IACf,CAAC,EAAE,WAAW;IACd,CAAC,EAAE,KAAK;IACR,YAAY,EAAE,KAAK;IACnB,EAAE,EAAE,UAAU;IACd,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,MAAM;IACT,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,QAAQ;IACd,EAAE,EAAE,cAAc;IAClB,EAAE,EAAE,MAAM;CACF,CAAA;AAEV;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,GAAG,iBAAiB;IACpB,GAAG,OAAO;CACF,CAAA;AAEV;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAC1D,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE;IAC1B,MAAM,cAAc,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACzC,IAAI,cAAc,EAAE,CAAC;QACnB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,EACD,IAAI,GAAG,EAAoB,CAC5B,CAAA;AAID,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,CAAU,EAC4B,EAAE,CACxC,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AAEhE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;AAC1B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,EAAE,CAAA;AAE5B;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,WAAW;IACX,YAAY;IACZ,mBAAmB;IACnB,kBAAkB;CACV,CAAA;AAIV,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAS,EAAoB,EAAE,CAC3D,YAAY,CAAC,QAAQ,CAAC,CAAgB,CAAC,CAAA;AAEzC,MAAM,mBAAmB,GAA+B;IACtD,KAAK;IACL,UAAU;IACV,MAAM;IACN,cAAc;CACf,CAAA;AAED,IAAI,WAAW,GAAwB,SAAS,CAAA;AAEhD,MAAM,CAAC,GAAG,IAAI,CAAC;IACb,SAAS,EAAE,KAAK;IAChB,gBAAgB,EAAE,IAAI;IACtB,KAAK,EAAE,sCAAsC;IAC7C,oBAAoB,EAAE,GAAG,CAAC,EAAE;QAC1B,IAAI,WAAW;YAAE,OAAO,IAAI,CAAA;QAC5B,MAAM,CAAC,GAAG,GAAqB,CAAA;QAC/B,iDAAiD;QACjD,2DAA2D;QAC3D,KAAK;QACL,0DAA0D;QAC1D,IAAI,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9C,WAAW,GAAG,IAAI,CAAA;QACpB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CACF,CAAC;KACC,OAAO,CAAC,KAAK,CAAC;KACd,WAAW,CACV,uDAAuD,CACxD;KACA,OAAO,CAAC,aAAa,CAAC,CAAA;AAEzB,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;IACvD,GAAG,EAAE,IAAI;CACV,CAAC,CAAC,WAAW,CACZ,sEAAsE,CACvE,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;IACzB;;OAEG;KACF,OAAO,CAAC,eAAe,CAAC;KACxB,WAAW,CACV;;;;;;;;;;;KAWC,CACF;KAEA,IAAI,CAAC;IACJ,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,8BAA8B;KAC5C;IACD,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,yCAAyC;KACvD;CACF,CAAC;KAED,GAAG,CAAC;IACH,QAAQ,EAAE;QACR,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,6BAA6B;QACtC,WAAW,EAAE;;;;;;;;;;OAUZ;KACF;CACF,CAAC;KAED,OAAO,CAAC;IACP,UAAU,EAAE;QACV,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE;;;;;;;;;;;;;qBAaE;KAChB;IAED,kBAAkB,EAAE;QAClB,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;sCAsBmB;KACjC;IAED,WAAW,EAAE;QACX,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;;;;iDAQ8B;KAC5C;IAED,mBAAmB,EAAE;QACnB,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;;;;qEAQkD;KAChE;CACF,CAAC;KAED,GAAG,CAAC;IACH,KAAK,EAAE;QACL,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE;;;OAGZ;QACD,OAAO,EAAE,QAAQ;KAClB;IACD,GAAG,EAAE;QACH,WAAW,EAAE,iCAAiC;QAC9C,OAAO,EAAE,QAAQ;KAClB;IACD,MAAM,EAAE;QACN,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,uDAAuD;KACrE;IACD,EAAE,EAAE;QACF,WAAW,EAAE;0DACuC;QACpD,OAAO,EAAE,OAAO,CAAC,QAAQ;KAC1B;IACD,IAAI,EAAE;QACJ,WAAW,EAAE;2DACwC;QACrD,OAAO,EAAE,OAAO,CAAC,IAAI;KACtB;IACD,cAAc,EAAE;QACd,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;kDAC+B;QAC5C,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB;CACF,CAAC;KAED,IAAI,CAAC;IACJ,aAAa,EAAE;QACb,WAAW,EAAE;;;;;8DAK2C;KACzD;CACF,CAAC;KACD,GAAG,CAAC;IACH,eAAe,EAAE;QACf,IAAI,EAAE,GAAG;QACT,WAAW,EAAE;sEACmD;QAChE,OAAO,EAAE,CAAC;KACX;IACD,oBAAoB,EAAE;QACpB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE;oDACiC;QAC9C,OAAO,EAAE,CAAC;KACX;IACD,wBAAwB,EAAE;QACxB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,CAAC;KACX;IACD,wBAAwB,EAAE;QACxB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,MAAM;KAChB;IACD,+BAA+B,EAAE;QAC/B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,EAAE;QACX,WAAW,EAAE;;;;;;;;;;;;;;OAcZ;KACF;CACF,CAAC;KAED,GAAG,CAAC;IACH,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,CAAC,CAAU,EAAE,EAAE,CACvB,OAAO,CAAC,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAChD,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,EAAE;QACX,WAAW,EAAE;;;;;;;;;;qBAUE;KAChB;CACF,CAAC;KAED,OAAO,CAAC;IACP,SAAS,EAAE;QACT,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;;+BAMY;KAC1B;IACD,iBAAiB,EAAE;QACjB,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;mEACgD;KAC9D;CACF,CAAC;KAED,IAAI,CAAC;IACJ,SAAS,EAAE;QACT,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;yEAKsD;KACpE;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;0CACuB;QACpC,OAAO,EAAE,IAAI;KACd;IAED,SAAS,EAAE;QACT,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;uEACoD;KAClE;CACF,CAAC;KAED,GAAG,CAAC;IACH,MAAM,EAAE;QACN,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE;8EAC2D;QACxE,YAAY,EAAE,CAAC,MAAM,EAAE,SAAS,CAAU;QAC1C,OAAO,EAAE,SAAS;KACnB;IAED,MAAM,EAAE;QACN,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;;;;;qEAKkD;QAC/D,OAAO,EACL,OAAO,CAAC,GAAG,CAAC,MAAM;YAClB,OAAO,CAAC,GAAG,CAAC,MAAM;YAClB,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;gBAC7B,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,eAAe;gBAC1C,CAAC,CAAC,IAAI,CAAC;KACV;IAED,cAAc,EAAE;QACd,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;;;;;;;;kEAQ+C;KAC7D;IAED,kBAAkB,EAAE;QAClB,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;;;;;;2BAMQ;QACrB,OAAO,EAAE,MAAM;QACf,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;KAC7C;CACF,CAAC;KAED,GAAG,CAAC;IACH,OAAO,EAAE;QACP,IAAI,EAAE,GAAG;QACT,WAAW,EAAE;;;4EAGyD;KACvE;CACF,CAAC;KAED,GAAG,CAAC;IACH,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,WAAW;QACpB,WAAW,EAAE;;;;;;;;;;;;;;;;;;OAkBZ;QACD,YAAY,EAAE;YACZ,OAAO;YACP,MAAM;YACN,SAAS;YACT,KAAK;YACL,SAAS;SACD;KACX;CACF,CAAC;KAED,OAAO,CAAC;IACP,gBAAgB,EAAE;QAChB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE;iEAC8C;KAC5D;CACF,CAAC;KAED,IAAI,CAAC;IACJ,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;oCACiB;KAC/B;IACD,eAAe,EAAE;QACf,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;yCACsB;KACpC;IACD,WAAW,EAAE;QACX,WAAW,EAAE;qCACkB;KAChC;IACD,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;wEAGqD;KACnE;CACF,CAAC;KAED,IAAI,CAAC;IACJ,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,mBAAmB;KACjC;CACF,CAAC;KAED,IAAI,CAAC;IACJ,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,2BAA2B;KACzC;CACF,CAAC,CAAA","sourcesContent":["import { XDG } from '@vltpkg/xdg'\nimport { jack } from 'jackspeak'\n\nexport const defaultView = process.stdout.isTTY ? 'human' : 'json'\n\nconst canonicalCommands = {\n  config: 'config',\n  exec: 'exec',\n  gui: 'gui',\n  help: 'help',\n  init: 'init',\n  'install-exec': 'install-exec',\n  install: 'install',\n  login: 'login',\n  logout: 'logout',\n  list: 'list',\n  ls: 'ls',\n  pkg: 'pkg',\n  query: 'query',\n  'run-exec': 'run-exec',\n  run: 'run',\n  token: 'token',\n  uninstall: 'uninstall',\n  whoami: 'whoami',\n} as const\n\nconst aliases = {\n  i: 'install',\n  add: 'install',\n  rm: 'uninstall',\n  u: 'uninstall',\n  r: 'run',\n  'run-script': 'run',\n  rx: 'run-exec',\n  x: 'exec',\n  h: 'help',\n  '?': 'help',\n  conf: 'config',\n  ix: 'install-exec',\n  ls: 'list',\n} as const\n\n/**\n * Command aliases mapped to their canonical names\n */\nexport const commands = {\n  ...canonicalCommands,\n  ...aliases,\n} as const\n\n/**\n * Canonical command names mapped to an array of its aliases\n */\nexport const commandAliases = Object.entries(aliases).reduce(\n  (acc, [alias, canonical]) => {\n    const commandAliases = acc.get(canonical)\n    if (commandAliases) {\n      commandAliases.push(alias)\n    } else {\n      acc.set(canonical, [alias])\n    }\n    return acc\n  },\n  new Map<string, string[]>(),\n)\n\nexport type Commands = typeof commands\n\nexport const getCommand = (\n  s?: string,\n): Commands[keyof Commands] | undefined =>\n  s && s in commands ? commands[s as keyof Commands] : undefined\n\nconst xdg = new XDG('vlt')\nconst cacheDir = xdg.cache()\n\n/**\n * Fields that are parsed as a set of key=value pairs\n */\nexport const recordFields = [\n  'git-hosts',\n  'registries',\n  'git-host-archives',\n  'scope-registries',\n] as const\n\nexport type RecordField = (typeof recordFields)[number]\n\nexport const isRecordField = (s: string): s is RecordField =>\n  recordFields.includes(s as RecordField)\n\nconst stopParsingCommands: Commands[keyof Commands][] = [\n  'run',\n  'run-exec',\n  'exec',\n  'install-exec',\n]\n\nlet stopParsing: boolean | undefined = undefined\n\nconst j = jack({\n  envPrefix: 'VLT',\n  allowPositionals: true,\n  usage: `vlt [<options>] [<cmd> [<args> ...]]`,\n  stopAtPositionalTest: arg => {\n    if (stopParsing) return true\n    const a = arg as keyof Commands\n    // we stop parsing AFTER the thing, so you can do\n    // vlt run --vlt --configs scriptName --args --for --script\n    // or\n    // vlt exec --vlt --configs command --args --for --command\n    if (stopParsingCommands.includes(commands[a])) {\n      stopParsing = true\n    }\n    return false\n  },\n})\n  .heading('vlt')\n  .description(\n    `More documentation available at <https://docs.vlt.sh>`,\n  )\n  .heading('Subcommands')\n\nj.description(Object.keys(canonicalCommands).join(', '), {\n  pre: true,\n}).description(\n  'Run `vlt <cmd> --help` for more information about a specific command',\n)\n\nexport const definition = j\n  /**\n   * Definition of all configuration values used by vlt.\n   */\n  .heading('Configuration')\n  .description(\n    `If a \\`vlt.json\\` file is present in the root of the current project,\n     then that will be used as a source of configuration information.\n\n     Next, the \\`vlt.json\\` file in the XDG specified config directory\n     will be checked, and loaded for any fields not set in the local project.\n\n     Object type values will be merged together. Set a field to \\`null\\` in\n     the JSON configuration to explicitly remove it.\n\n     Command-specific fields may be set in a nested \\`command\\` object that\n     overrides any options defined at the top level.\n    `,\n  )\n\n  .flag({\n    color: {\n      short: 'c',\n      description: 'Use colors (Default for TTY)',\n    },\n    'no-color': {\n      short: 'C',\n      description: 'Do not use colors (Default for non-TTY)',\n    },\n  })\n\n  .opt({\n    registry: {\n      hint: 'url',\n      default: 'https://registry.npmjs.org/',\n      description: `Sets the registry for fetching packages, when no registry\n                    is explicitly set on a specifier.\n\n                    For example, \\`express@latest\\` will be resolved by looking\n                    up the metadata from this registry.\n\n                    Note that alias specifiers starting with \\`npm:\\` will\n                    still map to \\`https://registry.npmjs.org/\\` if this is\n                    changed, unless the a new mapping is created via the\n                    \\`--registries\\` option.\n      `,\n    },\n  })\n\n  .optList({\n    registries: {\n      hint: 'name=url',\n      description: `Specify named registry hosts by their prefix. To set the\n                    default registry used for non-namespaced specifiers,\n                    use the \\`--registry\\` option.\n\n                    Prefixes can be used as a package alias. For example:\n\n                    \\`\\`\\`\n                    vlt --registries loc=http://reg.local install foo@loc:foo@1.x\n                    \\`\\`\\`\n\n                    By default, the public npm registry is registered to the\n                    \\`npm:\\` prefix. It is not recommended to change this\n                    mapping in most cases.\n                    `,\n    },\n\n    'scope-registries': {\n      hint: '@scope=url',\n      description: `Map package name scopes to registry URLs.\n\n                    For example,\n                    \\`--scope-registries @acme=https://registry.acme/\\`\n                    would tell vlt to fetch any packages named\n                    \\`@acme/...\\` from the \\`https://registry.acme/\\`\n                    registry.\n\n                    Note: this way of specifying registries is more ambiguous,\n                    compared with using the \\`--registries\\` field and explicit\n                    prefixes, because instead of failing when the configuration\n                    is absent, it will instead attempt to fetch from the\n                    default registry.\n\n                    By comparison, using\n                    \\`--registries acme=https://registry.acme/\\` and then\n                    specifying dependencies such as \\`\"foo\": \"acme:foo@1.x\"\\`\n                    means that regardless of the name, the package will be\n                    fetched from the explicitly named registry, or fail if\n                    no registry is defined with that name.\n\n                    However, custom registry aliases are not supported by other\n                    package managers.`,\n    },\n\n    'git-hosts': {\n      hint: `name=template`,\n      short: 'G',\n      description: `Map a shorthand name to a git remote URL template.\n\n                    The \\`template\\` may contain placeholders, which will be\n                    swapped with the relevant values.\n\n                    \\`$1\\`, \\`$2\\`, etc. are replaced with the appropriate\n                    n-th path portion. For example, \\`github:user/project\\`\n                    would replace the \\`$1\\` in the template with \\`user\\`,\n                    and \\`$2\\` with \\`project\\`.`,\n    },\n\n    'git-host-archives': {\n      hint: `name=template`,\n      short: 'A',\n      description: `Similar to the \\`--git-host <name>=<template>\\` option,\n                    this option can define a template string that will be\n                    expanded to provide the URL to download a pre-built\n                    tarball of the git repository.\n\n                    In addition to the n-th path portion expansions performed\n                    by \\`--git-host\\`, this field will also expand the\n                    string \\`$committish\\` in the template, replacing it with\n                    the resolved git committish value to be fetched.`,\n    },\n  })\n\n  .opt({\n    cache: {\n      hint: 'path',\n      description: `\n        Location of the vlt on-disk cache. Defaults to the platform-specific\n        directory recommended by the XDG specification.\n      `,\n      default: cacheDir,\n    },\n    tag: {\n      description: `Default \\`dist-tag\\` to install`,\n      default: 'latest',\n    },\n    before: {\n      hint: 'date',\n      description: `Do not install any packages published after this date`,\n    },\n    os: {\n      description: `The operating system to use as the selector when choosing\n                    packages based on their \\`os\\` value.`,\n      default: process.platform,\n    },\n    arch: {\n      description: `CPU architecture to use as the selector when choosing\n                    packages based on their \\`cpu\\` value.`,\n      default: process.arch,\n    },\n    'node-version': {\n      hint: 'version',\n      description: `Node version to use when choosing packages based on\n                    their \\`engines.node\\` value.`,\n      default: process.version,\n    },\n  })\n\n  .flag({\n    'git-shallow': {\n      description: `Set to force \\`--depth=1\\` on all git clone actions.\n                    When set explicitly to false with --no-git-shallow,\n                    then \\`--depth=1\\` will not be used.\n\n                    When not set explicitly, \\`--depth=1\\` will be used for\n                    git hosts known to support this behavior.`,\n    },\n  })\n  .num({\n    'fetch-retries': {\n      hint: 'n',\n      description: `Number of retries to perform when encountering network\n                    errors or likely-transient errors from git hosts.`,\n      default: 3,\n    },\n    'fetch-retry-factor': {\n      hint: 'n',\n      description: `The exponential backoff factor to use when retrying\n                    requests due to network issues.`,\n      default: 2,\n    },\n    'fetch-retry-mintimeout': {\n      hint: 'n',\n      description: `Number of milliseconds before starting first retry`,\n      default: 0,\n    },\n    'fetch-retry-maxtimeout': {\n      hint: 'n',\n      description: `Maximum number of milliseconds between two retries`,\n      default: 30_000,\n    },\n    'stale-while-revalidate-factor': {\n      hint: 'n',\n      default: 60,\n      description: `If the server does not serve a \\`stale-while-revalidate\\`\n                    value in the \\`cache-control\\` header, then this multiplier\n                    is applied to the \\`max-age\\` or \\`s-maxage\\` values.\n\n                    By default, this is \\`60\\`, so for example a response that\n                    is cacheable for 5 minutes will allow a stale response\n                    while revalidating for up to 5 hours.\n\n                    If the server *does* provide a \\`stale-while-revalidate\\`\n                    value, then that is always used.\n\n                    Set to 0 to prevent any \\`stale-while-revalidate\\` behavior\n                    unless explicitly allowed by the server's \\`cache-control\\`\n                    header.\n      `,\n    },\n  })\n\n  .opt({\n    identity: {\n      short: 'i',\n      validate: (v: unknown) =>\n        typeof v === 'string' && /^[a-z0-9]*$/.test(v),\n      hint: 'name',\n      default: '',\n      description: `Provide a string to define an identity for storing auth\n                    information when logging into registries.\n\n                    Authentication tokens will be stored in the XDG data\n                    directory, in \\`vlt/auth/$\\{identity}/keychain.json\\`.\n\n                    If no identity is provided, then the default \\`''\\` will\n                    be used, storing the file at \\`vlt/auth/keychain.json\\`.\n\n                    May only contain lowercase alphanumeric characters.\n                    `,\n    },\n  })\n\n  .optList({\n    workspace: {\n      hint: 'ws',\n      short: 'w',\n      description: `Set to limit the spaces being worked on when working on\n                    workspaces.\n\n                    Can be paths or glob patterns matching paths.\n\n                    Specifying workspaces by package.json name is not\n                    supported.`,\n    },\n    'workspace-group': {\n      short: 'g',\n      description: `Specify named workspace group names to load and operate on\n                    when doing recursive operations on workspaces.`,\n    },\n  })\n\n  .flag({\n    recursive: {\n      short: 'r',\n      description: `Run an operation across multiple workspaces.\n\n                    No effect when used in non-monorepo projects.\n\n                    Implied by setting --workspace or --workspace-group. If\n                    not set, then the action is run on the project root.`,\n    },\n\n    bail: {\n      short: 'b',\n      description: `When running scripts across multiple workspaces, stop\n                    on the first failure.`,\n      default: true,\n    },\n\n    'no-bail': {\n      short: 'B',\n      description: `When running scripts across multiple workspaces, continue\n                    on failure, running the script for all workspaces.`,\n    },\n  })\n\n  .opt({\n    config: {\n      hint: 'user | project',\n      description: `Specify whether to operate on user-level or project-level\n                    configuration files when running \\`vlt config\\` commands.`,\n      validOptions: ['user', 'project'] as const,\n      default: 'project',\n    },\n\n    editor: {\n      hint: 'program',\n      description: `The blocking editor to use for \\`vlt config edit\\` and\n                    any other cases where a file should be opened for\n                    editing.\n\n                    Defaults to the \\`EDITOR\\` or \\`VISUAL\\` env if set, or\n                    \\`notepad.exe\\` on Windows, or \\`vi\\` elsewhere.`,\n      default:\n        process.env.EDITOR ||\n        process.env.VISUAL ||\n        (process.platform === 'win32' ?\n          `${process.env.SYSTEMROOT}\\\\notepad.exe`\n        : 'vi'),\n    },\n\n    'script-shell': {\n      hint: 'program',\n      description: `The shell to use when executing \\`package.json#scripts\\`\n                    (either as lifecycle scripts or explicitly with\n                    \\`vlt run\\`) and \\`vlt exec\\`.\n\n                    If not set, defaults to \\`/bin/sh\\` on POSIX systems,\n                    and \\`cmd.exe\\` on Windows.\n\n                    When no argument is provided to \\`vlt exec\\`, the \\`SHELL\\`\n                    environment variable takes precedence if set.`,\n    },\n\n    'fallback-command': {\n      hint: 'command',\n      description: `The command to run when the first argument doesn't\n                    match any known commands.\n\n                    For pnpm-style behavior, set this to 'run-exec'. e.g:\n                    \\`\\`\\`\n                    vlt config set fallback-command=run-exec\n                    \\`\\`\\``,\n      default: 'help',\n      validOptions: Object.keys(canonicalCommands),\n    },\n  })\n\n  .opt({\n    package: {\n      hint: 'p',\n      description: `When running \\`vlt install-exec\\`, this allows you to\n                    explicitly set the package to search for bins. If not\n                    provided, then vlt will interpret the first argument as\n                    the package, and attempt to run the default executable.`,\n    },\n  })\n\n  .opt({\n    view: {\n      hint: 'output',\n      default: defaultView,\n      description: `Configures the output format for commands.\n\n                    Defaults to \\`human\\` if stdout is a TTY, or \\`json\\`\n                    if it is not.\n\n                    - human: Maximally ergonomic output reporting for human\n                      consumption.\n                    - json: Parseable JSON output for machines.\n                    - inspect: Output results with \\`util.inspect\\`.\n                    - gui: Start a local web server and opens a browser to\n                      explore the results. (Only relevant for certain\n                      commands.)\n                    - mermaid: Output mermaid diagramming syntax. (Only\n                      relevant for certain commands.)\n\n                    If the requested view format is not supported for the\n                    current command, or if no option is provided, then it\n                    will fall back to the default.\n      `,\n      validOptions: [\n        'human',\n        'json',\n        'mermaid',\n        'gui',\n        'inspect',\n      ] as const,\n    },\n  })\n\n  .optList({\n    'dashboard-root': {\n      hint: 'path',\n      description: `The root directory to use for the dashboard GUI.\n                    If not set, the user home directory is used.`,\n    },\n  })\n\n  .flag({\n    'save-dev': {\n      short: 'D',\n      description: `Save installed packages to a package.json file as\n                    devDependencies`,\n    },\n    'save-optional': {\n      short: 'O',\n      description: `Save installed packages to a package.json file as\n                    optionalDependencies`,\n    },\n    'save-peer': {\n      description: `Save installed packages to a package.json file as\n                    peerDependencies`,\n    },\n    'save-prod': {\n      short: 'P',\n      description: `Save installed packages into dependencies specifically.\n                    This is useful if a package already exists in\n                    devDependencies or optionalDependencies, but you want to\n                    move it to be a non-optional production dependency.`,\n    },\n  })\n\n  .flag({\n    version: {\n      short: 'v',\n      description: 'Print the version',\n    },\n  })\n\n  .flag({\n    help: {\n      short: 'h',\n      description: 'Print helpful information',\n    },\n  })\n"]}
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../src/config/definition.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEhC,MAAM,CAAC,MAAM,WAAW;AACtB,uCAAuC;AACvC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO;IAC5B,6DAA6D;IAC7D,sDAAsD;IACxD,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO;QACxB,6BAA6B;QAC/B,CAAC,CAAC,MAAM,CAAA;AAEV,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,EAAE,CAChC,OAAO,CAAC,GAAG,CAAC,MAAM;IAClB,OAAO,CAAC,GAAG,CAAC,MAAM;IAClB,CAAC,OAAO,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC;QAC7B,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,eAAe;QAC1C,CAAC,CAAC,IAAI,CAAC,CAAA;AAET,MAAM,iBAAiB,GAAG;IACxB,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,EAAE,EAAE,IAAI;IACR,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,YAAY;IAC1B,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,EAAE,EAAE,IAAI;IACR,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,UAAU;IACtB,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAE,YAAY;IAC1B,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;CACR,CAAA;AAEV,MAAM,OAAO,GAAG;IACd,CAAC,EAAE,SAAS;IACZ,GAAG,EAAE,SAAS;IACd,EAAE,EAAE,WAAW;IACf,CAAC,EAAE,QAAQ;IACX,CAAC,EAAE,KAAK;IACR,GAAG,EAAE,SAAS;IACd,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,KAAK;IACR,YAAY,EAAE,KAAK;IACnB,EAAE,EAAE,UAAU;IACd,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,MAAM;IACT,EAAE,EAAE,YAAY;IAChB,CAAC,EAAE,MAAM;IACT,GAAG,EAAE,MAAM;IACX,EAAE,EAAE,MAAM;IACV,EAAE,EAAE,YAAY;CACR,CAAA;AAEV;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,GAAG,iBAAiB;IACpB,GAAG,OAAO;CACF,CAAA;AAEV;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,CAC1D,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE;IAC1B,MAAM,cAAc,GAAG,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACzC,IAAI,cAAc,EAAE,CAAC;QACnB,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC5B,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;IAC7B,CAAC;IACD,OAAO,GAAG,CAAA;AACZ,CAAC,EACD,IAAI,GAAG,EAAoB,CAC5B,CAAA;AAID,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,CAAU,EAC4B,EAAE,CACxC,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAmB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AAEhE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;AAC1B,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,EAAE,CAAA;AAE5B;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,WAAW;IACX,YAAY;IACZ,mBAAmB;IACnB,kBAAkB;IAClB,gBAAgB;CACR,CAAA;AAIV,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAS,EAAoB,EAAE,CAC3D,YAAY,CAAC,QAAQ,CAAC,CAAgB,CAAC,CAAA;AAEzC,MAAM,mBAAmB,GAA+B;IACtD,KAAK;IACL,UAAU;IACV,YAAY;IACZ,MAAM;CACP,CAAA;AAED,IAAI,WAAW,GAAwB,SAAS,CAAA;AAEhD,MAAM,CAAC,GAAG,IAAI,CAAC;IACb,SAAS,EAAE,KAAK;IAChB,gBAAgB,EAAE,IAAI;IACtB,KAAK,EAAE,sCAAsC;IAC7C,oBAAoB,EAAE,GAAG,CAAC,EAAE;QAC1B,IAAI,WAAW;YAAE,OAAO,IAAI,CAAA;QAC5B,MAAM,CAAC,GAAG,GAAqB,CAAA;QAC/B,iDAAiD;QACjD,2DAA2D;QAC3D,KAAK;QACL,0DAA0D;QAC1D,IAAI,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9C,WAAW,GAAG,IAAI,CAAA;QACpB,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;CACF,CAAC;KACC,OAAO,CAAC,KAAK,CAAC;KACd,WAAW,CACV,uDAAuD,CACxD;KACA,OAAO,CAAC,aAAa,CAAC,CAAA;AAEzB,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;IACvD,GAAG,EAAE,IAAI;CACV,CAAC,CAAC,WAAW,CACZ,sEAAsE,CACvE,CAAA;AAED,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;IACzB;;OAEG;KACF,OAAO,CAAC,eAAe,CAAC;KACxB,WAAW,CACV;;;;;;;;;;;KAWC,CACF;KAEA,IAAI,CAAC;IACJ,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,8BAA8B;KAC5C;IACD,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,yCAAyC;KACvD;CACF,CAAC;KAED,GAAG,CAAC;IACH,QAAQ,EAAE;QACR,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,6BAA6B;QACtC,WAAW,EAAE;;;;;;;;;;OAUZ;KACF;CACF,CAAC;KAED,OAAO,CAAC;IACP,UAAU,EAAE;QACV,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE;;;;;;;;;;;;;qBAaE;KAChB;IAED,kBAAkB,EAAE;QAClB,IAAI,EAAE,YAAY;QAClB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;sCAsBmB;KACjC;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE;;;;;;;;;;;;;;oBAcC;KACf;IAED,WAAW,EAAE;QACX,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;;;;iDAQ8B;KAC5C;IAED,mBAAmB,EAAE;QACnB,IAAI,EAAE,eAAe;QACrB,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;;;;qEAQkD;KAChE;CACF,CAAC;KAED,GAAG,CAAC;IACH,KAAK,EAAE;QACL,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE;;;OAGZ;QACD,OAAO,EAAE,QAAQ;KAClB;IACD,GAAG,EAAE;QACH,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,QAAQ;KAClB;IACD,MAAM,EAAE;QACN,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,uDAAuD;KACrE;IACD,EAAE,EAAE;QACF,WAAW,EAAE;0DACuC;QACpD,OAAO,EAAE,OAAO,CAAC,QAAQ;KAC1B;IACD,IAAI,EAAE;QACJ,WAAW,EAAE;2DACwC;QACrD,OAAO,EAAE,OAAO,CAAC,IAAI;KACtB;IACD,cAAc,EAAE;QACd,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;kDAC+B;QAC5C,OAAO,EAAE,OAAO,CAAC,OAAO;KACzB;CACF,CAAC;KAED,IAAI,CAAC;IACJ,aAAa,EAAE;QACb,WAAW,EAAE;;;;;8DAK2C;KACzD;CACF,CAAC;KACD,GAAG,CAAC;IACH,eAAe,EAAE;QACf,IAAI,EAAE,GAAG;QACT,WAAW,EAAE;sEACmD;QAChE,OAAO,EAAE,CAAC;KACX;IACD,oBAAoB,EAAE;QACpB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE;oDACiC;QAC9C,OAAO,EAAE,CAAC;KACX;IACD,wBAAwB,EAAE;QACxB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,CAAC;KACX;IACD,wBAAwB,EAAE;QACxB,IAAI,EAAE,GAAG;QACT,WAAW,EAAE,oDAAoD;QACjE,OAAO,EAAE,MAAM;KAChB;IACD,+BAA+B,EAAE;QAC/B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,EAAE;QACX,WAAW,EAAE;;;;;;;;;;;;;;OAcZ;KACF;CACF,CAAC;KAED,GAAG,CAAC;IACH,QAAQ,EAAE;QACR,KAAK,EAAE,GAAG;QACV,QAAQ,EAAE,CAAC,CAAU,EAAE,EAAE,CACvB,OAAO,CAAC,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC;QAChD,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,EAAE;QACX,WAAW,EAAE;;;;;;;;;;qBAUE;KAChB;CACF,CAAC;KAED,OAAO,CAAC;IACP,SAAS,EAAE;QACT,IAAI,EAAE,IAAI;QACV,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;;+BAMY;KAC1B;IACD,iBAAiB,EAAE;QACjB,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;mEACgD;KAC9D;CACF,CAAC;KAED,GAAG,CAAC;IACH,KAAK,EAAE;QACL,KAAK,EAAE,GAAG;QACV,IAAI,EAAE,OAAO;QACb,WAAW,EACT,4DAA4D;KAC/D;IACD,MAAM,EAAE;QACN,KAAK,EAAE,GAAG;QACV,IAAI,EAAE,OAAO;QACb,WAAW,EACT,oDAAoD;KACvD;CACF,CAAC;KAED,IAAI,CAAC;IACJ,YAAY,EAAE;QACZ,WAAW,EAAE;;;;;;;;8CAQ2B;KACzC;CACF,CAAC;KAED,IAAI,CAAC;IACJ,SAAS,EAAE;QACT,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;;;yEAKsD;KACpE;IAED,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;0CACuB;QACpC,OAAO,EAAE,IAAI;KACd;IAED,SAAS,EAAE;QACT,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;uEACoD;KAClE;CACF,CAAC;KAED,GAAG,CAAC;IACH,MAAM,EAAE;QACN,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EAAE;;;;;;mCAMgB;QAC7B,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAU;QACjD,OAAO,EAAE,KAAK;KACf;IAED,MAAM,EAAE;QACN,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;;;;;qEAKkD;QAC/D,OAAO,EAAE,aAAa,EAAE;KACzB;IAED,cAAc,EAAE;QACd,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;;;;;;;;;;;;OAYZ;KACF;IAED,kBAAkB,EAAE;QAClB,IAAI,EAAE,SAAS;QACf,WAAW,EAAE;;;;;;2BAMQ;QACrB,OAAO,EAAE,MAAM;QACf,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC;KAC7C;CACF,CAAC;KAED,GAAG,CAAC;IACH,OAAO,EAAE;QACP,IAAI,EAAE,GAAG;QACT,WAAW,EAAE;;;2DAGwC;KACtD;CACF,CAAC;KAED,GAAG,CAAC;IACH,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,WAAW;QACpB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;OAmBZ;QACD,YAAY,EAAE;YACZ,OAAO;YACP,MAAM;YACN,SAAS;YACT,KAAK;YACL,SAAS;YACT,QAAQ;SACA;KACX;CACF,CAAC;KAED,OAAO,CAAC;IACP,gBAAgB,EAAE;QAChB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE;iEAC8C;KAC5D;CACF,CAAC;KAED,IAAI,CAAC;IACJ,UAAU,EAAE;QACV,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;oCACiB;KAC/B;IACD,eAAe,EAAE;QACf,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;yCACsB;KACpC;IACD,WAAW,EAAE;QACX,WAAW,EAAE;qCACkB;KAChC;IACD,WAAW,EAAE;QACX,KAAK,EAAE,GAAG;QACV,WAAW,EAAE;;;wEAGqD;KACnE;CACF,CAAC;KAED,GAAG,CAAC;IACH,gBAAgB,EAAE;QAChB,IAAI,EAAE,OAAO;QACb,QAAQ,EAAE,CAAC,CAAU,EAAE,EAAE,CACvB,OAAO,CAAC,KAAK,QAAQ,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;QACtD,WAAW,EAAE;;;;;;;oEAOiD;KAC/D;CACF,CAAC;KAED,IAAI,CAAC;IACJ,SAAS,EAAE;QACT,WAAW,EAAE,wCAAwC;KACtD;IACD,iBAAiB,EAAE;QACjB,WAAW,EACT,+FAA+F;KAClG;IACD,iBAAiB,EAAE;QACjB,WAAW,EACT,oGAAoG;KACvG;IACD,eAAe,EAAE;QACf,WAAW,EACT,wJAAwJ;KAC3J;CACF,CAAC;KACD,GAAG,CAAC;IACH,eAAe,EAAE;QACf,IAAI,EAAE,OAAO;QACb,WAAW,EAAE;;;;;;;0GAOuF;KACrG;CACF,CAAC;KACD,GAAG,CAAC;IACH,MAAM,EAAE;QACN,WAAW,EAAE,qCAAqC;QAClD,YAAY,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAU;QAC/C,OAAO,EAAE,QAAQ;KAClB;CACF,CAAC;KACD,GAAG,CAAC;IACH,GAAG,EAAE;QACH,WAAW,EAAE,kDAAkD;KAChE;IACD,mBAAmB,EAAE;QACnB,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE;+EAC4D;KAC1E;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,oFAAoF;KAClG;IACD,eAAe,EAAE;QACf,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,yEAAyE;KACvF;CACF,CAAC;KAED,IAAI,CAAC;IACJ,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,+CAA+C;KAC7D;IACD,OAAO,EAAE;QACP,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,mBAAmB;KACjC;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,2BAA2B;KACzC;IACD,GAAG,EAAE;QACH,KAAK,EAAE,GAAG;QACV,WAAW,EAAE,oCAAoC;KAClD;CACF,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE;IACtC,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,EAAE,CAAA;IAChC,OAAO,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,CAAoB,EAAE,EAAE;QAClD,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;QACnB,oBAAoB;QACpB,IAAI,CAAC,GAAG;YAAE,MAAM,KAAK,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAA;QACxD,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC,EAAE,CAAA;QAC3C,OAAO,KAAK,CAAC,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAA;IACpC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,GAAG,EAAE,CAChC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { XDG } from '@vltpkg/xdg'\nimport { jack } from 'jackspeak'\n\nexport const defaultView =\n  // If stdout is a TTY, use human output\n  process.stdout.isTTY ? 'human'\n    // If its not a TTY but is a CI environment, use human output\n    // TODO: make a better view option for CI environments\n  : process.env.CI ? 'human'\n    // Otherwise, use json output\n  : 'json'\n\nexport const defaultEditor = () =>\n  process.env.EDITOR ||\n  process.env.VISUAL ||\n  (process.platform === 'win32' ?\n    `${process.env.SYSTEMROOT}\\\\notepad.exe`\n  : 'vi')\n\nconst canonicalCommands = {\n  build: 'build',\n  cache: 'cache',\n  ci: 'ci',\n  config: 'config',\n  docs: 'docs',\n  exec: 'exec',\n  'exec-local': 'exec-local',\n  help: 'help',\n  init: 'init',\n  install: 'install',\n  login: 'login',\n  logout: 'logout',\n  list: 'list',\n  ls: 'ls',\n  pack: 'pack',\n  pkg: 'pkg',\n  publish: 'publish',\n  query: 'query',\n  'run-exec': 'run-exec',\n  run: 'run',\n  serve: 'serve',\n  token: 'token',\n  uninstall: 'uninstall',\n  update: 'update',\n  'exec-cache': 'exec-cache',\n  version: 'version',\n  whoami: 'whoami',\n} as const\n\nconst aliases = {\n  i: 'install',\n  add: 'install',\n  rm: 'uninstall',\n  u: 'update',\n  p: 'pkg',\n  pub: 'publish',\n  q: 'query',\n  b: 'build',\n  r: 'run',\n  'run-script': 'run',\n  rx: 'run-exec',\n  s: 'serve',\n  x: 'exec',\n  xl: 'exec-local',\n  h: 'help',\n  '?': 'help',\n  ls: 'list',\n  xc: 'exec-cache',\n} as const\n\n/**\n * Command aliases mapped to their canonical names\n */\nexport const commands = {\n  ...canonicalCommands,\n  ...aliases,\n} as const\n\n/**\n * Canonical command names mapped to an array of its aliases\n */\nexport const commandAliases = Object.entries(aliases).reduce(\n  (acc, [alias, canonical]) => {\n    const commandAliases = acc.get(canonical)\n    if (commandAliases) {\n      commandAliases.push(alias)\n    } else {\n      acc.set(canonical, [alias])\n    }\n    return acc\n  },\n  new Map<string, string[]>(),\n)\n\nexport type Commands = typeof commands\n\nexport const getCommand = (\n  s?: string,\n): Commands[keyof Commands] | undefined =>\n  s && s in commands ? commands[s as keyof Commands] : undefined\n\nconst xdg = new XDG('vlt')\nconst cacheDir = xdg.cache()\n\n/**\n * Fields that are parsed as a set of key=value pairs\n */\nexport const recordFields = [\n  'git-hosts',\n  'registries',\n  'git-host-archives',\n  'scope-registries',\n  'jsr-registries',\n] as const\n\nexport type RecordField = (typeof recordFields)[number]\n\nexport const isRecordField = (s: string): s is RecordField =>\n  recordFields.includes(s as RecordField)\n\nconst stopParsingCommands: Commands[keyof Commands][] = [\n  'run',\n  'run-exec',\n  'exec-local',\n  'exec',\n]\n\nlet stopParsing: boolean | undefined = undefined\n\nconst j = jack({\n  envPrefix: 'VLT',\n  allowPositionals: true,\n  usage: `vlt [<options>] [<cmd> [<args> ...]]`,\n  stopAtPositionalTest: arg => {\n    if (stopParsing) return true\n    const a = arg as keyof Commands\n    // we stop parsing AFTER the thing, so you can do\n    // vlt run --vlt --configs scriptName --args --for --script\n    // or\n    // vlt exec --vlt --configs command --args --for --command\n    if (stopParsingCommands.includes(commands[a])) {\n      stopParsing = true\n    }\n    return false\n  },\n})\n  .heading('vlt')\n  .description(\n    `More documentation available at <https://docs.vlt.sh>`,\n  )\n  .heading('Subcommands')\n\nj.description(Object.keys(canonicalCommands).join(', '), {\n  pre: true,\n}).description(\n  'Run `vlt <cmd> --help` for more information about a specific command',\n)\n\nexport const definition = j\n  /**\n   * Definition of all configuration values used by vlt.\n   */\n  .heading('Configuration')\n  .description(\n    `If a \\`vlt.json\\` file is present in the root of the current project,\n     then that will be used as a source of configuration information.\n\n     Next, the \\`vlt.json\\` file in the XDG specified config directory\n     will be checked, and loaded for any fields not set in the local project.\n\n     Object type values will be merged together. Set a field to \\`null\\` in\n     the JSON configuration to explicitly remove it.\n\n     Command-specific fields may be set in a nested \\`command\\` object that\n     overrides any options defined at the top level.\n    `,\n  )\n\n  .flag({\n    color: {\n      short: 'c',\n      description: 'Use colors (Default for TTY)',\n    },\n    'no-color': {\n      short: 'C',\n      description: 'Do not use colors (Default for non-TTY)',\n    },\n  })\n\n  .opt({\n    registry: {\n      hint: 'url',\n      default: 'https://registry.npmjs.org/',\n      description: `Sets the registry for fetching packages, when no registry\n                    is explicitly set on a specifier.\n\n                    For example, \\`express@latest\\` will be resolved by looking\n                    up the metadata from this registry.\n\n                    Note that alias specifiers starting with \\`npm:\\` will\n                    still map to \\`https://registry.npmjs.org/\\` if this is\n                    changed, unless the a new mapping is created via the\n                    \\`--registries\\` option.\n      `,\n    },\n  })\n\n  .optList({\n    registries: {\n      hint: 'name=url',\n      description: `Specify named registry hosts by their prefix. To set the\n                    default registry used for non-namespaced specifiers,\n                    use the \\`--registry\\` option.\n\n                    Prefixes can be used as a package alias. For example:\n\n                    \\`\\`\\`\n                    vlt --registries loc=http://reg.local install foo@loc:foo@1.x\n                    \\`\\`\\`\n\n                    By default, the public npm registry is registered to the\n                    \\`npm:\\` prefix. It is not recommended to change this\n                    mapping in most cases.\n                    `,\n    },\n\n    'scope-registries': {\n      hint: '@scope=url',\n      description: `Map package name scopes to registry URLs.\n\n                    For example,\n                    \\`--scope-registries @acme=https://registry.acme/\\`\n                    would tell vlt to fetch any packages named\n                    \\`@acme/...\\` from the \\`https://registry.acme/\\`\n                    registry.\n\n                    Note: this way of specifying registries is more ambiguous,\n                    compared with using the \\`--registries\\` field and explicit\n                    prefixes, because instead of failing when the configuration\n                    is absent, it will instead attempt to fetch from the\n                    default registry.\n\n                    By comparison, using\n                    \\`--registries acme=https://registry.acme/\\` and then\n                    specifying dependencies such as \\`\"foo\": \"acme:foo@1.x\"\\`\n                    means that regardless of the name, the package will be\n                    fetched from the explicitly named registry, or fail if\n                    no registry is defined with that name.\n\n                    However, custom registry aliases are not supported by other\n                    package managers.`,\n    },\n\n    'jsr-registries': {\n      hint: 'name=url',\n      description: `Map alias names to JSR.io registry urls.\n\n                    For example,\n                    \\`--jsr-registries acme=https://jsr.acme.io/\\` would\n                    tell vlt to fetch any packages with the \\`acme:\\` registry\n                    prefix from the \\`https://jsr.acme.io/\\` registry, using\n                    the \"npm Compatibility\" translation. So for example,\n                    the package \\`acme:@foo/bar\\` would fetch the\n                    \\`@jsr/foo__bar\\` package from the \\`jsr.acme.io\\`\n                    registry.\n\n                    By default the \\`jsr\\` alias is always mapped to\n                    \\`https://npm.jsr.io/\\`, so existing \\`jsr:\\` packages will\n                    be fetched from the public \\`jsr\\` registry appropriately.\n                   `,\n    },\n\n    'git-hosts': {\n      hint: `name=template`,\n      short: 'G',\n      description: `Map a shorthand name to a git remote URL template.\n\n                    The \\`template\\` may contain placeholders, which will be\n                    swapped with the relevant values.\n\n                    \\`$1\\`, \\`$2\\`, etc. are replaced with the appropriate\n                    n-th path portion. For example, \\`github:user/project\\`\n                    would replace the \\`$1\\` in the template with \\`user\\`,\n                    and \\`$2\\` with \\`project\\`.`,\n    },\n\n    'git-host-archives': {\n      hint: `name=template`,\n      short: 'A',\n      description: `Similar to the \\`--git-host <name>=<template>\\` option,\n                    this option can define a template string that will be\n                    expanded to provide the URL to download a pre-built\n                    tarball of the git repository.\n\n                    In addition to the n-th path portion expansions performed\n                    by \\`--git-host\\`, this field will also expand the\n                    string \\`$committish\\` in the template, replacing it with\n                    the resolved git committish value to be fetched.`,\n    },\n  })\n\n  .opt({\n    cache: {\n      hint: 'path',\n      description: `\n        Location of the vlt on-disk cache. Defaults to the platform-specific\n        directory recommended by the XDG specification.\n      `,\n      default: cacheDir,\n    },\n    tag: {\n      description: `Default \\`dist-tag\\` to install or publish`,\n      default: 'latest',\n    },\n    before: {\n      hint: 'date',\n      description: `Do not install any packages published after this date`,\n    },\n    os: {\n      description: `The operating system to use as the selector when choosing\n                    packages based on their \\`os\\` value.`,\n      default: process.platform,\n    },\n    arch: {\n      description: `CPU architecture to use as the selector when choosing\n                    packages based on their \\`cpu\\` value.`,\n      default: process.arch,\n    },\n    'node-version': {\n      hint: 'version',\n      description: `Node version to use when choosing packages based on\n                    their \\`engines.node\\` value.`,\n      default: process.version,\n    },\n  })\n\n  .flag({\n    'git-shallow': {\n      description: `Set to force \\`--depth=1\\` on all git clone actions.\n                    When set explicitly to false with --no-git-shallow,\n                    then \\`--depth=1\\` will not be used.\n\n                    When not set explicitly, \\`--depth=1\\` will be used for\n                    git hosts known to support this behavior.`,\n    },\n  })\n  .num({\n    'fetch-retries': {\n      hint: 'n',\n      description: `Number of retries to perform when encountering network\n                    errors or likely-transient errors from git hosts.`,\n      default: 3,\n    },\n    'fetch-retry-factor': {\n      hint: 'n',\n      description: `The exponential backoff factor to use when retrying\n                    requests due to network issues.`,\n      default: 2,\n    },\n    'fetch-retry-mintimeout': {\n      hint: 'n',\n      description: `Number of milliseconds before starting first retry`,\n      default: 0,\n    },\n    'fetch-retry-maxtimeout': {\n      hint: 'n',\n      description: `Maximum number of milliseconds between two retries`,\n      default: 30_000,\n    },\n    'stale-while-revalidate-factor': {\n      hint: 'n',\n      default: 60,\n      description: `If the server does not serve a \\`stale-while-revalidate\\`\n                    value in the \\`cache-control\\` header, then this multiplier\n                    is applied to the \\`max-age\\` or \\`s-maxage\\` values.\n\n                    By default, this is \\`60\\`, so for example a response that\n                    is cacheable for 5 minutes will allow a stale response\n                    while revalidating for up to 5 hours.\n\n                    If the server *does* provide a \\`stale-while-revalidate\\`\n                    value, then that is always used.\n\n                    Set to 0 to prevent any \\`stale-while-revalidate\\` behavior\n                    unless explicitly allowed by the server's \\`cache-control\\`\n                    header.\n      `,\n    },\n  })\n\n  .opt({\n    identity: {\n      short: 'i',\n      validate: (v: unknown) =>\n        typeof v === 'string' && /^[a-z0-9]*$/.test(v),\n      hint: 'name',\n      default: '',\n      description: `Provide a string to define an identity for storing auth\n                    information when logging into registries.\n\n                    Authentication tokens will be stored in the XDG data\n                    directory, in \\`vlt/auth/$\\{identity}/keychain.json\\`.\n\n                    If no identity is provided, then the default \\`''\\` will\n                    be used, storing the file at \\`vlt/auth/keychain.json\\`.\n\n                    May only contain lowercase alphanumeric characters.\n                    `,\n    },\n  })\n\n  .optList({\n    workspace: {\n      hint: 'ws',\n      short: 'w',\n      description: `Set to limit the spaces being worked on when working on\n                    workspaces.\n\n                    Can be paths or glob patterns matching paths.\n\n                    Specifying workspaces by package.json name is not\n                    supported.`,\n    },\n    'workspace-group': {\n      short: 'g',\n      description: `Specify named workspace group names to load and operate on\n                    when doing recursive operations on workspaces.`,\n    },\n  })\n\n  .opt({\n    scope: {\n      short: 's',\n      hint: 'query',\n      description:\n        'Set to filter the scope of an operation using a DSS Query.',\n    },\n    target: {\n      short: 't',\n      hint: 'query',\n      description:\n        'Set to select packages using a DSS Query selector.',\n    },\n  })\n\n  .flag({\n    'if-present': {\n      description: `When running scripts across multiple packages,\n                    only include packages that have the script.\n\n                    If this is not set, then the run will fail if any\n                    packages do not have the script.\n\n                    This will default to true if --scope, --workspace,\n                    --workspace-group, or --recursive is set. Otherwise,\n                    it will default to false.`,\n    },\n  })\n\n  .flag({\n    recursive: {\n      short: 'r',\n      description: `Run an operation across multiple workspaces.\n\n                    No effect when used in non-monorepo projects.\n\n                    Implied by setting --workspace or --workspace-group. If\n                    not set, then the action is run on the project root.`,\n    },\n\n    bail: {\n      short: 'b',\n      description: `When running scripts across multiple workspaces, stop\n                    on the first failure.`,\n      default: true,\n    },\n\n    'no-bail': {\n      short: 'B',\n      description: `When running scripts across multiple workspaces, continue\n                    on failure, running the script for all workspaces.`,\n    },\n  })\n\n  .opt({\n    config: {\n      hint: 'all | user | project',\n      description: `Specify which configuration to show or operate on when running\n                    \\`vlt config\\` commands. For read operations (get, pick, list):\n                    \\`all\\` shows merged configuration from both user and project\n                    files (default). For write operations (set, delete, edit):\n                    defaults to \\`project\\`. \\`user\\` shows/modifies only user-level\n                    configuration, \\`project\\` shows/modifies only project-level\n                    configuration.`,\n      validOptions: ['all', 'user', 'project'] as const,\n      default: 'all',\n    },\n\n    editor: {\n      hint: 'program',\n      description: `The blocking editor to use for \\`vlt config edit\\` and\n                    any other cases where a file should be opened for\n                    editing.\n\n                    Defaults to the \\`EDITOR\\` or \\`VISUAL\\` env if set, or\n                    \\`notepad.exe\\` on Windows, or \\`vi\\` elsewhere.`,\n      default: defaultEditor(),\n    },\n\n    'script-shell': {\n      hint: 'program',\n      description: `The shell to use when executing \\`package.json#scripts\\`.\n\n                    For \\`vlt exec\\` and \\`vlt exec-local\\`, this is never set,\n                    meaning that command arguments are run exactly as provided.\n\n                    For \\`vlt run\\` (and other things that run lifecycle\n                    scripts in \\`package.json#scripts\\`), the entire command\n                    with all arguments is provided as a single string, meaning\n                    that some value must be provided for shell interpretation,\n                    and so for these contexts, the \\`script-shell\\` value will\n                    default to \\`/bin/sh\\` on POSIX systems or \\`cmd.exe\\` on\n                    Windows.\n      `,\n    },\n\n    'fallback-command': {\n      hint: 'command',\n      description: `The command to run when the first argument doesn't\n                    match any known commands.\n\n                    For pnpm-style behavior, set this to 'run-exec'. e.g:\n                    \\`\\`\\`\n                    vlt config set fallback-command=run-exec\n                    \\`\\`\\``,\n      default: 'help',\n      validOptions: Object.keys(canonicalCommands),\n    },\n  })\n\n  .opt({\n    package: {\n      hint: 'p',\n      description: `When running \\`vlt exec\\`, this allows you to explicitly\n                    set the package to search for bins. If not provided, then\n                    vlt will interpret the first argument as the package, and\n                    attempt to run the default executable.`,\n    },\n  })\n\n  .opt({\n    view: {\n      hint: 'output',\n      default: defaultView,\n      description: `Configures the output format for commands.\n\n                    Defaults to \\`human\\` if stdout is a TTY, or \\`json\\`\n                    if it is not.\n\n                    - human: Maximally ergonomic output reporting for human\n                      consumption.\n                    - json: Parseable JSON output for machines.\n                    - inspect: Output results with \\`util.inspect\\`.\n                    - gui: Start a local web server and opens a browser to\n                      explore the results. (Only relevant for certain\n                      commands.)\n                    - mermaid: Output mermaid diagramming syntax. (Only\n                      relevant for certain commands.)\n                    - silent: Suppress all output to stdout.\n\n                    If the requested view format is not supported for the\n                    current command, or if no option is provided, then it\n                    will fall back to the default.\n      `,\n      validOptions: [\n        'human',\n        'json',\n        'mermaid',\n        'gui',\n        'inspect',\n        'silent',\n      ] as const,\n    },\n  })\n\n  .optList({\n    'dashboard-root': {\n      hint: 'path',\n      description: `The root directory to use for the dashboard browser-based UI.\n                    If not set, the user home directory is used.`,\n    },\n  })\n\n  .flag({\n    'save-dev': {\n      short: 'D',\n      description: `Save installed packages to a package.json file as\n                    devDependencies`,\n    },\n    'save-optional': {\n      short: 'O',\n      description: `Save installed packages to a package.json file as\n                    optionalDependencies`,\n    },\n    'save-peer': {\n      description: `Save installed packages to a package.json file as\n                    peerDependencies`,\n    },\n    'save-prod': {\n      short: 'P',\n      description: `Save installed packages into dependencies specifically.\n                    This is useful if a package already exists in\n                    devDependencies or optionalDependencies, but you want to\n                    move it to be a non-optional production dependency.`,\n    },\n  })\n\n  .opt({\n    'expect-results': {\n      hint: 'value',\n      validate: (v: unknown) =>\n        typeof v === 'string' && /^([<>]=?)?[0-9]+$/.test(v),\n      description: `When running \\`vlt query\\`, this option allows you to\n                    set a expected number of resulting items.\n\n                    Accepted values are numbers and strings.\n\n                    Strings starting with \\`>\\`, \\`<\\`, \\`>=\\` or \\`<=\\`\n                    followed by a number can be used to check if the result\n                    is greater than or less than a specific number.`,\n    },\n  })\n\n  .flag({\n    'dry-run': {\n      description: 'Run command without making any changes',\n    },\n    'expect-lockfile': {\n      description:\n        'Fail if lockfile is missing or out of date. Used by ci command to enforce lockfile integrity.',\n    },\n    'frozen-lockfile': {\n      description:\n        'Fail if lockfile is missing or out of sync with package.json. Prevents any lockfile modifications.',\n    },\n    'lockfile-only': {\n      description:\n        'Only update the lockfile (vlt-lock.json) and package.json files, skip all node_modules operations including package extraction and filesystem changes.',\n    },\n  })\n  .opt({\n    'allow-scripts': {\n      hint: 'query',\n      description: `Filter which packages are allowed to run lifecycle scripts using DSS query syntax.\n                    When provided, only packages matching the query will execute their\n                    install, preinstall, postinstall, prepare, preprepare, and postprepare scripts.\n                    Defaults to ':not(*)' which means no scripts will be run.\n                    \n                    Example: --allow-scripts=\":root > *, #my-package\"\n                    Runs scripts only for direct dependencies of the current project and any occurrences\n                    of a specific dependency with the name \"my-package\" anywhere in the dependency graph.`,\n    },\n  })\n  .opt({\n    access: {\n      description: 'Set the access level of the package',\n      validOptions: ['public', 'restricted'] as const,\n      default: 'public',\n    },\n  })\n  .opt({\n    otp: {\n      description: `Provide an OTP to use when publishing a package.`,\n    },\n    'publish-directory': {\n      hint: 'path',\n      description: `Directory to use for pack and publish operations instead of the current directory.\n                    The directory must exist and nothing will be copied to it.`,\n    },\n    port: {\n      hint: 'number',\n      description: `Port for the browser-based UI server when using vlt serve command (default: 8000).`,\n    },\n    'registry-port': {\n      hint: 'number',\n      description: `Port for the VSR registry when using vlt serve command (default: 1337).`,\n    },\n  })\n\n  .flag({\n    yes: {\n      short: 'y',\n      description: `Automatically accept any confirmation prompts`,\n    },\n    version: {\n      short: 'v',\n      description: 'Print the version',\n    },\n    help: {\n      short: 'h',\n      description: 'Print helpful information',\n    },\n    all: {\n      short: 'a',\n      description: 'Show all commands, bins, and flags',\n    },\n  })\n\nexport const getSortedCliOptions = () => {\n  const defs = definition.toJSON()\n  return getSortedKeys().map((k: keyof typeof defs) => {\n    const def = defs[k]\n    /* c8 ignore next */\n    if (!def) throw error('invalid key found', { found: k })\n    if (def.type === 'boolean') return `--${k}`\n    return `--${k}=<${def.hint ?? k}>`\n  })\n}\n\nexport const getSortedKeys = () =>\n  Object.keys(definition.toJSON()).sort((a, b) => a.localeCompare(b))\n"]}

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

@@ -22,38 +22,52 @@
  */
 import { PackageInfoClient } from '@vltpkg/package-info';
 import { PackageJson } from '@vltpkg/package-json';
+import type { SpecOptions } from '@vltpkg/spec';
+import type { WhichConfig } from '@vltpkg/vlt-json';
 import { Monorepo } from '@vltpkg/workspaces';
 import type { Jack, OptionsResults, Unwrap } from 'jackspeak';
 import { PathScurry } from 'path-scurry';
-import { kIndent, kNewline } from 'polite-json';
 import type { Commands, RecordField } from './definition.ts';
 import { commands, definition, isRecordField, recordFields } from './definition.ts';
 export { commands, definition, isRecordField, recordFields, type Commands, };
+export declare const kCustomInspect: unique symbol;
 export type RecordPairs = Record<string, unknown>;
 export type RecordString = Record<string, string>;
-export type ConfigFiles = Record<string, ConfigFileData>;
-export type PairsAsRecords = Omit<ConfigOptions, 'projectRoot' | 'scurry' | 'packageJson' | 'monorepo' | 'packageInfo'> & {
-    command?: Record<string, ConfigOptions>;
+export type PairsAsRecords = ConfigOptionsNoExtras & {
+    command?: {
+        [k in keyof Commands]?: ConfigOptionsNoExtras;
+    };
 };
-export declare const pairsToRecords: (obj: ConfigFileData) => PairsAsRecords;
+export declare const pairsToRecords: (obj: NonNullable<ConfigFileData> | OptionsResults<ConfigDefinitions>) => PairsAsRecords;
 export declare const recordsToPairs: (obj: RecordPairs) => RecordPairs;
+export type ConfigDataNoCommand = {
+    [k in keyof OptionsResults<ConfigDefinitions>]?: OptionsResults<ConfigDefinitions>[k];
+};
 /**
  * Config data can be any options, and also a 'command' field which
  * contains command names and override options for that command.
  */
-export type ConfigData = OptionsResults<ConfigDefinitions> & {
-    command?: Record<string, OptionsResults<ConfigDefinitions>>;
+export type ConfigData = ConfigDataNoCommand & {
+    command?: {
+        [k in keyof Commands]?: ConfigDataNoCommand;
+    };
+};
+export type ConfigFileDataNoCommand = {
+    [k in keyof ConfigDataNoCommand]: k extends (OptListKeys<ConfigDataNoCommand>) ? RecordString | string[] : ConfigDataNoCommand[k];
 };
 /**
- * Config data as it appears in config files, with kv pair lists
- * stored as `Record<string, string>`.
+ * Config data as it appears in the config field of the vlt.json, with kv pair
+ * lists stored as `Record<string, string>` and
  */
-export type ConfigFileData = {
-    [k in keyof ConfigData]?: k extends OptListKeys<ConfigData> ? RecordString | string[] : k extends 'command' ? ConfigFiles : ConfigData[k];
+export type ConfigFileData = ConfigFileDataNoCommand & {
+    command?: {
+        [k in keyof Commands]?: ConfigFileDataNoCommand;
+    };
+};
+export type ConfigOptionsNoExtras = {
+    [k in keyof OptionsResults<ConfigDefinitions>]: k extends (RecordField) ? RecordString : k extends 'command' ? never : OptionsResults<ConfigDefinitions>[k];
 };
-export type ConfigOptions = {
-    [k in keyof ConfigData]: k extends RecordField ? RecordString : k extends 'command' ? never : ConfigData[k];
-} & {
+export type ConfigOptions = ConfigOptionsNoExtras & Pick<SpecOptions, 'catalog' | 'catalogs'> & {
     packageJson: PackageJson;
     scurry: PathScurry;
     projectRoot: string;
@@ -80,11 +94,6 @@ export declare class Config {
      * representing vlt's configuration
      */
     jack: Jack<ConfigDefinitions>;
-    stringifyOptions: {
-        [kIndent]: string;
-        [kNewline]: string;
-    };
-    configFiles: ConfigFiles;
     /**
      * Parsed values in effect
      */
@@ -109,7 +118,7 @@ export declare class Config {
      */
     positionals?: string[];
     /**
-     * The root of the project where a vlt.json, vlt-workspaces.json,
+     * The root of the project where a vlt.json, vlt.json,
      * package.json, or .git was found. Not necessarily the `process.cwd()`,
      * though that is the default location.
      *
@@ -154,14 +163,17 @@ export declare class Config {
     /**
      * Write the config values to the user or project config file.
      */
-    writeConfigFile(which: 'project' | 'user', values: ConfigFileData): Promise<ConfigFileData>;
+    writeConfigFile(this: LoadedConfig, which: WhichConfig, values: NonNullable<ConfigFileData>): Promise<void>;
     /**
      * Fold in the provided fields with the existing properties
      * in the config file.
      */
-    addConfigToFile(which: 'project' | 'user', values: ConfigFileData): Promise<ConfigFileData>;
-    getFilename(which?: 'project' | 'user'): string;
-    deleteConfigKeys(which: 'project' | 'user', fields: string[]): Promise<boolean>;
+    addConfigToFile(this: LoadedConfig, which: WhichConfig, values: NonNullable<ConfigFileData>): Promise<void>;
+    /**
+     * Deletes the specified config fields from the named file
+     * Returns `true` if anything was changed.
+     */
+    deleteConfigKeys(this: LoadedConfig, which: WhichConfig, fields: string[]): Promise<boolean>;
     /**
      * Edit the user or project configuration file.
      *
@@ -172,23 +184,18 @@ export declare class Config {
      * file after editing, then it's restored to what it was before, which might
      * mean deleting the file.
      */
-    editConfigFile(which: 'project' | 'user', edit: (file: string) => Promise<void> | void): Promise<void>;
+    editConfigFile(this: LoadedConfig, which: WhichConfig, edit: (file: string) => Promise<void> | void): Promise<void>;
     /**
      * Find the local config file and load both it and the user-level config in
      * the XDG config home.
-     *
-     * Note: if working in a workspaces monorepo, then the vlt.json file MUST
-     * be in the same folder as the vlt-workspaces.json file, because we stop
-     * looking when we find either one.
      */
     loadConfigFile(): Promise<this>;
     /**
-     * Determine whether we should use colors in the output. Update
-     * chalk appropriately.
-     *
-     * Implicitly calls this.parse() if it not parsed already.
+     * Force a complete reload of config files from disk.
+     * This clears all caches and re-reads config files.
+     * Useful for long-running processes that need to pick up config changes.
      */
-    loadColor(): Promise<this & LoadedConfig>;
+    reloadFromDisk(): Promise<void>;
     /**
      * Load the configuration and return a Promise to a
      * {@link Config} object
@@ -208,7 +215,5 @@ export type ParsedConfig = Config & {
 /**
  * A fully loaded {@link Config} object
  */
-export type LoadedConfig = ParsedConfig & {
-    get(k: 'color'): boolean;
-};
+export type LoadedConfig = ParsedConfig;
 //# sourceMappingURL=index.d.ts.map