dotenv-diff 1.6.3 → 1.6.4

package/README.md

@@ -43,6 +43,18 @@ When using the `--check-values` option, the tool will also compare the actual va
 
 `dotenv-diff` warns when a `.env*` file contains the same key multiple times. The last occurrence wins. Suppress these warnings with `--allow-duplicates`.
 
+## Ignore specific keys
+
+Exclude certain keys from the comparison using `--ignore` for exact names or `--ignore-regex` for patterns:
+
+```bash
+dotenv-diff --ignore API_KEY,SESSION_ID
+dotenv-diff --ignore-regex '^SECRET_'
+dotenv-diff --ignore API_KEY --ignore-regex '^SECRET_'
+```
+
+Ignored keys are removed from all warnings and do not affect the exit code.
+
 ## Output format in JSON
 
 You can output the results in JSON format using the `--json` option:

package/dist/src/cli/program.js

@@ -9,5 +9,7 @@ export function createProgram() {
         .option('--env <file>', 'Path to a specific .env file')
         .option('--example <file>', 'Path to a specific .env.example file')
         .option('--allow-duplicates', 'Do not warn about duplicate keys in .env* files')
+        .option('--ignore <keys>', 'Comma-separated list of keys to ignore')
+        .option('--ignore-regex <pattern>', 'Regex pattern to ignore matching keys')
         .option('--json', 'Output results in JSON format');
 }

package/dist/src/cli/run.js

@@ -24,11 +24,19 @@ export async function run(program) {
             process.exit(1);
         }
         const report = [];
