@wirecat/cli-core 0.422.0 → 0.424.0

package/dist/cli/settings.js

@@ -1,4 +1,4 @@
-import { existsSync } from "node:fs";
+import { existsSync, readFileSync } from "node:fs";
 import { CliError, configFilePath, resolvePaths, saveConfigFile } from "@wirecat/cli-base";
 import * as v from "valibot";
 import { AI_ENTRIES, resolveAISettings } from "../analysis/settings.js";
@@ -7,7 +7,7 @@ import { envName, readOnlyLockOf } from "../ports/app.js";
 import { assertOverridesTighten, CEILING_KEY, LEVELS, layerPermissions, permissionOverrides, RESOURCES, } from "../sends/permissions.js";
 import { storePath } from "../store/path.js";
 import { sharedConfigPath } from "../store/shared-config.js";
-import { loadSnakeCaseConfig } from "./config-keys.js";
+import { issueMessage, parseConfigText, publicIssue, savedPermissionKeys, schemaIssues, withoutIssues, } from "./config-issues.js";
 import { DEFAULT_CONFIG, ensureDefaultConfig } from "./default-config.js";
 import { profilesHere } from "./messenger/accounts.js";
 import { usableProfileName } from "./profile.js";
@@ -81,6 +81,26 @@ const SHARED_DEFAULTS_ONLY = {
 export const NONE_NAMED = "none named";
 /** A name for a command that speaks for no account; never chosen for one that does. */
 const NO_PROFILE = "default";
+/** The profile a run is for: none when nothing named one, even though `Settings.profile` holds a placeholder. */
+export const namedProfile = (settings) => settings.sources?.profile === NONE_NAMED ? undefined : settings.profile;
+/**
+ * No profile named and none on this computer. The settings cannot see the program, so the program swaps the
+ * `setup` this suggests for `withoutSetup` when it has no such command.
+ */
+export class NoProfileHere extends CliError {
+    app;
+    constructor(app) {
+        super("validation_error", `name a profile: there is none on this computer yet — create one with \`${app.command} personal setup\` ` +
+            "(any name in place of personal)", { profiles: [] });
+        this.app = app;
+    }
+    /** `words`: the command that was typed, without its arguments, so the suggestion runs as written. */
+    withoutSetup(words) {
+        const command = words ? `${this.app.command} personal ${words}` : `${this.app.command} personal …`;
+        return new CliError("validation_error", `name a profile: there is none on this computer yet — any name works, such as \`${command}\` ` +
+            `(or set ${envName(this.app, "PROFILE")})`, { profiles: [] });
+    }
+}
 /** The first candidate that is set, and which layer it came from. */
 export const first = (candidates, fallback) => {
     for (const [from, value] of candidates)
@@ -108,7 +128,6 @@ export const settingsFor = (app, extension = {}) => {
         profiles: v.optional(v.record(v.string(), strictOf(entries), "has to be an object of profiles, by name")),
     }, objectMessage);
     const configEntries = {
-        default_profile: v.optional(v.string(plain("has to be a profile name, in quotes"))),
         defaults: v.optional(strictOf(defaultsEntries)),
         profiles: v.optional(v.record(v.string(), strictOf(profileEntries), "has to be an object of profiles, by name"), {}),
         personal: v.optional(kindSection(profileEntries)),
@@ -117,22 +136,35 @@ export const settingsFor = (app, extension = {}) => {
     const schema = strictOf(configEntries);
     const defaultsOnlyKeys = Object.keys(defaultsOnly);
     const botOnlyKeys = Object.keys(BOT_ONLY_ENTRIES);
-    const allSettings = [...Object.keys(profileEntries), ...botOnlyKeys, ...defaultsOnlyKeys, "default_profile"];
+    const allSettings = [...Object.keys(profileEntries), ...botOnlyKeys, ...defaultsOnlyKeys];
     const PROFILE = envName(app, "PROFILE");
     const PROFILE_LOCK = envName(app, "PROFILE_LOCK");
     const TIMEOUT = envName(app, "TIMEOUT");
     const REQUESTS_PER_MINUTE = envName(app, "REQUESTS_PER_MINUTE");
     const configPathFor = ({ env = process.env, configDir }) => configFilePath(configDir ?? resolvePaths({ appName: app.appName, prefix: app.envPrefix, env }).config);
-    const readConfig = (path) => {
+    const readSchema = extension.schema ?? schema;
+    const context = (file) => ({ file, tool: app.command });
+    /** The file as written, `undefined` when there is none, or the issue that says it is not JSON. */
+    const readRaw = (path) => {
+        let text;
         try {
-            return loadSnakeCaseConfig(path, extension.schema ?? schema, () => ({ profiles: {} }));
+            text = readFileSync(path, "utf8");
         }
-        catch (error) {
-            const message = error instanceof Error ? error.message : String(error);
-            throw new CliError("configuration_error", message.includes("catch_up_marks_read")
-                ? `${message}; remove catch_up_marks_read from the config file and use ${app.command} <profile> chats mark-read <chat>`
-                : message);
+        catch {
+            return { raw: undefined };
         }
+        return parseConfigText(text, path);
+    };
+    /** The file with every problem found; what loads is the file without the settings they name. */
+    const loadConfig = (path) => {
+        const read = readRaw(path);
+        if ("issue" in read)
+            return { config: { profiles: {} }, issues: [read.issue], raw: undefined };
+        if (read.raw === undefined)
+            return { config: { profiles: {} }, issues: [], raw: undefined };
+        const issues = schemaIssues(read.raw, readSchema, context(path));
+        const parsed = v.safeParse(readSchema, withoutIssues(read.raw, issues));
+        return { config: (parsed.success ? parsed.output : { profiles: {} }), issues, raw: read.raw };
     };
     /**
      * A lock pins a process to one profile: the owner sets it where an agent runs, and a first word
@@ -157,15 +189,10 @@ export const settingsFor = (app, extension = {}) => {
     const unnamed = (config, env, needed) => {
         if (!needed)
             return { value: NO_PROFILE, from: NONE_NAMED };
-        if (config.default_profile !== undefined) {
-            throw new CliError("validation_error", `default_profile is no longer read — name the profile: \`${app.command} ${config.default_profile} …\`; ` +
-                `\`${app.command} config unset default_profile\` removes it from the config file`, { profiles: profilesOf(config, env) });
-        }
         const here = profilesOf(config, env);
-        throw new CliError("validation_error", here.length === 0
-            ? `name a profile: there is none on this computer yet — create one with \`${app.command} personal setup\` ` +
-                "(any name in place of personal)"
-            : `name a profile: \`${app.command} <profile> …\` — profiles here: ${here.join(", ")} (or set ${PROFILE})`, { profiles: here });
+        if (here.length === 0)
+            throw new NoProfileHere(app);
+        throw new CliError("validation_error", `name a profile: \`${app.command} <profile> …\` — profiles here: ${here.join(", ")} (or set ${PROFILE})`, { profiles: here });
     };
     const profilesOf = (config, env) => profilesHere(app, [...namedProfiles(config), ...(extension.profiles?.(env) ?? [])], env);
     const resolveSettings = (flags = {}, options = {}) => {
@@ -178,7 +205,10 @@ export const settingsFor = (app, extension = {}) => {
         catch (error) {
             throw new CliError("configuration_error", error instanceof Error ? error.message : String(error));
         }
-        const config = readConfig(configPath);
+        const loaded = loadConfig(configPath);
+        if (loaded.issues.length > 0 && !options.withIssues)
+            throw new CliError("configuration_error", issueMessage(loaded.issues.map(publicIssue)));
+        const { config } = loaded;
         const lock = given(env[PROFILE_LOCK]);
         const named = first([
             ["first word", flags.profile],
@@ -202,9 +232,6 @@ export const settingsFor = (app, extension = {}) => {
             [extension.sourcePaths ? "config file: defaults" : "config defaults", shared],
         ];
         const fromLayers = (key, fallback, only = layers) => first(only.map(([from, scope]) => [from, scope?.[key]]), fallback);
-        if (fromLayers("catch_up_marks_read", undefined).value !== undefined) {
-            throw new CliError("configuration_error", `remove catch_up_marks_read from the config file and use ${app.command} <profile> chats mark-read <chat>`);
-        }
         const kindLayers = layers.filter(([from]) => from.startsWith(`config file: ${kind}.`));
         const limit = flags.limit === undefined ? fromLayers("limit", DEFAULT_LIMIT) : { value: flags.limit, from: "flag" };
         const record = flags.record === undefined ? fromLayers("record", false) : { value: flags.record, from: "flag" };
@@ -303,6 +330,8 @@ export const settingsFor = (app, extension = {}) => {
             },
             configured,
             shared,
+            configIssues: loaded.issues.map(publicIssue),
+            savedPermissions: savedPermissionKeys(config),
         };
         // The file was checked by the schema; a flag was not, and `--limit abc` is `NaN` by the time it
         // gets here, which slices an array to nothing without complaining.
@@ -319,16 +348,52 @@ export const settingsFor = (app, extension = {}) => {
         const extra = extension.resolve?.({ flags, settings, layers, fromLayers });
         return { ...settings, ...extra?.values, sources: { ...settings.sources, ...extra?.sources } };
     };
-    const configuredProfiles = (options = {}) => namedProfiles(readConfig(configPathFor(options)));
-    /** `config set` and `config unset`: checked by the same schema the reader uses, so it never writes a file the reader refuses. */
-    const changeSetting = (path, { profile, setting, value, kind, }) => {
+    const configuredProfiles = (options = {}) => {
+        const { config, issues } = loadConfig(configPathFor(options));
+        if (issues.length > 0 && !options.withIssues)
+            throw new CliError("configuration_error", issueMessage(issues.map(publicIssue)));
+        return namedProfiles(config);
+    };
+    /**
+     * `config set` and `config unset`, on the file as written, so they also run on a file with problems. A set is
+     * refused only for a problem it would add; an unset removes the setting whether or not the schema knows it.
+     * `root` reaches a path outside any profile or `defaults`, and only one that has a problem.
+     */
+    const changeSetting = (path, { profile, setting, value, kind, root = false, }) => {
         const [name = setting, ...rest] = setting.split(".");
         const level = name === "permissions" && rest.length > 0 ? rest.join(".") : undefined;
         const modelField = /^models\.([a-z][a-z0-9-]*)\.(provider|model|base_url)$/.exec(setting);
-        if (!allSettings.includes(setting) && level === undefined && !modelField) {
-            const offered = value === undefined ? allSettings : allSettings.filter((one) => one !== "default_profile");
-            throw new CliError("validation_error", `no setting called "${setting}" — one of: ${offered.join(", ")}`);
+        const known = allSettings.includes(setting) || level !== undefined || modelField !== null;
+        const read = readRaw(path);
+        if ("issue" in read)
+            throw new CliError("configuration_error", issueMessage([publicIssue(read.issue)]));
+        const raw = read.raw === undefined ? {} : read.raw;
+        if (!isScope(raw))
+            throw new CliError("configuration_error", `${path}: the file has to be an object, in braces`);
+        const scopePath = root
+            ? []
+            : [...(kind === undefined ? [] : [kind]), ...(profile === undefined ? ["defaults"] : ["profiles", profile])];
+        const keyPath = root
+            ? setting.split(".")
+            : level !== undefined
+                ? ["permissions", level]
+                : modelField
+                    ? ["models", modelField[1], modelField[2]]
+                    : [setting];
+        const at = [...scopePath, ...keyPath];
+        const before = schemaIssues(raw, readSchema, context(path));
+        if (value === undefined) {
+            if (root && !before.some((issue) => issue.at.join(".") === at.join(".")))
+                throw new CliError("validation_error", `${setting} has no problem to remove — name the profile, or add --defaults, to unset a setting`);
+            if (!known && valueAt(raw, at) === undefined)
+                throw new CliError("validation_error", `no setting called "${setting}" — one of: ${allSettings.join(", ")}`);
+            const changed = structuredClone(raw);
+            removeAt(changed, at);
+            saveConfigFile(path, changed);
+            return null;
         }
+        if (!known)
+            throw new CliError("validation_error", `no setting called "${setting}" — one of: ${allSettings.join(", ")}`);
         if (profile !== undefined && defaultsOnlyKeys.includes(setting)) {
             throw new CliError("validation_error", `${setting} is one setting for the whole program, not per profile — add --defaults`);
         }
@@ -338,98 +403,45 @@ export const settingsFor = (app, extension = {}) => {
         if (kind !== "bot" && botOnlyKeys.includes(setting)) {
             throw new CliError("validation_error", `${setting} is a bot's setting — add --bot`);
         }
-        const config = readConfig(path);
-        if (setting === "default_profile") {
-            if (kind !== undefined) {
-                throw new CliError("validation_error", "default_profile is one for the whole file — drop --personal and --bot");
-            }
-            if (value !== undefined) {
-                throw new CliError("validation_error", `default_profile is gone: a command names its profile every time — \`${app.command} <profile> …\` or ${PROFILE}`);
-            }
-            const { default_profile: _, ...rest } = config;
-            saveConfigFile(path, rest);
-            return null;
-        }
-        const section = kind === undefined ? undefined : (config[kind] ?? {});
-        const current = section === undefined
-            ? profile === undefined
-                ? config.defaults
-                : config.profiles[profile]
-            : profile === undefined
-                ? section.defaults
-                : section.profiles?.[profile];
-        const scope = { ...current };
-        if (modelField) {
-            const purpose = modelField[1];
-            const field = modelField[2];
-            const models = { ...scope.models };
-            const target = { ...models[purpose] };
-            if (value === undefined)
-                delete target[field];
-            else
-                target[field] = parseValue(value);
-            if (Object.keys(target).length > 0)
-                models[purpose] = target;
-            else
-                delete models[purpose];
-            if (Object.keys(models).length > 0)
-                scope.models = models;
-            else
-                delete scope.models;
-        }
-        else if (level !== undefined) {
-            const levels = { ...scope.permissions };
-            if (value === undefined)
-                delete levels[level];
-            else
-                levels[level] = value.trim();
-            if (Object.keys(levels).length > 0)
-                scope.permissions = levels;
-            else
-                delete scope.permissions;
-        }
-        else if (value === undefined)
-            delete scope[setting];
-        else
-            scope[setting] = parseValue(value);
-        const empty = Object.keys(scope).length === 0;
-        let changed;
-        if (kind === undefined || section === undefined) {
-            changed =
-                profile === undefined
-                    ? { ...config, defaults: scope }
-                    : { ...config, profiles: { ...config.profiles, [profile]: scope } };
-            if (profile === undefined && empty)
-                delete changed.defaults;
-            if (profile !== undefined && empty)
-                delete changed.profiles[profile];
-        }
-        else {
-            const next = profile === undefined
-                ? { ...section, defaults: scope }
-                : { ...section, profiles: { ...section.profiles, [profile]: scope } };
-            if (profile === undefined && empty)
-                delete next.defaults;
-            if (profile !== undefined && empty && next.profiles)
-                delete next.profiles[profile];
-            if (next.profiles && Object.keys(next.profiles).length === 0)
-                delete next.profiles;
-            changed = { ...config, [kind]: next };
-            if (Object.keys(next).length === 0)
-                delete changed[kind];
-        }
-        const checked = v.safeParse(extension.schema ?? schema, changed);
-        if (!checked.success) {
-            throw new CliError("validation_error", `${setting} cannot be "${value}": ${checked.issues[0]?.message ?? "invalid"}`);
-        }
-        saveConfigFile(path, checked.output);
-        if (modelField)
-            return (scope.models?.[modelField[1]]?.[modelField[2]] ??
-                null);
-        return level === undefined ? (scope[setting] ?? null) : (scope.permissions?.[level] ?? null);
+        const changed = structuredClone(raw);
+        setAt(changed, at, level === undefined ? parseValue(value) : value.trim());
+        const had = new Set(before.map((issue) => issue.at.join(".")));
+        const added = schemaIssues(changed, readSchema, context(path)).find((issue) => !had.has(issue.at.join(".")) || issue.at.join(".") === at.join("."));
+        if (added)
+            throw new CliError("validation_error", `${setting} cannot be "${value}": ${added.what}`);
+        const checked = v.safeParse(readSchema, changed);
+        saveConfigFile(path, checked.success ? checked.output : changed);
+        return valueAt(checked.success ? checked.output : changed, at) ?? null;
     };
     return { resolveSettings, configuredProfiles, changeSetting, allSettings, defaultsOnlyKeys, schema };
 };
+const isScope = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+const valueAt = (node, path) => path.reduce((at, key) => (isScope(at) ? at[key] : undefined), node);
+const setAt = (node, path, value) => {
+    let at = node;
+    for (const key of path.slice(0, -1)) {
+        if (!isScope(at[key]))
+            at[key] = {};
+        at = at[key];
+    }
+    at[path.at(-1)] = value;
+};
+/** Removes the value and every section it leaves empty, so an unset leaves no `{}` behind. */
+const removeAt = (node, path) => {
+    const [key, ...rest] = path;
+    if (key === undefined)
+        return;
+    if (rest.length === 0) {
+        delete node[key];
+        return;
+    }
+    const child = node[key];
+    if (!isScope(child))
+        return;
+    removeAt(child, rest);
+    if (Object.keys(child).length === 0)
+        delete node[key];
+};
 /** Every profile the file names, in any section. */
 const namedProfiles = (config) => [
     ...new Set([