Fix local config system (#223)

* fix local config system

* fix merge conflicts

* format readme

* allow clearing properties

* deep partial

* use zod 4

* format code

* vendor dep

* bump version

* run formatter

* remove dep

* tick version

Author: 404Wolf

README.md

@@ -206,7 +206,7 @@ $ curl https://maxm--df1d09da00cd11f0a0de569c3dd06744.web.val.run
 Hello GET https://maxm--df1d09da00cd11f0a0de569c3dd06744.web.val.run/
 ```
 
-### Watching for Changes
+## Watching for Changes
 
 Oftentimes you'll end up in a workflow that looks like
 
@@ -250,7 +250,7 @@ One common Val Town Val workflow is branching out. `vt`'s `checkout` and
 - `vt branch` lists all branches.
 - `vt branch -D` deletes a branch. You can't delete the branch you are on.
 
-### Management
+## Management
 
 - `vt list` lists all your Val Town Vals
 - `vt delete` deletes the current Val of the folder you are in (with
@@ -275,6 +275,17 @@ Right now, we offer the following configuration options:
 - `editorTemplate`: The Val URI for the editor files that you are prompted about
   when you run a `vt clone`, `vt remix`, or `vt create`.
 
+### Multiple Accounts
+
+`vt` supports project-scoped account configuration via this system. You can set
+local configuration options for a single `vt` folder using the `--local` flag.
+To set a local API key for a folder, use
+`vt config set --local apiKey xxxMY_ALT_API_KEYxxx`. This will store your API
+key for use in `vt` in `.vt/config.yaml`, rather than your global configuration.
+
+You can clear a config value by using `vt config set property ""` (empty
+string).
+
 ## LLMs
 
 `vt` lets you use all your favorite local LLM tools like

deno.json

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/denoland/deno/348900b8b79f4a434cab4c74b3bc8d4d2fa8ee74/cli/schemas/config-file.v1.json",
   "name": "@valtown/vt",
   "description": "The Val Town CLI",
-  "version": "0.1.51",
+  "version": "0.1.52",
   "exports": "./vt.ts",
   "license": "MIT",
   "tasks": {
@@ -37,12 +37,11 @@
     "highlight.js": "npm:highlight.js@^11.11.1",
     "strip-ansi": "npm:strip-ansi@^7.1.2",
     "word-wrap": "npm:word-wrap@^1.2.5",
-    "zod-to-json-schema": "npm:zod-to-json-schema@^3.24.6",
     "zod-validation-error": "npm:zod-validation-error@^4.0.2",
     "emphasize": "npm:emphasize@^7.0.0",
     "kia": "jsr:@jonasschiano/kia@0.0.120",
     "open": "npm:open@^10.2.0",
-    "zod": "npm:zod@^3.24.2",
+    "zod": "npm:zod@^4.2.1",
     "~/": "./src/",
     "~/companion/": "./companion/"
   },

deno.lock

@@ -2,23 +2,26 @@ import { Command } from "@cliffy/command";
 import VTConfig, { globalConfig } from "~/vt/VTConfig.ts";
 import { findVtRoot } from "~/vt/vt/utils.ts";
 import { doWithSpinner } from "~/cmd/utils.ts";
-import { getNestedProperty, setNestedProperty } from "~/utils.ts";
+import { removeNestedProperty, setNestedProperty } from "~/utils.ts";
 import { stringify as stringifyYaml } from "@std/yaml";
 import { VTConfigSchema } from "~/vt/vt/schemas.ts";
-import { zodToJsonSchema } from "zod-to-json-schema";
 import { printYaml } from "~/cmd/styles.ts";
 import { fromError } from "zod-validation-error";
 import z from "zod";
 import { colors } from "@cliffy/ansi/colors";
-import { DEFAULT_WRAP_AMOUNT, GLOBAL_VT_CONFIG_PATH } from "~/consts.ts";
+import {
+  DEFAULT_WRAP_AMOUNT,
+  GLOBAL_VT_CONFIG_PATH,
+  LOCAL_VT_CONFIG_PATH,
+} from "~/consts.ts";
 import { join } from "@std/path";
 import wrap from "word-wrap";
 import { openEditorAt } from "~/cmd/lib/utils/openEditorAt.ts";
-import { Select } from "@cliffy/prompt";
+import { Confirm, Select } from "@cliffy/prompt";
+import { execSync } from "node:child_process";
 
 function showConfigOptions() {
-  // deno-lint-ignore no-explicit-any
-  const jsonSchema = zodToJsonSchema(VTConfigSchema) as any;
+  const jsonSchema = VTConfigSchema.toJSONSchema({ unrepresentable: "any" });
   delete jsonSchema["$schema"];
 
   // deno-lint-ignore no-explicit-any
@@ -42,6 +45,46 @@ function showConfigOptions() {
   printYaml(stringifyYaml(jsonSchema["properties"]));
 }
 
+/**
+ * If the user tries to add an API secret to their local vt config file, offer
+ * to add the config file to their local gitignore.
+ */
+async function offerToAddToGitignore() {
+  const gitRoot = execSync("git rev-parse --show-toplevel", {
+    encoding: "utf-8",
+    stdio: ["pipe", "pipe", "ignore"],
+  }).trim();
+
+  const addToIgnore = await Confirm.prompt(
+    "You are adding an API secret to your local config file, and we noticed you have a Git repo set up for this folder.\n" +
+      `Would you like to add \`${LOCAL_VT_CONFIG_PATH}\` to your \`.gitignore\`?`,
+  );
+
+  if (addToIgnore) {
+    let gitignoreContent = "";
+    const gitignorePath = join(gitRoot, ".gitignore");
+
+    try {
+      gitignoreContent = await Deno.readTextFile(gitignorePath);
+      // Add a newline if the file doesn't end with one
+      if (gitignoreContent.length > 0 && !gitignoreContent.endsWith("\n")) {
+        gitignoreContent += "\n";
+      }
+    } catch (e) {
+      if (!(e instanceof Deno.errors.NotFound)) {
+        // If error is something other than "file not found", rethrow it
+        throw e;
+      }
+      // If file doesn't exist, we'll create it with empty content
+    }
+
+    // Add the path to gitignore
+    gitignoreContent += LOCAL_VT_CONFIG_PATH + "\n";
+    await Deno.writeTextFile(gitignorePath, gitignoreContent);
+    console.log(`Added ${LOCAL_VT_CONFIG_PATH} to .gitignore`);
+  }
+}
+
 export const configWhereCmd = new Command()
   .name("where")
   .description("Show the config file locations")
