@wchen.ai/env-from-example 1.0.1 → 1.0.3

package/dist/test/unit/setup-env.test.js

@@ -1,236 +0,0 @@
-import { describe, it, expect, afterEach } from 'vitest';
-import path from 'path';
-import fs from 'fs';
-import { getRootDirFromArgv, parseEnvExample, getExistingEnvVersion, getExistingEnvVariables, serializeEnvExample, polishEnvExample, bumpSemver, updateEnvSchemaVersion, } from '../../setup-env.js';
-const FIXTURES_DIR = path.resolve(__dirname, '../fixtures');
-describe('getRootDirFromArgv', () => {
-    const originalArgv = process.argv;
-    afterEach(() => {
-        process.argv = originalArgv;
-    });
-    it('returns process.cwd() when --cwd is not present', () => {
-        process.argv = ['node', 'setup-env.js'];
-        expect(getRootDirFromArgv()).toBe(process.cwd());
-    });
-    it('returns resolved path when --cwd is present with value', () => {
-        process.argv = ['node', 'setup-env.js', '--cwd', '/some/project'];
-        expect(getRootDirFromArgv()).toBe(path.resolve('/some/project'));
-    });
-    it('returns process.cwd() when --cwd is last (no value)', () => {
-        process.argv = ['node', 'setup-env.js', '--yes', '--cwd'];
-        expect(getRootDirFromArgv()).toBe(process.cwd());
-    });
-    it('returns resolved path for relative --cwd', () => {
-        process.argv = ['node', 'setup-env.js', '--cwd', './fixtures/full'];
-        const result = getRootDirFromArgv();
-        expect(path.isAbsolute(result)).toBe(true);
-        expect(result).toMatch(/fixtures[\\/]full$/);
-    });
-});
-describe('parseEnvExample', () => {
-    it('throws when .env.example does not exist', () => {
-        expect(() => parseEnvExample('/nonexistent/dir')).toThrow(/.env.example not found at/);
-    });
-    it('parses full fixture: version, sections, required, commented-out', () => {
-        const rootDir = path.join(FIXTURES_DIR, 'full');
-        const { version, variables } = parseEnvExample(rootDir);
-        expect(version).toBe('1.0');
-        const keys = variables.map((v) => v.key);
-        expect(keys).toContain('DATABASE_URL');
-        expect(keys).toContain('DATABASE_POOL_SIZE');
-        expect(keys).toContain('API_KEY');
-        expect(keys).toContain('API_SECRET');
-        expect(keys).toContain('API_BASE_URL');
-        expect(keys).toContain('NODE_ENV');
-        expect(keys).toContain('SESSION_SECRET');
-        expect(keys).toContain('FEATURE_BETA');
-        expect(keys).toContain('PORT');
-        const databaseUrl = variables.find((v) => v.key === 'DATABASE_URL');
-        expect(databaseUrl.defaultValue).toBe('postgres://localhost:5432/myapp');
-        expect(databaseUrl.required).toBe(true);
-        expect(databaseUrl.isCommentedOut).toBe(false);
-        expect(databaseUrl.comment).toMatch(/Postgres|REQUIRED/);
-        const apiBaseUrl = variables.find((v) => v.key === 'API_BASE_URL');
-        expect(apiBaseUrl.defaultValue).toBe('https://api.example.com/v1');
-        const featureBeta = variables.find((v) => v.key === 'FEATURE_BETA');
-        expect(featureBeta.isCommentedOut).toBe(true);
-        expect(featureBeta.defaultValue).toBe('false');
-        const port = variables.find((v) => v.key === 'PORT');
-        expect(port.isCommentedOut).toBe(true);
-        expect(port.defaultValue).toBe('3000');
-    });
-    it('parses minimal fixture with version', () => {
-        const rootDir = path.join(FIXTURES_DIR, 'minimal');
-        const { version, variables } = parseEnvExample(rootDir);
-        expect(version).toBe('2.0');
-        expect(variables).toHaveLength(2);
-        const nodeEnv = variables.find((v) => v.key === 'NODE_ENV');
-        expect(nodeEnv.defaultValue).toBe('development');
-        expect(nodeEnv.required).toBe(false);
-        const someKey = variables.find((v) => v.key === 'SOME_KEY');
-        expect(someKey.defaultValue).toBe('default_value');
-    });
-    it('parses required-only fixture', () => {
-        const rootDir = path.join(FIXTURES_DIR, 'required-only');
-        const { version, variables } = parseEnvExample(rootDir);
-        expect(version).toBe('1.0');
-        expect(variables).toHaveLength(1);
-        expect(variables[0].key).toBe('REQUIRED_VAR');
-        expect(variables[0].required).toBe(true);
-        expect(variables[0].defaultValue).toBe('');
-    });
-    it('parses no-version fixture: version is null', () => {
-        const rootDir = path.join(FIXTURES_DIR, 'no-version');
-        const { version, variables } = parseEnvExample(rootDir);
-        expect(version).toBeNull();
-        expect(variables).toHaveLength(2);
-        expect(variables.find((v) => v.key === 'FOO')?.defaultValue).toBe('bar');
-        expect(variables.find((v) => v.key === 'BAZ')?.defaultValue).toBe('qux');
-    });
-    it('strips inline comments from values', () => {
-        const rootDir = path.join(FIXTURES_DIR, 'full');
-        const { variables } = parseEnvExample(rootDir);
-        // API_BASE_URL has no inline comment in fixture; DATABASE_URL might have comment in some examples
-        // Check that quoted values are unquoted
-        const apiBase = variables.find((v) => v.key === 'API_BASE_URL');
-        expect(apiBase.defaultValue).toBe('https://api.example.com/v1');
-    });
-    it('preserves section headers in comment', () => {
-        const rootDir = path.join(FIXTURES_DIR, 'full');
-        const { variables } = parseEnvExample(rootDir);
-        const dbUrl = variables.find((v) => v.key === 'DATABASE_URL');
-        expect(dbUrl.comment).toMatch(/------/);
-    });
-});
-describe('getExistingEnvVersion', () => {
-    it('returns null for content without version', () => {
-        expect(getExistingEnvVersion('FOO=bar')).toBeNull();
-        expect(getExistingEnvVersion('')).toBeNull();
-    });
-    it('returns version from quoted ENV_SCHEMA_VERSION', () => {
-        const content = '# ENV_SCHEMA_VERSION="1.0"\nFOO=bar';
-        expect(getExistingEnvVersion(content)).toBe('1.0');
-    });
-    it('returns version from unquoted ENV_SCHEMA_VERSION', () => {
-        const content = '# ENV_SCHEMA_VERSION=2.0\n';
-        expect(getExistingEnvVersion(content)).toBe('2.0');
-    });
-    it('returns first match when multiple version-like lines exist', () => {
-        const content = '# ENV_SCHEMA_VERSION="1.0"\n# ENV_SCHEMA_VERSION="2.0"';
-        expect(getExistingEnvVersion(content)).toBe('1.0');
-    });
-});
-describe('getExistingEnvVariables', () => {
-    it('returns empty object when file does not exist', () => {
-        const result = getExistingEnvVariables(path.join(FIXTURES_DIR, 'nonexistent.env'));
-        expect(result).toEqual({});
-    });
-    it('parses existing .env file', () => {
-        const envPath = path.join(FIXTURES_DIR, 'full', '.env.example');
-        const result = getExistingEnvVariables(envPath);
-        expect(result).toBeDefined();
-        expect(typeof result).toBe('object');
-        expect(result.DATABASE_URL).toBe('postgres://localhost:5432/myapp');
-        expect(result.NODE_ENV).toBe('development');
-    });
-    it('returns empty object for empty or comment-only file', () => {
-        const tmpDir = path.join(FIXTURES_DIR, 'full');
-        const commentOnlyPath = path.join(tmpDir, '.env.comment-only');
-        fs.writeFileSync(commentOnlyPath, '# only comments\n\n', 'utf-8');
-        try {
-            const result = getExistingEnvVariables(commentOnlyPath);
-            expect(result).toEqual({});
-        }
-        finally {
-            try {
-                fs.unlinkSync(commentOnlyPath);
-            }
-            catch {
-                // ignore
-            }
-        }
-    });
-});
-describe('serializeEnvExample', () => {
-    it('outputs version line and variables with sections', () => {
-        const variables = [
-            {
-                key: 'FOO',
-                defaultValue: 'bar',
-                comment: '# ------ Section ------\nDescription',
-                required: false,
-                isCommentedOut: false,
-            },
-            {
-                key: 'BAZ',
-                defaultValue: 'qux',
-                comment: '',
-                required: false,
-                isCommentedOut: true,
-            },
-        ];
-        const out = serializeEnvExample('1.0', variables);
-        expect(out).toMatch(/# ENV_SCHEMA_VERSION="1.0"/);
-        expect(out).toMatch(/# ------ Section ------/);
-        expect(out).toMatch(/FOO=bar/);
-        expect(out).toMatch(/# BAZ=qux/);
-    });
-    it('outputs no version line when version is null', () => {
-        const variables = [
-            { key: 'X', defaultValue: 'y', comment: '', required: false, isCommentedOut: false },
-        ];
-        const out = serializeEnvExample(null, variables);
-        expect(out).not.toMatch(/ENV_SCHEMA_VERSION/);
-        expect(out).toMatch(/^X=y/);
-    });
-});
-describe('bumpSemver', () => {
-    it('bumps patch', () => {
-        expect(bumpSemver('1.0.0', 'patch')).toBe('1.0.1');
-        expect(bumpSemver('1.0', 'patch')).toBe('1.0.1');
-    });
-    it('bumps minor', () => {
-        expect(bumpSemver('1.0.0', 'minor')).toBe('1.1.0');
-        expect(bumpSemver('2.1', 'minor')).toBe('2.2.0');
-    });
-    it('bumps major', () => {
-        expect(bumpSemver('1.0.0', 'major')).toBe('2.0.0');
-        expect(bumpSemver('3.2.1', 'major')).toBe('4.0.0');
-    });
-});
-describe('polishEnvExample', () => {
-    it('overwrites .env.example with normalized content and dedupes keys', () => {
-        const fixtureDir = path.join(FIXTURES_DIR, 'full');
-        const envPath = path.join(fixtureDir, '.env.example');
-        const before = fs.readFileSync(envPath, 'utf-8');
-        polishEnvExample(fixtureDir);
-        const after = fs.readFileSync(envPath, 'utf-8');
-        expect(after).toMatch(/# ENV_SCHEMA_VERSION="1.0"/);
-        expect(after).toMatch(/DATABASE_URL=postgres:\/\/localhost:5432\/myapp/);
-        expect(after).toMatch(/# ------ Database ------/);
-        // Restore original so other tests and fixtures are unchanged
-        fs.writeFileSync(envPath, before, 'utf-8');
-    });
-    it('throws when .env.example does not exist', () => {
-        expect(() => polishEnvExample('/nonexistent/dir')).toThrow(/.env.example not found/);
-    });
-});
-describe('updateEnvSchemaVersion', () => {
-    it('updates ENV_SCHEMA_VERSION in .env.example', () => {
-        const fixtureDir = path.join(FIXTURES_DIR, 'minimal');
-        const envPath = path.join(fixtureDir, '.env.example');
-        const before = fs.readFileSync(envPath, 'utf-8');
-        try {
-            updateEnvSchemaVersion(fixtureDir, '3.0.0');
-            const after = fs.readFileSync(envPath, 'utf-8');
-            expect(after).toMatch(/# ENV_SCHEMA_VERSION="3.0.0"/);
-            expect(after).toMatch(/NODE_ENV=development/);
-        }
-        finally {
-            fs.writeFileSync(envPath, before, 'utf-8');
-        }
-    });
-    it('throws when .env.example does not exist', () => {
-        expect(() => updateEnvSchemaVersion('/nonexistent', '1.0.0')).toThrow(/.env.example not found/);
-    });
-});

package/dist/vitest.config.js

@@ -1,15 +0,0 @@
-import { defineConfig } from "vitest/config";
-import { resolve } from "path";
-export default defineConfig({
-    test: {
-        include: ["test/**/*.test.ts"],
-        environment: "node",
-        globals: true,
-        fileParallelism: false,
-    },
-    resolve: {
-        alias: {
-            "env-from-example": resolve(__dirname, "env-from-example.ts"),
-        },
-    },
-});