@vltpkg/vlt-json 0.0.0-14

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,38 @@
+# @vltpkg/vlt-json
+
+Facilities for finding, loading, and updating the `vlt.json` vlt
+project configuration file.
+
+## Usage
+
+```js
+import { find, load, save } from '@vltpkg/xdg'
+
+// finds the project config file.
+const projectRoot = find()
+
+// Load a bit of data, providing a typedef check for it
+// If a matching field is not found, then `undefined` is returned.
+
+const isWorkspaceConfig = (x: unknown): x is WorkspaceConfig => { ... }
+const workspaceOptions = load('workspaces', isWorkspaceConfig)
+// now workspaceOptions is WorkspaceConfig | undefined
+
+// do whatever and then save it back. This organizes writes so
+// that we do not clobber the file if there are multiple parts
+// of vlt all trying to write to it. Once the validator function
+// is established, it'll be re-used on that field when saving.
+save('workspaces', workspaceConfig)
+
+// If you need a user-level instead of project-level file, use
+// the third argument to specify that file instead.
+const userConfig = load('config', isValidConfig, 'user')
+const projectConfig = load('config', isValidConfig)
+userConfig.color = true
+save('config', userConfig, 'user')
+
+// Note that save() ALWAYS clobbers, so if you want to do
+// a merge, load() first, make the change, and then save back.
+// If the file was edited since it was opened, then this will
+// fail.
+```

package/dist/esm/index.d.ts

@@ -0,0 +1,9 @@
+export type WhichConfig = 'user' | 'project';
+export type Validator<T> = (x: unknown, file: string) => asserts x is T;
+/** This should only be used in tests */
+export declare const unload: (which?: WhichConfig) => void;
+export declare const reload: (field: string, which?: WhichConfig) => unknown;
+export declare const load: <T>(field: string, validator: Validator<T>, which?: WhichConfig) => T | undefined;
+export declare const find: (which?: WhichConfig, cwd?: string, home?: string) => string;
+export declare const save: (field: string, value: unknown, which?: WhichConfig) => 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":"AAuBA,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAA;AA8E5C,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CACzB,CAAC,EAAE,OAAO,EACV,IAAI,EAAE,MAAM,KACT,OAAO,CAAC,CAAC,IAAI,CAAC,CAAA;AAcnB,wCAAwC;AACxC,eAAO,MAAM,MAAM,WAAW,WAAW,SAMxC,CAAA;AAED,eAAO,MAAM,MAAM,UACV,MAAM,UACN,WAAW,KACjB,OASF,CAAA;AAED,eAAO,MAAM,IAAI,GAAI,CAAC,SACb,MAAM,aACF,SAAS,CAAC,CAAC,CAAC,UAChB,WAAW,KACjB,CAAC,GAAG,SAON,CAAA;AAED,eAAO,MAAM,IAAI,WACR,WAAW,kCAGjB,MA6BF,CAAA;AAED,eAAO,MAAM,IAAI,UACR,MAAM,SACN,OAAO,UACP,WAAW,KACjB,IAkCF,CAAA"}

package/dist/esm/index.js

