Fix: Fixed bug in --fix for compare mode (#251)

* chore: removed unused code

* fix: fixed bug in --fix for compare mode

Author: Chrilleweb

src/commands/compare.ts

@@ -129,7 +129,14 @@ export async function compareMany(
     }
 
     // Print duplicates
-    printDuplicates(envName, exampleName, dupsEnv, dupsEx, opts.json ?? false);
+    printDuplicates(
+      envName,
+      exampleName,
+      dupsEnv,
+      dupsEx,
+      opts.json ?? false,
+      opts.fix ?? false,
+    );
 
     // Calculate stats for JSON entry
     const stats = calculateStats(
@@ -160,9 +167,9 @@ export async function compareMany(
     }
 
     // Print all issues
-    printIssues(filtered, opts.json ?? false);
+    printIssues(filtered, opts.json ?? false, opts.fix ?? false);
 
-    if (filtered.gitignoreIssue && !opts.json) {
+    if (filtered.gitignoreIssue && !opts.json && !opts.fix) {
       printGitignoreWarning({
         envFile: envName,
         reason: filtered.gitignoreIssue.reason,
@@ -182,7 +189,6 @@ export async function compareMany(
     if (opts.fix) {
       const { changed, result } = applyFixes({
         envPath,
-        examplePath,
         missingKeys: filtered.missing,
         duplicateKeys: dupsEnv.map((d) => d.key),
         ensureGitignore: hasGitignoreIssue,

src/core/fixEnv.ts

@@ -8,7 +8,6 @@ import { DEFAULT_GITIGNORE_ENV_PATTERNS } from '../config/constants.js';
  */
 interface ApplyFixesOptions {
   envPath: string;
-  examplePath: string;
   missingKeys: string[];
   duplicateKeys: string[];
   ensureGitignore?: boolean;
@@ -20,17 +19,15 @@ interface ApplyFixesOptions {
 interface FixResult {
   removedDuplicates: string[];
   addedEnv: string[];
-  addedExample: string[];
   gitignoreUpdated: boolean;
 }
 
 /**
- * Applies fixes to the .env and .env.example files based on the detected issues.
+ * Applies fixes to the .env file based on the detected issues.
  *
  * This function will:
  * - Remove duplicate keys from .env (keeping the last occurrence)
- * - Add missing keys to .env with empty values
- * - Add missing keys to .env.example (if not already present)
+ * - Add missing keys to .env file (with empty values)
  * - Ensure .env is ignored in .gitignore (if in a git repo and ensureGitignore is true)
  *
  * @param options - Fix options including file paths and keys to fix
@@ -42,7 +39,6 @@ export function applyFixes(options: ApplyFixesOptions): {
 } {
   const {
     envPath,
-    examplePath,
     missingKeys = [],
     duplicateKeys = [],
     ensureGitignore = false,
@@ -51,7 +47,6 @@ export function applyFixes(options: ApplyFixesOptions): {
   const result: FixResult = {
     removedDuplicates: [],
     addedEnv: [],
-    addedExample: [],
     gitignoreUpdated: false,
   };
 
@@ -94,29 +89,6 @@ export function applyFixes(options: ApplyFixesOptions): {
     fs.writeFileSync(envPath, newContent);
     result.addedEnv = missingKeys;
   }
-
-  // --- Add missing keys to .env.example ---
-  if (examplePath && missingKeys.length) {
-    const exContent = fs.readFileSync(examplePath, 'utf-8');
-    const existingExKeys = new Set(
-      exContent
-        .split('\n')
-        .map((l) => l.trim().split('=')[0])
-        .filter(Boolean),
-    );
-    const newExampleKeys = missingKeys.filter((k) => !existingExKeys.has(k));
-
-    if (newExampleKeys.length) {
-      const newExContent =
-        exContent +
-        (exContent.endsWith('\n') ? '' : '\n') +
-        newExampleKeys.join('\n') +
-        '\n';
-      fs.writeFileSync(examplePath, newExContent);
-      result.addedExample = newExampleKeys;
-    }
-  }
-
   // --- Ensure .env is ignored in .gitignore ---
   if (ensureGitignore) {
     result.gitignoreUpdated = updateGitignoreForEnv(envPath);
@@ -125,7 +97,6 @@ export function applyFixes(options: ApplyFixesOptions): {
   const changed =
     result.removedDuplicates.length > 0 ||
     result.addedEnv.length > 0 ||
-    result.addedExample.length > 0 ||
     result.gitignoreUpdated;
 
   return { changed, result };

src/services/printScanResult.ts

@@ -196,7 +196,6 @@ export function printScanResult(
       {
         removedDuplicates: fixContext.removedDuplicates,
         addedEnv: fixContext.addedEnv,
-        addedExample: opts.examplePath ? fixContext.addedEnv : [],
       },
       comparedAgainst || DEFAULT_ENV_FILE,
       opts.examplePath ? path.basename(opts.examplePath) : 'example file',

src/services/processComparisonFile.ts

@@ -29,7 +29,6 @@ interface ProcessComparisonResult {
   fixApplied: boolean;
   removedDuplicates: string[];
   addedEnv: string[];
-  addedExample: string[];
   gitignoreUpdated: boolean;
   exampleFull?: Record<string, string> | undefined;
   uppercaseWarnings?: UppercaseWarning[];
@@ -62,7 +61,6 @@ export function processComparisonFile(
   let fixApplied = false;
   let removedDuplicates: string[] = [];
   let addedEnv: string[] = [];
-  let addedExample: string[] = [];
   let gitignoreUpdated = false;
   let exampleFull: Record<string, string> | undefined = undefined;
   let uppercaseWarnings: UppercaseWarning[] = [];
@@ -138,9 +136,6 @@ export function processComparisonFile(
     ) {
       const { changed, result } = applyFixes({
         envPath: compareFile.path,
-        examplePath: opts.examplePath
-          ? resolveFromCwd(opts.cwd, opts.examplePath)
-          : '',
         missingKeys: scanResult.missing,
         duplicateKeys: dupsEnv.map((d) => d.key),
         ensureGitignore: true,
@@ -150,7 +145,6 @@ export function processComparisonFile(
         fixApplied = true;
         removedDuplicates = result.removedDuplicates;
         addedEnv = result.addedEnv;
-        addedExample = result.addedExample;
         gitignoreUpdated = result.gitignoreUpdated;
 
         scanResult.missing = [];
@@ -178,7 +172,6 @@ export function processComparisonFile(
       fixApplied,
       removedDuplicates,
       addedEnv,
-      addedExample,
       gitignoreUpdated,
       exampleFull,
       uppercaseWarnings,
@@ -201,7 +194,6 @@ export function processComparisonFile(
     fixApplied,
     removedDuplicates,
     addedEnv,
-    addedExample,
     gitignoreUpdated,
     exampleFull,
     uppercaseWarnings,

src/ui/compare/printIssues.ts

@@ -5,11 +5,16 @@ import type { Filtered } from '../../config/types.js';
  * Prints the issues found during the comparison.
  * @param filtered The filtered comparison results.
  * @param json Whether to output in JSON format.
+ * @param fix Whether fix mode is enabled (skips printing missing keys as they will be fixed).
  * @returns void
  */
-export function printIssues(filtered: Filtered, json: boolean): void {
+export function printIssues(
+  filtered: Filtered,
+  json: boolean,
+  fix = false,
+): void {
   if (json) return;
-  if (filtered.missing.length) {
+  if (filtered.missing.length && !fix) {
     const header = chalk.red('❌ Missing keys:');
     console.log(header);
     filtered.missing.forEach((key) => console.log(chalk.red(`  - ${key}`)));

src/ui/shared/printAutoFix.ts

@@ -3,7 +3,6 @@ import chalk from 'chalk';
 interface AutoFixResult {
   removedDuplicates: string[];
   addedEnv: string[];
-  addedExample: string[];
 }
 
 /**
@@ -41,13 +40,6 @@ export function printAutoFix(
         ),
       );
     }
-    if (result.addedExample.length && !result.addedEnv.length) {
-      console.log(
-        chalk.green(
-          `  - Synced ${result.addedExample.length} keys to ${exampleName}: ${result.addedExample.join(', ')}`,
-        ),
-      );
-    }
     if (gitignoreUpdated) {
       console.log(chalk.green(`  - Added ${envName} to .gitignore`));
     }

src/ui/shared/printDuplicates.ts

@@ -7,6 +7,7 @@ import chalk from 'chalk';
  * @param dEnv Array of duplicate keys in the environment file with their counts.
  * @param dEx Array of duplicate keys in the example file with their counts.
  * @param json Whether to output in JSON format.
+ * @param fix Whether fix mode is enabled (skips printing duplicates as they will be fixed).
  * @returns void
  */
 export function printDuplicates(
@@ -15,9 +16,10 @@ export function printDuplicates(
   dEnv: Array<{ key: string; count: number }>,
   dEx: Array<{ key: string; count: number }>,
   json: boolean,
+  fix = false,
 ): void {
   if (json) return;
-  if (dEnv.length) {
+  if (dEnv.length && !fix) {
     console.log(
       chalk.yellow(`⚠️  Duplicate keys in ${envName} (last occurrence wins):`),
     );

test/e2e/cli.flags.e2e.test.ts

@@ -258,7 +258,7 @@ describe('duplicate detection', () => {
   it('will detect duplicates in scan mode', () => {
     const cwd = tmpDir();
     fs.writeFileSync(path.join(cwd, '.env'), 'A=1\nA=2\nC=3\n');
-        fs.writeFileSync(
+    fs.writeFileSync(
       path.join(cwd, 'app.js'),
       `
       const api = process.env.A;
@@ -376,6 +376,40 @@ describe('duplicate detection', () => {
       expect(output.stats).toBeDefined();
     });
   });
+
+  it('when adding missing keys, remove duplicates and add .env til gitignore dont print issues', () => {
+    const cwd = tmpDir();
+    fs.writeFileSync(
+      path.join(cwd, '.env'),
+      'EXISTING=value\nEXISTING=value2\n',
+    );
+    fs.writeFileSync(
+      path.join(cwd, 'app.js'),
+      `
+            const newVar = process.env.NEW_VAR;
+          `,
+    );
+
+    const res = runCli(cwd, ['--scan-usage', '--fix']);
+    expect(res.status).toBe(0);
+    expect(res.stdout).toContain('Auto-fix applied');
+    expect(res.stdout).toContain('Added 1 missing keys to .env');
+    expect(res.stdout).toContain('Removed 1 duplicate keys from .env');
+  });
+
+  it('when adding missing keys, remove duplicates and add .env til gitignore dont print issues in --compare', () => {
+    const cwd = tmpDir();
+    fs.writeFileSync(
+      path.join(cwd, '.env'),
+      'EXISTING=value\nEXISTING=value2\n',
+    );
+    fs.writeFileSync(path.join(cwd, '.env.example'), 'EXISTING=\nNEW_KEY=\n');
+    const res = runCli(cwd, ['--compare', '--fix']);
+    expect(res.stdout).toContain('Auto-fix applied');
+    expect(res.stdout).toContain('Added 1 missing keys to .env');
+    expect(res.stdout).toContain('Removed 1 duplicate keys from .env');
+  });
+
   it('does not duplicate keys in .env.example when they already exist', () => {
     const cwd = tmpDir();
     fs.writeFileSync(path.join(cwd, '.env'), 'EXISTING=value\n');

test/unit/commands/compare.test.ts

@@ -220,6 +220,7 @@ describe('compareMany', () => {
         missing: ['KEY3'],
       }),
       false,
+      false,
     );
   });
 
@@ -240,6 +241,7 @@ describe('compareMany', () => {
         extra: ['EXTRA_KEY'],
       }),
       false,
+      false,
     );
   });
 
@@ -261,6 +263,7 @@ describe('compareMany', () => {
         empty: ['KEY1'],
       }),
       false,
+      false,
     );
   });
 
@@ -286,6 +289,7 @@ describe('compareMany', () => {
       [{ key: 'DUP_KEY', count: 2 }],
       [{ key: 'DUP_EX', count: 3 }],
       false,
+      false,
     );
   });
 
@@ -303,6 +307,7 @@ describe('compareMany', () => {
       [],
       [],
       false,
+      false,
     );
   });
 
@@ -346,6 +351,7 @@ describe('compareMany', () => {
         mismatches: [{ key: 'KEY1', expected: 'expected', actual: 'actual' }],
       }),
       false,
+      false,
     );
   });
 
@@ -362,7 +368,6 @@ describe('compareMany', () => {
         removedDuplicates: [],
         addedEnv: ['MISSING_KEY'],
         gitignoreUpdated: false,
-        addedExample: [],
       },
     });
 
@@ -373,7 +378,6 @@ describe('compareMany', () => {
 
     expect(mockApplyFixes).toHaveBeenCalledWith({
       envPath,
-      examplePath,
       missingKeys: ['MISSING_KEY'],
       duplicateKeys: [],
       ensureGitignore: false,
@@ -412,7 +416,6 @@ describe('compareMany', () => {
         removedDuplicates: ['DUPLICATE_KEY', 'ANOTHER_DUP'],
         addedEnv: [],
         gitignoreUpdated: false,
-        addedExample: [],
       },
     });
 
@@ -423,7 +426,6 @@ describe('compareMany', () => {
 
     expect(mockApplyFixes).toHaveBeenCalledWith({
       envPath,
-      examplePath,
       missingKeys: [],
       duplicateKeys: ['DUPLICATE_KEY', 'ANOTHER_DUP'],
       ensureGitignore: false,
@@ -531,6 +533,7 @@ describe('compareMany', () => {
         extra: [],
       }),
       false,
+      false,
     );
   });
 
@@ -711,6 +714,7 @@ describe('compareMany', () => {
         empty: expect.arrayContaining(['KEY1', 'KEY2']),
       }),
       false,
+      false,
     );
   });
 
@@ -790,7 +794,6 @@ describe('compareMany', () => {
         removedDuplicates: [],
         addedEnv: [],
         gitignoreUpdated: true,
-        addedExample: [],
       },
     });
 
@@ -832,6 +835,7 @@ describe('compareMany', () => {
         mismatches: [{ key: 'KEY1', expected: 'exp', actual: 'act' }],
       }),
       false,
+      false,
     );
     expect(mockPrintGitignoreWarning).toHaveBeenCalled();
   });