@outfitter/config 0.3.3 → 0.4.0

package/dist/shared/@outfitter/config-aje2en96.js

@@ -0,0 +1,71 @@
+// @bun
+import {
+  CircularExtendsError,
+  ParseError,
+  deepMerge,
+  parseConfigFile
+} from "./config-s4swz8m3.js";
+
+// packages/config/src/internal/extends.ts
+import { existsSync, readFileSync } from "fs";
+import { dirname, isAbsolute, resolve } from "path";
+import { NotFoundError, Result } from "@outfitter/contracts";
+function resolveExtendsPath(extendsValue, fromFile) {
+  if (isAbsolute(extendsValue)) {
+    return extendsValue;
+  }
+  return resolve(dirname(fromFile), extendsValue);
+}
+function loadConfigFileWithExtends(filePath, visited = new Set) {
+  const normalizedPath = resolve(filePath);
+  if (visited.has(normalizedPath)) {
+    return Result.err(new CircularExtendsError({
+      message: `Circular extends detected: ${[...visited, normalizedPath].join(" -> ")}`,
+      chain: [...visited, normalizedPath]
+    }));
+  }
+  if (!existsSync(filePath)) {
+    return Result.err(new NotFoundError({
+      message: `Config file not found: ${filePath}`,
+      resourceType: "config",
+      resourceId: filePath
+    }));
+  }
+  let content;
+  try {
+    content = readFileSync(filePath, "utf-8");
+  } catch {
+    return Result.err(new NotFoundError({
+      message: `Failed to read config file: ${filePath}`,
+      resourceType: "config",
+      resourceId: filePath
+    }));
+  }
+  const filename = filePath.split("/").pop() ?? "config";
+  const parseResult = parseConfigFile(content, filename);
+  if (parseResult.isErr()) {
+    return Result.err(parseResult.error);
+  }
+  const parsed = parseResult.unwrap();
+  const extendsValue = parsed["extends"];
+  if (extendsValue === undefined) {
+    return Result.ok(parsed);
+  }
+  if (typeof extendsValue !== "string") {
+    return Result.err(new ParseError({
+      message: `Invalid "extends" value in ${filePath}: expected string, got ${typeof extendsValue}`,
+      filename: filePath
+    }));
+  }
+  visited.add(normalizedPath);
+  const extendsPath = resolveExtendsPath(extendsValue, filePath);
+  const baseResult = loadConfigFileWithExtends(extendsPath, visited);
+  if (baseResult.isErr()) {
+    return Result.err(baseResult.error);
+  }
+  const baseConfig = baseResult.unwrap();
+  const { extends: __, ...currentConfig } = parsed;
+  return Result.ok(deepMerge(baseConfig, currentConfig));
+}
+
+export { resolveExtendsPath, loadConfigFileWithExtends };

package/dist/shared/@outfitter/config-br341dr7.js

