@vltpkg/cli-sdk 0.0.0-13 → 0.0.0-15

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

@@ -22,41 +22,52 @@
  */
 import { PackageInfoClient } from '@vltpkg/package-info';
 import { PackageJson } from '@vltpkg/package-json';
+import type { SpecOptions } from '@vltpkg/spec';
+import type { WhichConfig } from '@vltpkg/vlt-json';
 import { Monorepo } from '@vltpkg/workspaces';
 import type { Jack, OptionsResults, Unwrap } from 'jackspeak';
 import { PathScurry } from 'path-scurry';
-import { kIndent, kNewline } from 'polite-json';
 import type { Commands, RecordField } from './definition.ts';
 import { commands, definition, isRecordField, recordFields } from './definition.ts';
 export { commands, definition, isRecordField, recordFields, type Commands, };
 export declare const kCustomInspect: unique symbol;
 export type RecordPairs = Record<string, unknown>;
 export type RecordString = Record<string, string>;
-export type ConfigFiles = Record<string, ConfigFileData['config']>;
-export type PairsAsRecords = Omit<ConfigOptions, 'projectRoot' | 'scurry' | 'packageJson' | 'monorepo' | 'packageInfo'> & {
-    command?: Record<string, ConfigOptions>;
+export type PairsAsRecords = ConfigOptionsNoExtras & {
+    command?: {
+        [k in keyof Commands]?: ConfigOptionsNoExtras;
+    };
 };
-export declare const pairsToRecords: (obj: NonNullable<ConfigFileData["config"]>) => PairsAsRecords;
+export declare const pairsToRecords: (obj: NonNullable<ConfigFileData> | OptionsResults<ConfigDefinitions>) => PairsAsRecords;
 export declare const recordsToPairs: (obj: RecordPairs) => RecordPairs;
+export type ConfigDataNoCommand = {
+    [k in keyof OptionsResults<ConfigDefinitions>]?: OptionsResults<ConfigDefinitions>[k];
+};
 /**
  * Config data can be any options, and also a 'command' field which
  * contains command names and override options for that command.
  */
-export type ConfigData = OptionsResults<ConfigDefinitions> & {
-    command?: Record<string, OptionsResults<ConfigDefinitions>>;
+export type ConfigData = ConfigDataNoCommand & {
+    command?: {
+        [k in keyof Commands]?: ConfigDataNoCommand;
+    };
+};
+export type ConfigFileDataNoCommand = {
+    [k in keyof ConfigDataNoCommand]: k extends (OptListKeys<ConfigDataNoCommand>) ? RecordString | string[] : ConfigDataNoCommand[k];
 };
 /**
- * Config data as it appears in config files, with kv pair lists
- * stored as `Record<string, string>`.
+ * Config data as it appears in the config field of the vlt.json, with kv pair
+ * lists stored as `Record<string, string>` and
  */
-export type ConfigFileData = {
-    config?: {
-        [k in keyof ConfigData]?: k extends OptListKeys<ConfigData> ? RecordString | string[] : k extends 'command' ? ConfigFiles : ConfigData[k];
+export type ConfigFileData = ConfigFileDataNoCommand & {
+    command?: {
+        [k in keyof Commands]?: ConfigFileDataNoCommand;
     };
 };
-export type ConfigOptions = {
-    [k in keyof ConfigData]: k extends RecordField ? RecordString : k extends 'command' ? never : ConfigData[k];
-} & {
+export type ConfigOptionsNoExtras = {
+    [k in keyof OptionsResults<ConfigDefinitions>]: k extends (RecordField) ? RecordString : k extends 'command' ? never : OptionsResults<ConfigDefinitions>[k];
+};
+export type ConfigOptions = ConfigOptionsNoExtras & Pick<SpecOptions, 'catalog' | 'catalogs'> & {
     packageJson: PackageJson;
     scurry: PathScurry;
     projectRoot: string;
@@ -83,11 +94,6 @@ export declare class Config {
      * representing vlt's configuration
      */
     jack: Jack<ConfigDefinitions>;
-    stringifyOptions: {
-        [kIndent]: string;
-        [kNewline]: string;
-    };
-    configFiles: ConfigFiles;
     /**
      * Parsed values in effect
      */
@@ -157,100 +163,17 @@ export declare class Config {
     /**
      * Write the config values to the user or project config file.
      */
-    writeConfigFile(which: 'project' | 'user', values: NonNullable<ConfigFiles['config']>): Promise<{
-        color?: boolean | undefined;
-        'no-color'?: boolean | undefined;
-        registry?: string | undefined;
-        registries?: string[] | RecordString | undefined;
-        'scope-registries'?: string[] | RecordString | undefined;
-        'jsr-registries'?: string[] | RecordString | undefined;
-        'git-hosts'?: string[] | RecordString | undefined;
-        'git-host-archives'?: string[] | RecordString | undefined;
-        cache?: string | undefined;
-        tag?: string | undefined;
-        before?: string | undefined;
-        os?: string | undefined;
-        arch?: string | undefined;
-        'node-version'?: string | undefined;
-        'git-shallow'?: boolean | undefined;
-        'fetch-retries'?: number | undefined;
-        'fetch-retry-factor'?: number | undefined;
-        'fetch-retry-mintimeout'?: number | undefined;
-        'fetch-retry-maxtimeout'?: number | undefined;
-        'stale-while-revalidate-factor'?: number | undefined;
-        identity?: string | undefined;
-        workspace?: string[] | RecordString | undefined;
-        'workspace-group'?: string[] | RecordString | undefined;
-        recursive?: boolean | undefined;
-        bail?: boolean | undefined;
-        'no-bail'?: boolean | undefined;
-        config?: "user" | "project" | undefined;
-        editor?: string | undefined;
-        'script-shell'?: string | undefined;
-        'fallback-command'?: string | undefined;
-        package?: string | undefined;
-        view?: "human" | "json" | "gui" | "mermaid" | "inspect" | undefined;
-        'dashboard-root'?: string[] | RecordString | undefined;
-        'save-dev'?: boolean | undefined;
-        'save-optional'?: boolean | undefined;
-        'save-peer'?: boolean | undefined;
-        'save-prod'?: boolean | undefined;
-        'expect-results'?: string | undefined;
-        yes?: boolean | undefined;
-        version?: boolean | undefined;
-        help?: boolean | undefined;
-        command?: ConfigFiles | undefined;
-    }>;
+    writeConfigFile(this: LoadedConfig, which: WhichConfig, values: NonNullable<ConfigFileData>): Promise<void>;
     /**
      * Fold in the provided fields with the existing properties
      * in the config file.
      */
-    addConfigToFile(which: 'project' | 'user', values: NonNullable<ConfigFileData['config']>): Promise<{
-        color?: boolean | undefined;
-        'no-color'?: boolean | undefined;
-        registry?: string | undefined;
-        registries?: string[] | RecordString | undefined;
-        'scope-registries'?: string[] | RecordString | undefined;
-        'jsr-registries'?: string[] | RecordString | undefined;
-        'git-hosts'?: string[] | RecordString | undefined;
-        'git-host-archives'?: string[] | RecordString | undefined;
-        cache?: string | undefined;
-        tag?: string | undefined;
-        before?: string | undefined;
-        os?: string | undefined;
-        arch?: string | undefined;
-        'node-version'?: string | undefined;
-        'git-shallow'?: boolean | undefined;
-        'fetch-retries'?: number | undefined;
-        'fetch-retry-factor'?: number | undefined;
-        'fetch-retry-mintimeout'?: number | undefined;
-        'fetch-retry-maxtimeout'?: number | undefined;
-        'stale-while-revalidate-factor'?: number | undefined;
-        identity?: string | undefined;
-        workspace?: string[] | RecordString | undefined;
-        'workspace-group'?: string[] | RecordString | undefined;
-        recursive?: boolean | undefined;
-        bail?: boolean | undefined;
-        'no-bail'?: boolean | undefined;
-        config?: "user" | "project" | undefined;
-        editor?: string | undefined;
-        'script-shell'?: string | undefined;
-        'fallback-command'?: string | undefined;
-        package?: string | undefined;
-        view?: "human" | "json" | "gui" | "mermaid" | "inspect" | undefined;
-        'dashboard-root'?: string[] | RecordString | undefined;
-        'save-dev'?: boolean | undefined;
-        'save-optional'?: boolean | undefined;
-        'save-peer'?: boolean | undefined;
-        'save-prod'?: boolean | undefined;
-        'expect-results'?: string | undefined;
-        yes?: boolean | undefined;
-        version?: boolean | undefined;
-        help?: boolean | undefined;
-        command?: ConfigFiles | undefined;
-    }>;
-    getFilename(which?: 'project' | 'user'): string;
-    deleteConfigKeys(which: 'project' | 'user', fields: string[]): Promise<boolean>;
+    addConfigToFile(this: LoadedConfig, which: WhichConfig, values: NonNullable<ConfigFileData>): Promise<void>;
+    /**
+     * Deletes the specified config fields from the named file
+     * Returns `true` if anything was changed.
+     */
+    deleteConfigKeys(this: LoadedConfig, which: WhichConfig, fields: string[]): Promise<boolean>;
     /**
      * Edit the user or project configuration file.
      *
@@ -261,14 +184,10 @@ export declare class Config {
      * file after editing, then it's restored to what it was before, which might
      * mean deleting the file.
      */
-    editConfigFile(which: 'project' | 'user', edit: (file: string) => Promise<void> | void): Promise<void>;
+    editConfigFile(this: LoadedConfig, which: WhichConfig, edit: (file: string) => Promise<void> | void): Promise<void>;
     /**
      * Find the local config file and load both it and the user-level config in
      * the XDG config home.
-     *
-     * Note: if working in a workspaces monorepo, then the vlt.json file MUST
-     * be in the same folder as the vlt.json file, because we stop
-     * looking when we find either one.
      */
     loadConfigFile(): Promise<this>;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/config/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAE7C,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAK7D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAExC,OAAO,EAGL,OAAO,EACP,QAAQ,EACT,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EACL,QAAQ,EACR,UAAU,EAEV,aAAa,EACb,YAAY,EACb,MAAM,iBAAiB,CAAA;AAExB,OAAO,EACL,QAAQ,EACR,UAAU,EACV,aAAa,EACb,YAAY,EACZ,KAAK,QAAQ,GACd,CAAA;AAED,eAAO,MAAM,cAAc,eAA2C,CAAA;AAEtE,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AACjD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AACjD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAA;AAwBlE,MAAM,MAAM,cAAc,GAAG,IAAI,CAC/B,aAAa,EACX,aAAa,GACb,QAAQ,GACR,aAAa,GACb,UAAU,GACV,aAAa,CAChB,GAAG;IACF,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;CACxC,CAAA;AAED,eAAO,MAAM,cAAc,QACpB,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,KACzC,cAkBF,CAAA;AAED,eAAO,MAAM,cAAc,QAAS,WAAW,KAAG,WA2BjD,CAAA;AAYD;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC,iBAAiB,CAAC,GAAG;IAC3D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAA;CAC5D,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,CAAC,EAAE;SACN,CAAC,IAAI,MAAM,UAAU,CAAC,CAAC,EAAE,CAAC,SAAS,WAAW,CAAC,UAAU,CAAC,GACzD,YAAY,GAAG,MAAM,EAAE,GACvB,CAAC,SAAS,SAAS,GAAG,WAAW,GACjC,UAAU,CAAC,CAAC,CAAC;KAChB,CAAA;CACF,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;KACzB,CAAC,IAAI,MAAM,UAAU,GAAG,CAAC,SAAS,WAAW,GAAG,YAAY,GAC3D,CAAC,SAAS,SAAS,GAAG,KAAK,GAC3B,UAAU,CAAC,CAAC,CAAC;CAChB,GAAG;IACF,WAAW,EAAE,WAAW,CAAA;IACxB,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,WAAW,EAAE,iBAAiB,CAAA;CAC/B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,UAAU,CAAC,CAAA;AAEzD,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;KAC7B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,GAAG,CAAC,GAAG,KAAK;CAC9D,CAAA;AACD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,OAAO,CAClC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,CAAC,CAAC,CAAC,EAC1C,SAAS,CACV,CAAA;AAED;;;;GAIG;AACH,qBAAa,MAAM;;IACjB;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAE7B,gBAAgB,EAAE;QAChB,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;QACjB,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KACnB,CAAwC;IAEzC,WAAW,EAAE,WAAW,CAAK;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC,iBAAiB,CAAC,CAAA;IAE1C;;OAEG;IACH,aAAa,EAAE;SACZ,GAAG,IAAI,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU;KAC/C,CAAK;IAEN;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAiC3B;IAED;;;OAGG;IACH,YAAY,CAAC,WAAW,GAAE,MAAsB;IAQhD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IAEtB;;;;;;;OAOG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAA;gBAGhC,IAAI,GAAE,IAAI,CAAC,iBAAiB,CAAc,EAC1C,WAAW,SAAgB;IAO7B;;OAEG;IACH,KAAK,CAAC,IAAI,GAAE,MAAM,EAAiB,GAAG,IAAI,GAAG,YAAY;IAgCzD;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,YAAY;IAkBnD;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,cAAc,CAAC,iBAAiB,CAAC,EACnD,CAAC,EAAE,CAAC,GACH,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAKvC;;OAEG;IACG,eAAe,CACnB,KAAK,EAAE,SAAS,GAAG,MAAM,EACzB,MAAM,EAAE,WAAW,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAiB5C;;;OAGG;IACG,eAAe,CACnB,KAAK,EAAE,SAAS,GAAG,MAAM,EACzB,MAAM,EAAE,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA8E/C,WAAW,CAAC,KAAK,GAAE,SAAS,GAAG,MAAkB,GAAG,MAAM;IAMpD,gBAAgB,CACpB,KAAK,EAAE,SAAS,GAAG,MAAM,EACzB,MAAM,EAAE,MAAM,EAAE;IAyClB;;;;;;;;;OASG;IACG,cAAc,CAClB,KAAK,EAAE,SAAS,GAAG,MAAM,EACzB,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAiD9C;;;;;;;OAOG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAgDrC;;;OAGG;WACU,IAAI,CACf,WAAW,SAAgB,EAC3B,IAAI,WAAe;IACnB;;;OAGG;IACH,MAAM,UAAQ,GACb,OAAO,CAAC,YAAY,CAAC;CAOzB;AAKD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAClC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;IACvC,MAAM,EAAE,cAAc,CAAC,iBAAiB,CAAC,CAAA;IACzC,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/config/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAGH,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAA;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAM/C,OAAO,KAAK,EAAa,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AAC7C,OAAO,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAG7D,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EACL,QAAQ,EACR,UAAU,EAEV,aAAa,EACb,YAAY,EACb,MAAM,iBAAiB,CAAA;AAExB,OAAO,EACL,QAAQ,EACR,UAAU,EACV,aAAa,EACb,YAAY,EACZ,KAAK,QAAQ,GACd,CAAA;AAED,eAAO,MAAM,cAAc,eAA2C,CAAA;AAEtE,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AACjD,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAwBjD,MAAM,MAAM,cAAc,GAAG,qBAAqB,GAAG;IACnD,OAAO,CAAC,EAAE;SACP,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,EAAE,qBAAqB;KAC9C,CAAA;CACF,CAAA;AAED,eAAO,MAAM,cAAc,QAErB,WAAW,CAAC,cAAc,CAAC,GAC3B,cAAc,CAAC,iBAAiB,CAAC,KACpC,cAgBF,CAAA;AAED,eAAO,MAAM,cAAc,QAAS,WAAW,KAAG,WA2BjD,CAAA;AAID,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,MAAM,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;CACtF,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,mBAAmB,GAAG;IAC7C,OAAO,CAAC,EAAE;SACP,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,EAAE,mBAAmB;KAC5C,CAAA;CACF,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;KACnC,CAAC,IAAI,MAAM,mBAAmB,GAAG,CAAC,SAAS,CAC1C,WAAW,CAAC,mBAAmB,CAAC,CACjC,GACC,YAAY,GAAG,MAAM,EAAE,GACvB,mBAAmB,CAAC,CAAC,CAAC;CACzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,uBAAuB,GAAG;IACrD,OAAO,CAAC,EAAE;SACP,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,EAAE,uBAAuB;KAChD,CAAA;CACF,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;KACjC,CAAC,IAAI,MAAM,cAAc,CAAC,iBAAiB,CAAC,GAAG,CAAC,SAAS,CACxD,WAAW,CACZ,GACC,YAAY,GACZ,CAAC,SAAS,SAAS,GAAG,KAAK,GAC3B,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;CACvC,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,qBAAqB,GAC/C,IAAI,CAAC,WAAW,EAAE,SAAS,GAAG,UAAU,CAAC,GAAG;IAC1C,WAAW,EAAE,WAAW,CAAA;IACxB,MAAM,EAAE,UAAU,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,WAAW,EAAE,iBAAiB,CAAA;CAC/B,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,OAAO,UAAU,CAAC,CAAA;AAEzD,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI;KAC7B,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,SAAS,GAAG,CAAC,GAAG,KAAK;CAC9D,CAAA;AACD,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,OAAO,CAClC,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,CAAC,CAAC,CAAC,EAC1C,SAAS,CACV,CAAA;AAED;;;;GAIG;AACH,qBAAa,MAAM;;IACjB;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAA;IAE7B;;OAEG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC,iBAAiB,CAAC,CAAA;IAE1C;;OAEG;IACH,aAAa,EAAE;SACZ,GAAG,IAAI,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAC,CAAC,EAAE,UAAU;KAC/C,CAAK;IAEN;;OAEG;IACH,IAAI,OAAO,IAAI,aAAa,CAgD3B;IAED;;;OAGG;IACH,YAAY,CAAC,WAAW,GAAE,MAAsB;IAQhD;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;IAEtB;;;;;;;OAOG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAA;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,QAAQ,CAAC,CAAA;gBAGhC,IAAI,GAAE,IAAI,CAAC,iBAAiB,CAAc,EAC1C,WAAW,SAAgB;IAO7B;;OAEG;IACH,KAAK,CAAC,IAAI,GAAE,MAAM,EAAiB,GAAG,IAAI,GAAG,YAAY;IAgCzD;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,CAAC,EAAE,WAAW,CAAC,UAAU,CAAC,GAAG,YAAY;IAkBnD;;;;;OAKG;IACH,GAAG,CAAC,CAAC,SAAS,MAAM,cAAc,CAAC,iBAAiB,CAAC,EACnD,CAAC,EAAE,CAAC,GACH,cAAc,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;IAKvC;;OAEG;IACG,eAAe,CACnB,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,WAAW,CAAC,cAAc,CAAC;IAKrC;;;OAGG;IACG,eAAe,CACnB,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,WAAW,CAAC,cAAc,CAAC;IAqDrC;;;OAGG;IACG,gBAAgB,CACpB,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,MAAM,EAAE;IAwClB;;;;;;;;;OASG;IACG,cAAc,CAClB,IAAI,EAAE,YAAY,EAClB,KAAK,EAAE,WAAW,EAClB,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAmC9C;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAYrC;;;OAGG;WACU,IAAI,CACf,WAAW,SAAgB,EAC3B,IAAI,WAAe;IACnB;;;OAGG;IACH,MAAM,UAAQ,GACb,OAAO,CAAC,YAAY,CAAC;CAOzB;AAKD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IAClC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;IACvC,MAAM,EAAE,cAAc,CAAC,iBAAiB,CAAC,CAAA;IACzC,WAAW,EAAE,MAAM,EAAE,CAAA;CACtB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,CAAA"}

package/dist/esm/config/index.js

@@ -23,15 +23,12 @@
 import { error } from '@vltpkg/error-cause';
 import { PackageInfoClient } from '@vltpkg/package-info';
 import { PackageJson } from '@vltpkg/package-json';
+import { assertRecordStringString, assertRecordStringT, isRecordStringString, } from '@vltpkg/types';
+import { find, load, reload, save } from '@vltpkg/vlt-json';
 import { Monorepo } from '@vltpkg/workspaces';
-import { XDG } from '@vltpkg/xdg';
-import { readFileSync, rmSync, writeFileSync } from 'node:fs';
-import { lstat, mkdir, readFile, writeFile } from 'node:fs/promises';
-import { homedir } from 'node:os';
-import { dirname, resolve } from 'node:path';
+import { readFile, rm, writeFile } from 'node:fs/promises';
+import { dirname } from 'node:path';
 import { PathScurry } from 'path-scurry';
-import { parse as jsonParse, stringify as jsonStringify, kIndent, kNewline, } from 'polite-json';
-import { walkUp } from 'walk-up-path';
 import { commands, definition, getCommand, isRecordField, recordFields, } from "./definition.js";
 import { merge } from "./merge.js";
 export { commands, definition, isRecordField, recordFields, };
@@ -86,9 +83,6 @@ export const recordsToPairs = (obj) => {
     ]));
 };
 const kRecord = Symbol('parsed key=value record');
-const exists = (f) => lstat(f).then(() => true, () => false);
-const home = homedir();
-const xdg = new XDG('vlt');
 /**
  * Class that handles configuration for vlt.
  *
@@ -100,8 +94,6 @@ export class Config {
      * representing vlt's configuration
      */
     jack;
-    stringifyOptions = { [kIndent]: '  ', [kNewline]: '\n' };
-    configFiles = {};
     /**
      * Parsed values in effect
      */
@@ -127,6 +119,8 @@ export class Config {
                 scurry,
                 packageJson,
             }),
+            catalog: load('catalog', assertRecordStringString),
+            catalogs: load('catalogs', o => assertRecordStringT(o, isRecordStringString, 'Record<string, Record<string, string>>')),
         };
         const options = Object.assign(asRecords, extras);
         this.#options = Object.assign(options, {
@@ -250,90 +244,52 @@ export class Config {
      * Write the config values to the user or project config file.
      */
     async writeConfigFile(which, values) {
-        const f = this.getFilename(which);
-        await mkdir(dirname(f), { recursive: true });
-        const vals = Object.assign(pairsToRecords(values), this.stringifyOptions);
-        const data = await readFile(f, 'utf8')
-            .then(data => jsonParse(data))
-            .catch(() => ({ config: {} }));
-        data.config = vals;
-        await writeFile(f, jsonStringify(data));
-        this.configFiles[f] = vals;
-        return values;
+        return save('config', pairsToRecords(values), which);
     }
     /**
      * Fold in the provided fields with the existing properties
      * in the config file.
      */
     async addConfigToFile(which, values) {
-        const f = this.getFilename(which);
-        return this.writeConfigFile(which, merge((await this.#maybeLoadConfigFile(f)) ?? {}, values));
+        return this.writeConfigFile(which, merge((await this.#maybeLoadConfigFile(which)) ?? {}, values));
     }
-    /**
-     * if the file exists, parse and load it. returns object if data was
-     * loaded, or undefined if not.
-     */
-    async #maybeLoadConfigFile(file) {
-        const result = await this.#readConfigFile(file);
-        if (result) {
-            const { command, ...values } = recordsToPairs(result);
-            if (command) {
-                for (const [c, opts] of Object.entries(command)) {
-                    const cmd = getCommand(c);
-                    if (cmd) {
-                        this.commandValues[cmd] = merge(this.commandValues[cmd] ?? {}, opts);
-                    }
-                }
-            }
-            this.jack.setConfigValues(values, file);
-            return result;
-        }
-    }
-    async #readConfigFile(file) {
-        if (this.configFiles[file])
-            return this.configFiles[file];
-        const data = await readFile(file, 'utf8').catch(() => { });
-        if (!data)
-            return undefined;
-        let result;
-        try {
-            result = jsonParse(data);
-            if (result && typeof result === 'object') {
-                if (result[kIndent] !== undefined)
-                    this.stringifyOptions[kIndent] = result[kIndent];
-                if (result[kNewline] !== undefined)
-                    this.stringifyOptions[kNewline] = result[kNewline];
-            }
-        }
-        catch (er) {
-            throw error('failed to parse vlt config file', {
+    // called in this weird bound way so that it can be used by the
+    // vlt-json config loading module.
+    #validator = function (c, file) {
+        this.#validateConfig(c, file);
+    }.bind(this);
+    #validateConfig(c, file) {
+        if (!c || typeof c !== 'object' || Array.isArray(c)) {
+            throw error('invalid config, expected object', {
                 path: file,
-                cause: er,
+                found: c,
+                wanted: 'ConfigFileData',
             });
         }
-        if (!result ||
-            typeof result !== 'object' ||
-            Array.isArray(result) ||
-            // if it has a config field, must be an object
-            ('config' in result &&
-                (!result.config || typeof result.config !== 'object'))) {
-            throw error('invalid config, expected object with "config" member', {
-                path: file,
-                found: result,
-                wanted: '{ "config"?: ConfigFileData }',
-            });
+        const { command, ...values } = recordsToPairs(c);
+        if (command) {
+            for (const [c, opts] of Object.entries(command)) {
+                const cmd = getCommand(c);
+                if (cmd) {
+                    this.commandValues[cmd] = merge(this.commandValues[cmd] ?? {}, opts);
+                }
+            }
         }
-        this.configFiles[file] = result.config;
-        return this.configFiles[file];
+        this.jack.setConfigValues(values, file);
     }
-    getFilename(which = 'project') {
-        return which === 'user' ?
-            xdg.config('vlt.json')
-            : resolve(this.projectRoot, 'vlt.json');
+    /**
+     * if the file exists, parse and load it. returns object if data was
+     * loaded, or undefined if not.
+     */
+    async #maybeLoadConfigFile(whichConfig) {
+        return load('config', this.#validator, whichConfig);
     }
+    /**
+     * Deletes the specified config fields from the named file
+     * Returns `true` if anything was changed.
+     */
     async deleteConfigKeys(which, fields) {
-        const file = this.getFilename(which);
-        const data = await this.#maybeLoadConfigFile(file);
+        const data = await this.#maybeLoadConfigFile(which);
         if (!data)
             return false;
         let didSomething = false;
@@ -369,7 +325,8 @@ export class Config {
                 delete data[k];
             }
         }
-        await this.writeConfigFile(which, data);
+        if (didSomething)
+            await this.writeConfigFile(which, data);
         return didSomething;
     }
     /**
@@ -383,42 +340,33 @@ export class Config {
      * mean deleting the file.
      */
     async editConfigFile(which, edit) {
-        const file = this.getFilename(which);
-        const backup = await readFile(file, 'utf8')
-            .then(data => jsonParse(data))
-            .catch(() => null);
+        // load the file as a backup
+        // call the edit function
+        // reload it
+        const file = find(which);
+        const backup = await readFile(file, 'utf8').catch(() => undefined);
         if (!backup) {
-            writeFileSync(file, JSON.stringify({ config: {} }, null, 2) + '\n');
+            await writeFile(file, JSON.stringify({ config: {} }, null, 2) + '\n');
         }
         let valid = false;
         try {
             await edit(file);
-            const res = jsonParse(readFileSync(file, 'utf8'));
-            if (!res ||
-                typeof res !== 'object' ||
-                Array.isArray(res) ||
-                ('config' in res &&
-                    (!res.config || typeof res.config !== 'object'))) {
-                throw error('Invalid configuration, expected object with config member', {
-                    path: file,
-                    found: res,
-                    wanted: '{ config: ConfigData }',
-                });
-            }
-            const { config } = res;
-            if (config) {
-                this.jack.setConfigValues(recordsToPairs(config));
-                this.configFiles[file] = config;
-            }
+            // force it to reload the file and validate it again
+            // if this fails, we roll back.
+            const result = reload('config', which);
+            save('config', result ?? {}, which);
             valid = true;
         }
         finally {
             if (!valid) {
+                // TODO: maybe write the file to a re-edit backup location?
+                // then you could do `vlt config edit retry` or something.
                 if (backup) {
-                    writeFileSync(file, jsonStringify(backup));
+                    await writeFile(file, backup);
+                    reload(which);
                 }
                 else {
-                    rmSync(file, { force: true });
+                    await rm(file, { force: true });
                 }
             }
         }
@@ -426,45 +374,11 @@ export class Config {
     /**
      * Find the local config file and load both it and the user-level config in
      * the XDG config home.
-     *
-     * Note: if working in a workspaces monorepo, then the vlt.json file MUST
-     * be in the same folder as the vlt.json file, because we stop
-     * looking when we find either one.
      */
     async loadConfigFile() {
-        const userConfig = xdg.config('vlt.json');
-        await this.#maybeLoadConfigFile(userConfig);
-        let lastKnownRoot = resolve(this.projectRoot);
-        for (const dir of walkUp(this.projectRoot)) {
-            // don't look in ~
-            if (dir === home)
-                break;
-            // finding a project config file stops the search
-            const projectConfig = resolve(dir, 'vlt.json');
-            if (projectConfig === userConfig)
-                break;
-            if ((await exists(projectConfig)) &&
-                (await this.#maybeLoadConfigFile(projectConfig))) {
-                lastKnownRoot = dir;
-                break;
-            }
-            // stat existence of these files
-            const [hasPackage, hasModules, hasProject, hasGit] = await Promise.all([
-                exists(resolve(dir, 'package.json')),
-                exists(resolve(dir, 'node_modules')),
-                exists(resolve(dir, 'vlt.json')),
-                exists(resolve(dir, '.git')),
-            ]);
-            // treat these as potential roots
-            if (hasPackage || hasModules || hasProject) {
-                lastKnownRoot = dir;
-            }
-            // define backstops
-            if (hasProject || hasGit) {
-                break;
-            }
-        }
-        this.projectRoot = lastKnownRoot;
+        await this.#maybeLoadConfigFile('user');
+        this.projectRoot = dirname(find('project', this.projectRoot));
+        await this.#maybeLoadConfigFile('project');
         return this;
     }
     /**