@vltpkg/config 0.0.0-19

package/LICENSE

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

package/README.md

@@ -0,0 +1,78 @@
+# @vltpkg/config
+
+Config utilities for the vlt client.
+
+**[Usage](#usage)** · **[API](#api)**
+
+## Overview
+
+These are config utilities used by the vlt cli.
+
+## Usage
+
+```js
+import { get, set, edit, list, del } from '@vltpkg/config'
+
+// Assuming you have a LoadedConfig instance from @vltpkg/cli-sdk
+// const conf = await loadConfig()
+
+// Get a config value by key
+const colorValue = await get(conf) // requires conf.positionals[1] to be the key name
+// Supports dot notation for nested properties in record fields
+// e.g., conf.positionals = ['get', 'registry.npmjs.org']
+
+// Set config values using key=value pairs
+// conf.positionals should contain pairs like ['set', 'color=auto', 'timeout=5000']
+await set(conf)
+// Creates config file if it doesn't exist when called with no pairs
+// Supports dot notation for record fields: 'registry.npmjs.org=https://registry.npmjs.org/'
+
+// Edit the config file with the configured editor
+await edit(conf) // opens conf.get('config') file in conf.get('editor')
+
+// List all current config values as key=value pairs
+const allConfig = list(conf) // returns array of 'key=value' strings
+
+// Delete config keys
+// conf.positionals should contain keys to delete: ['del', 'color', 'timeout']
+await del(conf) // removes specified keys from conf.get('config') file
+```
+
+### API
+
+#### `get(conf: LoadedConfig)`
+
+- Retrieves a single config value by key
+- Supports dot notation for accessing nested properties in record
+  fields
+- Returns the value as
+  `string | number | boolean | string[] | Record<string, string> | undefined`
+- Requires exactly one key in `conf.positionals[1]`
+
+#### `set(conf: LoadedConfig)`
+
+- Sets config values from key=value pairs in `conf.positionals`
+- Creates an empty config file if no pairs are provided
+- Supports dot notation for record fields (e.g.,
+  `registry.npmjs.org=value`)
+- Writes to the config file specified by `conf.get('config')`
+
+#### `edit(conf: LoadedConfig)`
+
+- Opens the config file in the editor specified by
+  `conf.get('editor')`
+- Uses `spawnSync` to launch the editor with the config file path
+- Throws an error if the editor command fails
+
+#### `list(conf: LoadedConfig)`
+
+- Returns all current config options as an array of 'key=value'
+  strings
+- Converts the internal config records to a flat list format
+
+#### `del(conf: LoadedConfig)`
+
+- Deletes specified config keys from the config file
+- Requires at least one key in `conf.positionals` (after the command
+  name)
+- Removes keys from the file specified by `conf.get('config')`

package/dist/esm/index.d.ts

@@ -0,0 +1,7 @@
+import type { LoadedConfig } from '@vltpkg/cli-sdk/config';
+export declare const list: (conf: LoadedConfig) => import("@vltpkg/cli-sdk/config").RecordPairs;
+export declare const del: (conf: LoadedConfig) => Promise<void>;
+export declare const get: (conf: LoadedConfig) => Promise<string | number | boolean | string[] | import("@vltpkg/cli-sdk/config").RecordString | undefined>;
+export declare const edit: (conf: LoadedConfig) => Promise<void>;
+export declare const set: (conf: LoadedConfig) => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAEV,YAAY,EACb,MAAM,wBAAwB,CAAA;AAE/B,eAAO,MAAM,IAAI,SAAU,YAAY,iDAEtC,CAAA;AAED,eAAO,MAAM,GAAG,SAAgB,YAAY,kBAS3C,CAAA;AAED,eAAO,MAAM,GAAG,SAAgB,YAAY,8GAqC3C,CAAA;AAED,eAAO,MAAM,IAAI,SAAgB,YAAY,kBAkB5C,CAAA;AAED,eAAO,MAAM,GAAG,SAAgB,YAAY,kBA8E3C,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,165 @@
+import { spawnSync } from 'node:child_process';
+import * as dotProp from '@vltpkg/dot-prop';
+import { error } from '@vltpkg/error-cause';
+import { asRootError } from '@vltpkg/output/error';
+import { isObject } from '@vltpkg/types';
+import { getSortedKeys } from '@vltpkg/cli-sdk/definition';
+import { isRecordField, pairsToRecords, recordsToPairs, } from '@vltpkg/cli-sdk/config';
+export const list = (conf) => {
+    return recordsToPairs(conf.options);
+};
+export const del = async (conf) => {
+    const fields = conf.positionals.slice(1);
+    if (!fields.length) {
+        throw error('At least one key is required', {
+            code: 'EUSAGE',
+        });
+    }
+    await conf.deleteConfigKeys(conf.get('config'), fields);
+};
+export const get = async (conf) => {
+    const keys = conf.positionals.slice(1);
+    const k = keys[0];
+    if (!k || keys.length > 1) {
+        throw error('Exactly one key is required', {
+            code: 'EUSAGE',
+        });
+    }
+    // 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);
+};
+export const edit = async (conf) => {
+    const [command, ...args] = conf.get('editor').split(' ');
+    if (!command) {
+        throw error(`editor is empty`);
+    }
+    await conf.editConfigFile(conf.get('config'), file => {
+        args.push(file);
+        const res = spawnSync(command, args, {
+            stdio: 'inherit',
+        });
+        if (res.status !== 0) {
+            throw error(`${command} command failed`, {
+                ...res,
+                command,
+                args,
+            });
+        }
+    });
+};
+export const set = async (conf) => {
+    const pairs = conf.positionals.slice(1);
+    if (!pairs.length) {
+        // Create an empty config file
+        await conf.addConfigToFile(conf.get('config'), {});
+        return;
+    }
+    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',
+            });
+        }
+        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,
+                });
+            }
+        }
+        else {
+            simplePairs.push(pair);
+        }
+    }
+    // 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,
+            validOptions,
+        });
+    }
+    // an unknown property
+    throw error('Invalid config keys', {
+        code: 'ECONFIG',
+        found: simplePairs.map(kv => kv.split('=')[0]),
+        validOptions: getSortedKeys(),
+    });
+};
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAC3C,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,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC1D,OAAO,EACL,aAAa,EACb,cAAc,EACd,cAAc,GACf,MAAM,wBAAwB,CAAA;AAO/B,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,IAAkB,EAAE,EAAE;IACzC,OAAO,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AACrC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IAC9C,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,CAAC,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IAC9C,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,CAAC,MAAM,IAAI,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IAC/C,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,CAAC,MAAM,GAAG,GAAG,KAAK,EAAE,IAAkB,EAAE,EAAE;IAC9C,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 { spawnSync } from 'node:child_process'\nimport * as dotProp from '@vltpkg/dot-prop'\nimport { error } from '@vltpkg/error-cause'\nimport { asRootError } from '@vltpkg/output/error'\nimport { isObject } from '@vltpkg/types'\nimport { getSortedKeys } from '@vltpkg/cli-sdk/definition'\nimport {\n  isRecordField,\n  pairsToRecords,\n  recordsToPairs,\n} from '@vltpkg/cli-sdk/config'\n\nimport type {\n  ConfigDefinitions,\n  LoadedConfig,\n} from '@vltpkg/cli-sdk/config'\n\nexport const list = (conf: LoadedConfig) => {\n  return recordsToPairs(conf.options)\n}\n\nexport const 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\nexport const 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\nexport const 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\nexport const 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/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@vltpkg/config",
+  "description": "Project config logic for vltpkg",
+  "version": "0.0.0-19",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vltpkg/vltpkg.git",
+    "directory": "src/config"
+  },
+  "tshy": {
+    "selfLink": false,
+    "liveDev": true,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "path-scurry": "^2.0.0",
+    "@vltpkg/cli-sdk": "0.0.0-19",
+    "@vltpkg/dot-prop": "0.0.0-19",
+    "@vltpkg/output": "0.0.0-19",
+    "@vltpkg/package-json": "0.0.0-19",
+    "@vltpkg/error-cause": "0.0.0-19",
+    "@vltpkg/types": "0.0.0-19"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.28.0",
+    "@types/node": "^22.15.29",
+    "eslint": "^9.28.0",
+    "prettier": "^3.6.0",
+    "tap": "^21.1.0",
+    "tshy": "^3.0.2",
+    "typedoc": "~0.27.9",
+    "typescript": "5.7.3",
+    "typescript-eslint": "^8.33.1"
+  },
+  "license": "BSD-2-Clause-Patent",
+  "engines": {
+    "node": ">=22"
+  },
+  "tap": {
+    "extends": "../../tap-config.yaml"
+  },
+  "prettier": "../../.prettierrc.js",
+  "module": "./dist/esm/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "vltpkg",
+    "config"
+  ],
+  "scripts": {
+    "format": "prettier --write . --log-level warn --ignore-path ../../.prettierignore --cache",
+    "format:check": "prettier --check . --ignore-path ../../.prettierignore --cache",
+    "lint": "eslint . --fix",
+    "lint:check": "eslint .",
+    "snap": "tap",
+    "test": "tap",
+    "posttest": "tsc --noEmit",
+    "tshy": "tshy",
+    "typecheck": "tsc --noEmit"
+  }
+}