@@ -0,0 +1,87 @@
+// @bun
+import {
+  loadConfigFileWithExtends
+} from "./config-aje2en96.js";
+
+// packages/config/src/internal/loading.ts
+import { existsSync } from "fs";
+import { join } from "path";
+import {
+  formatZodIssues,
+  NotFoundError,
+  Result,
+  ValidationError
+} from "@outfitter/contracts";
+var CONFIG_EXTENSIONS = ["toml", "yaml", "yml", "json", "jsonc", "json5"];
+function findConfigFile(dir) {
+  for (const ext of CONFIG_EXTENSIONS) {
+    const filePath = join(dir, `config.${ext}`);
+    if (existsSync(filePath)) {
+      return filePath;
+    }
+  }
+  return;
+}
+function getDefaultSearchPaths(appName) {
+  const xdgConfigHome = process.env["XDG_CONFIG_HOME"];
+  const home = process.env["HOME"] ?? "";
+  const defaultConfigPath = join(home, ".config", appName);
+  if (xdgConfigHome) {
+    const xdgPath = join(xdgConfigHome, appName);
+    if (xdgPath !== defaultConfigPath) {
+      return [xdgPath, defaultConfigPath];
+    }
+  }
+  return [defaultConfigPath];
+}
+function isZodSchema(value) {
+  return typeof value === "object" && value !== null && "safeParse" in value && typeof value["safeParse"] === "function";
+}
+function loadConfig(appName, schemaOrOptions, maybeOptions) {
+  let schema;
+  let options;
+  if (schemaOrOptions !== undefined) {
+    if (isZodSchema(schemaOrOptions)) {
+      schema = schemaOrOptions;
+      options = maybeOptions;
+    } else {
+      options = schemaOrOptions;
+    }
+  }
+  const searchPaths = options?.searchPaths ? options.searchPaths.map((p) => join(p, appName)) : getDefaultSearchPaths(appName);
+  let configFilePath;
+  for (const searchPath of searchPaths) {
+    const found = findConfigFile(searchPath);
+    if (found) {
+      configFilePath = found;
+      break;
+    }
+  }
+  if (!configFilePath) {
+    return Result.err(new NotFoundError({
+      message: `Configuration file not found for ${appName}`,
+      resourceType: "config",
+      resourceId: appName
+    }));
+  }
+  const loadResult = loadConfigFileWithExtends(configFilePath);
+  if (loadResult.isErr()) {
+    return Result.err(loadResult.error);
+  }
+  const parsed = loadResult.unwrap();
+  if (!schema) {
+    return Result.ok(parsed);
+  }
+  const validateResult = schema.safeParse(parsed);
+  if (!validateResult.success) {
+    const fullMessage = formatZodIssues(validateResult.error.issues);
+    const firstPath = validateResult.error.issues[0]?.path?.join(".");
+    return Result.err(new ValidationError({
+      message: fullMessage,
+      ...firstPath ? { field: firstPath } : {}
+    }));
+  }
+  return Result.ok(validateResult.data);
+}
+
+export { loadConfig };

package/dist/shared/@outfitter/config-pf9xp78h.js

@@ -0,0 +1,29 @@
+// @bun
+// packages/config/src/internal/xdg.ts
+import { join } from "path";
+function getConfigDir(appName) {
+  const xdgConfigHome = process.env["XDG_CONFIG_HOME"];
+  const home = process.env["HOME"] ?? "";
+  const baseDir = xdgConfigHome ?? join(home, ".config");
+  return join(baseDir, appName);
+}
+function getDataDir(appName) {
+  const xdgDataHome = process.env["XDG_DATA_HOME"];
+  const home = process.env["HOME"] ?? "";
+  const baseDir = xdgDataHome ?? join(home, ".local", "share");
+  return join(baseDir, appName);
+}
+function getCacheDir(appName) {
+  const xdgCacheHome = process.env["XDG_CACHE_HOME"];
+  const home = process.env["HOME"] ?? "";
+  const baseDir = xdgCacheHome ?? join(home, ".cache");
+  return join(baseDir, appName);
+}
+function getStateDir(appName) {
+  const xdgStateHome = process.env["XDG_STATE_HOME"];
+  const home = process.env["HOME"] ?? "";
+  const baseDir = xdgStateHome ?? join(home, ".local", "state");
+  return join(baseDir, appName);
+}
+
+export { getConfigDir, getDataDir, getCacheDir, getStateDir };

package/dist/shared/@outfitter/config-s4swz8m3.js

