nero-env 0.1.0

package/README.md

@@ -0,0 +1,47 @@
+# nero-env
+
+A simple CLI tool to validate environment variables in a project.
+
+nero-env compares your active .env file with .env.example and reports:
+
+- missing variables
+- empty values
+- unused variables
+
+Clear output. No configuration. Safe by default.
+
+## Installation
+
+```bash
+npm install -g nero-env
+```
+
+## Usage
+
+```bash
+nero-env
+```
+
+Check a specific project:
+
+```bash
+nero-env --path ./apps/api
+```
+
+<!-- Fail on issues (useful for CI):
+```bash
+nero-env --strict
+```
+
+Use a specific env file:
+```bash
+nero-env --env development
+``` -->
+
+## What it checks
+
+- **Missing** → defined in .env.example but not in .env
+- **Empty** → defined but has no value
+- **Unused** → present in .env but not declared in .env.example
+
+Output clearly shows which file needs fixing.

package/dist/cli/command.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = run;
+const node_path_1 = require("node:path");
+const options_1 = require("./options");
+const readEnv_1 = require("../core/readEnv");
+const compareEnv_1 = require("../core/compareEnv");
+const validateEnv_1 = require("../core/validateEnv");
+const formatter_1 = require("../output/formatter");
+const printer_1 = require("../output/printer");
+function run() {
+    const options = (0, options_1.parseOptions)();
+    const targetPath = options.projectPath;
+    const envFilePath = (0, node_path_1.join)(targetPath, ".env");
+    const exampleFilePath = (0, node_path_1.join)(targetPath, ".env.example");
+    const actualEnv = (0, readEnv_1.readEnvFile)(envFilePath);
+    const exampleEnv = (0, readEnv_1.readEnvFile)(exampleFilePath);
+    const report = (0, compareEnv_1.compareEnv)(exampleEnv, actualEnv);
+    // Extra validation layer
+    const emptyKeys = (0, validateEnv_1.validateEnv)(actualEnv);
+    if (emptyKeys.length > 0) {
+        report.issues.empty = emptyKeys;
+        report.hasIssues = true;
+    }
+    const formattedReport = (0, formatter_1.formatEnvReport)(report);
+    (0, printer_1.printReport)(formattedReport);
+    if (formattedReport.hasIssues) {
+        process.exit(1);
+    }
+}

package/dist/cli/help.js

@@ -0,0 +1 @@
+"use strict";

package/dist/cli/options.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseOptions = parseOptions;
+const commander_1 = require("commander");
+const node_path_1 = require("node:path");
+function parseOptions() {
+    const program = new commander_1.Command();
+    program
+        .name("nero-env")
+        .description("Validate and compare .env files")
+        .option("-p, --path <path>", "Path to the project directory", process.cwd())
+        .parse(process.argv);
+    const opts = program.opts();
+    return {
+        projectPath: (0, node_path_1.resolve)(opts.path),
+    };
+}

package/dist/core/compareEnv.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compareEnv = compareEnv;
+function compareEnv(exampleEnv, actualEnv) {
+    const expectedKeys = new Set(Object.keys(exampleEnv));
+    const actualKeys = new Set(Object.keys(actualEnv));
+    const issues = {
+        missing: [],
+        unused: [],
+        empty: [],
+    };
+    // Missing: expected but not provided
+    for (const key of expectedKeys) {
+        if (!actualKeys.has(key)) {
+            issues.missing.push(key);
+        }
+    }
+    // Unused: provided but not expected
+    for (const key of actualKeys) {
+        if (!expectedKeys.has(key)) {
+            issues.unused.push(key);
+        }
+    }
+    // Empty: provided but value is empty string
+    for (const [key, value] of Object.entries(actualEnv)) {
+        if (value === "") {
+            issues.empty.push(key);
+        }
+    }
+    const hasIssues = issues.missing.length > 0 ||
+        issues.unused.length > 0 ||
+        issues.empty.length > 0;
+    return {
+        issues,
+        hasIssues,
+    };
+}

package/dist/core/readEnv.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readEnvFile = readEnvFile;
+const node_fs_1 = __importDefault(require("node:fs"));
+function readEnvFile(filePath) {
+    const envVariables = {};
+    try {
+        const fileContent = node_fs_1.default.readFileSync(filePath, "utf8");
+        if (!fileContent) {
+            return envVariables;
+        }
+        const lines = fileContent.split("\n");
+        for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
+            const rawLine = lines[lineIndex].trim();
+            // Skip empty lines and comments
+            if (!rawLine || rawLine.startsWith("#")) {
+                continue;
+            }
+            const equalsIndex = rawLine.indexOf("=");
+            // Skip malformed lines (no '=')
+            if (equalsIndex === -1) {
+                continue;
+            }
+            const key = rawLine.slice(0, equalsIndex).trim();
+            const value = rawLine.slice(equalsIndex + 1).trim();
+            envVariables[key] = value;
+        }
+    }
+    catch {
+        return envVariables;
+    }
+    return envVariables;
+}

