@vltpkg/cli-sdk 0.0.0-10

package/dist/esm/config/definition.js

@@ -0,0 +1,517 @@
+import { XDG } from '@vltpkg/xdg';
+import { jack } from 'jackspeak';
+export const defaultView = process.stdout.isTTY ? 'human' : 'json';
+const canonicalCommands = {
+    cache: 'cache',
+    config: 'config',
+    exec: 'exec',
+    'exec-local': 'exec-local',
+    gui: 'gui',
+    help: 'help',
+    init: 'init',
+    install: 'install',
+    login: 'login',
+    logout: 'logout',
+    list: 'list',
+    ls: 'ls',
+    pkg: 'pkg',
+    query: 'query',
+    'run-exec': 'run-exec',
+    run: 'run',
+    token: 'token',
+    uninstall: 'uninstall',
+    'exec-cache': 'exec-cache',
+    whoami: 'whoami',
+};
+const aliases = {
+    i: 'install',
+    add: 'install',
+    rm: 'uninstall',
+    u: 'uninstall',
+    r: 'run',
+    'run-script': 'run',
+    rx: 'run-exec',
+    x: 'exec',
+    xl: 'exec-local',
+    h: 'help',
+    '?': 'help',
+    conf: 'config',
+    ls: 'list',
+    xc: 'exec-cache',
+};
+/**
+ * Command aliases mapped to their canonical names
+ */
+export const commands = {
+    ...canonicalCommands,
+    ...aliases,
+};
+/**
+ * Canonical command names mapped to an array of its aliases
+ */
+export const commandAliases = Object.entries(aliases).reduce((acc, [alias, canonical]) => {
+    const commandAliases = acc.get(canonical);
+    if (commandAliases) {
+        commandAliases.push(alias);
+    }
+    else {
+        acc.set(canonical, [alias]);
+    }
+    return acc;
+}, new Map());
+export const getCommand = (s) => s && s in commands ? commands[s] : undefined;
+const xdg = new XDG('vlt');
+const cacheDir = xdg.cache();
+/**
+ * Fields that are parsed as a set of key=value pairs
+ */
+export const recordFields = [
+    'git-hosts',
+    'registries',
+    'git-host-archives',
+    'scope-registries',
+];
+export const isRecordField = (s) => recordFields.includes(s);
+const stopParsingCommands = [
+    'run',
+    'run-exec',
+    'exec-local',
+    'exec',
+];
+let stopParsing = undefined;
+const j = jack({
+    envPrefix: 'VLT',
+    allowPositionals: true,
+    usage: `vlt [<options>] [<cmd> [<args> ...]]`,
+    stopAtPositionalTest: arg => {
+        if (stopParsing)
+            return true;
+        const a = arg;
+        // we stop parsing AFTER the thing, so you can do
+        // vlt run --vlt --configs scriptName --args --for --script
+        // or
+        // vlt exec --vlt --configs command --args --for --command
+        if (stopParsingCommands.includes(commands[a])) {
+            stopParsing = true;
+        }
+        return false;
+    },
+})
+    .heading('vlt')
+    .description(`More documentation available at <https://docs.vlt.sh>`)
+    .heading('Subcommands');
+j.description(Object.keys(canonicalCommands).join(', '), {
+    pre: true,
+}).description('Run `vlt <cmd> --help` for more information about a specific command');
+export const definition = j
+    /**
+     * Definition of all configuration values used by vlt.
+     */
+    .heading('Configuration')
+    .description(`If a \`vlt.json\` file is present in the root of the current project,
+     then that will be used as a source of configuration information.
+
+     Next, the \`vlt.json\` file in the XDG specified config directory
+     will be checked, and loaded for any fields not set in the local project.
+
+     Object type values will be merged together. Set a field to \`null\` in
+     the JSON configuration to explicitly remove it.
+
+     Command-specific fields may be set in a nested \`command\` object that
+     overrides any options defined at the top level.
+    `)
+    .flag({
+    color: {
+        short: 'c',
+        description: 'Use colors (Default for TTY)',
+    },
+    'no-color': {
+        short: 'C',
+        description: 'Do not use colors (Default for non-TTY)',
+    },
+})
+    .opt({
+    registry: {
+        hint: 'url',
+        default: 'https://registry.npmjs.org/',
+        description: `Sets the registry for fetching packages, when no registry
+                    is explicitly set on a specifier.
+
+                    For example, \`express@latest\` will be resolved by looking
+                    up the metadata from this registry.
+
+                    Note that alias specifiers starting with \`npm:\` will
+                    still map to \`https://registry.npmjs.org/\` if this is
+                    changed, unless the a new mapping is created via the
+                    \`--registries\` option.
+      `,
+    },
+})
+    .optList({
+    registries: {
+        hint: 'name=url',
+        description: `Specify named registry hosts by their prefix. To set the
+                    default registry used for non-namespaced specifiers,
+                    use the \`--registry\` option.
+
+                    Prefixes can be used as a package alias. For example:
+
+                    \`\`\`
+                    vlt --registries loc=http://reg.local install foo@loc:foo@1.x
+                    \`\`\`
+
+                    By default, the public npm registry is registered to the
+                    \`npm:\` prefix. It is not recommended to change this
+                    mapping in most cases.
+                    `,
+    },
+    'scope-registries': {
+        hint: '@scope=url',
+        description: `Map package name scopes to registry URLs.
+
+                    For example,
+                    \`--scope-registries @acme=https://registry.acme/\`
+                    would tell vlt to fetch any packages named
+                    \`@acme/...\` from the \`https://registry.acme/\`
+                    registry.
+
+                    Note: this way of specifying registries is more ambiguous,
+                    compared with using the \`--registries\` field and explicit
+                    prefixes, because instead of failing when the configuration
+                    is absent, it will instead attempt to fetch from the
+                    default registry.
+
+                    By comparison, using
+                    \`--registries acme=https://registry.acme/\` and then
+                    specifying dependencies such as \`"foo": "acme:foo@1.x"\`
+                    means that regardless of the name, the package will be
+                    fetched from the explicitly named registry, or fail if
+                    no registry is defined with that name.
+
+                    However, custom registry aliases are not supported by other
+                    package managers.`,
+    },
+    'git-hosts': {
+        hint: `name=template`,
+        short: 'G',
+        description: `Map a shorthand name to a git remote URL template.
+
+                    The \`template\` may contain placeholders, which will be
+                    swapped with the relevant values.
+
+                    \`$1\`, \`$2\`, etc. are replaced with the appropriate
+                    n-th path portion. For example, \`github:user/project\`
+                    would replace the \`$1\` in the template with \`user\`,
+                    and \`$2\` with \`project\`.`,
+    },
+    'git-host-archives': {
+        hint: `name=template`,
+        short: 'A',
+        description: `Similar to the \`--git-host <name>=<template>\` option,
+                    this option can define a template string that will be
+                    expanded to provide the URL to download a pre-built
+                    tarball of the git repository.
+
+                    In addition to the n-th path portion expansions performed
+                    by \`--git-host\`, this field will also expand the
+                    string \`$committish\` in the template, replacing it with
+                    the resolved git committish value to be fetched.`,
+    },
+})
+    .opt({
+    cache: {
+        hint: 'path',
+        description: `
+        Location of the vlt on-disk cache. Defaults to the platform-specific
+        directory recommended by the XDG specification.
+      `,
+        default: cacheDir,
+    },
+    tag: {
+        description: `Default \`dist-tag\` to install`,
+        default: 'latest',
+    },
+    before: {
+        hint: 'date',
+        description: `Do not install any packages published after this date`,
+    },
+    os: {
+        description: `The operating system to use as the selector when choosing
+                    packages based on their \`os\` value.`,
+        default: process.platform,
+    },
+    arch: {
+        description: `CPU architecture to use as the selector when choosing
+                    packages based on their \`cpu\` value.`,
+        default: process.arch,
+    },
+    'node-version': {
+        hint: 'version',
+        description: `Node version to use when choosing packages based on
+                    their \`engines.node\` value.`,
+        default: process.version,
+    },
+})
+    .flag({
+    'git-shallow': {
+        description: `Set to force \`--depth=1\` on all git clone actions.
+                    When set explicitly to false with --no-git-shallow,
+                    then \`--depth=1\` will not be used.
+
+                    When not set explicitly, \`--depth=1\` will be used for
+                    git hosts known to support this behavior.`,
+    },
+})
+    .num({
+    'fetch-retries': {
+        hint: 'n',
+        description: `Number of retries to perform when encountering network
+                    errors or likely-transient errors from git hosts.`,
+        default: 3,
+    },
+    'fetch-retry-factor': {
+        hint: 'n',
+        description: `The exponential backoff factor to use when retrying
+                    requests due to network issues.`,
+        default: 2,
+    },
+    'fetch-retry-mintimeout': {
+        hint: 'n',
+        description: `Number of milliseconds before starting first retry`,
+        default: 0,
+    },
+    'fetch-retry-maxtimeout': {
+        hint: 'n',
+        description: `Maximum number of milliseconds between two retries`,
+        default: 30_000,
+    },
+    'stale-while-revalidate-factor': {
+        hint: 'n',
+        default: 60,
+        description: `If the server does not serve a \`stale-while-revalidate\`
+                    value in the \`cache-control\` header, then this multiplier
+                    is applied to the \`max-age\` or \`s-maxage\` values.
+
+                    By default, this is \`60\`, so for example a response that
+                    is cacheable for 5 minutes will allow a stale response
+                    while revalidating for up to 5 hours.
+
+                    If the server *does* provide a \`stale-while-revalidate\`
+                    value, then that is always used.
+
+                    Set to 0 to prevent any \`stale-while-revalidate\` behavior
+                    unless explicitly allowed by the server's \`cache-control\`
+                    header.
+      `,
+    },
+})
+    .opt({
+    identity: {
+        short: 'i',
+        validate: (v) => typeof v === 'string' && /^[a-z0-9]*$/.test(v),
+        hint: 'name',
+        default: '',
+        description: `Provide a string to define an identity for storing auth
+                    information when logging into registries.
+
+                    Authentication tokens will be stored in the XDG data
+                    directory, in \`vlt/auth/$\{identity}/keychain.json\`.
+
+                    If no identity is provided, then the default \`''\` will
+                    be used, storing the file at \`vlt/auth/keychain.json\`.
+
+                    May only contain lowercase alphanumeric characters.
+                    `,
+    },
+})
+    .optList({
+    workspace: {
+        hint: 'ws',
+        short: 'w',
+        description: `Set to limit the spaces being worked on when working on
+                    workspaces.
+
+                    Can be paths or glob patterns matching paths.
+
+                    Specifying workspaces by package.json name is not
+                    supported.`,
+    },
+    'workspace-group': {
+        short: 'g',
+        description: `Specify named workspace group names to load and operate on
+                    when doing recursive operations on workspaces.`,
+    },
+})
+    .flag({
+    recursive: {
+        short: 'r',
+        description: `Run an operation across multiple workspaces.
+
+                    No effect when used in non-monorepo projects.
+
+                    Implied by setting --workspace or --workspace-group. If
+                    not set, then the action is run on the project root.`,
+    },
+    bail: {
+        short: 'b',
+        description: `When running scripts across multiple workspaces, stop
+                    on the first failure.`,
+        default: true,
+    },
+    'no-bail': {
+        short: 'B',
+        description: `When running scripts across multiple workspaces, continue
+                    on failure, running the script for all workspaces.`,
+    },
+})
+    .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',
+    },
+    editor: {
+        hint: 'program',
+        description: `The blocking editor to use for \`vlt config edit\` and
+                    any other cases where a file should be opened for
+                    editing.
+
+                    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'),
+    },
+    'script-shell': {
+        hint: 'program',
+        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',
+        description: `The command to run when the first argument doesn't
+                    match any known commands.
+
+                    For pnpm-style behavior, set this to 'run-exec'. e.g:
+                    \`\`\`
+                    vlt config set fallback-command=run-exec
+                    \`\`\``,
+        default: 'help',
+        validOptions: Object.keys(canonicalCommands),
+    },
+})
+    .opt({
+    package: {
+        hint: 'p',
+        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({
+    view: {
+        hint: 'output',
+        default: defaultView,
+        description: `Configures the output format for commands.
+
+                    Defaults to \`human\` if stdout is a TTY, or \`json\`
+                    if it is not.
+
+                    - human: Maximally ergonomic output reporting for human
+                      consumption.
+                    - json: Parseable JSON output for machines.
+                    - inspect: Output results with \`util.inspect\`.
+                    - gui: Start a local web server and opens a browser to
+                      explore the results. (Only relevant for certain
+                      commands.)
+                    - mermaid: Output mermaid diagramming syntax. (Only
+                      relevant for certain commands.)
+
+                    If the requested view format is not supported for the
+                    current command, or if no option is provided, then it
+                    will fall back to the default.
+      `,
+        validOptions: [
+            'human',
+            'json',
+            'mermaid',
+            'gui',
+            'inspect',
+        ],
+    },
+})
+    .optList({
+    'dashboard-root': {
+        hint: 'path',
+        description: `The root directory to use for the dashboard GUI.
+                    If not set, the user home directory is used.`,
+    },
+})
+    .flag({
+    'save-dev': {
+        short: 'D',
+        description: `Save installed packages to a package.json file as
+                    devDependencies`,
+    },
+    'save-optional': {
+        short: 'O',
+        description: `Save installed packages to a package.json file as
+                    optionalDependencies`,
+    },
+    'save-peer': {
+        description: `Save installed packages to a package.json file as
+                    peerDependencies`,
+    },
+    'save-prod': {
+        short: 'P',
+        description: `Save installed packages into dependencies specifically.
+                    This is useful if a package already exists in
+                    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({
+    yes: {
+        short: 'y',
+        description: `Automatically accept any confirmation prompts`,
+    },
+    version: {
+        short: 'v',
+        description: 'Print the version',
+    },
+    help: {
+        short: 'h',
+        description: 'Print helpful information',
+    },
+});
+//# sourceMappingURL=definition.js.map

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

@@ -0,0 +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,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,YAAY,EAAE,YAAY;IAC1B,GAAG,EAAE,KAAK;IACV,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,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,UAAU,EAAE,UAAU;IACtB,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,OAAO;IACd,SAAS,EAAE,WAAW;IACtB,YAAY,EAAE,YAAY;IAC1B,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,EAAE,EAAE,YAAY;IAChB,CAAC,EAAE,MAAM;IACT,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,QAAQ;IACd,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;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,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,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;;;;;;;;;;;;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;;;;;;;;;;;;;;;;;;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,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,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;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  cache: 'cache',\n  config: 'config',\n  exec: 'exec',\n  'exec-local': 'exec-local',\n  gui: 'gui',\n  help: 'help',\n  init: 'init',\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  'exec-cache': 'exec-cache',\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  xl: 'exec-local',\n  h: 'help',\n  '?': 'help',\n  conf: 'config',\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] 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    '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\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\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  .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    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  })\n"]}