@@ -0,0 +1,97 @@
+// @bun
+// packages/config/src/internal/parsing.ts
+import { Result, TaggedError } from "@outfitter/contracts";
+import { parse as parseToml } from "smol-toml";
+import { parse as parseYaml } from "yaml";
+var ParseErrorBase = TaggedError("ParseError")();
+
+class ParseError extends ParseErrorBase {
+  category = "validation";
+}
+var CircularExtendsErrorBase = TaggedError("CircularExtendsError")();
+
+class CircularExtendsError extends CircularExtendsErrorBase {
+  category = "validation";
+}
+function isPlainObject(value) {
+  if (value === null || typeof value !== "object") {
+    return false;
+  }
+  if (Array.isArray(value)) {
+    return false;
+  }
+  return true;
+}
+function deepMerge(target, source) {
+  const result = { ...target };
+  for (const key of Object.keys(source)) {
+    const sourceValue = source[key];
+    const targetValue = result[key];
+    if (sourceValue === undefined) {
+      continue;
+    }
+    if (sourceValue === null) {
+      result[key] = null;
+      continue;
+    }
+    if (Array.isArray(sourceValue)) {
+      result[key] = sourceValue;
+      continue;
+    }
+    if (isPlainObject(sourceValue) && isPlainObject(targetValue)) {
+      result[key] = deepMerge(targetValue, sourceValue);
+      continue;
+    }
+    result[key] = sourceValue;
+  }
+  return result;
+}
+function getExtension(filename) {
+  const lastDot = filename.lastIndexOf(".");
+  if (lastDot === -1) {
+    return "";
+  }
+  return filename.slice(lastDot + 1).toLowerCase();
+}
+function parseConfigFile(content, filename) {
+  const ext = getExtension(filename);
+  try {
+    switch (ext) {
+      case "toml": {
+        const parsed = parseToml(content);
+        return Result.ok(parsed);
+      }
+      case "yaml":
+      case "yml": {
+        const parsed = parseYaml(content, { merge: true });
+        if (parsed === null || typeof parsed !== "object") {
+          return Result.ok({});
+        }
+        return Result.ok(parsed);
+      }
+      case "json": {
+        const parsed = JSON.parse(content);
+        return Result.ok(parsed);
+      }
+      case "jsonc":
+      case "json5": {
+        const parsed = Bun.JSON5.parse(content);
+        return Result.ok(parsed);
+      }
+      default: {
+        return Result.err(new ParseError({
+          message: `Unsupported config file extension: .${ext}`,
+          filename
+        }));
+      }
+    }
+  } catch (error) {
+    const message = error instanceof Error ? error.message : "Unknown parse error";
+    return Result.err(new ParseError({
+      message: `Failed to parse ${filename}: ${message}`,
+      filename
+    }));
+  }
+}
+
+export { ParseError, CircularExtendsError, deepMerge, parseConfigFile };

package/dist/shared/@outfitter/config-sp6gradd.d.ts

@@ -0,0 +1,129 @@
+import { TaggedErrorClass } from "@outfitter/contracts";
+import { Result } from "@outfitter/contracts";
+type ParseErrorFields = {
+	/** Human-readable error message describing the parse failure */
+	message: string;
+	/** Name of the file that failed to parse */
+	filename: string;
+	/** Line number where the error occurred (if available) */
+	line?: number;
+	/** Column number where the error occurred (if available) */
+	column?: number;
+};
+declare const ParseErrorBase: TaggedErrorClass<"ParseError", ParseErrorFields>;
+/**
+* Error thrown when a configuration file cannot be parsed.
+*
+* Contains details about the parse failure including the filename
+* and optionally the line/column where the error occurred.
+*
+* @example
+* ```typescript
+* const result = parseConfigFile("invalid toml [", "config.toml");
+* if (result.isErr() && result.error._tag === "ParseError") {
+*   console.error(`Parse error in ${result.error.filename}: ${result.error.message}`);
+* }
+* ```
+*/
+declare class ParseError extends ParseErrorBase {
+	readonly category: "validation";
+}
+type CircularExtendsErrorFields = {
+	/** Human-readable error message */
+	message: string;
+	/** The config file paths that form the circular reference */
+	chain: string[];
+};
+declare const CircularExtendsErrorBase: TaggedErrorClass<"CircularExtendsError", CircularExtendsErrorFields>;
+/**
+* Error thrown when a circular extends reference is detected.
+*/
+declare class CircularExtendsError extends CircularExtendsErrorBase {
+	readonly category: "validation";
+}
+/**
+* Deep merge two objects with configurable merge semantics.
+*
+* Merge behavior:
+* - Recursively merges nested plain objects
+* - Arrays are replaced (not concatenated)
+* - `null` explicitly replaces the target value
+* - `undefined` is skipped (does not override)
+*
+* @typeParam T - The type of the target object
+* @param target - Base object to merge into (not mutated)
+* @param source - Object with values to merge
+* @returns New object with merged values
+*
+* @example
+* ```typescript
+* const defaults = { server: { port: 3000, host: "localhost" } };
+* const overrides = { server: { port: 8080 } };
+*
+* const merged = deepMerge(defaults, overrides);
+* // { server: { port: 8080, host: "localhost" } }
+* ```
+*
+* @example
+* ```typescript
+* // Arrays replace, not merge
+* const target = { tags: ["a", "b"] };
+* const source = { tags: ["c"] };
+* deepMerge(target, source); // { tags: ["c"] }
+*
+* // undefined is skipped
+* const base = { a: 1, b: 2 };
+* deepMerge(base, { a: undefined, b: 3 }); // { a: 1, b: 3 }
+*
+* // null explicitly replaces
+* deepMerge(base, { a: null }); // { a: null, b: 2 }
+* ```
+*/
+declare function deepMerge<T extends object>(target: T, source: Partial<T>): T;
+/**
+* Parse configuration file content based on filename extension.
+*
+* Supports multiple formats:
+* - `.toml` - Parsed with smol-toml (preferred for config)
+* - `.yaml`, `.yml` - Parsed with yaml (merge key support enabled)
+* - `.json` - Parsed with strict JSON.parse
+* - `.jsonc` - Parsed with json5 compatibility (comments/trailing commas)
+* - `.json5` - Parsed with json5 (comments and trailing commas allowed)
+*
+* @param content - Raw file content to parse
+* @param filename - Filename used to determine format (by extension)
+* @returns Result containing parsed object or ParseError
+*
+* @example
+* ```typescript
+* const toml = `
+* [server]
+* port = 3000
+* host = "localhost"
+* `;
+*
+* const result = parseConfigFile(toml, "config.toml");
+* if (result.isOk()) {
+*   console.log(result.value.server.port); // 3000
+* }
+* ```
+*
+* @example
+* ```typescript
+* // YAML with anchors/aliases
+* const yaml = `
+* defaults: &defaults
+*   timeout: 5000
+* server:
+*   <<: *defaults
+*   port: 3000
+* `;
+*
+* const result = parseConfigFile(yaml, "config.yaml");
+* if (result.isOk()) {
+*   console.log(result.value.server.timeout); // 5000
+* }
+* ```
+*/
+declare function parseConfigFile(content: string, filename: string): Result<Record<string, unknown>, InstanceType<typeof ParseError>>;
+export { ParseError, CircularExtendsError, deepMerge, parseConfigFile };

