Merge branch 'main' into dependabot/npm_and_yarn/main/dev-dependencies-36ec20a6bf

Author: Chrilleweb

CHANGELOG.md

@@ -11,12 +11,30 @@ This project follows [Keep a Changelog](https://keepachangelog.com/) and [Semant
 
 ### Changed
 
+-
+
+### Fixed
+
+-
+
+## [2.3.12] - 2025-12-18
+
+### Added
+
+- Added warnings count to scan usage stats.
+
+### Changed
+
 - Updated dependencies to latest versions.
 - Moved `healthScore` further down on the console output for better visibility of issues.
+- Removed used variables output from scan usage to reduce noise.
+- Removed header output from scan usage to reduce noise.
+- Shortened config file path in CLI output to show only the filename.
+- Updated README documentation for better clarity.
 
 ### Fixed
 
--
+- Fixed false positive secret detection for certain harmless attribute keys in codebase scanner.
 
 ## [2.3.11] - 2025-12-13
 

README.md

@@ -1,6 +1,6 @@
 # dotenv-diff
 
-![Demo](./public/demo2.png)
+![Demo](./public/demo3.png)
 
 `dotenv-diff` scans your codebase to detect which environment variables are used
 and compares them against your `.env` or `.env.example` files.

public/demo3.png

@@ -50,9 +50,6 @@ export async function scanUsage(
   const endTime = performance.now();
   scanResult.stats.duration = (endTime - startTime) / 1000; // Convert to seconds
 
-  // Recalculate stats after filtering
-  calculateStats(scanResult);
-
   // If user explicitly passed --example flag, but the file doesn't exist:
   if (printMissingExample(opts)) {
     return { exitWithError: true };
@@ -128,6 +125,9 @@ export async function scanUsage(
     }
   }
 
+  // Recalculate stats after filtering
+  calculateStats(scanResult);
+
   // JSON output
   if (opts.json) {
     const jsonOutput = createJsonOutput(
@@ -237,10 +237,25 @@ function calculateStats(scanResult: ScanResult): ScanResult {
     scanResult.used.map((u: EnvUsage) => u.variable),
   ).size;
 
+  const warningsCount =
+    (scanResult.frameworkWarnings?.length ?? 0) +
+    (scanResult.exampleWarnings?.length ?? 0) +
+    (scanResult.t3EnvWarnings?.length ?? 0) +
+    (scanResult.logged?.length ?? 0) +
+    (scanResult.uppercaseWarnings?.length ?? 0) +
+    (scanResult.expireWarnings?.length ?? 0) +
+    (scanResult.inconsistentNamingWarnings?.length ?? 0) +
+    (scanResult.secrets?.length ?? 0) +
+    (scanResult.missing.length ?? 0) +
+    (scanResult.unused.length ?? 0) +
+    (scanResult.duplicates?.env?.length ?? 0) +
+    (scanResult.duplicates?.example?.length ?? 0);
+
   scanResult.stats = {
     filesScanned: scanResult.stats.filesScanned,
     totalUsages: scanResult.used.length,
     uniqueVariables,
+    warningsCount: warningsCount,
     duration: scanResult.stats.duration,
   };
 

src/commands/scanUsage.ts

@@ -149,6 +149,7 @@ export interface ScanResult {
     filesScanned: number;
     totalUsages: number;
     uniqueVariables: number;
+    warningsCount: number;
     duration: number;
   };
   secrets: SecretFinding[];
@@ -188,6 +189,7 @@ export interface ScanJsonEntry {
     filesScanned: number;
     totalUsages: number;
     uniqueVariables: number;
+    warningsCount: number;
     duration: number;
   };
   missing: Array<{

src/config/types.ts

@@ -86,17 +86,6 @@ export function createJsonOutput(
     output.totalEnvVariables = totalEnvVariables;
   }
 
-  // Optionally include all usages
-  if (opts.showStats) {
-    output.allUsages = scanResult.used.map((u: EnvUsage) => ({
-      variable: u.variable,
-      file: u.file,
-      line: u.line,
-      pattern: u.pattern,
-      context: u.context,
-    }));
-  }
-
   output.healthScore = healthScore;
 
   return output;

src/core/scanJsonOutput.ts

@@ -44,6 +44,10 @@ const HARMLESS_URLS = [
   /xmlns=["']http:\/\/www\.w3\.org\/2000\/svg["']/i, // SVG namespace
 ];
 
+// Known harmless attribute keys commonly used in UI / analytics
+const HARMLESS_ATTRIBUTE_KEYS =
+  /\b(trackingId|trackingContext|data-testid|data-test|aria-label)\b/i;
+
 /**
  * Determines the severity of a secret finding.
  * @param kind 'pattern' | 'entropy'
@@ -256,7 +260,10 @@ export function detectSecretsInSource(
 
     // 1) Suspicious key literal assignments
     if (SUSPICIOUS_KEYS.test(line)) {
-      const m = line!.match(/=\s*["'`](.+?)["'`]/);
+      // Ignore known harmless UI / analytics attributes
+      if (HARMLESS_ATTRIBUTE_KEYS.test(line)) continue;
+
+      const m = line.match(/=\s*["'`](.+?)["'`]/);
       if (
         m &&
         m[1] &&

src/core/secretDetectors.ts

@@ -70,6 +70,7 @@ export async function scanCodebase(opts: ScanOptions): Promise<ScanResult> {
       filesScanned,
       totalUsages: filteredUsages.length,
       uniqueVariables: uniqueVariables.length,
+      warningsCount: 0,
       duration: 0,
     },
     duplicates: {

src/services/codeBaseScanner.ts

@@ -4,8 +4,6 @@ import { printGitignoreWarning } from '../ui/shared/printGitignore.js';
 import type { ScanUsageOptions, ScanResult } from '../config/types.js';
 import { printHeader } from '../ui/scan/printHeader.js';
 import { printStats } from '../ui/scan/printStats.js';
-import { printUniqueVariables } from '../ui/scan/printUniqueVariables.js';
-import { printVariables } from '../ui/scan/printVariables.js';
 import { printMissing } from '../ui/scan/printMissing.js';
 import { printUnused } from '../ui/scan/printUnused.js';
 import { printDuplicates } from '../ui/shared/printDuplicates.js';
@@ -54,14 +52,6 @@ export function outputToConsole(
   // Show stats if requested
   printStats(scanResult.stats, isJson, opts.showStats ?? true);
 
-  // Show used variables if any found
-  if (scanResult.stats.uniqueVariables > 0) {
-    // Show unique variables found
-    printUniqueVariables(scanResult.stats.uniqueVariables);
-    // Print used variables with locations
-    printVariables(scanResult.used, opts.showStats ?? false, isJson);
-  }
-
   // Missing variables (used in code but not in env file)
   if (
     printMissing(

src/services/scanOutputToConsole.ts

@@ -6,15 +6,10 @@ import chalk from 'chalk';
  * @returns void
  */
 export function printHeader(comparedAgainst?: string): void {
-  console.log();
-  console.log(
-    chalk.blue('🔍 Scanning codebase for environment variable usage...'),
-  );
   if (comparedAgainst) {
     console.log();
     console.log(
       chalk.magenta(`📋 Comparing codebase usage against: ${comparedAgainst}`),
     );
   }
-  console.log();
 }