package/dist/core/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/core/validateEnv.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateEnv = validateEnv;
+function validateEnv(actualEnv) {
+    const emptyKeys = [];
+    for (const [key, value] of Object.entries(actualEnv)) {
+        if (value === "") {
+            emptyKeys.push(key);
+        }
+    }
+    return emptyKeys;
+}

package/dist/index.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("./cli/command");
+const update_1 = require("./update");
+try {
+    (0, update_1.notifyUpdate)(); // non-blocking, safe, cached
+    (0, command_1.run)();
+}
+catch (err) {
+    console.error("Unexpected error:", err);
+    process.exit(1);
+}

package/dist/meta.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CLI_VERSION = exports.CLI_NAME = void 0;
+exports.CLI_NAME = "nero-env";
+exports.CLI_VERSION = "0.1.0";

package/dist/output/formatter.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatEnvReport = formatEnvReport;
+function formatEnvReport(report) {
+    const sections = [];
+    const { missing, unused, empty } = report.issues;
+    if (missing.length > 0) {
+        sections.push({
+            title: "Missing variables",
+            items: missing,
+            severity: "error",
+            source: ".env",
+        });
+    }
+    if (unused.length > 0) {
+        sections.push({
+            title: "Unused variables",
+            items: unused,
+            severity: "warning",
+            source: ".env.example",
+        });
+    }
+    if (empty.length > 0) {
+        sections.push({
+            title: "Empty variables",
+            items: empty,
+            severity: "warning",
+            source: ".env",
+        });
+    }
+    return {
+        sections,
+        hasIssues: report.hasIssues,
+    };
+}

package/dist/output/printer.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printReport = printReport;
+const chalk_1 = __importDefault(require("chalk"));
+const icons = {
+    error: chalk_1.default.red("❌"),
+    warning: chalk_1.default.yellow("⚠️"),
+    success: chalk_1.default.green("✅"),
+};
+function printReport(report) {
+    // Title
+    console.log(chalk_1.default.bold("Nero Env Check"));
+    console.log(chalk_1.default.dim("─────────────\n"));
+    // Success case
+    if (!report.hasIssues || report.sections.length === 0) {
+        console.log(`${icons.success} ${chalk_1.default.green("No environment issues found")}`);
+        printSummary(0, 0);
+        return;
+    }
+    let errorCount = 0;
+    let warningCount = 0;
+    // Issue sections
+    for (const section of report.sections) {
+        printSection(section);
+        console.log(); // spacing
+        if (section.severity === "error") {
+            errorCount += section.items.length;
+        }
+        else if (section.severity === "warning") {
+            warningCount += section.items.length;
+        }
+    }
+    printSummary(errorCount, warningCount);
+}
+function printSection(section) {
+    const icon = icons[section.severity];
+    if (section.source === ".env") {
+        console.log(`${icon}  ${chalk_1.default.bold(section.title)} ${chalk_1.default.dim(`(${section.source})`)}`);
+    }
+    else {
+        console.log(`${icon}  ${chalk_1.default.bold(section.title)} ${chalk_1.default.dim(`(not declared in ${section.source})`)}`);
+    }
+    for (const item of section.items) {
+        console.log(`  ${chalk_1.default.dim("•")} ${chalk_1.default.cyan(item)}`);
+    }
+}
+function printSummary(errors, warnings) {
+    console.log(chalk_1.default.dim("─────────────"));
+    if (errors === 0 && warnings === 0) {
+        console.log(chalk_1.default.dim("Summary: ") + chalk_1.default.green("No issues found"));
+        return;
+    }
+    const parts = [];
+    if (errors > 0) {
+        parts.push(chalk_1.default.red(`${errors} error${errors > 1 ? "s" : ""}`));
+    }
+    if (warnings > 0) {
+        parts.push(chalk_1.default.yellow(`${warnings} warning${warnings > 1 ? "s" : ""}`));
+    }
+    console.log(chalk_1.default.dim("Summary: ") + parts.join(chalk_1.default.dim(", ")));
+}

package/dist/output/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/update.js

@@ -0,0 +1,17 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.notifyUpdate = notifyUpdate;
+const update_notifier_1 = __importDefault(require("update-notifier"));
+const meta_1 = require("./meta");
+function notifyUpdate() {
+    (0, update_notifier_1.default)({
+        pkg: {
+            name: meta_1.CLI_NAME,
+            version: meta_1.CLI_VERSION,
+        },
+        updateCheckInterval: 1000 * 60 * 60 * 24,
+    }).notify({ isGlobal: true });
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "nero-env",
+  "version": "0.1.0",
+  "description": "Validate and compare .env files",
+  "bin": {
+    "nero-env": "dist/index.js"
+  },
+  "files": ["dist"],
+
+  "scripts": {
+    "build": "tsc",
+    "dev": "ts-node src/index.ts"
+  },
+  "license": "ISC",
+  "packageManager": "pnpm@10.17.1",
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "@types/update-notifier": "^6.0.8",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "update-notifier": "^7.3.1"
+  }
+}