dotenv-diff 1.1.1 → 1.1.3

package/README.md

@@ -1 +1,49 @@
-# dotenv diff cli to compare .env with .env.example
+# dotenv-diff
+
+Easily compare your `.env` and `.env.example` files in Node.js projects to detect missing, extra, empty, or mismatched environment variables.
+
+[![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)
+
+---
+
+## Installation
+
+```bash
+# npm
+npm install -g dotenv-diff
+
+# yarn
+yarn global add dotenv-diff
+
+# pnpm
+pnpm add -g dotenv-diff
+```
+## Usage
+
+```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`
+
+## Optional: Check values too 
+
+```bash
+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.
+
+## 🤝 Contributing
+
+Contributions are welcome! Feel free to open an issue or a pull request.
+
+## License
+
+MIT
+
+### Created by [chrilleweb](https://github.com/chrilleweb)

package/dist/cli.js

@@ -1,9 +1,19 @@
 #!/usr/bin/env node
+import { Command } from 'commander';
 import path from "path";
 import fs from "fs";
 import chalk from "chalk";
 import { parseEnvFile } from "./lib/parseEnv.js";
 import { diffEnv } from "./lib/diffEnv.js";
+const program = new Command();
+program
+    .name('dotenv-diff')
+    .description('Compare .env and .env.example files')
+    .option('--check-values', 'Compare actual values if example has values')
+    .parse(process.argv);
+const options = program.opts();
+const checkValues = options.checkValues ?? false;
+// Her kører din eksisterende diff-logik videre:
 const envPath = path.resolve(process.cwd(), ".env");
 const examplePath = path.resolve(process.cwd(), ".env.example");
 if (!fs.existsSync(envPath)) {
@@ -17,7 +27,7 @@ if (!fs.existsSync(examplePath)) {
 console.log(chalk.bold("🔍 Comparing .env and .env.example..."));
 const current = parseEnvFile(envPath);
 const example = parseEnvFile(examplePath);
-const diff = diffEnv(current, example);
+const diff = diffEnv(current, example, checkValues);
 // Find tomme variabler i .env
 const emptyKeys = Object.entries(current)
     .filter(([key, value]) => value.trim() === "")
@@ -25,7 +35,8 @@ const emptyKeys = Object.entries(current)
 let hasWarnings = false;
 if (diff.missing.length === 0 &&
     diff.extra.length === 0 &&
-    emptyKeys.length === 0) {
+    emptyKeys.length === 0 &&
+    diff.valueMismatches.length === 0) {
     console.log(chalk.green("✅ All keys match! Your .env file is valid."));
     process.exit(0);
 }
@@ -42,7 +53,7 @@ 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 (diff.valueMismatches.length > 0) {
+if (checkValues && diff.valueMismatches.length > 0) {
     hasWarnings = true;
     console.log(chalk.yellow("\n⚠️  The following keys have different values:"));
     diff.valueMismatches.forEach(({ key, expected, actual }) => {

package/dist/lib/diffEnv.js

@@ -1,18 +1,21 @@
-export function diffEnv(current, example) {
+export function diffEnv(current, example, checkValues = false) {
     const currentKeys = Object.keys(current);
     const exampleKeys = Object.keys(example);
     const missing = exampleKeys.filter((key) => !currentKeys.includes(key));
     const extra = currentKeys.filter((key) => !exampleKeys.includes(key));
-    const valueMismatches = exampleKeys
-        .filter((key) => {
-        return (currentKeys.includes(key) &&
-            example[key].trim() !== "" &&
-            current[key] !== example[key]);
-    })
-        .map((key) => ({
-        key,
-        expected: example[key],
-        actual: current[key],
-    }));
+    let valueMismatches = [];
+    if (checkValues) {
+        valueMismatches = exampleKeys
+            .filter((key) => {
+            return (currentKeys.includes(key) &&
+                example[key].trim() !== "" &&
+                current[key] !== example[key]);
+        })
+            .map((key) => ({
+            key,
+            expected: example[key],
+            actual: current[key],
+        }));
+    }
     return { missing, extra, valueMismatches };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotenv-diff",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "type": "module",
   "description": "A small CLI and library to find differences between .env and .env.example files.",
   "bin": {
@@ -9,13 +9,13 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-  "dist/cli.js",
-  "dist/lib/diffEnv.js",
-  "dist/lib/parseEnv.js",
-  "dist/index.js",
-  "dist/index.d.ts",
-  "README.md"
-],
+    "dist/cli.js",
+    "dist/lib/diffEnv.js",
+    "dist/lib/parseEnv.js",
+    "dist/index.js",
+    "dist/index.d.ts",
+    "README.md"
+  ],
   "scripts": {
     "build": "tsc",
     "dev": "vitest --watch",
@@ -41,7 +41,8 @@
     "node": ">=14.0.0"
   },
   "dependencies": {
-    "chalk": "^5.4.1"
+    "chalk": "^5.4.1",
+    "commander": "^14.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",