@ontrails/config 1.0.0-beta.15 → 1.0.0-beta.16

package/src/__tests__/resolve.test.ts

@@ -1,246 +0,0 @@
-import { describe, expect, test } from 'bun:test';
-import { z } from 'zod';
-
-import { env } from '../extensions.js';
-import { deriveConfig } from '../resolve.js';
-
-const baseSchema = z.object({
-  debug: z.boolean().default(false),
-  host: z.string().default('localhost'),
-  port: z.number().default(3000),
-});
-
-describe('deriveConfig', () => {
-  describe('schema defaults', () => {
-    test('applies schema defaults when no other source provides values', () => {
-      const result = deriveConfig({ schema: baseSchema });
-
-      expect(result.isOk()).toBe(true);
-      expect(result.unwrap()).toEqual({
-        debug: false,
-        host: 'localhost',
-        port: 3000,
-      });
-    });
-  });
-
-  describe('base config', () => {
-    test('overrides schema defaults', () => {
-      const result = deriveConfig({
-        base: { host: 'example.com', port: 8080 },
-        schema: baseSchema,
-      });
-
-      expect(result.isOk()).toBe(true);
-      const value = result.unwrap();
-      expect(value.host).toBe('example.com');
-      expect(value.port).toBe(8080);
-      // Schema default preserved for unspecified fields
-      expect(value.debug).toBe(false);
-    });
-  });
-
-  describe('profiles', () => {
-    test('overrides base config for matching profile', () => {
-      const result = deriveConfig({
-        base: { host: 'example.com', port: 8080 },
-        profile: 'production',
-        profiles: {
-          production: { host: 'prod.example.com', port: 443 },
-        },
-        schema: baseSchema,
-      });
-
-      expect(result.isOk()).toBe(true);
-      const value = result.unwrap();
-      expect(value.host).toBe('prod.example.com');
-      expect(value.port).toBe(443);
-      expect(value.debug).toBe(false);
-    });
-
-    test('silently ignores unrecognized profile (base only)', () => {
-      const result = deriveConfig({
-        base: { host: 'example.com' },
-        profile: 'staging',
-        profiles: {
-          production: { host: 'prod.example.com' },
-        },
-        schema: baseSchema,
-      });
-
-      expect(result.isOk()).toBe(true);
-      expect(result.unwrap().host).toBe('example.com');
-    });
-  });
-
-  describe('local overrides', () => {
-    test('deep-merge on top of profile', () => {
-      const nestedSchema = z.object({
-        db: z
-          .object({
-            host: z.string().default('localhost'),
-            port: z.number().default(5432),
-          })
-          .default({}),
-      });
-
-      const result = deriveConfig({
-        base: { db: { host: 'db.example.com', port: 5432 } },
-        localOverrides: { db: { port: 9999 } },
-        profile: 'production',
-        profiles: {
-          production: { db: { host: 'prod-db.example.com' } },
-        },
-        schema: nestedSchema,
-      });
-
-      expect(result.isOk()).toBe(true);
-      const value = result.unwrap();
-      expect(value.db.host).toBe('prod-db.example.com');
-      expect(value.db.port).toBe(9999);
-    });
-  });
-
-  describe('env var overrides', () => {
-    test('overrides all other sources', () => {
-      const schema = z.object({
-        host: env(z.string(), 'APP_HOST').default('localhost'),
-        port: env(z.number(), 'APP_PORT').default(3000),
-      });
-
-      const result = deriveConfig({
-        base: { host: 'example.com', port: 8080 },
-        env: { APP_HOST: 'env-host.example.com', APP_PORT: '9090' },
-        schema,
-      });
-
-      expect(result.isOk()).toBe(true);
-      const value = result.unwrap();
-      expect(value.host).toBe('env-host.example.com');
-      expect(value.port).toBe(9090);
-    });
-
-    test('coerces string to number', () => {
-      const schema = z.object({
-        port: env(z.number(), 'PORT').default(3000),
-      });
-
-      const result = deriveConfig({
-        env: { PORT: '8080' },
-        schema,
-      });
-
-      expect(result.isOk()).toBe(true);
-      expect(result.unwrap().port).toBe(8080);
-    });
-
-    test('rejects non-numeric string with Zod error instead of NaN', () => {
-      const schema = z.object({
-        port: env(z.number(), 'PORT').default(3000),
-      });
-
-      const result = deriveConfig({
-        env: { PORT: 'abc' },
-        schema,
-      });
-
-      expect(result.isErr()).toBe(true);
-    });
-
-    test('coerces string to boolean', () => {
-      const schema = z.object({
-        debug: env(z.boolean(), 'DEBUG').default(false),
-        verbose: env(z.boolean(), 'VERBOSE').default(false),
-      });
-
-      const trueValues = deriveConfig({
-        env: { DEBUG: 'true', VERBOSE: '1' },
-        schema,
-      });
-      expect(trueValues.isOk()).toBe(true);
-      expect(trueValues.unwrap().debug).toBe(true);
-      expect(trueValues.unwrap().verbose).toBe(true);
-
-      const falseValues = deriveConfig({
-        env: { DEBUG: 'false', VERBOSE: '0' },
-        schema,
-      });
-      expect(falseValues.isOk()).toBe(true);
-      expect(falseValues.unwrap().debug).toBe(false);
-      expect(falseValues.unwrap().verbose).toBe(false);
-    });
-  });
-
-  describe('validation', () => {
-    test('missing required field returns Result.err', () => {
-      const schema = z.object({
-        required: z.string(),
-      });
-
-      const result = deriveConfig({ schema });
-
-      expect(result.isErr()).toBe(true);
-    });
-  });
-
-  describe('mutation safety', () => {
-    test('repeated resolve() calls do not mutate the original base', () => {
-      const schema = z.object({
-        host: env(z.string(), 'APP_HOST').default('localhost'),
-      });
-      const base = { host: 'dev-host' };
-
-      const first = deriveConfig({
-        base,
-        env: { APP_HOST: 'env-host' },
-        schema,
-      });
-      expect(first.isOk()).toBe(true);
-      expect(first.unwrap().host).toBe('env-host');
-
-      const second = deriveConfig({ base, schema });
-      expect(second.isOk()).toBe(true);
-      expect(second.unwrap().host).toBe('dev-host');
-      expect(base.host).toBe('dev-host');
-    });
-  });
-
-  describe('full stack', () => {
-    test('all 5 sources compose correctly', () => {
-      const schema = z.object({
-        apiUrl: env(z.string(), 'API_URL').default('http://localhost'),
-        debug: env(z.boolean(), 'DEBUG').default(false),
-        local: z.string().default('default-local'),
-        name: z.string().default('app'),
-        port: z.number().default(3000),
-      });
-
-      const result = deriveConfig({
-        // base overrides name
-        base: { name: 'my-app', port: 8080 },
-        // env overrides debug and apiUrl
-        env: { API_URL: 'https://api.prod.com', DEBUG: 'true' },
-        // local overrides local
-        localOverrides: { local: 'my-local-value' },
-        // profile overrides port
-        profile: 'production',
-        profiles: { production: { port: 443 } },
-        schema,
-      });
-
-      expect(result.isOk()).toBe(true);
-      const value = result.unwrap();
-      // Schema default
-      // (nothing left at just default — name was overridden by base)
-      // Base
-      expect(value.name).toBe('my-app');
-      // Profile overrides base port
-      expect(value.port).toBe(443);
-      // Local overrides
-      expect(value.local).toBe('my-local-value');
-      // Env overrides
-      expect(value.apiUrl).toBe('https://api.prod.com');
-      expect(value.debug).toBe(true);
-    });
-  });
-});