-        const { exitWithError } = await compareMany([{ envName: path.basename(opts.envFlag), envPath: opts.envFlag, examplePath: opts.exampleFlag }], {
+        const { exitWithError } = await compareMany([
+            {
+                envName: path.basename(opts.envFlag),
+                envPath: opts.envFlag,
+                examplePath: opts.exampleFlag,
+            },
+        ], {
             checkValues: opts.checkValues,
             cwd: opts.cwd,
             allowDuplicates: opts.allowDuplicates,
             json: opts.json,
+            ignore: opts.ignore,
+            ignoreRegex: opts.ignoreRegex,
             collect: (e) => report.push(e),
         });
         if (opts.json) {
@@ -65,6 +73,8 @@ export async function run(program) {
         cwd: opts.cwd,
         allowDuplicates: opts.allowDuplicates,
         json: opts.json,
+        ignore: opts.ignore,
+        ignoreRegex: opts.ignoreRegex,
         collect: (e) => report.push(e),
     });
     if (opts.json) {

package/dist/src/commands/compare.d.ts

@@ -33,6 +33,8 @@ export declare function compareMany(pairs: Array<{
     cwd: string;
     allowDuplicates?: boolean;
     json?: boolean;
+    ignore: string[];
+    ignoreRegex: RegExp[];
     collect?: (entry: CompareJsonEntry) => void;
 }): Promise<{
     exitWithError: boolean;

package/dist/src/commands/compare.js

@@ -5,6 +5,7 @@ import { parseEnvFile } from '../lib/parseEnv.js';
 import { diffEnv } from '../lib/diffEnv.js';
 import { warnIfEnvNotIgnored } from '../services/git.js';
 import { findDuplicateKeys } from '../services/duplicates.js';
+import { filterIgnoredKeys } from '../core/filterIgnoredKeys.js';
 export async function compareMany(pairs, opts) {
     let exitWithError = false;
     for (const { envName, envPath, examplePath } of pairs) {
@@ -34,8 +35,10 @@ export async function compareMany(pairs, opts) {
         });
         // Duplicate detection
         if (!opts.allowDuplicates) {
-            const dupsEnv = findDuplicateKeys(envPath);
-            const dupsEx = findDuplicateKeys(examplePath);
+            const dupsEnv = findDuplicateKeys(envPath).filter(({ key }) => !opts.ignore.includes(key) &&
+                !opts.ignoreRegex.some((rx) => rx.test(key)));
+            const dupsEx = findDuplicateKeys(examplePath).filter(({ key }) => !opts.ignore.includes(key) &&
+                !opts.ignoreRegex.some((rx) => rx.test(key)));
             if (dupsEnv.length || dupsEx.length) {
                 entry.duplicates = {};
             }
@@ -55,8 +58,12 @@ export async function compareMany(pairs, opts) {
             }
         }
         // Diff + empty
-        const current = parseEnvFile(envPath);
-        const example = parseEnvFile(examplePath);
+        const currentFull = parseEnvFile(envPath);
+        const exampleFull = parseEnvFile(examplePath);
+        const currentKeys = filterIgnoredKeys(Object.keys(currentFull), opts.ignore, opts.ignoreRegex);
+        const exampleKeys = filterIgnoredKeys(Object.keys(exampleFull), opts.ignore, opts.ignoreRegex);
+        const current = Object.fromEntries(currentKeys.map((k) => [k, currentFull[k]]));
+        const example = Object.fromEntries(exampleKeys.map((k) => [k, exampleFull[k]]));
         const diff = diffEnv(current, example, opts.checkValues);
         const emptyKeys = Object.entries(current)
             .filter(([, v]) => (v ?? '').trim() === '')

package/dist/src/config/options.d.ts

@@ -6,6 +6,8 @@ export type Options = {
     json: boolean;
     envFlag: string | null;
     exampleFlag: string | null;
+    ignore: string[];
+    ignoreRegex: RegExp[];
     cwd: string;
 };
 type RawOptions = {
@@ -16,6 +18,8 @@ type RawOptions = {
     json?: boolean;
     env?: string;
     example?: string;
+    ignore?: string | string[];
+    ignoreRegex?: string | string[];
 };
 export declare function normalizeOptions(raw: RawOptions): Options;
 export {};

package/dist/src/config/options.js

@@ -6,6 +6,24 @@ export function normalizeOptions(raw) {
     const isYesMode = Boolean(raw.yes);
     const allowDuplicates = Boolean(raw.allowDuplicates);
     const json = Boolean(raw.json);
+    const parseList = (val) => {
+        const arr = Array.isArray(val) ? val : val ? [val] : [];
+        return arr
+            .flatMap((s) => s.split(','))
+            .map((s) => s.trim())
+            .filter(Boolean);
+    };
+    const ignore = parseList(raw.ignore);
+    const ignoreRegex = [];
+    for (const pattern of parseList(raw.ignoreRegex)) {
+        try {
+            ignoreRegex.push(new RegExp(pattern));
+        }
+        catch {
+            console.error(chalk.red(`❌ Error: invalid --ignore-regex pattern: ${pattern}`));
+            process.exit(1);
+        }
+    }
     if (isCiMode && isYesMode) {
         console.log(chalk.yellow('⚠️  Both --ci and --yes provided; proceeding with --yes.'));
     }
@@ -20,6 +38,8 @@ export function normalizeOptions(raw) {
         json,
         envFlag,
         exampleFlag,
+        ignore,
+        ignoreRegex,
         cwd,
     };
 }

package/dist/src/core/filterIgnoredKeys.d.ts

@@ -0,0 +1 @@
+export declare function filterIgnoredKeys(keys: string[], ignore: string[], ignoreRegex: RegExp[]): string[];

package/dist/src/core/filterIgnoredKeys.js

@@ -0,0 +1,3 @@
+export function filterIgnoredKeys(keys, ignore, ignoreRegex) {
+    return keys.filter((k) => !ignore.includes(k) && !ignoreRegex.some((rx) => rx.test(k)));
+}

package/package.json

@@ -1,25 +1,36 @@
 {
   "name": "dotenv-diff",
-  "version": "1.6.3",
+  "version": "1.6.4",
   "type": "module",
-  "description": "A small CLI and library to find differences between .env and .env.example files.",
+  "description": "A CLI tool to find differences between .env and .env.example / .env.* files.",
   "bin": {
     "dotenv-diff": "dist/bin/dotenv-diff.js"
   },
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
     "dist/",
     "README.md",
     "LICENSE"
   ],
+  "sideEffects": false,
   "scripts": {
     "build": "tsc",
     "dev": "vitest --watch",
-    "test": "vitest",
+    "test": "vitest run",
+    "test:unit": "vitest run test/unit",
+    "test:e2e": "vitest run test/e2e",
     "lint": "eslint ./src --ext .ts",
     "format": "prettier --write \"src/**/*.ts\" \"src/*.ts\"",
-    "start": "node dist/bin/dotenv-diff.js"
+    "start": "node dist/bin/dotenv-diff.js",
+    "prepublishOnly": "npm run lint && npm test && npm run build"
   },
   "author": "Chrilleweb",
   "license": "MIT",
@@ -36,8 +47,12 @@
     "type": "git",
     "url": "https://github.com/Chrilleweb/dotenv-diff.git"
   },
+  "homepage": "https://github.com/Chrilleweb/dotenv-diff#readme",
+  "bugs": {
+    "url": "https://github.com/Chrilleweb/dotenv-diff/issues"
+  },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=20.0.0"
   },
   "dependencies": {
     "chalk": "^5.4.1",