@vltpkg/cli-sdk 0.0.0-16 → 0.0.0-17

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

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

package/dist/esm/commands/config.js

@@ -1,4 +1,5 @@
 import { error } from '@vltpkg/error-cause';
+import * as dotProp from '@vltpkg/dot-prop';
 import { asRootError } from '@vltpkg/output/error';
 import { isObject } from '@vltpkg/types';
 import { spawnSync } from 'node:child_process';
@@ -123,7 +124,26 @@ const get = async (conf) => {
             code: 'EUSAGE',
         });
     }
-    return conf.get(k);
+    // check if this is a dot-prop path into a record field, in which case
+    // we need to get the record first and then use dot-prop to get the value
+    if (k.includes('.')) {
+        const [field, ...rest] = k.split('.');
+        const subKey = rest.join('.');
+        if (!field || !subKey) {
+            throw error('Could not read property', {
+                found: k,
+            });
+        }
+        // we'd need a type assertion helper from jackspeak definition
+        // options in order to cast the field to a known name type
+        // @ts-expect-error @typescript-eslint/no-unsafe-argument
+        const record = conf.getRecord(field);
+        return dotProp.get(record, subKey);
+    }
+    // otherwise just get the value directly from the config getter
+    return isRecordField(k) ?
+        conf.getRecord(k)
+        : conf.get(k);
 };
 const edit = async (conf) => {
     const [command, ...args] = conf.get('editor').split(' ');
@@ -147,47 +167,98 @@ const edit = async (conf) => {
 const set = async (conf) => {
     const pairs = conf.positionals.slice(1);
     if (!pairs.length) {
-        throw error('At least one key=value pair is required', {
-            code: 'EUSAGE',
-        });
-    }
-    let parsed = null;
-    try {
-        parsed = conf.jack.parseRaw(pairs.map(kv => `--${kv}`)).values;
+        // Create an empty config file
+        await conf.addConfigToFile(conf.get('config'), {});
+        return;
     }
-    catch (er) {
-        const { name, found, value, wanted, validOptions } = asRootError(er).cause;
-        // when a boolean gets a value, it throw a parse error
-        if (isObject(found) &&
-            typeof found.name === 'string' &&
-            typeof found.value === 'string') {
-            const { name, value } = found;
-            throw error(`Boolean flag must be "${name}" or "no-${name}", not a value`, {
-                code: 'ECONFIG',
-                name,
-                found: `${name}=${value}`,
+    const which = conf.get('config');
+    // separate dot-prop paths from simple keys for different handling
+    // any keys that include a dot (.) will be treated as dotPropPairs
+    // other keys/value pairs are handled as simplePairs
+    const dotPropPairs = [];
+    const simplePairs = [];
+    for (const pair of pairs) {
+        const eq = pair.indexOf('=');
+        if (eq === -1) {
+            throw error('Set arguments must contain `=`', {
+                code: 'EUSAGE',
             });
         }
-        if (wanted && !value && typeof name === 'string') {
-            throw error(`No value provided for ${JSON.stringify(name.replace(/^-+/, ''))}`, {
-                code: 'ECONFIG',
-                wanted,
-            });
+        const key = pair.substring(0, eq);
+        const value = pair.substring(eq + 1);
+        if (key.includes('.')) {
+            const [field, ...rest] = key.split('.');
+            const subKey = rest.join('.');
+            if (field && subKey) {
+                dotPropPairs.push({ key, field, subKey, value });
+            }
+            else {
+                throw error('Could not read property', {
+                    found: pair,
+                });
+            }
         }
-        if (Array.isArray(validOptions)) {
-            throw error(`Invalid value provided for ${name}`, {
-                code: 'ECONFIG',
-                found,
-                validOptions,
-            });
+        else {
+            simplePairs.push(pair);
         }
-        // an unknown property
-        throw error('Invalid config keys', {
+    }
+    // Handle keys that consists of a single name (e.g., `--foo`)
+    // so that it doesn't need the dot-prop logic to handle values
+    if (simplePairs.length > 0) {
+        try {
+            const parsed = conf.jack.parseRaw(simplePairs.map(kv => `--${kv}`)).values;
+            await conf.addConfigToFile(which, pairsToRecords(parsed));
+        }
+        catch (err) {
+            handleSetError(simplePairs, err);
+        }
+    }
+    // Handle dot-prop paths for record fields
+    if (dotPropPairs.length > 0) {
+        for (const { field, subKey, value } of dotPropPairs) {
+            if (isRecordField(field)) {
+                // For record fields, we add entries in the format field=key=value
+                const recordPair = `${field}=${subKey}=${value}`;
+                try {
+                    const parsed = conf.jack.parseRaw([
+                        `--${recordPair}`,
+                    ]).values;
+                    await conf.addConfigToFile(which, pairsToRecords(parsed));
+                    /* c8 ignore start */
+                }
+                catch (err) {
+                    handleSetError([recordPair], err);
+                }
+                /* c8 ignore end */
+            }
+        }
+    }
+};
+const handleSetError = (simplePairs, err) => {
+    const { name, found, validOptions } = asRootError(err).cause;
+    // when a boolean gets a value, it throw a parse error
+    if (isObject(found) &&
+        typeof found.name === 'string' &&
+        typeof found.value === 'string') {
+        const { name, value } = found;
+        throw error(`Boolean flag must be "${name}" or "no-${name}", not a value`, {
+            code: 'ECONFIG',
+            name,
+            found: `${name}=${value}`,
+        });
+    }
+    if (Array.isArray(validOptions)) {
+        throw error(`Invalid value provided for ${name}`, {
             code: 'ECONFIG',
-            found: pairs.map(kv => kv.split('=')[0]),
-            validOptions: getSortedKeys(),
+            found,
+            validOptions,
         });
     }
-    await conf.addConfigToFile(conf.get('config'), pairsToRecords(parsed));
+    // an unknown property
+    throw error('Invalid config keys', {
+        code: 'ECONFIG',
+        found: simplePairs.map(kv => kv.split('=')[0]),
+        validOptions: getSortedKeys(),
+    });
 };
 //# sourceMappingURL=config.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/commands/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAOvD,OAAO,EACL,UAAU,EACV,aAAa,EACb,cAAc,EACd,cAAc,GACf,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAGjD,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CACtC,YAAY,CAAC;IACX,OAAO,EAAE,QAAQ;IACjB,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,6BAA6B;IAE1C,WAAW,EAAE;QACX,GAAG,EAAE;YACH,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,8BAA8B;SAC5C;QAED,IAAI,EAAE;YACJ,WAAW,EACT,sDAAsD;SACzD;QAED,GAAG,EAAE;YACH,KAAK,EACH,+DAA+D;YACjE,WAAW,EAAE;;;2DAGsC;SACpD;QAED,GAAG,EAAE;YACH,KAAK,EAAE,+CAA+C;YACtD,WAAW,EAAE;;;;8DAIyC;SACvD;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,6BAA6B;YACpC,WAAW,EAAE,6BAA6B;SAC3C;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE;mDAC8B;SAC5C;KACF;CACF,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,OAAO,GAEhB,KAAK,EAAC,IAAI,EAAC,EAAE;IACf,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,KAAK,IAAI,CAAC;QACV,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,KAAK,CAAC,6BAA6B,EAAE;gBACzC,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG;gBACV,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC;aAC5D,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,IAAkB,EAAE,EAAE;IAClC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAA;IAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO;YACL,iDAAiD;YACjD,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;iBACd,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;iBACxC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;SACtB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACd,CAAC;IAED,mCAAmC;IACnC,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAChB,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAA;QACxC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;YAC7C,MAAM,IAAI,GACR,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChB,wBAAwB;gBAC1B,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YAEzC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,CAAC,CAAA;YACzB,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;YAC3B,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;gBAChB,GAAG,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YACvD,CAAC;YACD,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACpB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACvB,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,IAAkB,EAAE,EAAE;IAClC,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACrC,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,KAAK,CAAC,8BAA8B,EAAE;YAC1C,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAA;AACzD,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACtC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,KAAK,CAAC,6BAA6B,EAAE;YACzC,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,IAAI,CAAC,GAAG,CAAC,CAA4B,CAAC,CAAA;AAC/C,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACxC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACxD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAChC,CAAC;IACD,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,EAAE;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACf,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE;YACnC,KAAK,EAAE,SAAS;SACjB,CAAC,CAAA;QACF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,KAAK,CAAC,GAAG,OAAO,iBAAiB,EAAE;gBACvC,GAAG,GAAG;gBACN,OAAO;gBACP,IAAI;aACL,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACvC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,MAAM,KAAK,CAAC,yCAAyC,EAAE;YACrD,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,MAAM,GAA0B,IAAI,CAAA;IACxC,IAAI,CAAC;QACH,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAA;IAChE,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC;QACZ,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,GAChD,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,CAAA;QACvB,sDAAsD;QACtD,IACE,QAAQ,CAAC,KAAK,CAAC;YACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAC9B,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAC/B,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,CAAA;YAC7B,MAAM,KAAK,CACT,yBAAyB,IAAI,YAAY,IAAI,gBAAgB,EAC7D;gBACE,IAAI,EAAE,SAAS;gBACf,IAAI;gBACJ,KAAK,EAAE,GAAG,IAAI,IAAI,KAAK,EAAE;aAC1B,CACF,CAAA;QACH,CAAC;QACD,IAAI,MAAM,IAAI,CAAC,KAAK,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YACjD,MAAM,KAAK,CACT,yBAAyB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,EAClE;gBACE,IAAI,EAAE,SAAS;gBACf,MAAM;aACP,CACF,CAAA;QACH,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;YAChC,MAAM,KAAK,CAAC,8BAA8B,IAAI,EAAE,EAAE;gBAChD,IAAI,EAAE,SAAS;gBACf,KAAK;gBACL,YAAY;aACb,CAAC,CAAA;QACJ,CAAC;QACD,sBAAsB;QACtB,MAAM,KAAK,CAAC,qBAAqB,EAAE;YACjC,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,YAAY,EAAE,aAAa,EAAE;SAC9B,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,IAAI,CAAC,eAAe,CACxB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAClB,cAAc,CAAC,MAAM,CAAC,CACvB,CAAA;AACH,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { asRootError } from '@vltpkg/output/error'\nimport { isObject } from '@vltpkg/types'\nimport { spawnSync } from 'node:child_process'\nimport { getSortedKeys } from '../config/definition.ts'\nimport type {\n  ConfigDefinitions,\n  ConfigFileData,\n  LoadedConfig,\n  RecordPairs,\n} from '../config/index.ts'\nimport {\n  definition,\n  isRecordField,\n  pairsToRecords,\n  recordsToPairs,\n} from '../config/index.ts'\nimport { commandUsage } from '../config/usage.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\n\nexport const usage: CommandUsage = () =>\n  commandUsage({\n    command: 'config',\n    usage: '<command> [flags]',\n    description: 'Work with vlt configuration',\n\n    subcommands: {\n      get: {\n        usage: '<key> [<key> ...]',\n        description: 'Print the named config value',\n      },\n\n      list: {\n        description:\n          'Print all configuration settings currently in effect',\n      },\n\n      set: {\n        usage:\n          '<key>=<value> [<key>=<value> ...] [--config=<user | project>]',\n        description: `Set config values. By default, these are\n                      written to the project config file, \\`vlt.json\\`\n                      in the root of the project. To set things for all\n                      projects, run with \\`--config=user\\``,\n      },\n\n      del: {\n        usage: '<key> [<key> ...] [--config=<user | project>]',\n        description: `Delete the named config fields. If no values remain in\n                      the config file, delete the file as well. By default,\n                      operates on the \\`vlt.json\\` file in the root of the\n                      current project. To delete a config field from the user\n                      config file, specify \\`--config=user\\`.`,\n      },\n\n      edit: {\n        usage: '[--config=<user | project>]',\n        description: 'Edit the configuration file',\n      },\n\n      help: {\n        usage: '[field ...]',\n        description: `Get information about a config field, or show a list\n                      of known config field names.`,\n      },\n    },\n  })\n\nexport const command: CommandFn<\n  string | number | boolean | void | string[] | RecordPairs\n> = async conf => {\n  const sub = conf.positionals[0]\n  switch (sub) {\n    case 'set':\n      return set(conf)\n\n    case 'get':\n      return get(conf)\n\n    case 'ls':\n    case 'list':\n      return list(conf)\n\n    case 'edit':\n      return edit(conf)\n\n    case 'help':\n      return help(conf)\n\n    case 'del':\n      return del(conf)\n\n    default: {\n      throw error('Unrecognized config command', {\n        code: 'EUSAGE',\n        found: sub,\n        validOptions: ['set', 'get', 'list', 'edit', 'help', 'del'],\n      })\n    }\n  }\n}\n\nconst help = (conf: LoadedConfig) => {\n  const j = definition.toJSON()\n  const fields = conf.positionals.slice(1)\n  if (!fields.length) {\n    return [\n      'Specify one or more options to see information:',\n      ...Object.keys(j)\n        .sort((a, b) => a.localeCompare(b, 'en'))\n        .map(c => `  ${c}`),\n    ].join('\\n')\n  }\n\n  // TODO: some kind of fuzzy search?\n  const res: string[] = []\n  for (const f of fields) {\n    const def = j[f]\n    if (!def) {\n      res.push(`unknown config field: ${f}`)\n    } else {\n      const hint = def.hint ? `=<${def.hint}>` : ''\n      const type =\n        isRecordField(f) ?\n          'Record<string, string>'\n        : def.type + (def.multiple ? '[]' : '')\n\n      res.push(`--${f}${hint}`)\n      res.push(`  type: ${type}`)\n      if (def.default) {\n        res.push(`  default: ${JSON.stringify(def.default)}`)\n      }\n      if (def.description) {\n        res.push(def.description)\n      }\n    }\n  }\n  return res.join('\\n')\n}\n\nconst list = (conf: LoadedConfig) => {\n  return recordsToPairs(conf.options)\n}\n\nconst del = async (conf: LoadedConfig) => {\n  const fields = conf.positionals.slice(1)\n  if (!fields.length) {\n    throw error('At least one key is required', {\n      code: 'EUSAGE',\n    })\n  }\n  await conf.deleteConfigKeys(conf.get('config'), fields)\n}\n\nconst get = async (conf: LoadedConfig) => {\n  const keys = conf.positionals.slice(1)\n  const k = keys[0]\n  if (!k || keys.length > 1) {\n    throw error('Exactly one key is required', {\n      code: 'EUSAGE',\n    })\n  }\n  return conf.get(k as keyof ConfigDefinitions)\n}\n\nconst edit = async (conf: LoadedConfig) => {\n  const [command, ...args] = conf.get('editor').split(' ')\n  if (!command) {\n    throw error(`editor is empty`)\n  }\n  await conf.editConfigFile(conf.get('config'), file => {\n    args.push(file)\n    const res = spawnSync(command, args, {\n      stdio: 'inherit',\n    })\n    if (res.status !== 0) {\n      throw error(`${command} command failed`, {\n        ...res,\n        command,\n        args,\n      })\n    }\n  })\n}\n\nconst set = async (conf: LoadedConfig) => {\n  const pairs = conf.positionals.slice(1)\n  if (!pairs.length) {\n    throw error('At least one key=value pair is required', {\n      code: 'EUSAGE',\n    })\n  }\n  let parsed: ConfigFileData | null = null\n  try {\n    parsed = conf.jack.parseRaw(pairs.map(kv => `--${kv}`)).values\n  } catch (er) {\n    const { name, found, value, wanted, validOptions } =\n      asRootError(er).cause\n    // when a boolean gets a value, it throw a parse error\n    if (\n      isObject(found) &&\n      typeof found.name === 'string' &&\n      typeof found.value === 'string'\n    ) {\n      const { name, value } = found\n      throw error(\n        `Boolean flag must be \"${name}\" or \"no-${name}\", not a value`,\n        {\n          code: 'ECONFIG',\n          name,\n          found: `${name}=${value}`,\n        },\n      )\n    }\n    if (wanted && !value && typeof name === 'string') {\n      throw error(\n        `No value provided for ${JSON.stringify(name.replace(/^-+/, ''))}`,\n        {\n          code: 'ECONFIG',\n          wanted,\n        },\n      )\n    }\n    if (Array.isArray(validOptions)) {\n      throw error(`Invalid value provided for ${name}`, {\n        code: 'ECONFIG',\n        found,\n        validOptions,\n      })\n    }\n    // an unknown property\n    throw error('Invalid config keys', {\n      code: 'ECONFIG',\n      found: pairs.map(kv => kv.split('=')[0]),\n      validOptions: getSortedKeys(),\n    })\n  }\n  await conf.addConfigToFile(\n    conf.get('config'),\n    pairsToRecords(parsed),\n  )\n}\n"]}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/commands/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EACL,UAAU,EACV,aAAa,EACb,cAAc,EACd,cAAc,GACf,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAQjD,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CACtC,YAAY,CAAC;IACX,OAAO,EAAE,QAAQ;IACjB,KAAK,EAAE,mBAAmB;IAC1B,WAAW,EAAE,6BAA6B;IAE1C,WAAW,EAAE;QACX,GAAG,EAAE;YACH,KAAK,EAAE,mBAAmB;YAC1B,WAAW,EAAE,8BAA8B;SAC5C;QAED,IAAI,EAAE;YACJ,WAAW,EACT,sDAAsD;SACzD;QAED,GAAG,EAAE;YACH,KAAK,EACH,+DAA+D;YACjE,WAAW,EAAE;;;2DAGsC;SACpD;QAED,GAAG,EAAE;YACH,KAAK,EAAE,+CAA+C;YACtD,WAAW,EAAE;;;;8DAIyC;SACvD;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,6BAA6B;YACpC,WAAW,EAAE,6BAA6B;SAC3C;QAED,IAAI,EAAE;YACJ,KAAK,EAAE,aAAa;YACpB,WAAW,EAAE;mDAC8B;SAC5C;KACF;CACF,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,OAAO,GAEhB,KAAK,EAAC,IAAI,EAAC,EAAE;IACf,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;IAC/B,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,KAAK,IAAI,CAAC;QACV,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnB,KAAK,KAAK;YACR,OAAO,GAAG,CAAC,IAAI,CAAC,CAAA;QAElB,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,KAAK,CAAC,6BAA6B,EAAE;gBACzC,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,GAAG;gBACV,YAAY,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC;aAC5D,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,IAAkB,EAAE,EAAE;IAClC,MAAM,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAA;IAC7B,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,OAAO;YACL,iDAAiD;YACjD,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;iBACd,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;iBACxC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;SACtB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACd,CAAC;IAED,mCAAmC;IACnC,MAAM,GAAG,GAAa,EAAE,CAAA;IACxB,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAChB,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG,CAAC,IAAI,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAA;QACxC,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;YAC7C,MAAM,IAAI,GACR,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;gBAChB,wBAAwB;gBAC1B,CAAC,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;YAEzC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,EAAE,CAAC,CAAA;YACzB,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;YAC3B,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;gBAChB,GAAG,CAAC,IAAI,CAAC,cAAc,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YACvD,CAAC;YACD,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBACpB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YAC3B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACvB,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,CAAC,IAAkB,EAAE,EAAE;IAClC,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACrC,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,KAAK,CAAC,8BAA8B,EAAE;YAC1C,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAA;AACzD,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACtC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;IACjB,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,KAAK,CAAC,6BAA6B,EAAE;YACzC,IAAI,EAAE,QAAQ;SACf,CAAC,CAAA;IACJ,CAAC;IACD,sEAAsE;IACtE,yEAAyE;IACzE,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACrC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAE7B,IAAI,CAAC,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;YACtB,MAAM,KAAK,CAAC,yBAAyB,EAAE;gBACrC,KAAK,EAAE,CAAC;aACT,CAAC,CAAA;QACJ,CAAC;QAED,8DAA8D;QAC9D,0DAA0D;QAC1D,yDAAyD;QACzD,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;QAEpC,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAKpB,CAAA;IACf,CAAC;IAED,+DAA+D;IAC/D,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;QACnB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAA4B,CAAC,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACxC,MAAM,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACxD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAA;IAChC,CAAC;IACD,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,EAAE;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACf,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE;YACnC,KAAK,EAAE,SAAS;SACjB,CAAC,CAAA;QACF,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,KAAK,CAAC,GAAG,OAAO,iBAAiB,EAAE;gBACvC,GAAG,GAAG;gBACN,OAAO;gBACP,IAAI;aACL,CAAC,CAAA;QACJ,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;IACvC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,8BAA8B;QAC9B,MAAM,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAA;QAClD,OAAM;IACR,CAAC;IAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAEhC,kEAAkE;IAClE,kEAAkE;IAClE,oDAAoD;IACpD,MAAM,YAAY,GAKZ,EAAE,CAAA;IACR,MAAM,WAAW,GAAa,EAAE,CAAA;IAEhC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QAC5B,IAAI,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YACd,MAAM,KAAK,CAAC,gCAAgC,EAAE;gBAC5C,IAAI,EAAE,QAAQ;aACf,CAAC,CAAA;QACJ,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;QACpC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACvC,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;YAC7B,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;gBACpB,YAAY,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;YAClD,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC,yBAAyB,EAAE;oBACrC,KAAK,EAAE,IAAI;iBACZ,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACxB,CAAC;IACH,CAAC;IAED,6DAA6D;IAC7D,8DAA8D;IAC9D,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3B,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAC/B,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,CACjC,CAAC,MAAM,CAAA;YACR,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;QAC3D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,cAAc,CAAC,WAAW,EAAE,GAAG,CAAC,CAAA;QAClC,CAAC;IACH,CAAC;IAED,0CAA0C;IAC1C,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,YAAY,EAAE,CAAC;YACpD,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,kEAAkE;gBAClE,MAAM,UAAU,GAAG,GAAG,KAAK,IAAI,MAAM,IAAI,KAAK,EAAE,CAAA;gBAChD,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;wBAChC,KAAK,UAAU,EAAE;qBAClB,CAAC,CAAC,MAAM,CAAA;oBACT,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAA;oBACzD,qBAAqB;gBACvB,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,cAAc,CAAC,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,CAAA;gBACnC,CAAC;gBACD,mBAAmB;YACrB,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAA;AAED,MAAM,cAAc,GAAG,CAAC,WAAqB,EAAE,GAAY,EAAE,EAAE;IAC7D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,CAAA;IAC5D,sDAAsD;IACtD,IACE,QAAQ,CAAC,KAAK,CAAC;QACf,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAC9B,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAC/B,CAAC;QACD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,KAAK,CAAA;QAC7B,MAAM,KAAK,CACT,yBAAyB,IAAI,YAAY,IAAI,gBAAgB,EAC7D;YACE,IAAI,EAAE,SAAS;YACf,IAAI;YACJ,KAAK,EAAE,GAAG,IAAI,IAAI,KAAK,EAAE;SAC1B,CACF,CAAA;IACH,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QAChC,MAAM,KAAK,CAAC,8BAA8B,IAAI,EAAE,EAAE;YAChD,IAAI,EAAE,SAAS;YACf,KAAK;YACL,YAAY;SACb,CAAC,CAAA;IACJ,CAAC;IACD,sBAAsB;IACtB,MAAM,KAAK,CAAC,qBAAqB,EAAE;QACjC,IAAI,EAAE,SAAS;QACf,KAAK,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,YAAY,EAAE,aAAa,EAAE;KAC9B,CAAC,CAAA;AACJ,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport * as dotProp from '@vltpkg/dot-prop'\nimport { asRootError } from '@vltpkg/output/error'\nimport { isObject } from '@vltpkg/types'\nimport { spawnSync } from 'node:child_process'\nimport { getSortedKeys } from '../config/definition.ts'\nimport {\n  definition,\n  isRecordField,\n  pairsToRecords,\n  recordsToPairs,\n} from '../config/index.ts'\nimport { commandUsage } from '../config/usage.ts'\nimport type {\n  ConfigDefinitions,\n  LoadedConfig,\n  RecordPairs,\n} from '../config/index.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\n\nexport const usage: CommandUsage = () =>\n  commandUsage({\n    command: 'config',\n    usage: '<command> [flags]',\n    description: 'Work with vlt configuration',\n\n    subcommands: {\n      get: {\n        usage: '<key> [<key> ...]',\n        description: 'Print the named config value',\n      },\n\n      list: {\n        description:\n          'Print all configuration settings currently in effect',\n      },\n\n      set: {\n        usage:\n          '<key>=<value> [<key>=<value> ...] [--config=<user | project>]',\n        description: `Set config values. By default, these are\n                      written to the project config file, \\`vlt.json\\`\n                      in the root of the project. To set things for all\n                      projects, run with \\`--config=user\\``,\n      },\n\n      del: {\n        usage: '<key> [<key> ...] [--config=<user | project>]',\n        description: `Delete the named config fields. If no values remain in\n                      the config file, delete the file as well. By default,\n                      operates on the \\`vlt.json\\` file in the root of the\n                      current project. To delete a config field from the user\n                      config file, specify \\`--config=user\\`.`,\n      },\n\n      edit: {\n        usage: '[--config=<user | project>]',\n        description: 'Edit the configuration file',\n      },\n\n      help: {\n        usage: '[field ...]',\n        description: `Get information about a config field, or show a list\n                      of known config field names.`,\n      },\n    },\n  })\n\nexport const command: CommandFn<\n  string | number | boolean | void | string[] | RecordPairs\n> = async conf => {\n  const sub = conf.positionals[0]\n  switch (sub) {\n    case 'set':\n      return set(conf)\n\n    case 'get':\n      return get(conf)\n\n    case 'ls':\n    case 'list':\n      return list(conf)\n\n    case 'edit':\n      return edit(conf)\n\n    case 'help':\n      return help(conf)\n\n    case 'del':\n      return del(conf)\n\n    default: {\n      throw error('Unrecognized config command', {\n        code: 'EUSAGE',\n        found: sub,\n        validOptions: ['set', 'get', 'list', 'edit', 'help', 'del'],\n      })\n    }\n  }\n}\n\nconst help = (conf: LoadedConfig) => {\n  const j = definition.toJSON()\n  const fields = conf.positionals.slice(1)\n  if (!fields.length) {\n    return [\n      'Specify one or more options to see information:',\n      ...Object.keys(j)\n        .sort((a, b) => a.localeCompare(b, 'en'))\n        .map(c => `  ${c}`),\n    ].join('\\n')\n  }\n\n  // TODO: some kind of fuzzy search?\n  const res: string[] = []\n  for (const f of fields) {\n    const def = j[f]\n    if (!def) {\n      res.push(`unknown config field: ${f}`)\n    } else {\n      const hint = def.hint ? `=<${def.hint}>` : ''\n      const type =\n        isRecordField(f) ?\n          'Record<string, string>'\n        : def.type + (def.multiple ? '[]' : '')\n\n      res.push(`--${f}${hint}`)\n      res.push(`  type: ${type}`)\n      if (def.default) {\n        res.push(`  default: ${JSON.stringify(def.default)}`)\n      }\n      if (def.description) {\n        res.push(def.description)\n      }\n    }\n  }\n  return res.join('\\n')\n}\n\nconst list = (conf: LoadedConfig) => {\n  return recordsToPairs(conf.options)\n}\n\nconst del = async (conf: LoadedConfig) => {\n  const fields = conf.positionals.slice(1)\n  if (!fields.length) {\n    throw error('At least one key is required', {\n      code: 'EUSAGE',\n    })\n  }\n\n  await conf.deleteConfigKeys(conf.get('config'), fields)\n}\n\nconst get = async (conf: LoadedConfig) => {\n  const keys = conf.positionals.slice(1)\n  const k = keys[0]\n  if (!k || keys.length > 1) {\n    throw error('Exactly one key is required', {\n      code: 'EUSAGE',\n    })\n  }\n  // check if this is a dot-prop path into a record field, in which case\n  // we need to get the record first and then use dot-prop to get the value\n  if (k.includes('.')) {\n    const [field, ...rest] = k.split('.')\n    const subKey = rest.join('.')\n\n    if (!field || !subKey) {\n      throw error('Could not read property', {\n        found: k,\n      })\n    }\n\n    // we'd need a type assertion helper from jackspeak definition\n    // options in order to cast the field to a known name type\n    // @ts-expect-error @typescript-eslint/no-unsafe-argument\n    const record = conf.getRecord(field)\n\n    return dotProp.get(record, subKey) as\n      | string\n      | number\n      | boolean\n      | string[]\n      | undefined\n  }\n\n  // otherwise just get the value directly from the config getter\n  return isRecordField(k) ?\n      conf.getRecord(k)\n    : conf.get(k as keyof ConfigDefinitions)\n}\n\nconst edit = async (conf: LoadedConfig) => {\n  const [command, ...args] = conf.get('editor').split(' ')\n  if (!command) {\n    throw error(`editor is empty`)\n  }\n  await conf.editConfigFile(conf.get('config'), file => {\n    args.push(file)\n    const res = spawnSync(command, args, {\n      stdio: 'inherit',\n    })\n    if (res.status !== 0) {\n      throw error(`${command} command failed`, {\n        ...res,\n        command,\n        args,\n      })\n    }\n  })\n}\n\nconst set = async (conf: LoadedConfig) => {\n  const pairs = conf.positionals.slice(1)\n  if (!pairs.length) {\n    // Create an empty config file\n    await conf.addConfigToFile(conf.get('config'), {})\n    return\n  }\n\n  const which = conf.get('config')\n\n  // separate dot-prop paths from simple keys for different handling\n  // any keys that include a dot (.) will be treated as dotPropPairs\n  // other keys/value pairs are handled as simplePairs\n  const dotPropPairs: {\n    key: string\n    field: string\n    subKey: string\n    value: string\n  }[] = []\n  const simplePairs: string[] = []\n\n  for (const pair of pairs) {\n    const eq = pair.indexOf('=')\n    if (eq === -1) {\n      throw error('Set arguments must contain `=`', {\n        code: 'EUSAGE',\n      })\n    }\n\n    const key = pair.substring(0, eq)\n    const value = pair.substring(eq + 1)\n    if (key.includes('.')) {\n      const [field, ...rest] = key.split('.')\n      const subKey = rest.join('.')\n      if (field && subKey) {\n        dotPropPairs.push({ key, field, subKey, value })\n      } else {\n        throw error('Could not read property', {\n          found: pair,\n        })\n      }\n    } else {\n      simplePairs.push(pair)\n    }\n  }\n\n  // Handle keys that consists of a single name (e.g., `--foo`)\n  // so that it doesn't need the dot-prop logic to handle values\n  if (simplePairs.length > 0) {\n    try {\n      const parsed = conf.jack.parseRaw(\n        simplePairs.map(kv => `--${kv}`),\n      ).values\n      await conf.addConfigToFile(which, pairsToRecords(parsed))\n    } catch (err) {\n      handleSetError(simplePairs, err)\n    }\n  }\n\n  // Handle dot-prop paths for record fields\n  if (dotPropPairs.length > 0) {\n    for (const { field, subKey, value } of dotPropPairs) {\n      if (isRecordField(field)) {\n        // For record fields, we add entries in the format field=key=value\n        const recordPair = `${field}=${subKey}=${value}`\n        try {\n          const parsed = conf.jack.parseRaw([\n            `--${recordPair}`,\n          ]).values\n          await conf.addConfigToFile(which, pairsToRecords(parsed))\n          /* c8 ignore start */\n        } catch (err) {\n          handleSetError([recordPair], err)\n        }\n        /* c8 ignore end */\n      }\n    }\n  }\n}\n\nconst handleSetError = (simplePairs: string[], err: unknown) => {\n  const { name, found, validOptions } = asRootError(err).cause\n  // when a boolean gets a value, it throw a parse error\n  if (\n    isObject(found) &&\n    typeof found.name === 'string' &&\n    typeof found.value === 'string'\n  ) {\n    const { name, value } = found\n    throw error(\n      `Boolean flag must be \"${name}\" or \"no-${name}\", not a value`,\n      {\n        code: 'ECONFIG',\n        name,\n        found: `${name}=${value}`,\n      },\n    )\n  }\n  if (Array.isArray(validOptions)) {\n    throw error(`Invalid value provided for ${name}`, {\n      code: 'ECONFIG',\n      found,\n      validOptions,\n    })\n  }\n  // an unknown property\n  throw error('Invalid config keys', {\n    code: 'ECONFIG',\n    found: simplePairs.map(kv => kv.split('=')[0]),\n    validOptions: getSortedKeys(),\n  })\n}\n"]}

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

@@ -1,8 +1,8 @@
-import type { CommandFn, CommandUsage } from '../index.ts';
 import type { InitFileResults } from '@vltpkg/init';
+import type { CommandFn, CommandUsage } from '../index.ts';
 export declare const usage: CommandUsage;
 export declare const views: {
-    readonly human: (results: InitFileResults, _options: import("../view.ts").ViewOptions, _config: import("../config/index.ts").ParsedConfig) => string;
+    readonly human: (results: InitFileResults | InitFileResults[]) => string;
 };
-export declare const command: CommandFn<InitFileResults>;
+export declare const command: CommandFn<InitFileResults | InitFileResults[]>;
 //# sourceMappingURL=init.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/commands/init.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAE1D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAGnD,eAAO,MAAM,KAAK,EAAE,YAKhB,CAAA;AAEJ,eAAO,MAAM,KAAK;;CAeyB,CAAA;AAE3C,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,eAAe,CACX,CAAA"}
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/commands/init.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AACnD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAG1D,eAAO,MAAM,KAAK,EAAE,YAKhB,CAAA;AAGJ,eAAO,MAAM,KAAK;8BACC,eAAe,GAAG,eAAe,EAAE;CAsBX,CAAA;AAE3C,eAAO,MAAM,OAAO,EAAE,SAAS,CAC7B,eAAe,GAAG,eAAe,EAAE,CAoFpC,CAAA"}

package/dist/esm/commands/init.js

@@ -1,25 +1,111 @@
-import { commandUsage } from "../config/usage.js";
+import { mkdirSync } from 'node:fs';
+import { relative, resolve } from 'node:path';
+import { minimatch } from 'minimatch';
 import { init } from '@vltpkg/init';
+import { load, save } from '@vltpkg/vlt-json';
+import { assertWSConfig, asWSConfig } from '@vltpkg/workspaces';
+import { commandUsage } from "../config/usage.js";
 export const usage = () => commandUsage({
     command: 'init',
     usage: '',
     description: `Create a new package.json file in the current directory.`,
 });
+// TODO: colorize the JSON if config.options.color
 export const views = {
-    human: (results, _options, _config) => {
+    human: (results) => {
         const output = [];
-        // TODO: colorize the JSON if config.options.color
-        for (const [type, { path, data }] of Object.entries(results)) {
-            output.push(`Wrote ${type} to ${path}:
+        // if results is an array, it means multiple workspaces were initialized
+        if (Array.isArray(results)) {
+            for (const result of results) {
+                for (const [type, { path }] of Object.entries(result)) {
+                    output.push(`Wrote ${type} to ${path}:`);
+                }
+            }
+        }
+        else {
+            // otherwise, it's a single result
+            for (const [type, { path, data }] of Object.entries(results)) {
+                output.push(`Wrote ${type} to ${path}:
 
-${JSON.stringify(data, null, 2)}
-`);
+${JSON.stringify(data, null, 2)}`);
+            }
         }
-        output.push(`Modify/add properties using \`vlt pkg\`. For example:
+        output.push(`\nModify/add properties using \`vlt pkg\`. For example:
 
   vlt pkg set "description=My new project"`);
         return output.join('\n');
     },
 };
-export const command = async () => await init({ cwd: process.cwd() });
+export const command = async (conf) => {
+    if (conf.values.workspace?.length) {
+        const workspacesConfig = load('workspaces', assertWSConfig);
+        const parsedWSConfig = asWSConfig(workspacesConfig ?? {});
+        const results = [];
+        const addToConfig = [];
+        // create a new package.json file for every workspace
+        // defined as cli --workspace options
+        for (const workspace of conf.values.workspace) {
+            // cwd is the resolved location of the workspace
+            const cwd = resolve(conf.options.projectRoot, workspace);
+            // create the folder in case it's missing
+            mkdirSync(cwd, { recursive: true });
+            // run the initialization script and collect results
+            results.push(await init({ cwd }));
+            // Check if this workspace path is covered by existing workspace patterns
+            const isMatched = Object.values(parsedWSConfig).some((patterns) => {
+                return patterns.some(pattern => minimatch(workspace, pattern));
+            });
+            // When a workspace is not matched we track it for insertion later
+            if (!isMatched) {
+                addToConfig.push(relative(conf.options.projectRoot, cwd).replace(/\\/g, '/'));
+            }
+        }
+        // if there are workspaces that were not matched by existing
+        // patterns, we add them to the workspaces config
+        if (addToConfig.length > 0) {
+            let workspaces = workspacesConfig;
+            // if the original workspaces config is a string, we'll need
+            // to convert it to an array in order to append the recently
+            // added workspaces
+            if (typeof workspacesConfig === 'string') {
+                workspaces = [workspacesConfig, ...addToConfig];
+            }
+            else if (Array.isArray(workspacesConfig)) {
+                // if the original workspaces config is an array, we simply
+                // append the missing items to it
+                workspaces = [...workspacesConfig, ...addToConfig];
+            }
+            else {
+                // otherwise we assume it's an Record<string, string[]> object
+                // and we'll add the new workspaces to the `packages` keys
+                workspaces = (workspacesConfig ?? {});
+                // if the `packages` key is not being used
+                if (!workspaces.packages) {
+                    workspaces.packages = addToConfig;
+                }
+                else {
+                    // if the `packages` key is defined as a string, we
+                    // convert it to an array to append the new items
+                    if (typeof workspaces.packages === 'string') {
+                        workspaces.packages = [
+                            workspaces.packages,
+                            ...addToConfig,
+                        ];
+                    }
+                    else {
+                        // if it is, we simply append the new workspaces
+                        workspaces.packages = [
+                            ...workspaces.packages,
+                            ...addToConfig,
+                        ];
+                    }
+                }
+            }
+            // finally, we add the new workspaces to the config file
+            save('workspaces', workspaces);
+        }
+        return results;
+    }
+    return init({ cwd: process.cwd() });
+};
 //# sourceMappingURL=init.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAInC,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CACtC,YAAY,CAAC;IACX,OAAO,EAAE,MAAM;IACf,KAAK,EAAE,EAAE;IACT,WAAW,EAAE,0DAA0D;CACxE,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,KAAK,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE;QACpC,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,kDAAkD;QAClD,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7D,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI;;EAExC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;CAC9B,CAAC,CAAA;QACE,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;;2CAE2B,CAAC,CAAA;QACxC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;CACwC,CAAA;AAE3C,MAAM,CAAC,MAAM,OAAO,GAA+B,KAAK,IAAI,EAAE,CAC5D,MAAM,IAAI,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA","sourcesContent":["import { commandUsage } from '../config/usage.ts'\nimport type { CommandFn, CommandUsage } from '../index.ts'\nimport { init } from '@vltpkg/init'\nimport type { InitFileResults } from '@vltpkg/init'\nimport type { Views } from '../view.ts'\n\nexport const usage: CommandUsage = () =>\n  commandUsage({\n    command: 'init',\n    usage: '',\n    description: `Create a new package.json file in the current directory.`,\n  })\n\nexport const views = {\n  human: (results, _options, _config) => {\n    const output: string[] = []\n    // TODO: colorize the JSON if config.options.color\n    for (const [type, { path, data }] of Object.entries(results)) {\n      output.push(`Wrote ${type} to ${path}:\n\n${JSON.stringify(data, null, 2)}\n`)\n    }\n    output.push(`Modify/add properties using \\`vlt pkg\\`. For example:\n\n  vlt pkg set \"description=My new project\"`)\n    return output.join('\\n')\n  },\n} as const satisfies Views<InitFileResults>\n\nexport const command: CommandFn<InitFileResults> = async () =>\n  await init({ cwd: process.cwd() })\n"]}
+{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/commands/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AACnC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AACnC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAKjD,MAAM,CAAC,MAAM,KAAK,GAAiB,GAAG,EAAE,CACtC,YAAY,CAAC;IACX,OAAO,EAAE,MAAM;IACf,KAAK,EAAE,EAAE;IACT,WAAW,EAAE,0DAA0D;CACxE,CAAC,CAAA;AAEJ,kDAAkD;AAClD,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,KAAK,EAAE,CAAC,OAA4C,EAAE,EAAE;QACtD,MAAM,MAAM,GAAa,EAAE,CAAA;QAC3B,wEAAwE;QACxE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBACtD,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI,GAAG,CAAC,CAAA;gBAC1C,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,kCAAkC;YAClC,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7D,MAAM,CAAC,IAAI,CAAC,SAAS,IAAI,OAAO,IAAI;;EAE1C,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;YAC5B,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC;;2CAE2B,CAAC,CAAA;QACxC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;CACwC,CAAA;AAE3C,MAAM,CAAC,MAAM,OAAO,GAEhB,KAAK,EAAC,IAAI,EAAC,EAAE;IACf,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC;QAClC,MAAM,gBAAgB,GAAG,IAAI,CAAC,YAAY,EAAE,cAAc,CAAC,CAAA;QAC3D,MAAM,cAAc,GAAG,UAAU,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAA;QACzD,MAAM,OAAO,GAAsB,EAAE,CAAA;QACrC,MAAM,WAAW,GAAa,EAAE,CAAA;QAEhC,qDAAqD;QACrD,qCAAqC;QACrC,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;YAC9C,gDAAgD;YAChD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,SAAS,CAAC,CAAA;YAExD,yCAAyC;YACzC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;YAEnC,oDAAoD;YACpD,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,CAAA;YAEjC,yEAAyE;YACzE,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,IAAI,CAClD,CAAC,QAAkB,EAAE,EAAE;gBACrB,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAC7B,SAAS,CAAC,SAAS,EAAE,OAAO,CAAC,CAC9B,CAAA;YACH,CAAC,CACF,CAAA;YAED,kEAAkE;YAClE,IAAI,CAAC,SAAS,EAAE,CAAC;gBACf,WAAW,CAAC,IAAI,CACd,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAC5D,CAAA;YACH,CAAC;QACH,CAAC;QAED,4DAA4D;QAC5D,iDAAiD;QACjD,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3B,IAAI,UAAU,GAAG,gBAAgB,CAAA;YACjC,4DAA4D;YAC5D,4DAA4D;YAC5D,mBAAmB;YACnB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE,CAAC;gBACzC,UAAU,GAAG,CAAC,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAA;YACjD,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE,CAAC;gBAC3C,2DAA2D;gBAC3D,iCAAiC;gBACjC,UAAU,GAAG,CAAC,GAAG,gBAAgB,EAAE,GAAG,WAAW,CAAC,CAAA;YACpD,CAAC;iBAAM,CAAC;gBACN,8DAA8D;gBAC9D,0DAA0D;gBAC1D,UAAU,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAGnC,CAAA;gBACD,0CAA0C;gBAC1C,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;oBACzB,UAAU,CAAC,QAAQ,GAAG,WAAW,CAAA;gBACnC,CAAC;qBAAM,CAAC;oBACN,mDAAmD;oBACnD,iDAAiD;oBACjD,IAAI,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBAC5C,UAAU,CAAC,QAAQ,GAAG;4BACpB,UAAU,CAAC,QAAQ;4BACnB,GAAG,WAAW;yBACf,CAAA;oBACH,CAAC;yBAAM,CAAC;wBACN,gDAAgD;wBAChD,UAAU,CAAC,QAAQ,GAAG;4BACpB,GAAG,UAAU,CAAC,QAAQ;4BACtB,GAAG,WAAW;yBACf,CAAA;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,wDAAwD;YACxD,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAA;QAChC,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,OAAO,IAAI,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;AACrC,CAAC,CAAA","sourcesContent":["import { mkdirSync } from 'node:fs'\nimport { relative, resolve } from 'node:path'\nimport { minimatch } from 'minimatch'\nimport { init } from '@vltpkg/init'\nimport { load, save } from '@vltpkg/vlt-json'\nimport { assertWSConfig, asWSConfig } from '@vltpkg/workspaces'\nimport { commandUsage } from '../config/usage.ts'\nimport type { InitFileResults } from '@vltpkg/init'\nimport type { CommandFn, CommandUsage } from '../index.ts'\nimport type { Views } from '../view.ts'\n\nexport const usage: CommandUsage = () =>\n  commandUsage({\n    command: 'init',\n    usage: '',\n    description: `Create a new package.json file in the current directory.`,\n  })\n\n// TODO: colorize the JSON if config.options.color\nexport const views = {\n  human: (results: InitFileResults | InitFileResults[]) => {\n    const output: string[] = []\n    // if results is an array, it means multiple workspaces were initialized\n    if (Array.isArray(results)) {\n      for (const result of results) {\n        for (const [type, { path }] of Object.entries(result)) {\n          output.push(`Wrote ${type} to ${path}:`)\n        }\n      }\n    } else {\n      // otherwise, it's a single result\n      for (const [type, { path, data }] of Object.entries(results)) {\n        output.push(`Wrote ${type} to ${path}:\n\n${JSON.stringify(data, null, 2)}`)\n      }\n    }\n    output.push(`\\nModify/add properties using \\`vlt pkg\\`. For example:\n\n  vlt pkg set \"description=My new project\"`)\n    return output.join('\\n')\n  },\n} as const satisfies Views<InitFileResults>\n\nexport const command: CommandFn<\n  InitFileResults | InitFileResults[]\n> = async conf => {\n  if (conf.values.workspace?.length) {\n    const workspacesConfig = load('workspaces', assertWSConfig)\n    const parsedWSConfig = asWSConfig(workspacesConfig ?? {})\n    const results: InitFileResults[] = []\n    const addToConfig: string[] = []\n\n    // create a new package.json file for every workspace\n    // defined as cli --workspace options\n    for (const workspace of conf.values.workspace) {\n      // cwd is the resolved location of the workspace\n      const cwd = resolve(conf.options.projectRoot, workspace)\n\n      // create the folder in case it's missing\n      mkdirSync(cwd, { recursive: true })\n\n      // run the initialization script and collect results\n      results.push(await init({ cwd }))\n\n      // Check if this workspace path is covered by existing workspace patterns\n      const isMatched = Object.values(parsedWSConfig).some(\n        (patterns: string[]) => {\n          return patterns.some(pattern =>\n            minimatch(workspace, pattern),\n          )\n        },\n      )\n\n      // When a workspace is not matched we track it for insertion later\n      if (!isMatched) {\n        addToConfig.push(\n          relative(conf.options.projectRoot, cwd).replace(/\\\\/g, '/'),\n        )\n      }\n    }\n\n    // if there are workspaces that were not matched by existing\n    // patterns, we add them to the workspaces config\n    if (addToConfig.length > 0) {\n      let workspaces = workspacesConfig\n      // if the original workspaces config is a string, we'll need\n      // to convert it to an array in order to append the recently\n      // added workspaces\n      if (typeof workspacesConfig === 'string') {\n        workspaces = [workspacesConfig, ...addToConfig]\n      } else if (Array.isArray(workspacesConfig)) {\n        // if the original workspaces config is an array, we simply\n        // append the missing items to it\n        workspaces = [...workspacesConfig, ...addToConfig]\n      } else {\n        // otherwise we assume it's an Record<string, string[]> object\n        // and we'll add the new workspaces to the `packages` keys\n        workspaces = (workspacesConfig ?? {}) as Record<\n          string,\n          string[]\n        >\n        // if the `packages` key is not being used\n        if (!workspaces.packages) {\n          workspaces.packages = addToConfig\n        } else {\n          // if the `packages` key is defined as a string, we\n          // convert it to an array to append the new items\n          if (typeof workspaces.packages === 'string') {\n            workspaces.packages = [\n              workspaces.packages,\n              ...addToConfig,\n            ]\n          } else {\n            // if it is, we simply append the new workspaces\n            workspaces.packages = [\n              ...workspaces.packages,\n              ...addToConfig,\n            ]\n          }\n        }\n      }\n      // finally, we add the new workspaces to the config file\n      save('workspaces', workspaces)\n    }\n    return results\n  }\n\n  return init({ cwd: process.cwd() })\n}\n"]}

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

@@ -1 +1 @@
-{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/commands/list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,eAAe,EACf,kBAAkB,EAEnB,MAAM,eAAe,CAAA;AACtB,OAAO,EAEL,mBAAmB,EACnB,UAAU,EACV,aAAa,EAEd,MAAM,eAAe,CAAA;AAKtB,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1D,eAAO,MAAM,KAAK,EAAE,YA4ChB,CAAA;AAEJ,MAAM,MAAM,UAAU,GAAG,eAAe,GACtC,kBAAkB,GAClB,wBAAwB,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAEpD,eAAO,MAAM,KAAK;;;;;CAUoB,CAAA;AAEtC,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,UAAU,CA4EzC,CAAA"}
+{"version":3,"file":"list.d.ts","sourceRoot":"","sources":["../../../src/commands/list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,eAAe,EACf,kBAAkB,EAEnB,MAAM,eAAe,CAAA;AACtB,OAAO,EAGL,mBAAmB,EACnB,UAAU,EACV,aAAa,EAEd,MAAM,eAAe,CAAA;AAOtB,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAI1D,eAAO,MAAM,KAAK,EAAE,YAyDhB,CAAA;AAEJ,MAAM,MAAM,UAAU,GAAG,eAAe,GACtC,kBAAkB,GAClB,wBAAwB,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAEpD,eAAO,MAAM,KAAK;;;;;CAUoB,CAAA;AAEtC,eAAO,MAAM,OAAO,EAAE,SAAS,CAAC,UAAU,CAwHzC,CAAA"}

package/dist/esm/commands/list.js

@@ -1,21 +1,27 @@
-import { actual, humanReadableOutput, jsonOutput, mermaidOutput, GraphModifier, } from '@vltpkg/graph';
+import { actual, asNode, humanReadableOutput, jsonOutput, mermaidOutput, GraphModifier, } from '@vltpkg/graph';
+import LZString from 'lz-string';
 import { Query } from '@vltpkg/query';
 import { SecurityArchive } from '@vltpkg/security-archive';
+import { error } from '@vltpkg/error-cause';
 import { commandUsage } from "../config/usage.js";
 import { startGUI } from "../start-gui.js";
 export const usage = () => commandUsage({
     command: 'ls',
     usage: [
         '',
-        '[query | specs] [--view=human | json | mermaid | gui]',
+        '[package-names...] [--view=human | json | mermaid | gui]',
+        '[--scope=<query>] [--target=<query>] [--view=human | json | mermaid | gui]',
     ],
-    description: `List installed dependencies matching given package names or resulting
-      packages from matching a given Dependency Selector Syntax query if one
-      is provided.
+    description: `List installed dependencies matching given package names or query selectors.
 
-      The vlt Dependency Selector Syntax is a CSS-like query language that
-      allows you to filter installed dependencies using a variety of metadata
-      in the form of CSS-like attributes, pseudo selectors & combinators.
+      Package names provided as positional arguments will be used to filter
+      the results to show only dependencies with those names.
+
+      The --scope and --target options accepts DSS query selectors to filter
+      packages. Using --scope, you can specify which packages to treat as the
+      top-level items in the output graph. The --target option allows you to
+      filter what dependencies to include in the output. Using both options
+      allows you to render subgraphs of the dependency graph.
 
       Defaults to listing direct dependencies of a project and any configured
       workspace.`,
@@ -23,20 +29,28 @@ export const usage = () => commandUsage({
         '': {
             description: 'List direct dependencies of the current project / workspace',
         },
-        '"*"': {
-            description: 'List all dependencies for the current project / workspace',
-        },
         'foo bar baz': {
             description: `List all dependencies named 'foo', 'bar', or 'baz'`,
         },
-        [`'[name="@scoped/package"] > *'`]: {
-            description: 'Lists direct dependencies of a specific package',
+        '--scope=":root > #dependency-name"': {
+            description: 'Defines a direct dependency as the output top-level scope',
+        },
+        '--target="*"': {
+            description: 'List all dependencies using a query selector',
         },
-        [`'*:workspace > *:peer'`]: {
+        '--target=":workspace > *:peer"': {
             description: 'List all peer dependencies of all workspaces',
         },
     },
     options: {
+        scope: {
+            value: '<query>',
+            description: 'Query selector to select top-level packages using the DSS query language syntax.',
+        },
+        target: {
+            value: '<query>',
+            description: 'Query selector to filter packages using the DSS query language syntax.',
+        },
         view: {
             value: '[human | json | mermaid | gui]',
             description: 'Output format. Defaults to human-readable or json if no tty.',
@@ -48,7 +62,7 @@ export const views = {
     mermaid: mermaidOutput,
     human: humanReadableOutput,
     gui: async ({ queryString }, _, conf) => {
-        await startGUI(conf, '/explore?query=' + encodeURIComponent(queryString));
+        await startGUI(conf, `/explore/${LZString.compressToEncodedURIComponent(queryString)}/overview`);
     },
 };
 export const command = async (conf) => {
@@ -62,15 +76,24 @@ export const command = async (conf) => {
         monorepo,
         loadManifests: true,
     });
-    const queryString = conf.positionals
-        .map(k => (/^[@\w-]/.test(k) ? `#${k.replace(/\//, '\\/')}` : k))
+    // Validate positional arguments - only allow package names, not direct queries
+    for (const arg of conf.positionals) {
+        if (!/^[@\w-]/.test(arg)) {
+            throw error(`Direct queries are not supported as positional arguments. Use package names only.`, {
+                code: 'EUSAGE',
+                cause: `Argument '${arg}' appears to be a query syntax. Only package names are allowed as positional arguments.`,
+            });
+        }
+    }
+    const positionalQueryString = conf.positionals
+        .map(k => `#${k.replace(/\//, '\\/')}`)
         .join(', ');
-    const securityArchive = Query.hasSecuritySelectors(queryString) ?
-        await SecurityArchive.start({
-            graph,
-            specOptions: conf.options,
-        })
-        : undefined;
+    const targetQueryString = conf.get('target');
+    const queryString = targetQueryString || positionalQueryString;
+    const securityArchive = await SecurityArchive.start({
+        graph,
+        specOptions: conf.options,
+    });
     const query = new Query({
         graph,
         specOptions: conf.options,
@@ -80,27 +103,56 @@ export const command = async (conf) => {
     const selectImporters = [];
     const importers = new Set();
     const scopeIDs = [];
-    if (monorepo) {
-        for (const workspace of monorepo.filter(conf.values)) {
-            const w = graph.nodes.get(workspace.id);
-            if (w) {
-                importers.add(w);
-                selectImporters.push(`[name="${w.name}"]`);
-                selectImporters.push(`[name="${w.name}"] > *`);
-                scopeIDs.push(workspace.id);
-            }
+    // handle --scope option to add scope nodes as importers
+    const scopeQueryString = conf.get('scope');
+    let scopeNodes;
+    if (scopeQueryString) {
+        // run scope query to get all matching nodes
+        const scopeQuery = new Query({
+            graph,
+            specOptions: conf.options,
+            securityArchive,
+        });
+        const { nodes } = await scopeQuery.search(scopeQueryString, {
+            signal: new AbortController().signal,
+        });
+        scopeNodes = nodes;
+    }
+    if (scopeQueryString && scopeNodes) {
+        // Add all scope nodes to importers Set (treat them as top-level items)
+        for (const queryNode of scopeNodes) {
+            importers.add(asNode(queryNode));
         }
     }
-    if (importers.size === 0) {
-        for (const importer of graph.importers) {
-            importers.add(importer);
+    else {
+        // if in a workspace environment, select only the specified
+        // workspaces as top-level items
+        if (monorepo) {
+            for (const workspace of monorepo.filter(conf.values)) {
+                const w = graph.nodes.get(workspace.id);
+                if (w) {
+                    importers.add(w);
+                    selectImporters.push(`[name="${w.name}"]`);
+                    selectImporters.push(`[name="${w.name}"] > *`);
+                    scopeIDs.push(workspace.id);
+                }
+            }
+        }
+        // if no top-level item was set then by default
+        // we just set all importers as top-level items
+        if (importers.size === 0) {
+            for (const importer of graph.importers) {
+                importers.add(importer);
+            }
         }
     }
+    // build a default query string to use in the target search
     const selectImportersQueryString = selectImporters.join(', ');
     const defaultQueryString = (selectImporters.length &&
         selectImporters.length < graph.importers.size) ?
         selectImportersQueryString
         : projectQueryString;
+    // retrieve the selected nodes and edges
     const { edges, nodes } = await query.search(queryString || defaultQueryString, {
         signal: new AbortController().signal,
         scopeIDs: scopeIDs.length > 0 ? scopeIDs : undefined,
@@ -110,7 +162,7 @@ export const command = async (conf) => {
         edges,
         nodes,
         queryString: queryString || defaultQueryString,
-        highlightSelection: !!queryString,
+        highlightSelection: !!(targetQueryString || positionalQueryString),
     };
 };
 //# sourceMappingURL=list.js.map