@outfitter/config 0.3.3 → 0.3.4

package/README.md

@@ -59,11 +59,13 @@ if (result.isOk()) {
 ```
 
 **Parameters:**
+
 - `appName` - Application name for XDG directory lookup
 - `schema` - Zod schema for validation
 - `options.searchPaths` - Custom search paths (overrides XDG defaults)
 
 **Search Order:**
+
 1. Custom `searchPaths` if provided
 2. `$XDG_CONFIG_HOME/{appName}/config.{ext}`
 3. `~/.config/{appName}/config.{ext}`
@@ -88,6 +90,7 @@ const result = resolveConfig(AppSchema, {
 ```
 
 **Parameters:**
+
 - `schema` - Zod schema for validation
 - `sources` - Configuration sources to merge
 
@@ -113,6 +116,7 @@ if (result.isOk()) {
 ```
 
 **Parameters:**
+
 - `content` - Raw file content
 - `filename` - Filename (extension determines parser)
 
@@ -179,6 +183,7 @@ const merged = deepMerge(defaults, overrides);
 ```
 
 **Merge Behavior:**
+
 - Recursively merges nested plain objects
 - Arrays are replaced (not concatenated)
 - `null` explicitly replaces the target value
@@ -194,10 +199,10 @@ Configuration sources for multi-layer resolution.
 
 ```typescript
 interface ConfigSources<T> {
-  defaults?: Partial<T>;  // Lowest precedence
-  file?: Partial<T>;      // From config file
-  env?: Partial<T>;       // Environment variables
-  flags?: Partial<T>;     // CLI flags (highest)
+  defaults?: Partial<T>; // Lowest precedence
+  file?: Partial<T>; // From config file
+  env?: Partial<T>; // Environment variables
+  flags?: Partial<T>; // CLI flags (highest)
 }
 ```
 
@@ -207,7 +212,7 @@ Options for `loadConfig()`.
 
 ```typescript
 interface LoadConfigOptions {
-  searchPaths?: string[];  // Custom search paths
+  searchPaths?: string[]; // Custom search paths
 }
 ```
 
@@ -256,11 +261,11 @@ const prodDefaults = getEnvironmentDefaults("production");
 // { logLevel: null, verbose: false, errorDetail: "message" }
 ```
 
-| Setting | `development` | `production` | `test` |
-|---------|--------------|-------------|--------|
-| logLevel | `"debug"` | `null` | `null` |
-| verbose | `true` | `false` | `false` |
-| errorDetail | `"full"` | `"message"` | `"full"` |
+| Setting     | `development` | `production` | `test`   |
+| ----------- | ------------- | ------------ | -------- |
+| logLevel    | `"debug"`     | `null`       | `null`   |
+| verbose     | `true`        | `false`      | `false`  |
+| errorDetail | `"full"`      | `"message"`  | `"full"` |
 
 ### Types
 
@@ -286,12 +291,12 @@ interface EnvironmentDefaults {
 
 This package follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) for locating configuration files.
 
-| Variable | macOS/Linux Default | Purpose |
-|----------|---------------------|---------|
-| `XDG_CONFIG_HOME` | `~/.config` | User-specific configuration |
-| `XDG_DATA_HOME` | `~/.local/share` | User-specific data files |
-| `XDG_CACHE_HOME` | `~/.cache` | Non-essential cached data |
-| `XDG_STATE_HOME` | `~/.local/state` | Persistent state (logs, history) |
+| Variable          | macOS/Linux Default | Purpose                          |
+| ----------------- | ------------------- | -------------------------------- |
+| `XDG_CONFIG_HOME` | `~/.config`         | User-specific configuration      |
+| `XDG_DATA_HOME`   | `~/.local/share`    | User-specific data files         |
+| `XDG_CACHE_HOME`  | `~/.cache`          | Non-essential cached data        |
+| `XDG_STATE_HOME`  | `~/.local/state`    | Persistent state (logs, history) |
 
 ---
 
@@ -317,13 +322,13 @@ Higher precedence sources override lower ones. Nested objects are deep-merged.
 
 ## Supported File Formats
 
-| Extension | Parser | Notes |
-|-----------|--------|-------|
-| `.toml` | smol-toml | Preferred for configuration |
-| `.yaml`, `.yml` | yaml | YAML anchors/aliases supported |
-| `.json` | JSON.parse | Strict parsing |
-| `.jsonc` | json5 | JSON with comments and trailing commas |
-| `.json5` | json5 | Comments and trailing commas allowed |
+| Extension       | Parser     | Notes                                  |
+| --------------- | ---------- | -------------------------------------- |
+| `.toml`         | smol-toml  | Preferred for configuration            |
+| `.yaml`, `.yml` | yaml       | YAML anchors/aliases supported         |
+| `.json`         | JSON.parse | Strict parsing                         |
+| `.jsonc`        | json5      | JSON with comments and trailing commas |
+| `.json5`        | json5      | Comments and trailing commas allowed   |
 
 ---
 

package/dist/index.d.ts

@@ -1,234 +1,5 @@
-/**
-* Unified environment profiles for Outfitter packages.
-*
-* Provides a shared "environment" concept that cascades defaults
-* across all Outfitter packages. The environment is determined by
-* the `OUTFITTER_ENV` environment variable, falling back to
-* `"production"` when unset or invalid.
-*
-* @example
-* ```typescript
-* import { getEnvironment, getEnvironmentDefaults } from "@outfitter/config";
-*
-* const env = getEnvironment(); // "development" | "production" | "test"
-* const defaults = getEnvironmentDefaults(env);
-*
-* if (defaults.verbose) {
-*   console.log("Verbose mode enabled");
-* }
-* ```
-*
-* @module
-*/
-/**
-* Valid Outfitter environment names.
-*
-* - `"development"` — Local development with verbose output and debug logging
-* - `"production"` — Production deployments with minimal output
-* - `"test"` — Test runs with full error detail but no logging
-*/
-type OutfitterEnv = "development" | "production" | "test";
-/**
-* Profile-specific defaults for an environment.
-*
-* These defaults provide sensible starting values that individual
-* packages can override or extend.
-*/
-interface EnvironmentDefaults {
-	/** How much error detail to include in output. */
-	errorDetail: "full" | "message";
-	/** Default log level. `null` means logging is disabled by default. */
-	logLevel: "debug" | "info" | "warn" | "error" | null;
-	/** Whether verbose output is enabled by default. */
-	verbose: boolean;
-}
-/**
-* Determine the current Outfitter environment.
-*
-* Reads the `OUTFITTER_ENV` environment variable. If set to a valid
-* value (`"development"`, `"production"`, or `"test"`), returns that
-* value. Otherwise falls back to `"production"`.
-*
-* @returns The current environment
-*
-* @example
-* ```typescript
-* // With OUTFITTER_ENV=development
-* getEnvironment(); // "development"
-*
-* // With OUTFITTER_ENV unset or invalid
-* getEnvironment(); // "production"
-* ```
-*/
-declare function getEnvironment(): OutfitterEnv;
-/**
-* Get the default settings for an environment profile.
-*
-* Returns a shallow copy of the defaults for the given environment.
-* These defaults are intended as starting values that individual
-* packages can override via their own configuration.
-*
-* | Setting | `development` | `production` | `test` |
-* |---------|--------------|-------------|--------|
-* | logLevel | `"debug"` | `null` | `null` |
-* | verbose | `true` | `false` | `false` |
-* | errorDetail | `"full"` | `"message"` | `"full"` |
-*
-* @param env - The environment to get defaults for
-* @returns Profile-specific default settings
-*
-* @example
-* ```typescript
-* const defaults = getEnvironmentDefaults("development");
-* // { logLevel: "debug", verbose: true, errorDetail: "full" }
-*
-* const prodDefaults = getEnvironmentDefaults("production");
-* // { logLevel: null, verbose: false, errorDetail: "message" }
-* ```
-*/
-declare function getEnvironmentDefaults(env: OutfitterEnv): EnvironmentDefaults;
-import { z } from "zod";
-/**
-* Port number schema (1-65535) with string-to-number coercion.
-*
-* Validates that a string contains only digits, then transforms
-* to a number and validates the port range.
-*
-* @example
-* ```typescript
-* const schema = z.object({ PORT: portSchema });
-* schema.parse({ PORT: "3000" }); // { PORT: 3000 }
-* schema.parse({ PORT: "invalid" }); // throws
-* schema.parse({ PORT: "99999" }); // throws (out of range)
-* ```
-*/
-declare const portSchema: z.ZodType<number, string>;
-/**
-* Boolean schema with proper string coercion.
-*
-* Accepts: "true", "false", "1", "0", ""
-* - "true" or "1" -> true
-* - "false", "0", or "" -> false
-*
-* @example
-* ```typescript
-* const schema = z.object({ DEBUG: booleanSchema });
-* schema.parse({ DEBUG: "true" }); // { DEBUG: true }
-* schema.parse({ DEBUG: "1" }); // { DEBUG: true }
-* schema.parse({ DEBUG: "false" }); // { DEBUG: false }
-* schema.parse({ DEBUG: "" }); // { DEBUG: false }
-* ```
-*/
-declare const booleanSchema: z.ZodType<boolean, string>;
-/**
-* Optional boolean schema - returns undefined if not set.
-*
-* Unlike `booleanSchema`, this returns `undefined` for missing
-* or empty values, allowing callers to distinguish between
-* "explicitly set to false" and "not set".
-*
-* @example
-* ```typescript
-* const schema = z.object({ NO_COLOR: optionalBooleanSchema });
-* schema.parse({ NO_COLOR: "true" }); // { NO_COLOR: true }
-* schema.parse({ NO_COLOR: "" }); // { NO_COLOR: undefined }
-* schema.parse({ NO_COLOR: undefined }); // { NO_COLOR: undefined }
-* ```
-*/
-declare const optionalBooleanSchema: z.ZodType<boolean | undefined, string | undefined>;
-/**
-* Parse and validate environment variables against a Zod schema.
-*
-* By default reads from `process.env`, but accepts a custom env
-* object for testing.
-*
-* @typeParam T - The Zod schema shape
-* @param schema - Zod object schema to validate against
-* @param envObj - Environment object (defaults to process.env)
-* @returns Validated and transformed environment object
-* @throws {z.ZodError} When validation fails
-*
-* @example
-* ```typescript
-* const AppEnv = z.object({
-*   PORT: portSchema,
-*   DEBUG: booleanSchema,
-* });
-*
-* const env = parseEnv(AppEnv);
-* console.log(env.PORT); // number
-* console.log(env.DEBUG); // boolean
-* ```
-*/
-declare function parseEnv<T extends z.ZodRawShape>(schema: z.ZodObject<T>, envObj?: Record<string, string | undefined>): z.infer<z.ZodObject<T>>;
-type AppEnvShape = {
-	NODE_ENV: z.ZodDefault<z.ZodEnum<{
-		development: "development";
-		test: "test";
-		production: "production";
-	}>>;
-	NO_COLOR: typeof optionalBooleanSchema;
-	FORCE_COLOR: typeof optionalBooleanSchema;
-	CI: typeof optionalBooleanSchema;
-	TERM: z.ZodOptional<z.ZodString>;
-	XDG_CONFIG_HOME: z.ZodOptional<z.ZodString>;
-	XDG_DATA_HOME: z.ZodOptional<z.ZodString>;
-	XDG_STATE_HOME: z.ZodOptional<z.ZodString>;
-	XDG_CACHE_HOME: z.ZodOptional<z.ZodString>;
-	HOME: z.ZodOptional<z.ZodString>;
-};
-/**
-* Schema for common application environment variables.
-*/
-declare const appEnvSchema: z.ZodObject<AppEnvShape>;
-/**
-* Type for the pre-parsed application environment.
-*/
-type Env = z.infer<typeof appEnvSchema>;
-/**
-* Pre-parsed application environment.
-*
-* Access common environment variables with proper typing:
-* - `env.NODE_ENV`: "development" | "test" | "production"
-* - `env.NO_COLOR`: boolean | undefined
-* - `env.FORCE_COLOR`: boolean | undefined
-* - `env.CI`: boolean | undefined
-* - `env.TERM`: string | undefined
-* - `env.XDG_*`: string | undefined
-* - `env.HOME`: string | undefined
-*
-* @example
-* ```typescript
-* import { env } from "@outfitter/config";
-*
-* if (env.CI) {
-*   console.log("Running in CI environment");
-* }
-*
-* if (env.NO_COLOR) {
-*   // Disable color output
-* }
-* ```
-*/
-declare const env: Env;
-/**
-* Reads an optional boolean from process.env at call time.
-*
-* Unlike `env.NO_COLOR` (which is static), this reads dynamically
-* for use cases where env vars may change at runtime (e.g., tests).
-*
-* @param key - The environment variable name to read
-* @returns `true` if "true"/"1", `false` if "false"/"0", `undefined` otherwise
-*
-* @example
-* ```typescript
-* // For terminal detection that needs dynamic behavior
-* if (getEnvBoolean("NO_COLOR")) {
-*   // colors disabled
-* }
-* ```
-*/
-declare function getEnvBoolean(key: "NO_COLOR" | "FORCE_COLOR" | "CI"): boolean | undefined;
+import { Env, booleanSchema, env, getEnvBoolean, optionalBooleanSchema, parseEnv, portSchema } from "./shared/@outfitter/config-veqxf02x.js";
+import { EnvironmentDefaults, OutfitterEnv, getEnvironment, getEnvironmentDefaults } from "./shared/@outfitter/config-wawavx3r.js";
 import { TaggedErrorClass } from "@outfitter/contracts";
 import { NotFoundError, Result, ValidationError } from "@outfitter/contracts";
 import { ZodSchema } from "zod";

package/dist/index.js

@@ -1,71 +1,20 @@
-// src/environment.ts
-var VALID_ENVIRONMENTS = new Set([
-  "development",
-  "production",
-  "test"
-]);
-var ENVIRONMENT_DEFAULTS = {
-  development: {
-    logLevel: "debug",
-    verbose: true,
-    errorDetail: "full"
-  },
-  production: {
-    logLevel: null,
-    verbose: false,
-    errorDetail: "message"
-  },
-  test: {
-    logLevel: null,
-    verbose: false,
-    errorDetail: "full"
-  }
-};
-function getEnvironment() {
-  const value = process.env["OUTFITTER_ENV"];
-  if (value !== undefined && VALID_ENVIRONMENTS.has(value)) {
-    return value;
-  }
-  return "production";
-}
-function getEnvironmentDefaults(env) {
-  return { ...ENVIRONMENT_DEFAULTS[env] };
-}
-// src/env.ts
-import { z } from "zod";
-var portSchema = z.string().regex(/^\d+$/).transform(Number).pipe(z.number().int().positive().max(65535));
-var booleanSchema = z.enum(["true", "false", "1", "0", ""]).transform((val) => val === "true" || val === "1");
-var optionalBooleanSchema = z.string().optional().transform((val) => {
-  if (val === undefined || val === "")
-    return;
-  return val === "true" || val === "1";
-});
-function parseEnv(schema, envObj = process.env) {
-  return schema.parse(envObj);
-}
-var appEnvSchema = z.object({
-  NODE_ENV: z.enum(["development", "test", "production"]).default("development"),
-  NO_COLOR: optionalBooleanSchema,
-  FORCE_COLOR: optionalBooleanSchema,
-  CI: optionalBooleanSchema,
-  TERM: z.string().optional(),
-  XDG_CONFIG_HOME: z.string().optional(),
-  XDG_DATA_HOME: z.string().optional(),
-  XDG_STATE_HOME: z.string().optional(),
-  XDG_CACHE_HOME: z.string().optional(),
-  HOME: z.string().optional()
-});
-var env = parseEnv(appEnvSchema);
-function getEnvBoolean(key) {
-  const value = process.env[key];
-  if (value === undefined || value === "")
-    return;
-  return value === "true" || value === "1";
-}
+// @bun
+import {
+  booleanSchema,
+  env,
+  getEnvBoolean,
+  optionalBooleanSchema,
+  parseEnv,
+  portSchema
+} from "./shared/@outfitter/config-443pb6p2.js";
+import {
+  getEnvironment,
+  getEnvironmentDefaults
+} from "./shared/@outfitter/config-w3pwcpr2.js";
 
-// src/index.ts
-import { existsSync, readFileSync } from "node:fs";
-import { dirname, isAbsolute, join, resolve } from "node:path";
+// packages/config/src/index.ts
+import { existsSync, readFileSync } from "fs";
+import { dirname, isAbsolute, join, resolve } from "path";
 import {
   NotFoundError,
   Result,

package/package.json

@@ -1,11 +1,24 @@
 {
   "name": "@outfitter/config",
+  "version": "0.3.4",
   "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 ../.. && 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.4.2",
+    "@outfitter/types": "0.2.4",
     "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"
   }
 }