dotenv-diff 1.3.0 → 1.5.0

package/README.md

@@ -1,8 +1,6 @@
 # dotenv-diff
 
-![Terminal_view](public/image.png)
-
-Easily compare your `.env` and `.env.example` files in Node.js projects to detect missing, extra, empty, or mismatched environment variables.
+Easily compare your .env, .env.example, and other environment files (like .env.local, .env.production) to detect missing, extra, empty, or mismatched variables — and ensure they’re properly ignored by Git.
 
 [![npm version](https://img.shields.io/npm/v/dotenv-diff.svg)](https://www.npmjs.com/package/dotenv-diff)
 [![npm downloads](https://img.shields.io/npm/dt/dotenv-diff.svg)](https://www.npmjs.com/package/dotenv-diff)
@@ -26,11 +24,12 @@ pnpm add -g dotenv-diff
 ```bash
 dotenv-diff
 ```
-## Compares .env and .env.example in the current working directory and checks for:
-- Missing variables in `.env.example`
-- Extra variables in `.env`
-- Empty variables in `.env`
-- Mismatched values between `.env` and `.env.example`
+## What it checks
+dotenv-diff will automatically compare all matching .env* files in your project against .env.example, including:
+- `.env`
+- `.env.local`
+- `.env.production`
+- Any other .env.* file
 
 ## Optional: Check values too 
 
@@ -40,6 +39,17 @@ dotenv-diff --check-values
 
 When using the `--check-values` option, the tool will also compare the actual values of the variables in `.env` and `.env.example`. It will report any mismatches found and it also compares values if .env.example defines a non-empty expected value.
 
+## CI usage
+
+Run non-interactively in CI environments with:
+
+```bash
+dotenv-diff --ci     # never create files, exit 1 if required files are missing
+dotenv-diff --yes    # auto-create missing files without prompts
+```
+
+You can also use `-y` as a shorthand for `--yes`.
+
 ## Automatic file creation prompts
 
 If one of the files is missing, `dotenv-diff` will ask if you want to create it from the other:

package/dist/cli.js

@@ -19,33 +19,59 @@ program
     .name('dotenv-diff')
     .description('Compare .env and .env.example files')
     .option('--check-values', 'Compare actual values if example has values')
+    .option('--ci', 'Run non-interactively and never create files')
+    .option('-y, --yes', 'Run non-interactively and answer Yes to prompts')
     .parse(process.argv);
 const options = program.opts();
 const checkValues = options.checkValues ?? false;
+const isCiMode = Boolean(options.ci);
+const isYesMode = Boolean(options.yes);
+if (isCiMode && isYesMode) {
+    console.log(chalk.yellow('⚠️  Both --ci and --yes provided; proceeding with --yes.'));
+}
 const cwd = process.cwd();
-const envPath = path.resolve(cwd, '.env');
-const examplePath = path.resolve(cwd, '.env.example');
+const envFiles = fs
+    .readdirSync(cwd)
+    .filter((f) => f.startsWith('.env') && !f.startsWith('.env.example'))
+    .sort((a, b) => (a === '.env' ? -1 : b === '.env' ? 1 : a.localeCompare(b)));
+// Brug første .env* fil som "main" hvis flere findes
+// (resten håndteres senere i et loop)
+const primaryEnv = envFiles.includes('.env') ? '.env' : envFiles[0] || '.env';
+const primaryExample = '.env.example';
+const envPath = path.resolve(cwd, primaryEnv);
+const examplePath = path.resolve(cwd, primaryExample);
 const envExists = fs.existsSync(envPath);
 const exampleExists = fs.existsSync(examplePath);
-// Case 1: Neither file exists
-if (!envExists && !exampleExists) {
-    console.log(chalk.yellow('⚠️  No .env or .env.example file found. Skipping comparison.'));
+// Case 1: No env files and no .env.example → nothing to do
+if (envFiles.length === 0 && !exampleExists) {
+    console.log(chalk.yellow('⚠️  No .env* or .env.example file found. Skipping comparison.'));
     process.exit(0);
 }
 // Case 2: .env is missing but .env.example exists
 if (!envExists && exampleExists) {
     console.log(chalk.yellow('📄 .env file not found.'));
-    const response = await prompts({
-        type: 'select',
-        name: 'createEnv',
-        message: '❓ Do you want to create a new .env file from .env.example?',
-        choices: [
-            { title: 'Yes', value: true },
-            { title: 'No', value: false }
-        ],
-        initial: 0
-    });
-    if (!response.createEnv) {
+    let createEnv = false;
+    if (isYesMode) {
+        createEnv = true;
+    }
+    else if (isCiMode) {
+        console.log(chalk.gray('🚫 Skipping .env creation (CI mode).'));
+        process.exit(1);
+    }
+    else {
+        const response = await prompts({
+            type: 'select',
+            name: 'createEnv',
+            message: '❓ Do you want to create a new .env file from .env.example?',
+            choices: [
+                { title: 'Yes', value: true },
+                { title: 'No', value: false },
+            ],
+            initial: 0,
+        });
+        createEnv = Boolean(response.createEnv);
+    }
+    if (!createEnv) {
         console.log(chalk.gray('🚫 Skipping .env creation.'));
         process.exit(0);
     }
@@ -57,21 +83,33 @@ if (!envExists && exampleExists) {
 // Case 3: .env exists, but .env.example is missing
 if (envExists && !exampleExists) {
     console.log(chalk.yellow('📄 .env.example file not found.'));
-    const response = await prompts({
-        type: 'select',
-        name: 'createExample',
-        message: '❓ Do you want to create a new .env.example file from .env?',
-        choices: [
-            { title: 'Yes', value: true },
-            { title: 'No', value: false }
-        ],
-        initial: 0
-    });
-    if (!response.createExample) {
+    let createExample = false;
+    if (isYesMode) {
+        createExample = true;
+    }
+    else if (isCiMode) {
+        console.log(chalk.gray('🚫 Skipping .env.example creation (CI mode).'));
+        process.exit(1);
+    }
+    else {
+        const response = await prompts({
+            type: 'select',
+            name: 'createExample',
+            message: '❓ Do you want to create a new .env.example file from .env?',
+            choices: [
+                { title: 'Yes', value: true },
+                { title: 'No', value: false },
+            ],
+            initial: 0,
+        });
+        createExample = Boolean(response.createExample);
+    }
+    if (!createExample) {
         console.log(chalk.gray('🚫 Skipping .env.example creation.'));
         process.exit(0);
     }
-    const envContent = fs.readFileSync(envPath, 'utf-8')
+    const envContent = fs
+        .readFileSync(envPath, 'utf-8')
         .split('\n')
         .map((line) => {
         const trimmed = line.trim();
@@ -89,38 +127,60 @@ if (!fs.existsSync(envPath) || !fs.existsSync(examplePath)) {
     console.error(chalk.red('❌ Error: .env or .env.example is missing after setup.'));
     process.exit(1);
 }
-// Case 5: Both files exist, proceed with comparison
-warnIfEnvNotIgnored();
-console.log(chalk.bold('🔍 Comparing .env and .env.example...\n'));
-const current = parseEnvFile(envPath);
-const example = parseEnvFile(examplePath);
-const diff = diffEnv(current, example, checkValues);
-const emptyKeys = Object.entries(current)
-    .filter(([, value]) => value.trim() === '')
-    .map(([key]) => key);
-if (diff.missing.length === 0 &&
-    diff.extra.length === 0 &&
-    emptyKeys.length === 0 &&
-    diff.valueMismatches.length === 0) {
-    console.log(chalk.green('✅ All keys match! Your .env file is valid.'));
-    process.exit(0);
-}
-if (diff.missing.length > 0) {
-    console.log(chalk.red('\n❌ Missing keys in .env:'));
-    diff.missing.forEach((key) => console.log(chalk.red(`  - ${key}`)));
-}
-if (diff.extra.length > 0) {
-    console.log(chalk.yellow('\n⚠️  Extra keys in .env (not defined in .env.example):'));
-    diff.extra.forEach((key) => console.log(chalk.yellow(`  - ${key}`)));
-}
-if (emptyKeys.length > 0) {
-    console.log(chalk.yellow('\n⚠️  The following keys in .env have no value (empty):'));
-    emptyKeys.forEach((key) => console.log(chalk.yellow(`  - ${key}`)));
-}
-if (checkValues && diff.valueMismatches.length > 0) {
-    console.log(chalk.yellow('\n⚠️  The following keys have different values:'));
-    diff.valueMismatches.forEach(({ key, expected, actual }) => {
-        console.log(chalk.yellow(`  - ${key}: expected '${expected}', but got '${actual}'`));
+// Case 5: Compare all found .env* files
+let exitWithError = false;
+for (const envName of envFiles.length > 0 ? envFiles : [primaryEnv]) {
+    const suffix = envName === '.env' ? '' : envName.replace('.env', '');
+    const exampleName = suffix ? `.env.example${suffix}` : primaryExample;
+    const envPathCurrent = path.resolve(cwd, envName);
+    const examplePathCurrent = fs.existsSync(path.resolve(cwd, exampleName))
+        ? path.resolve(cwd, exampleName)
+        : examplePath;
+    if (!fs.existsSync(envPathCurrent) || !fs.existsSync(examplePathCurrent)) {
+        console.log(chalk.bold(`🔍 Comparing ${envName} ↔ ${path.basename(examplePathCurrent)}...`));
+        console.log(chalk.yellow('  ⚠️  Skipping: missing matching example file.'));
+        console.log();
+        continue;
+    }
+    console.log(chalk.bold(`🔍 Comparing ${envName} ↔ ${path.basename(examplePathCurrent)}...`));
+    warnIfEnvNotIgnored({
+        cwd,
+        envFile: envName,
+        log: (msg) => console.log(msg.replace(/^/gm, '  ')),
     });
+    const current = parseEnvFile(envPathCurrent);
+    const example = parseEnvFile(examplePathCurrent);
+    const diff = diffEnv(current, example, checkValues);
+    const emptyKeys = Object.entries(current)
+        .filter(([, value]) => (value ?? '').trim() === '')
+        .map(([key]) => key);
+    if (diff.missing.length === 0 &&
+        diff.extra.length === 0 &&
+        emptyKeys.length === 0 &&
+        diff.valueMismatches.length === 0) {
+        console.log(chalk.green('  ✅ All keys match.'));
+        console.log();
+        continue;
+    }
+    if (diff.missing.length > 0) {
+        exitWithError = true;
+        console.log(chalk.red('  ❌ Missing keys:'));
+        diff.missing.forEach((key) => console.log(chalk.red(`      - ${key}`)));
+    }
+    if (diff.extra.length > 0) {
+        console.log(chalk.yellow('  ⚠️  Extra keys (not in example):'));
+        diff.extra.forEach((key) => console.log(chalk.yellow(`      - ${key}`)));
+    }
+    if (emptyKeys.length > 0) {
+        console.log(chalk.yellow('  ⚠️  Empty values:'));
+        emptyKeys.forEach((key) => console.log(chalk.yellow(`      - ${key}`)));
+    }
+    if (checkValues && diff.valueMismatches.length > 0) {
+        console.log(chalk.yellow('  ⚠️  Value mismatches:'));
+        diff.valueMismatches.forEach(({ key, expected, actual }) => {
+            console.log(chalk.yellow(`      - ${key}: expected '${expected}', but got '${actual}'`));
+        });
+    }
+    console.log(); // blank line efter sektionen med findings
 }
-process.exit(diff.missing.length > 0 ? 1 : 0);
+process.exit(exitWithError ? 1 : 0);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotenv-diff",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "type": "module",
   "description": "A small CLI and library to find differences between .env and .env.example files.",
   "bin": {
@@ -18,7 +18,7 @@
     "dev": "vitest --watch",
     "test": "vitest",
     "lint": "eslint ./src --ext .ts",
-    "format": "prettier --write ./src/**/*.ts",
+    "format": "prettier --write \"src/**/*.ts\" \"src/*.ts\"",
     "start": "node dist/cli.js"
   },
   "author": "Chrilleweb",