@@ -70,7 +113,10 @@ export const configWhereCmd = new Command()
 
 export const configSetCmd = new Command()
   .description("Set a configuration value")
-  .option("--local", "Set in the local configuration (val-specific)")
+  .option(
+    "--local",
+    'Set in the local configuration (val-specific). Leave value blank "" to unset.',
+  )
   .arguments("<key:string> <value:string>")
   .example(
     "Set your valtown API key (global)",
@@ -90,40 +136,28 @@ export const configSetCmd = new Command()
         const vtConfig = new VTConfig(vtRoot);
 
         const config = await vtConfig.loadConfig();
-        const updatedConfig = setNestedProperty(config, key, value);
-        const oldProperty = getNestedProperty(config, key, null) as
-          | string
-          | null;
-
-        if (oldProperty !== null && oldProperty.toString() === value) {
-          throw new Error(
-            `Property ${colors.bold(key)} is already set to ${
-              colors.bold(oldProperty)
-            }`,
-          );
-        }
 
-        let validatedConfig: z.infer<typeof VTConfigSchema>;
+        const updatedConfig = value === ""
+          ? removeNestedProperty(config, key)
+          : setNestedProperty(config, key, value);
+
         try {
           if (useGlobal) {
-            validatedConfig = await vtConfig.saveGlobalConfig(updatedConfig);
+            await vtConfig.saveGlobalConfig(updatedConfig);
           } else {
-            validatedConfig = await vtConfig.saveLocalConfig(updatedConfig);
+            await vtConfig.saveLocalConfig(updatedConfig);
           }
 
-          if (JSON.stringify(config) !== JSON.stringify(validatedConfig)) {
-            spinner.succeed(
-              `Set ${colors.bold(`${key}=${value}`)} in ${
+          spinner.succeed(
+            value === ""
+              ? `Unset ${colors.bold(`${key}`)}`
+              : `Set ${colors.bold(`${key}=${value}`)} in ${
                 useGlobal ? "global" : "local"
               } configuration`,
-            );
-          } else {
-            throw new Error(
-              `Property ${colors.bold(key)} is not valid.` +
-                `\n  Use \`${
-                  colors.bold("vt config options")
-                }\` to view config options`,
-            );
+          );
+
+          if (key === "apiKey" && value !== "" && !useGlobal) {
+            await offerToAddToGitignore();
           }
         } catch (e) {
           if (e instanceof z.ZodError) {

src/cmd/lib/config.ts

@@ -18,6 +18,7 @@ export const VT_CONFIG_FILE_NAME = "config.yaml";
 export const META_FOLDER_NAME = ".vt";
 export const ENTRYPOINT_NAME = "vt.ts";
 export const META_IGNORE_FILE_NAME = ".vtignore";
+export const LOCAL_VT_CONFIG_PATH = join(META_FOLDER_NAME, VT_CONFIG_FILE_NAME);
 export const GLOBAL_VT_CONFIG_PATH = join(xdg.config(), PROGRAM_NAME);
 /** The directory that contains GLOBAL_VT_META_FILE_PATH */
 export const GLOBAL_VT_META_PATH = join(xdg.cache(), PROGRAM_NAME);

src/consts.ts

@@ -0,0 +1,22 @@
+import { assertEquals } from "@std/assert";
+import { removeNestedProperty } from "./utils.ts";
+
+Deno.test("removeNestedProperty", () => {
+  // Top level property
+  const obj1 = { a: 1, b: 2 };
+  const result1 = removeNestedProperty(obj1, "a");
+  assertEquals(result1, { b: 2 });
+  assertEquals(obj1, { a: 1, b: 2 }); // Original unchanged
+
+  // Nested property
+  const obj2 = {
+    a: 1,
+    b: {
+      c: 2,
+      d: { e: 3 },
+    },
+  };
+  const result2 = removeNestedProperty(obj2, "b.d.e");
+  assertEquals(result2, { a: 1, b: { c: 2, d: {} } });
+  assertEquals(obj2.b.d.e, 3); // Original unchanged
+});

src/utils.test.ts

@@ -104,6 +104,34 @@ export function setNestedProperty(
   return deepMerge(obj, valueObj);
 }
 
+/**
+ * Removes a value at a nested property path and returns a new object.
+ * The original object is not modified.
+ *
+ * @param obj - The source object
+ * @param path - Dot-separated property path (e.g., 'user.address.city')
+ * @returns A new object with the specified path removed
+ */
+export function removeNestedProperty(
+  obj: Record<string, unknown>,
+  path: string,
+): Record<string, unknown> {
+  const result = structuredClone(obj);
+
+  const parts = path.split(".");
+  parts.reduce((current, part, index, array) => {
+    if (index === array.length - 1) {
+      // Last part - delete the property
+      delete current[part];
+    } else if (current[part] && typeof current[part] === "object") {
+      return current[part] as Record<string, unknown>;
+    }
+    return current;
+  }, result as Record<string, unknown>);
+
+  return result;
+}
+
 /**
  * Checks if a directory is empty asynchronously.
  *

src/utils.ts

@@ -8,7 +8,11 @@ import {
 } from "~/consts.ts";
 import * as path from "@std/path";
 import { ensureDir, exists } from "@std/fs";
-import { DefaultVTConfig, VTConfigSchema } from "~/vt/vt/schemas.ts";
+import {
+  DefaultVTConfig,
+  VTConfigDeepPartial,
+  VTConfigSchema,
+} from "~/vt/vt/schemas.ts";
 import { parse as parseYaml, stringify as stringifyYaml } from "@std/yaml";
 import type z from "zod";
 import { findVtRoot } from "~/vt/vt/utils.ts";
@@ -118,9 +122,9 @@ export default class VTConfig {
    */
   public async saveLocalConfig(
     config: Record<string, unknown>,
-  ): Promise<z.infer<typeof VTConfigSchema>> {
+  ): Promise<z.infer<typeof VTConfigDeepPartial>> {
     // Validate the configuration against the schema
-    const validatedConfig = VTConfigSchema.strict().parse(config);
+    const validatedConfig = VTConfigDeepPartial.parse(config);
 
     // Ensure the metadata directory exists
     await ensureDir(path.join(this.#localConfigPath, META_FOLDER_NAME));

src/vt/VTConfig.ts

@@ -1,12 +1,13 @@
 import { join } from "@std/path";
-import { z } from "zod";
+import { z } from "zod/v4";
 import {
   AUTH_CACHE_LOCALSTORE_ENTRY,
   DEFAULT_EDITOR_TEMPLATE,
   GLOBAL_VT_CONFIG_PATH,
   META_IGNORE_FILE_NAME,
   SAW_AS_LATEST_VERSION,
 } from "~/consts.ts";
+import { zodDeepPartial } from "../zodDeepPartial.ts";
 
 /**
  * JSON schema for the state.json file for the .vt folder.
@@ -79,6 +80,8 @@ export const VTConfigSchema = z.object({
   editorTemplate: z.string().optional(), // a Val URI
 });
 
+export const VTConfigDeepPartial = zodDeepPartial(VTConfigSchema);
+
 export const DefaultVTConfig: z.infer<typeof VTConfigSchema> = {
   apiKey: null,
   globalIgnoreFiles: [join(GLOBAL_VT_CONFIG_PATH, META_IGNORE_FILE_NAME)],