package/src/__tests__/workspace.test.ts

@@ -1,64 +0,0 @@
-import { afterEach, beforeEach, describe, expect, test } from 'bun:test';
-import { mkdtemp, readdir, readFile, rm } from 'node:fs/promises';
-import { join } from 'node:path';
-import { tmpdir } from 'node:os';
-
-import { ensureWorkspace } from '../workspace.js';
-
-describe('ensureWorkspace', () => {
-  let root: string;
-
-  beforeEach(async () => {
-    root = await mkdtemp(join(tmpdir(), 'trails-ws-'));
-  });
-
-  afterEach(async () => {
-    await rm(root, { force: true, recursive: true });
-  });
-
-  describe('directory creation', () => {
-    test('creates .trails/ directory', async () => {
-      await ensureWorkspace(root);
-      const entries = await readdir(join(root, '.trails'));
-      expect(entries).toContain('config');
-      expect(entries).toContain('dev');
-      expect(entries).toContain('generated');
-    });
-
-    test('creates all expected subdirectories', async () => {
-      await ensureWorkspace(root);
-      const config = await readdir(join(root, '.trails', 'config'));
-      expect(config).toBeDefined();
-      const dev = await readdir(join(root, '.trails', 'dev'));
-      expect(dev).toBeDefined();
-      const generated = await readdir(join(root, '.trails', 'generated'));
-      expect(generated).toBeDefined();
-    });
-  });
-
-  describe('.gitignore', () => {
-    test('writes .gitignore on first run', async () => {
-      await ensureWorkspace(root);
-      const content = await readFile(
-        join(root, '.trails', '.gitignore'),
-        'utf8'
-      );
-      expect(content).toContain('config/');
-      expect(content).toContain('dev/');
-      expect(content).toContain('generated/');
-    });
-
-    test('does not overwrite existing .gitignore', async () => {
-      await ensureWorkspace(root);
-      const customContent = '# custom\n*\n';
-      await Bun.write(join(root, '.trails', '.gitignore'), customContent);
-
-      await ensureWorkspace(root);
-      const content = await readFile(
-        join(root, '.trails', '.gitignore'),
-        'utf8'
-      );
-      expect(content).toBe(customContent);
-    });
-  });
-});