@@ -0,0 +1,155 @@
+import { error } from '@vltpkg/error-cause';
+import { XDG } from '@vltpkg/xdg';
+import { lstatSync, readFileSync, writeFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { resolve } from 'node:path';
+import { walkUp } from 'walk-up-path';
+import { parse as jsonParse, stringify as jsonStringify, kIndent, kNewline, } from 'polite-json';
+const stringifyOptions = {};
+const lstatCache = {};
+const cachedLstat = (path) => {
+    if (path in lstatCache)
+        return lstatCache[path];
+    try {
+        return (lstatCache[path] = lstatSync(path));
+    }
+    catch {
+        delete lstatCache[path];
+        return undefined;
+    }
+};
+const exists = (f) => !!cachedLstat(f);
+const isRecord = (x) => !!x && typeof x === 'object';
+const mtimes = {
+    user: undefined,
+    project: undefined,
+};
+const datas = {
+    user: undefined,
+    project: undefined,
+};
+const validators = {};
+const paths = {
+    user: new XDG('vlt').config('vlt.json'),
+    project: undefined,
+};
+const maybeReadData = (path) => {
+    try {
+        const rawData = jsonParse(readFileSync(path, 'utf8'));
+        if (!isRecord(rawData))
+            return undefined;
+        const so = stringifyOptions[path] ?? {
+            [kIndent]: 2,
+            [kNewline]: '\n',
+        };
+        const { [kNewline]: nl = so[kNewline], [kIndent]: ind = so[kIndent], ...data } = rawData;
+        stringifyOptions[path] = so;
+        stringifyOptions[path][kNewline] = nl;
+        stringifyOptions[path][kIndent] = ind;
+        return data;
+    }
+    catch (er) {
+        throw error('Failed to parse vlt.json file', {
+            path,
+            cause: er,
+        });
+    }
+};
+const loadFullObject = (which) => {
+    if (datas[which])
+        return datas[which];
+    const path = find(which);
+    const mtime = cachedLstat(path)?.mtime.getTime();
+    const data = mtime ? maybeReadData(path) : {};
+    if (mtime && data) {
+        mtimes[which] = mtime;
+    }
+    return (datas[which] = data ?? {});
+};
+const runValidator = (v, x, file) => {
+    if (x !== undefined)
+        v(x, file);
+};
+/** This should only be used in tests */
+export const unload = (which = 'project') => {
+    const file = find(which);
+    delete datas[which];
+    delete paths[which];
+    delete lstatCache[file];
+    delete mtimes[which];
+};
+export const reload = (field, which = 'project') => {
+    unload(which);
+    const file = find(which);
+    const data = loadFullObject(which);
+    for (const [field, validator] of Object.entries(validators)) {
+        const value = data[field];
+        runValidator(validator, value, file);
+    }
+    return data[field];
+};
+export const load = (field, validator, which = 'project') => {
+    const data = loadFullObject(which);
+    const file = find(which);
+    validators[field] ??= validator;
+    const value = data[field];
+    if (value !== undefined)
+        validator(value, file);
+    return value;
+};
+export const find = (which = 'project', cwd = process.cwd(), home = homedir()) => {
+    if (paths[which])
+        return paths[which];
+    let lastKnownRoot = cwd;
+    for (const dir of walkUp(cwd)) {
+        // don't look in ~
+        if (dir === home)
+            break;
+        const projectConfig = resolve(dir, 'vlt.json');
+        // don't let it match user config
+        if (projectConfig === paths.user)
+            break;
+        // these mean we're done looking
+        if (exists(projectConfig)) {
+            return (paths[which] = projectConfig);
+        }
+        // these are likely candidates, come back if nothing else matches
+        if (exists(resolve(dir, 'package.json')) ||
+            exists(resolve(dir, 'node_modules'))) {
+            lastKnownRoot = dir;
+        }
+        if (exists(resolve(dir, '.git')))
+            break;
+    }
+    return (paths[which] = resolve(lastKnownRoot, 'vlt.json'));
+};
+export const save = (field, value, which = 'project') => {
+    const validator = validators[field];
+    const data = datas[which];
+    if (!validator || !data) {
+        throw error('Cannot save field before loading initially', {
+            name: field,
+            found: value,
+        });
+    }
+    const file = find(which);
+    runValidator(validator, value, file);
+    data[field] = value;
+    const mtime = mtimes[which];
+    const path = find(which);
+    delete lstatCache[path];
+    const updatedMtime = cachedLstat(path)?.mtime.getTime();
+    // if we didn't have a file, and now do, or if we had a file and
+    // it's been changed since we read it, no go.
+    if (updatedMtime && (!mtime || updatedMtime > mtime)) {
+        throw error('File was changed by another process, cannot safely write', {
+            path,
+            name: field,
+            found: value,
+        });
+    }
+    writeFileSync(path, jsonStringify({ ...data, ...stringifyOptions[path] }));
+    delete lstatCache[path];
+    mtimes[which] = cachedLstat(path)?.mtime.getTime();
+};
+//# 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,KAAK,EAAE,MAAM,qBAAqB,CAAA;AAC3C,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAEjC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAChE,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAA;AAErC,OAAO,EACL,KAAK,IAAI,SAAS,EAClB,SAAS,IAAI,aAAa,EAC1B,OAAO,EACP,QAAQ,GACT,MAAM,aAAa,CAAA;AAEpB,MAAM,gBAAgB,GAMlB,EAAE,CAAA;AAIN,MAAM,UAAU,GAA0B,EAAE,CAAA;AAC5C,MAAM,WAAW,GAAG,CAAC,IAAY,EAAqB,EAAE;IACtD,IAAI,IAAI,IAAI,UAAU;QAAE,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;IAC/C,IAAI,CAAC;QACH,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;IAC7C,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;QACvB,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC,CAAA;AAED,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;AAE9C,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAgC,EAAE,CAC5D,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,CAAA;AAE9B,MAAM,MAAM,GAA4C;IACtD,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,SAAS;CACnB,CAAA;AAED,MAAM,KAAK,GAGP;IACF,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,SAAS;CACnB,CAAA;AAED,MAAM,UAAU,GAAuC,EAAE,CAAA;AAEzD,MAAM,KAAK,GAA4C;IACrD,IAAI,EAAE,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;IACvC,OAAO,EAAE,SAAS;CACnB,CAAA;AAED,MAAM,aAAa,GAAG,CACpB,IAAY,EACyB,EAAE;IACvC,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;QACrD,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;YAAE,OAAO,SAAS,CAAA;QACxC,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI;YACnC,CAAC,OAAO,CAAC,EAAE,CAAC;YACZ,CAAC,QAAQ,CAAC,EAAE,IAAI;SACjB,CAAA;QACD,MAAM,EACJ,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,EAC7B,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,EAC5B,GAAG,IAAI,EACR,GAAG,OAAO,CAAA;QACX,gBAAgB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QAC3B,gBAAgB,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAA;QACrC,gBAAgB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,GAAG,CAAA;QACrC,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,EAAE,EAAE,CAAC;QACZ,MAAM,KAAK,CAAC,+BAA+B,EAAE;YAC3C,IAAI;YACJ,KAAK,EAAE,EAAE;SACV,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAA;AAED,MAAM,cAAc,GAAG,CACrB,KAAkB,EACO,EAAE;IAC3B,IAAI,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;IACrC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;IAChD,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC7C,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,CAAA;IACvB,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI,EAAE,CAAC,CAAA;AACpC,CAAC,CAAA;AAOD,MAAM,YAAY,GAIN,CACV,CAAe,EACf,CAAU,EACV,IAAY,EACgB,EAAE;IAC9B,IAAI,CAAC,KAAK,SAAS;QAAE,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;AACjC,CAAC,CAAA;AAED,wCAAwC;AACxC,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,QAAqB,SAAS,EAAE,EAAE;IACvD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;IACnB,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;IACnB,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;IACvB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;AACtB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,CACpB,KAAa,EACb,QAAqB,SAAS,EACrB,EAAE;IACX,MAAM,CAAC,KAAK,CAAC,CAAA;IACb,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAClC,KAAK,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;QAC5D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;QACzB,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IACtC,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;AACpB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,CAClB,KAAa,EACb,SAAuB,EACvB,QAAqB,SAAS,EACf,EAAE;IACjB,MAAM,IAAI,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IAClC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,UAAU,CAAC,KAAK,CAAC,KAAK,SAAS,CAAA;IAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACzB,IAAI,KAAK,KAAK,SAAS;QAAE,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC/C,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,CAClB,QAAqB,SAAS,EAC9B,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,IAAI,GAAG,OAAO,EAAE,EACR,EAAE;IACV,IAAI,KAAK,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,KAAK,CAAC,CAAA;IACrC,IAAI,aAAa,GAAG,GAAG,CAAA;IACvB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9B,kBAAkB;QAClB,IAAI,GAAG,KAAK,IAAI;YAAE,MAAK;QAEvB,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAE9C,iCAAiC;QACjC,IAAI,aAAa,KAAK,KAAK,CAAC,IAAI;YAAE,MAAK;QAEvC,gCAAgC;QAChC,IAAI,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,aAAa,CAAC,CAAA;QACvC,CAAC;QAED,iEAAiE;QACjE,IACE,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;YACpC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,EACpC,CAAC;YACD,aAAa,GAAG,GAAG,CAAA;QACrB,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAAE,MAAK;IACzC,CAAC;IAED,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC,CAAA;AAC5D,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG,CAClB,KAAa,EACb,KAAc,EACd,QAAqB,SAAS,EACxB,EAAE;IACR,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAA;IACnC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;IACzB,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,MAAM,KAAK,CAAC,4CAA4C,EAAE;YACxD,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,KAAK;SACb,CAAC,CAAA;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,YAAY,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;IACpC,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,CAAA;IACnB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAA;IACxB,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;IACvB,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;IACvD,gEAAgE;IAChE,6CAA6C;IAC7C,IAAI,YAAY,IAAI,CAAC,CAAC,KAAK,IAAI,YAAY,GAAG,KAAK,CAAC,EAAE,CAAC;QACrD,MAAM,KAAK,CACT,0DAA0D,EAC1D;YACE,IAAI;YACJ,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,KAAK;SACb,CACF,CAAA;IACH,CAAC;IACD,aAAa,CACX,IAAI,EACJ,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,CACtD,CAAA;IACD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAA;IACvB,MAAM,CAAC,KAAK,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;AACpD,CAAC,CAAA","sourcesContent":["import { error } from '@vltpkg/error-cause'\nimport { XDG } from '@vltpkg/xdg'\nimport type { Stats } from 'node:fs'\nimport { lstatSync, readFileSync, writeFileSync } from 'node:fs'\nimport { homedir } from 'node:os'\nimport { resolve } from 'node:path'\nimport { walkUp } from 'walk-up-path'\n\nimport {\n  parse as jsonParse,\n  stringify as jsonStringify,\n  kIndent,\n  kNewline,\n} from 'polite-json'\n\nconst stringifyOptions: Record<\n  string,\n  {\n    [kIndent]: number | string\n    [kNewline]: string\n  }\n> = {}\n\nexport type WhichConfig = 'user' | 'project'\n\nconst lstatCache: Record<string, Stats> = {}\nconst cachedLstat = (path: string): undefined | Stats => {\n  if (path in lstatCache) return lstatCache[path]\n  try {\n    return (lstatCache[path] = lstatSync(path))\n  } catch {\n    delete lstatCache[path]\n    return undefined\n  }\n}\n\nconst exists = (f: string) => !!cachedLstat(f)\n\nconst isRecord = (x: unknown): x is Record<string, unknown> =>\n  !!x && typeof x === 'object'\n\nconst mtimes: Record<WhichConfig, undefined | number> = {\n  user: undefined,\n  project: undefined,\n}\n\nconst datas: Record<\n  WhichConfig,\n  undefined | Record<string, unknown>\n> = {\n  user: undefined,\n  project: undefined,\n}\n\nconst validators: Record<string, Validator<unknown>> = {}\n\nconst paths: Record<WhichConfig, undefined | string> = {\n  user: new XDG('vlt').config('vlt.json'),\n  project: undefined,\n}\n\nconst maybeReadData = (\n  path: string,\n): undefined | Record<string, unknown> => {\n  try {\n    const rawData = jsonParse(readFileSync(path, 'utf8'))\n    if (!isRecord(rawData)) return undefined\n    const so = stringifyOptions[path] ?? {\n      [kIndent]: 2,\n      [kNewline]: '\\n',\n    }\n    const {\n      [kNewline]: nl = so[kNewline],\n      [kIndent]: ind = so[kIndent],\n      ...data\n    } = rawData\n    stringifyOptions[path] = so\n    stringifyOptions[path][kNewline] = nl\n    stringifyOptions[path][kIndent] = ind\n    return data\n  } catch (er) {\n    throw error('Failed to parse vlt.json file', {\n      path,\n      cause: er,\n    })\n  }\n}\n\nconst loadFullObject = (\n  which: WhichConfig,\n): Record<string, unknown> => {\n  if (datas[which]) return datas[which]\n  const path = find(which)\n  const mtime = cachedLstat(path)?.mtime.getTime()\n  const data = mtime ? maybeReadData(path) : {}\n  if (mtime && data) {\n    mtimes[which] = mtime\n  }\n  return (datas[which] = data ?? {})\n}\n\nexport type Validator<T> = (\n  x: unknown,\n  file: string,\n) => asserts x is T\n\nconst runValidator: <T>(\n  v: Validator<T>,\n  x: unknown,\n  file: string,\n) => void = <T>(\n  v: Validator<T>,\n  x: unknown,\n  file: string,\n): asserts x is T | undefined => {\n  if (x !== undefined) v(x, file)\n}\n\n/** This should only be used in tests */\nexport const unload = (which: WhichConfig = 'project') => {\n  const file = find(which)\n  delete datas[which]\n  delete paths[which]\n  delete lstatCache[file]\n  delete mtimes[which]\n}\n\nexport const reload = (\n  field: string,\n  which: WhichConfig = 'project',\n): unknown => {\n  unload(which)\n  const file = find(which)\n  const data = loadFullObject(which)\n  for (const [field, validator] of Object.entries(validators)) {\n    const value = data[field]\n    runValidator(validator, value, file)\n  }\n  return data[field]\n}\n\nexport const load = <T>(\n  field: string,\n  validator: Validator<T>,\n  which: WhichConfig = 'project',\n): T | undefined => {\n  const data = loadFullObject(which)\n  const file = find(which)\n  validators[field] ??= validator\n  const value = data[field]\n  if (value !== undefined) validator(value, file)\n  return value\n}\n\nexport const find = (\n  which: WhichConfig = 'project',\n  cwd = process.cwd(),\n  home = homedir(),\n): string => {\n  if (paths[which]) return paths[which]\n  let lastKnownRoot = cwd\n  for (const dir of walkUp(cwd)) {\n    // don't look in ~\n    if (dir === home) break\n\n    const projectConfig = resolve(dir, 'vlt.json')\n\n    // don't let it match user config\n    if (projectConfig === paths.user) break\n\n    // these mean we're done looking\n    if (exists(projectConfig)) {\n      return (paths[which] = projectConfig)\n    }\n\n    // these are likely candidates, come back if nothing else matches\n    if (\n      exists(resolve(dir, 'package.json')) ||\n      exists(resolve(dir, 'node_modules'))\n    ) {\n      lastKnownRoot = dir\n    }\n\n    if (exists(resolve(dir, '.git'))) break\n  }\n\n  return (paths[which] = resolve(lastKnownRoot, 'vlt.json'))\n}\n\nexport const save = (\n  field: string,\n  value: unknown,\n  which: WhichConfig = 'project',\n): void => {\n  const validator = validators[field]\n  const data = datas[which]\n  if (!validator || !data) {\n    throw error('Cannot save field before loading initially', {\n      name: field,\n      found: value,\n    })\n  }\n  const file = find(which)\n  runValidator(validator, value, file)\n  data[field] = value\n  const mtime = mtimes[which]\n  const path = find(which)\n  delete lstatCache[path]\n  const updatedMtime = cachedLstat(path)?.mtime.getTime()\n  // if we didn't have a file, and now do, or if we had a file and\n  // it's been changed since we read it, no go.\n  if (updatedMtime && (!mtime || updatedMtime > mtime)) {\n    throw error(\n      'File was changed by another process, cannot safely write',\n      {\n        path,\n        name: field,\n        found: value,\n      },\n    )\n  }\n  writeFileSync(\n    path,\n    jsonStringify({ ...data, ...stringifyOptions[path] }),\n  )\n  delete lstatCache[path]\n  mtimes[which] = cachedLstat(path)?.mtime.getTime()\n}\n"]}

package/dist/esm/package.json

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

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@vltpkg/vlt-json",
+  "description": "utility for finding, reading, and updating the vlt.json file",
+  "version": "0.0.0-14",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vltpkg/vltpkg.git",
+    "directory": "src/vlt-json"
+  },
+  "tshy": {
+    "selfLink": false,
+    "liveDev": true,
+    "dialects": [
+      "esm"
+    ],
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    }
+  },
+  "dependencies": {
+    "polite-json": "^5.0.0",
+    "walk-up-path": "^4.0.0",
+    "@vltpkg/error-cause": "0.0.0-14",
+    "@vltpkg/xdg": "0.0.0-14"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.28.0",
+    "@types/node": "^22.15.29",
+    "eslint": "^9.28.0",
+    "prettier": "^3.5.3",
+    "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"
+  ],
+  "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"
+  }
+}