fix flag for .env not ignored på .gitignore

Author: Chrilleweb

CHANGELOG.md

@@ -12,6 +12,13 @@ This project follows [Keep a Changelog](https://keepachangelog.com/) and [Semant
 ### Fixed
 -
 
+## [2.2.8] - 2025-09-30
+### Added
+- Fix .env is not ignored by git when using --fix flag.
+
+### Changed
+- No breaking changes.
+
 ## [2.2.7] - 2025-09-28
 ### Added
 - Added warning on .env not ignored by .gitignore on default.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotenv-diff",
-  "version": "2.2.7",
+  "version": "2.2.8",
   "type": "module",
   "description": "Scan your codebase to find environment variables in use.",
   "bin": {

src/commands/compare.ts

@@ -3,7 +3,7 @@ import path from 'path';
 import chalk from 'chalk';
 import { parseEnvFile } from '../core/parseEnv.js';
 import { diffEnv } from '../core/diffEnv.js';
-import { warnIfEnvNotIgnored } from '../services/git.js';
+import { warnIfEnvNotIgnored, isEnvIgnoredByGit } from '../services/git.js';
 import { findDuplicateKeys } from '../services/duplicates.js';
 import { filterIgnoredKeys } from '../core/filterIgnoredKeys.js';
 import type { Category, CompareJsonEntry } from '../config/types.js';
@@ -73,13 +73,15 @@ export async function compareMany(
 
     // Git ignore hint (only when not JSON)
     let gitignoreUnsafe = false;
+    let gitignoreMsg: string | null = null;
+
     if (run('gitignore')) {
       warnIfEnvNotIgnored({
         cwd: opts.cwd,
         envFile: envName,
         log: (msg) => {
           gitignoreUnsafe = true;
-          if (!opts.json) console.log(msg.replace(/^/gm, '  '));
+          gitignoreMsg = msg;
         },
       });
     }
@@ -295,17 +297,61 @@ export async function compareMany(
         );
         console.log();
       }
+      if (gitignoreMsg && !opts.json) {
+        console.log((gitignoreMsg as string).replace(/^/gm, '  '));
+      }
     }
 
     if (!opts.json && !opts.fix) {
+      const ignored = isEnvIgnoredByGit({ cwd: opts.cwd, envFile: '.env' });
+      const envNotIgnored = ignored === false || ignored === null;
       if (
-        filtered.missing.length ||
-        filtered.duplicatesEnv.length ||
-        filtered.duplicatesEx.length
+        filtered.missing.length > 0 &&
+        filtered.duplicatesEnv.length > 0 &&
+        envNotIgnored
+      ) {
+        console.log(
+          chalk.gray(
+            '💡 Tip: Run with `--fix` to add missing keys, remove duplicates and add .env to .gitignore',
+          ),
+        );
+        console.log();
+      } else if (
+        filtered.missing.length > 0 &&
+        filtered.duplicatesEnv.length > 0
       ) {
         console.log(
           chalk.gray(
-            '💡 Tip: Run with `--fix` to automatically add missing keys and remove duplicates.',
+            '💡 Tip: Run with `--fix` to add missing keys and remove duplicates',
+          ),
+        );
+        console.log();
+      } else if (filtered.duplicatesEnv.length > 0 && envNotIgnored) {
+        console.log(
+          chalk.gray(
+            '💡 Tip: Run with `--fix` to remove duplicate keys and add .env to .gitignore',
+          ),
+        );
+        console.log();
+      } else if (filtered.missing.length > 0 && envNotIgnored) {
+        console.log(
+          chalk.gray(
+            '💡 Tip: Run with `--fix` to add missing keys and add .env to .gitignore',
+          ),
+        );
+        console.log();
+      } else if (filtered.missing.length > 0) {
+        console.log(chalk.gray('💡 Tip: Run with `--fix` to add missing keys'));
+        console.log();
+      } else if (filtered.duplicatesEnv.length > 0) {
+        console.log(
+          chalk.gray('💡 Tip: Run with `--fix` to remove duplicate keys'),
+        );
+        console.log();
+      } else if (envNotIgnored) {
+        console.log(
+          chalk.gray(
+            '💡 Tip: Run with `--fix` to ensure .env is added to .gitignore',
           ),
         );
         console.log();

src/commands/scanUsage.ts

@@ -12,6 +12,7 @@ import { createJsonOutput } from '../core/scanJsonOutput.js';
 import { findDuplicateKeys } from '../services/duplicates.js';
 import { compareWithEnvFiles } from '../core/compareScan.js';
 import { applyFixes } from '../core/fixEnv.js';
+import { isEnvIgnoredByGit } from '../services/git.js';
 
 /**
  * Scans codebase for environment variable usage and compares with .env file
@@ -46,9 +47,9 @@ export async function scanUsage(
   // Recalculate stats after filtering out commented usages
   const uniqueVariables = new Set(scanResult.used.map((u) => u.variable)).size;
   scanResult.stats = {
-    filesScanned: scanResult.stats.filesScanned, // Keep original files scanned count
+    filesScanned: scanResult.stats.filesScanned,
     totalUsages: scanResult.used.length,
-    uniqueVariables: uniqueVariables,
+    uniqueVariables,
   };
 
   // If user explicitly passed --example but the file doesn't exist:
@@ -59,7 +60,6 @@ export async function scanUsage(
     if (missing) {
       const msg = `❌ Missing specified example file: ${opts.examplePath}`;
       if (opts.isCiMode) {
-        // IMPORTANT: stdout (console.log), not stderr, to satisfy the test
         console.log(chalk.red(msg));
         return { exitWithError: true };
       } else if (!opts.json) {
@@ -81,6 +81,7 @@ export async function scanUsage(
   let fixApplied = false;
   let fixedKeys: string[] = [];
   let removedDuplicates: string[] = [];
+  let gitignoreUpdated = false;
 
   if (compareFile) {
     try {
@@ -131,14 +132,15 @@ export async function scanUsage(
           if (changed) {
             fixApplied = true;
             removedDuplicates = result.removedDuplicates;
+            gitignoreUpdated = gitignoreUpdated || result.gitignoreUpdated;
             // Clear duplicates after fix
             duplicatesFound = false;
             dupsEnv = [];
             dupsExample = [];
           }
         }
 
-        // Add to scan result for both JSON and console output (only if not fixed)
+        // Keep duplicates for output if not fixed
         if (
           (dupsEnv.length > 0 || dupsExample.length > 0) &&
           (!opts.fix || !fixApplied)
@@ -151,65 +153,55 @@ export async function scanUsage(
       }
     } catch (error) {
       const errorMessage = `⚠️  Could not read ${compareFile.name}: ${compareFile.path} - ${error}`;
-
       if (opts.isCiMode) {
-        // In CI mode, exit with error if file doesn't exist
         console.log(chalk.red(`❌ ${errorMessage}`));
         return { exitWithError: true };
       }
-
-      if (!opts.json) {
-        console.log(chalk.yellow(errorMessage));
-      }
+      if (!opts.json) console.log(chalk.yellow(errorMessage));
     }
   }
 
-  // Apply missing keys fix if --fix is enabled (but don't show message yet)
+  // Apply missing keys fix with applyFixes (so gitignore is handled too)
   if (opts.fix && compareFile) {
     const missingKeys = scanResult.missing;
-
     if (missingKeys.length > 0) {
       const envFilePath = compareFile.path;
       const exampleFilePath = opts.examplePath
         ? resolveFromCwd(opts.cwd, opts.examplePath)
-        : null;
+        : '';
 
-      // Append missing keys to .env
-      const content = fs.readFileSync(envFilePath, 'utf-8');
-      const newContent =
-        content +
-        (content.endsWith('\n') ? '' : '\n') +
-        missingKeys.map((k) => `${k}=`).join('\n') +
-        '\n';
-      fs.writeFileSync(envFilePath, newContent);
+      const { changed, result } = applyFixes({
+        envPath: envFilePath,
+        examplePath: exampleFilePath,
+        missingKeys,
+        duplicateKeys: [],
+      });
 
-      // Append to .env.example if it exists
-      if (exampleFilePath && fs.existsSync(exampleFilePath)) {
-        const exContent = fs.readFileSync(exampleFilePath, 'utf-8');
-        const existingExKeys = new Set(
-          exContent
-            .split('\n')
-            .map((l) => l.trim().split('=')[0])
-            .filter(Boolean),
-        );
-        const newKeys = missingKeys.filter((k) => !existingExKeys.has(k));
-        if (newKeys.length) {
-          const newExContent =
-            exContent +
-            (exContent.endsWith('\n') ? '' : '\n') +
-            newKeys.join('\n') +
-            '\n';
-          fs.writeFileSync(exampleFilePath, newExContent);
-        }
+      if (changed) {
+        fixApplied = true;
+        fixedKeys = result.addedEnv;
+        gitignoreUpdated = gitignoreUpdated || result.gitignoreUpdated;
+        scanResult.missing = [];
       }
+    }
+  }
 
+    // Always run a gitignore-only fix when --fix is set (even if no missing/duplicates)
+  if (opts.fix && compareFile) {
+    const { result } = applyFixes({
+      envPath: compareFile.path,
+      examplePath: '',
+      missingKeys: [],
+      duplicateKeys: [],
+    });
+    if (result.gitignoreUpdated) {
       fixApplied = true;
-      fixedKeys = missingKeys;
-      scanResult.missing = [];
+      gitignoreUpdated = true;
     }
   }
 
-  // Prepare JSON output
+
+  // JSON output
   if (opts.json) {
     const jsonOutput = createJsonOutput(
       scanResult,
@@ -235,7 +227,7 @@ export async function scanUsage(
   // Console output
   const result = outputToConsole(scanResult, opts, comparedAgainst);
 
-  // Show consolidated fix message at the bottom (after all other output)
+  // Consolidated fix message
   if (opts.fix && !opts.json) {
     if (fixApplied) {
       console.log(chalk.green('✅ Auto-fix applied:'));
@@ -265,7 +257,9 @@ export async function scanUsage(
           );
         }
       }
-
+      if (gitignoreUpdated) {
+        console.log(chalk.green('   - Added .env ignore rules to .gitignore'));
+      }
       console.log();
     } else {
       console.log(chalk.green('✅ Auto-fix applied: no changes needed.'));
@@ -274,6 +268,8 @@ export async function scanUsage(
   }
 
   if (!opts.json && !opts.fix) {
+    const ignored = isEnvIgnoredByGit({ cwd: opts.cwd, envFile: '.env' });
+    const envNotIgnored = ignored === false || ignored === null;
     if (scanResult.missing.length > 0 && duplicatesFound) {
       console.log(
         chalk.gray(
@@ -289,6 +285,13 @@ export async function scanUsage(
         chalk.gray('💡 Tip: Run with `--fix` to remove duplicate keys'),
       );
       console.log();
+    } else if (envNotIgnored) {
+      console.log(
+        chalk.gray(
+          '💡 Tip: Run with `--fix` to ensure .env is added to .gitignore',
+        ),
+      );
+      console.log();
     }
   }
 

src/core/fixEnv.ts

@@ -1,4 +1,6 @@
 import fs from 'fs';
+import path from 'path';
+import { isEnvIgnoredByGit, isGitRepo, findGitRoot } from '../services/git.js';
 
 /**
  * Applies fixes to the .env and .env.example files based on the detected issues.
@@ -23,6 +25,7 @@ export function applyFixes({
     removedDuplicates: [] as string[],
     addedEnv: [] as string[],
     addedExample: [] as string[],
+    gitignoreUpdated: false as boolean,
   };
 
   // --- Remove duplicates ---
@@ -44,7 +47,7 @@ export function applyFixes({
       newLines.unshift(line);
     }
     fs.writeFileSync(envPath, newLines.join('\n'));
-    result.removedDuplicates = duplicateKeys; // save all dupe keys
+    result.removedDuplicates = duplicateKeys;
   }
 
   // --- Add missing keys to .env ---
@@ -56,7 +59,7 @@ export function applyFixes({
       missingKeys.map((k) => `${k}=`).join('\n') +
       '\n';
     fs.writeFileSync(envPath, newContent);
-    result.addedEnv = missingKeys; // save all missing keys
+    result.addedEnv = missingKeys;
   }
 
   // --- Add missing keys to .env.example ---
@@ -76,14 +79,51 @@ export function applyFixes({
         newExampleKeys.join('\n') +
         '\n';
       fs.writeFileSync(examplePath, newExContent);
-      result.addedExample = newExampleKeys; // save all keys actually added
+      result.addedExample = newExampleKeys;
     }
   }
 
+  // --- Ensure .env is ignored in gitignore (best-effort; write at git root) ---
+  try {
+    const startDir = path.dirname(envPath);
+    const gitRoot = findGitRoot(startDir);
+    if (gitRoot && isGitRepo(gitRoot)) {
+      const gitignorePath = path.join(gitRoot, '.gitignore');
+      // Check against the actual file name (".env" or custom)
+      const envFileName = path.basename(envPath);
+      const ignored = isEnvIgnoredByGit({ cwd: gitRoot, envFile: envFileName });
+
+      if (ignored === false || ignored === null) {
+        const entry = '.env\n.env.*\n';
+        if (fs.existsSync(gitignorePath)) {
+          const current = fs.readFileSync(gitignorePath, 'utf8');
+          // Avoid duplicate entries
+          const hasDotEnv = current.split(/\r?\n/).some((l) => l.trim() === '.env');
+          const hasDotEnvStar = current.split(/\r?\n/).some((l) => l.trim() === '.env.*');
+          const pieces: string[] = [];
+          if (!hasDotEnv) pieces.push('.env');
+          if (!hasDotEnvStar) pieces.push('.env.*');
+
+          if (pieces.length) {
+            const toAppend = `${current.endsWith('\n') ? '' : '\n'}${pieces.join('\n')}\n`;
+            fs.appendFileSync(gitignorePath, toAppend);
+            result.gitignoreUpdated = true;
+          }
+        } else {
+          fs.writeFileSync(gitignorePath, entry);
+          result.gitignoreUpdated = true;
+        }
+      }
+    }
+  } catch {
+    // ignore errors - non-blocking DX
+  }
+
   const changed =
     result.removedDuplicates.length > 0 ||
     result.addedEnv.length > 0 ||
-    result.addedExample.length > 0;
+    result.addedExample.length > 0 ||
+    result.gitignoreUpdated;
 
   return { changed, result };
 }