package/src/workspace.ts

@@ -1,56 +0,0 @@
-/**
- * Ensure the `.trails/` workspace directory exists with proper structure.
- *
- * Auto-creates on first framework operation. The workspace holds local
- * config overrides, development state, and generated artifacts that
- * should not be committed to source control.
- */
-import { mkdir } from 'node:fs/promises';
-import { join } from 'node:path';
-
-const WORKSPACE_DIRS = ['config', 'dev', 'generated'] as const;
-
-const GITIGNORE_CONTENT = [
-  '# Local config overrides',
-  'config/',
-  '',
-  '# Development state',
-  'dev/',
-  '',
-  '# Generated artifacts',
-  'generated/',
-  '',
-  '# Shared Trails database',
-  'trails.db',
-  'trails.db-shm',
-  'trails.db-wal',
-  '',
-].join('\n');
-
-/**
- * Write `.gitignore` inside the workspace directory if it does not already exist.
- */
-const writeGitignoreIfMissing = async (trailsDir: string): Promise<void> => {
-  const gitignorePath = join(trailsDir, '.gitignore');
-  const file = Bun.file(gitignorePath);
-  if (!(await file.exists())) {
-    await Bun.write(gitignorePath, GITIGNORE_CONTENT);
-  }
-};
-
-/**
- * Ensure the `.trails/` workspace directory exists with proper structure.
- *
- * Creates `config/`, `dev/`, and `generated/` subdirectories plus a
- * `.gitignore` that excludes local-only files. Safe to call repeatedly —
- * existing files are never overwritten.
- */
-export const ensureWorkspace = async (root: string): Promise<void> => {
-  const trailsDir = join(root, '.trails');
-
-  await Promise.all(
-    WORKSPACE_DIRS.map((d) => mkdir(join(trailsDir, d), { recursive: true }))
-  );
-
-  await writeGitignoreIfMissing(trailsDir);
-};

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src"
-  },
-  "include": ["src"],
-  "exclude": ["**/__tests__/**", "**/*.test.ts", "dist"]
-}

package/tsconfig.tests.json

@@ -1,10 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "noEmit": true,
-    "rootDir": "./src",
-    "types": ["bun"]
-  },
-  "include": ["src/**/*.test.ts", "src/__tests__/**/*.ts"],
-  "exclude": []
-}

package/tsconfig.tsbuildinfo

@@ -1 +0,0 @@
-{"root":["./src/app-config.ts","./src/collect.ts","./src/compose.ts","./src/config-resource.ts","./src/define-config.ts","./src/derive-fields.ts","./src/derive-provenance.ts","./src/doctor.ts","./src/extensions.ts","./src/index.ts","./src/merge.ts","./src/ref.ts","./src/registry.ts","./src/resolve.ts","./src/secret-heuristics.ts","./src/workspace.ts","./src/zod-utils.ts","./src/derive/env.ts","./src/derive/example.ts","./src/derive/helpers.ts","./src/derive/index.ts","./src/derive/json-schema.ts","./src/trails/config-check.ts","./src/trails/config-describe.ts","./src/trails/config-explain.ts","./src/trails/config-init.ts"],"version":"5.9.3"}