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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wchen.ai/env-from-example",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Interactive and non-interactive CLI to set up .env from .env.example",
   "keywords": [
     "env",
@@ -32,7 +32,7 @@
     "schema.json"
   ],
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p tsconfig.build.json",
     "prepublishOnly": "pnpm run build",
     "start": "node dist/env-from-example.js",
     "dev": "tsx env-from-example.ts",

package/dist/setup-env.js

@@ -1,473 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import crypto from 'crypto';
-import { Command } from 'commander';
-import { input, confirm, select } from '@inquirer/prompts';
-import pc from 'picocolors';
-import dotenv from 'dotenv';
-export function getRootDirFromArgv() {
-    const argv = process.argv;
-    const cwdIdx = argv.indexOf('--cwd');
-    if (cwdIdx !== -1 && argv[cwdIdx + 1]) {
-        return path.resolve(argv[cwdIdx + 1]);
-    }
-    return process.cwd();
-}
-export function parseEnvExample(rootDir) {
-    const envExamplePath = path.join(rootDir, '.env.example');
-    if (!fs.existsSync(envExamplePath)) {
-        throw new Error(`.env.example not found at ${envExamplePath}`);
-    }
-    const content = fs.readFileSync(envExamplePath, 'utf-8');
-    const lines = content.split('\n');
-    const variables = [];
-    let currentComments = [];
-    let version = null;
-    for (const line of lines) {
-        const trimmed = line.trim();
-        if (trimmed.startsWith('# ENV_SCHEMA_VERSION=')) {
-            const match = trimmed.match(/# ENV_SCHEMA_VERSION="?([^"]+)"?/);
-            if (match)
-                version = match[1];
-            continue;
-        }
-        if (trimmed.startsWith('#')) {
-            const maybeVarMatch = trimmed.match(/^#\s*([A-Z0-9_]+)=(.*)$/);
-            if (maybeVarMatch && !trimmed.includes('------')) {
-                let val = maybeVarMatch[2].trim();
-                // Remove trailing comments in the value if any (e.g., "value" # comment)
-                val = val.split(' #')[0].trim();
-                if ((val.startsWith('"') && val.endsWith('"')) || (val.startsWith("'") && val.endsWith("'"))) {
-                    val = val.slice(1, -1);
-                }
-                variables.push({
-                    key: maybeVarMatch[1],
-                    defaultValue: val,
-                    comment: currentComments.join('\n'),
-                    required: false,
-                    isCommentedOut: true,
-                });
-                currentComments = [];
-                continue;
-            }
-            if (trimmed.includes('------')) {
-                currentComments = [trimmed]; // Keep section header
-            }
-            else {
-                currentComments.push(trimmed.replace(/^#\s*/, ''));
-            }
-            continue;
-        }
-        if (!trimmed) {
-            currentComments = [];
-            continue;
-        }
-        const match = trimmed.match(/^([A-Z0-9_]+)=(.*)$/);
-        if (match) {
-            let val = match[2].trim();
-            val = val.split(' #')[0].trim(); // Remove inline comments
-            if ((val.startsWith('"') && val.endsWith('"')) || (val.startsWith("'") && val.endsWith("'"))) {
-                val = val.slice(1, -1);
-            }
-            const fullComment = currentComments.join(' ');
-            const required = fullComment.toUpperCase().includes('[REQUIRED]');
-            variables.push({
-                key: match[1],
-                defaultValue: val,
-                comment: currentComments.join('\n'),
-                required,
-                isCommentedOut: false,
-            });
-            currentComments = [];
-        }
-        else {
-            currentComments = [];
-        }
-    }
-    return { version, variables };
-}
-export function getExistingEnvVersion(content) {
-    const match = content.match(/# ENV_SCHEMA_VERSION="?([^"\n]+)"?/);
-    return match ? match[1] : null;
-}
-const SETUP_ENV_CREDIT = '# setup-env (https://www.npmjs.com/package/setup-env)';
-/** Serialize variables and optional version to .env.example content (polished format). */
-export function serializeEnvExample(version, variables) {
-    const lines = [SETUP_ENV_CREDIT, ''];
-    if (version !== null && version !== undefined) {
-        lines.push(`# ENV_SCHEMA_VERSION="${version}"`);
-        lines.push('');
-    }
-    let lastSection = '';
-    for (const v of variables) {
-        const sectionMatch = v.comment.split('\n').find((l) => l.includes('------'));
-        if (sectionMatch && sectionMatch !== lastSection) {
-            if (lines.length > 0 && lines[lines.length - 1] !== '')
-                lines.push('');
-            lines.push(sectionMatch);
-            lastSection = sectionMatch;
-        }
-        const commentLines = v.comment
-            .split('\n')
-            .filter((l) => l && !l.includes('------'));
-        for (const c of commentLines) {
-            lines.push('# ' + c.replace(/^#\s*/, ''));
-        }
-        const needsQuotes = /[\s#"']/.test(v.defaultValue) || v.defaultValue === '';
-        const value = needsQuotes && v.defaultValue !== ''
-            ? `"${v.defaultValue.replace(/"/g, '\\"')}"`
-            : v.defaultValue;
-        if (v.isCommentedOut) {
-            lines.push(`# ${v.key}=${value}`);
-        }
-        else {
-            lines.push(`${v.key}=${value}`);
-        }
-        lines.push('');
-    }
-    return lines.join('\n').replace(/\n{3,}/g, '\n\n').trimEnd() + '\n';
-}
-/** Deduplicate variables by key (keep first occurrence to preserve section order). */
-function dedupeVariables(variables) {
-    const seen = new Set();
-    return variables.filter((v) => {
-        if (seen.has(v.key))
-            return false;
-        seen.add(v.key);
-        return true;
-    });
-}
-/** Turn UPPER_SNAKE_KEY into "Upper snake key" for use as default comment. */
-function humanizeEnvKey(key) {
-    return key
-        .split('_')
-        .map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase())
-        .join(' ');
-}
-/** Ensure each variable has a comment (description), [REQUIRED] if needed, and default documented. */
-function enrichVariablesForPolish(variables) {
-    return variables.map((v) => {
-        const commentLines = v.comment
-            .split('\n')
-            .filter((l) => l && !l.includes('------'));
-        const sectionHeader = v.comment.split('\n').find((l) => l.includes('------'));
-        let description = commentLines.find((l) => !l.toUpperCase().includes('[REQUIRED]'))?.trim() || '';
-        if (!description) {
-            description = humanizeEnvKey(v.key);
-        }
-        const parts = [description];
-        if (v.required) {
-            parts.push('[REQUIRED]');
-        }
-        const defaultLabel = v.defaultValue === '' ? 'Default: (empty)' : `Default: ${v.defaultValue}`;
-        parts.push(defaultLabel);
-        const newComment = [sectionHeader, parts.join(' ').trim()]
-            .filter(Boolean)
-            .join('\n');
-        return { ...v, comment: newComment };
-    });
-}
-/** Default ENV_SCHEMA_VERSION when missing: use package.json version or "1.0.0". */
-function getDefaultSchemaVersion(rootDir) {
-    const pkgPath = path.join(rootDir, 'package.json');
-    if (fs.existsSync(pkgPath)) {
-        try {
-            const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-            if (pkg.version && typeof pkg.version === 'string') {
-                return pkg.version;
-            }
-        }
-        catch {
-            // ignore
-        }
-    }
-    return '1.0.0';
-}
-/** Polish .env.example: add ENV_SCHEMA_VERSION if missing, add comments and default docs per variable, normalize format, dedupe keys. */
-export function polishEnvExample(rootDir) {
-    const envExamplePath = path.join(rootDir, '.env.example');
-    if (!fs.existsSync(envExamplePath)) {
-        throw new Error(`.env.example not found at ${envExamplePath}`);
-    }
-    const { version, variables } = parseEnvExample(rootDir);
-    const deduped = dedupeVariables(variables);
-    const enriched = enrichVariablesForPolish(deduped);
-    const effectiveVersion = version ?? getDefaultSchemaVersion(rootDir);
-    const content = serializeEnvExample(effectiveVersion, enriched);
-    fs.writeFileSync(envExamplePath, content, 'utf-8');
-}
-/** Parse a simple semver string (e.g. "1.0.0" or "1.0") and return [major, minor, patch]. */
-function parseSemver(s) {
-    const parts = s.replace(/^v/i, '').split('.');
-    const major = Math.max(0, parseInt(parts[0] || '0', 10) || 0);
-    const minor = Math.max(0, parseInt(parts[1] || '0', 10) || 0);
-    const patch = Math.max(0, parseInt(parts[2] || '0', 10) || 0);
-    return [major, minor, patch];
-}
-/** Bump semver: patch -> 1.0.0 => 1.0.1, minor => 1.1.0, major => 2.0.0. */
-export function bumpSemver(current, bump) {
-    const [major, minor, patch] = parseSemver(current);
-    if (bump === 'major')
-        return `${major + 1}.0.0`;
-    if (bump === 'minor')
-        return `${major}.${minor + 1}.0`;
-    return `${major}.${minor}.${patch + 1}`;
-}
-/** Update ENV_SCHEMA_VERSION in .env.example and optionally package.json version. */
-export function updateEnvSchemaVersion(rootDir, newVersion, options = {}) {
-    const envExamplePath = path.join(rootDir, '.env.example');
-    if (!fs.existsSync(envExamplePath)) {
-        throw new Error(`.env.example not found at ${envExamplePath}`);
-    }
-    const { version, variables } = parseEnvExample(rootDir);
-    const content = serializeEnvExample(newVersion, variables);
-    fs.writeFileSync(envExamplePath, content, 'utf-8');
-    if (options.syncPackage) {
-        const pkgPath = path.join(rootDir, 'package.json');
-        if (fs.existsSync(pkgPath)) {
-            const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-            pkg.version = newVersion;
-            fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n', 'utf-8');
-        }
-    }
-}
-export function getExistingEnvVariables(envPath) {
-    if (fs.existsSync(envPath)) {
-        const content = fs.readFileSync(envPath, 'utf-8');
-        return dotenv.parse(content);
-    }
-    return {};
-}
-async function run() {
-    const initialRoot = getRootDirFromArgv();
-    let schemaVersion;
-    let variables;
-    try {
-        const result = parseEnvExample(initialRoot);
-        schemaVersion = result.version;
-        variables = result.variables;
-    }
-    catch (err) {
-        console.error(pc.red(err instanceof Error ? err.message : String(err)));
-        process.exit(1);
-    }
-    const program = new Command();
-    program
-        .name('setup-env')
-        .description('Interactive and non-interactive CLI to setup .env file')
-        .option('-y, --yes', 'Non-interactive mode: accept existing .env or defaults automatically')
-        .option('-f, --force', 'Force run even if .env is up-to-date')
-        .option('-e, --env <environment>', 'Target environment (e.g., local, test, production)')
-        .option('--cwd <path>', 'Project root directory (default: current working directory)')
-        .option('--polish', 'Polish .env.example (normalize format, dedupe keys, preserve sections)')
-        .option('--version [bump]', 'Bump or set ENV_SCHEMA_VERSION (patch|minor|major or exact semver like 1.2.0)')
-        .option('--sync-package', 'With --version: also set package.json version to match');
-    // Register dynamic options
-    variables.forEach((v) => {
-        const optName = `--${v.key.toLowerCase().replace(/_/g, '-')}`;
-        program.option(`${optName} <value>`, v.comment.split('\n')[0] || `Set ${v.key}`);
-    });
-    program.parse();
-    const options = program.opts();
-    if (options.polish) {
-        const root = path.resolve(options.cwd || process.cwd());
-        try {
-            polishEnvExample(root);
-            console.log(pc.green(pc.bold('✅ .env.example polished.')));
-            return;
-        }
-        catch (e) {
-            console.error(pc.red(e instanceof Error ? e.message : String(e)));
-            process.exit(1);
-        }
-    }
-    if (options.version !== undefined) {
-        const root = path.resolve(options.cwd || process.cwd());
-        try {
-            const { version } = parseEnvExample(root);
-            const current = version || '1.0.0';
-            const bump = options.version === true ? undefined : options.version;
-            let newVersion;
-            if (bump === 'patch' || bump === 'minor' || bump === 'major') {
-                newVersion = bumpSemver(current, bump);
-            }
-            else if (bump && typeof bump === 'string' && /^\d+(\.\d+)*(\.\d+)?$/.test(bump)) {
-                newVersion = bump;
-            }
-            else if (bump && typeof bump === 'string') {
-                newVersion = bump;
-            }
-            else {
-                newVersion = bumpSemver(current, 'patch');
-            }
-            updateEnvSchemaVersion(root, newVersion, { syncPackage: options.syncPackage });
-            console.log(pc.green(pc.bold(`✅ ENV_SCHEMA_VERSION set to ${newVersion}`)));
-            if (options.syncPackage) {
-                console.log(pc.gray('package.json version updated.'));
-            }
-            return;
-        }
-        catch (e) {
-            console.error(pc.red(e instanceof Error ? e.message : String(e)));
-            process.exit(1);
-        }
-    }
-    const ROOT_DIR = path.resolve(options.cwd || process.cwd());
-    if (ROOT_DIR !== initialRoot) {
-        try {
-            const result = parseEnvExample(ROOT_DIR);
-            schemaVersion = result.version;
-            variables = result.variables;
-        }
-        catch (err) {
-            console.error(pc.red(err instanceof Error ? err.message : String(err)));
-            process.exit(1);
-        }
-    }
-    console.log(pc.cyan(pc.bold('Environment Setup CLI')));
-    let targetEnv = options.env;
-    if (!targetEnv && !options.yes) {
-        const envChoice = await select({
-            message: 'Select target environment to generate:',
-            choices: [
-                { name: 'default (.env)', value: 'default' },
-                { name: 'local (.env.local)', value: 'local' },
-                { name: 'test (.env.test)', value: 'test' },
-                { name: 'staging (.env.stage)', value: 'stage' },
-                { name: 'production (.env.production)', value: 'production' },
-                { name: 'custom', value: 'custom' },
-            ],
-        });
-        if (envChoice === 'custom') {
-            targetEnv = await input({
-                message: 'Enter custom environment name (e.g., ci, demo):',
-                validate: (val) => val.trim().length > 0 || 'Environment name is required',
-            });
-        }
-        else {
-            targetEnv = envChoice === 'default' ? '' : envChoice;
-        }
-    }
-    else if (!targetEnv && options.yes) {
-        targetEnv = ''; // fallback to default in non-interactive if not specified
-    }
-    const envFileName = targetEnv ? `.env.${targetEnv}` : '.env';
-    const envPath = path.join(ROOT_DIR, envFileName);
-    const existingEnvExists = fs.existsSync(envPath);
-    const existingVars = getExistingEnvVariables(envPath);
-    let existingVersion = null;
-    if (existingEnvExists) {
-        const content = fs.readFileSync(envPath, 'utf-8');
-        existingVersion = getExistingEnvVersion(content);
-    }
-    // Check if up-to-date
-    if (existingEnvExists && existingVersion === schemaVersion && !options.force && !options.yes) {
-        const proceed = await confirm({
-            message: pc.green(`${envFileName} is already up-to-date (Version ${schemaVersion}). Do you want to re-run setup?`),
-            default: false,
-        });
-        if (!proceed) {
-            console.log(pc.gray('Exiting...'));
-            process.exit(0);
-        }
-    }
-    const finalValues = {};
-    for (const v of variables) {
-        const cliOptKey = v.key.toLowerCase().replace(/([a-z])([A-Z])/g, '$1-$2').replace(/_/g, '');
-        const providedOptValue = options[v.key.toLowerCase().replace(/_/g, '')] || options[v.key.toLowerCase()]; // Command parses --database-url to databaseUrl
-        // 1. From CLI option overrides
-        let valFromCli = null;
-        for (const opt of Object.keys(options)) {
-            if (opt.toLowerCase() === v.key.toLowerCase().replace(/_/g, '')) {
-                valFromCli = options[opt];
-                break;
-            }
-        }
-        if (valFromCli !== null && valFromCli !== undefined) {
-            finalValues[v.key] = valFromCli;
-            continue;
-        }
-        // 2. Determine default
-        let currentDefault = existingVars[v.key] ?? v.defaultValue;
-        // Auto-generate SESSION_SECRET if empty
-        if (v.key === 'SESSION_SECRET' && !currentDefault) {
-            currentDefault = crypto.randomBytes(64).toString('base64');
-        }
-        // Skip commented out variables from interactive prompt
-        if (v.isCommentedOut) {
-            finalValues[v.key] = currentDefault;
-            continue;
-        }
-        // Non-interactive Mode: take existing or default
-        if (options.yes) {
-            if (v.required && !currentDefault) {
-                console.warn(pc.yellow(`Warning: [REQUIRED] ${v.key} has no default or existing value. Please set it manually later.`));
-            }
-            finalValues[v.key] = currentDefault;
-            continue;
-        }
-        // Interactive Mode
-        console.log(''); // Blank line for readability
-        if (v.comment) {
-            console.log(pc.gray(v.comment));
-        }
-        let promptMsg = pc.cyan(`Set ${v.key}`);
-        if (v.required)
-            promptMsg = pc.bold(`${promptMsg} [REQUIRED]`);
-        const answer = await input({
-            message: promptMsg,
-            default: currentDefault,
-            validate: (value) => {
-                if (v.required && !value.trim()) {
-                    return `${v.key} is required.`;
-                }
-                return true;
-            }
-        });
-        finalValues[v.key] = answer;
-    }
-    // Construct the new .env content
-    let newEnvContent = `# ==============================================\n`;
-    newEnvContent += `# Environment Variables\n`;
-    newEnvContent += `# ==============================================\n`;
-    if (schemaVersion) {
-        newEnvContent += `# ENV_SCHEMA_VERSION="${schemaVersion}"\n`;
-    }
-    newEnvContent += `# Generated on ${new Date().toISOString()}\n`;
-    newEnvContent += `# Generated by setup-env (https://www.npmjs.com/package/setup-env)\n`;
-    newEnvContent += `# ==============================================\n\n`;
-    let lastSection = '';
-    for (const v of variables) {
-        // Attempt to parse out the section header if available in the comments
-        const sectionMatch = v.comment.split('\n').find(l => l.includes('------'));
-        if (sectionMatch && sectionMatch !== lastSection) {
-            newEnvContent += `\n${sectionMatch}\n`;
-            lastSection = sectionMatch;
-        }
-        if (finalValues[v.key]) {
-            // Quote value if it contains spaces or special characters
-            const needsQuotes = /[\s#"']/.test(finalValues[v.key]) || finalValues[v.key] === '';
-            const safeValue = needsQuotes ? `"${finalValues[v.key].replace(/"/g, '\\"')}"` : finalValues[v.key];
-            newEnvContent += `${v.key}=${safeValue}\n`;
-        }
-        else {
-            newEnvContent += `# ${v.key}=\n`;
-        }
-    }
-    fs.writeFileSync(envPath, newEnvContent, 'utf-8');
-    console.log('');
-    console.log(pc.green(pc.bold(`✅ ${envFileName} file successfully created/updated!`)));
-    if (schemaVersion) {
-        console.log(pc.gray(`Schema Version: ${schemaVersion}`));
-    }
-}
-const __filename = fileURLToPath(import.meta.url);
-const isMain = process.argv[1] && path.resolve(process.argv[1]) === path.resolve(__filename);
-if (isMain) {
-    run().catch((err) => {
-        console.error(pc.red('Error:'), err);
-        process.exit(1);
-    });
-}