package/package.json

@@ -1,11 +1,24 @@
 {
   "name": "@outfitter/config",
+  "version": "0.4.0",
   "description": "XDG-compliant config loading with schema validation for Outfitter",
-  "version": "0.3.3",
-  "type": "module",
+  "keywords": [
+    "config",
+    "outfitter",
+    "typescript",
+    "xdg"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/outfitter-dev/outfitter.git",
+    "directory": "packages/config"
+  },
   "files": [
     "dist"
   ],
+  "type": "module",
+  "sideEffects": false,
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "exports": {
@@ -29,40 +42,27 @@
     },
     "./package.json": "./package.json"
   },
-  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
-    "build": "bunup --filter @outfitter/config",
-    "lint": "biome lint ./src",
-    "lint:fix": "biome lint --write ./src",
+    "build": "cd ../.. && bash ./scripts/run-bunup-with-lock.sh bunup --filter @outfitter/config",
+    "lint": "oxlint ./src",
+    "lint:fix": "oxlint --fix ./src",
     "test": "bun test",
     "typecheck": "tsc --noEmit",
     "clean": "rm -rf dist",
     "prepublishOnly": "bun ../../scripts/check-publish-manifest.ts"
   },
   "dependencies": {
-    "@outfitter/contracts": "0.4.1",
-    "@outfitter/types": "0.2.3",
+    "@outfitter/contracts": "0.5.0",
+    "@outfitter/types": "0.2.5",
     "smol-toml": "^1.6.0",
     "yaml": "^2.8.2",
     "zod": "^4.3.5"
   },
   "devDependencies": {
-    "@types/bun": "latest",
-    "typescript": "^5.8.0"
-  },
-  "keywords": [
-    "outfitter",
-    "config",
-    "xdg",
-    "typescript"
-  ],
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/outfitter-dev/outfitter.git",
-    "directory": "packages/config"
-  },
-  "publishConfig": {
-    "access": "public"
+    "@types/bun": "^1.3.9",
+    "typescript": "^5.9.3"
   }
 }