nero-env 0.1.2 → 0.1.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Roshan Singh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,35 +1,60 @@
-# nero-env
+<h1 align="center">nero-env</h1>
 
-A simple CLI tool to validate environment variables in a project.
+<p align="center">
+  <img src="https://img.shields.io/npm/v/nero-env?color=6366f1" alt="npm version" />
+  <img src="https://img.shields.io/npm/dm/nero-env?color=0f172a" alt="npm downloads" />
+  <img src="https://img.shields.io/github/license/alcanivorax/nero-env?color=22c55e" alt="license" />
+</p>
 
-nero-env compares your active .env file with .env.example and reports:
+<p align="center">
+  <img
+    src="https://raw.githubusercontent.com/alcanivorax/nero-env/main/assets/nero-env-preview.png"
+    alt="nero-env preview"
+    width="700"
+  />
+</p>
 
-- missing variables
-- empty values
-- unused variables
+A simple CLI tool to validate environment variables in your project.
 
-Clear output. No configuration. Safe by default.
+## Overview
 
-## Example
+nero-env compares your active `.env` file with `.env.example` and reports discrepancies. It helps ensure your environment configuration is complete and accurate.
 
-<img 
-  src="https://raw.githubusercontent.com/alcanivorax/nero-env/main/assets/nero-env-preview.png"
-  width="700"
-/>
+**What it checks:**
+
+- **Missing variables** - defined in `.env.example` but not in `.env`
+- **Empty values** - defined in `.env` but has no value assigned
+- **Unused variables** - present in `.env` but not declared in `.env.example`
+
+Clear output. No configuration required. Safe by default.
+
+---
 
 ## Installation
 
+Install globally using npm:
+
 ```bash
 npm install -g nero-env
 ```
 
+---
+
 ## Usage
 
+### Basic Usage
+
+Run in your project directory:
+
 ```bash
 nero-env
 ```
 
-Check a specific project:
+This will check for `.env` and `.env.example` files in the current directory.
+
+### Check a Specific Project
+
+Specify a custom path:
 
 ```bash
 nero-env --path ./apps/api

package/dist/cli/command.js

@@ -1,29 +1,26 @@
-"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)();
+import { join } from "node:path";
+import { parseOptions } from "./options.js";
+import { readEnvFile } from "../core/readEnv.js";
+import { compareEnv } from "../core/compareEnv.js";
+import { validateEnv } from "../core/validateEnv.js";
+import { formatEnvReport } from "../output/formatter.js";
+import { printReport } from "../output/printer.js";
+export function run() {
+    const options = 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);
+    const envFilePath = join(targetPath, ".env");
+    const exampleFilePath = join(targetPath, ".env.example");
+    const actualEnv = readEnvFile(envFilePath);
+    const exampleEnv = readEnvFile(exampleFilePath);
+    const report = compareEnv(exampleEnv, actualEnv);
     // Extra validation layer
-    const emptyKeys = (0, validateEnv_1.validateEnv)(actualEnv);
+    const emptyKeys = 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);
+    const formattedReport = formatEnvReport(report);
+    printReport(formattedReport);
     if (formattedReport.hasIssues) {
         process.exit(1);
     }

package/dist/cli/options.js

@@ -1,17 +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();
+import { Command } from "commander";
+import { resolve } from "node:path";
+import { CLI_NAME, CLI_VERSION } from "../meta.js";
+export function parseOptions() {
+    const program = new Command();
     program
-        .name("nero-env")
+        .name(CLI_NAME)
         .description("Validate and compare .env files")
-        .option("-p, --path <path>", "Path to the project directory", process.cwd())
+        .version(CLI_VERSION, "-v, --version", "output the version number")
+        .option("-p, --path <path>", "Path to the project directory (defaults to current working directory)", process.cwd())
+        .helpOption("-h, --help", "display help for command")
         .parse(process.argv);
     const opts = program.opts();
     return {
-        projectPath: (0, node_path_1.resolve)(opts.path),
+        projectPath: resolve(opts.path),
     };
 }

package/dist/core/compareEnv.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.compareEnv = compareEnv;
-function compareEnv(exampleEnv, actualEnv) {
+export function compareEnv(exampleEnv, actualEnv) {
     const expectedKeys = new Set(Object.keys(exampleEnv));
     const actualKeys = new Set(Object.keys(actualEnv));
     const issues = {

package/dist/core/readEnv.js

@@ -1,14 +1,8 @@
-"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) {
+import fs from "node:fs";
+export function readEnvFile(filePath) {
     const envVariables = {};
     try {
-        const fileContent = node_fs_1.default.readFileSync(filePath, "utf8");
+        const fileContent = fs.readFileSync(filePath, "utf8");
         if (!fileContent) {
             return envVariables;
         }

package/dist/core/types.js

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

package/dist/core/validateEnv.js

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

package/dist/index.js

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

package/dist/meta.js

@@ -1,5 +1,4 @@
-"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";
+// src/meta.ts
+import pkg from "../package.json" with { type: "json" };
+export const CLI_NAME = pkg.name;
+export const CLI_VERSION = pkg.version;

package/dist/output/formatter.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatEnvReport = formatEnvReport;
-function formatEnvReport(report) {
+export function formatEnvReport(report) {
     const sections = [];
     const { missing, unused, empty } = report.issues;
     if (missing.length > 0) {

package/dist/output/printer.js

@@ -1,22 +1,16 @@
-"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"));
+import chalk from "chalk";
 const icons = {
-    error: chalk_1.default.red("❌"),
-    warning: chalk_1.default.yellow("⚠️"),
-    success: chalk_1.default.green("✅"),
+    error: chalk.red("❌"),
+    warning: chalk.yellow("⚠️"),
+    success: chalk.green("✅"),
 };
-function printReport(report) {
+export function printReport(report) {
     // Title
-    console.log(chalk_1.default.bold("Nero Env Check"));
-    console.log(chalk_1.default.dim("─────────────\n"));
+    console.log(chalk.bold("Nero Env Check"));
+    console.log(chalk.dim("─────────────\n"));
     // Success case
     if (!report.hasIssues || report.sections.length === 0) {
-        console.log(`${icons.success} ${chalk_1.default.green("No environment issues found")}`);
+        console.log(`${icons.success} ${chalk.green("No environment issues found")}`);
         printSummary(0, 0);
         return;
     }
@@ -38,27 +32,27 @@ function printReport(report) {
 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})`)}`);
+        console.log(`${icon}  ${chalk.bold(section.title)} ${chalk.dim(`(${section.source})`)}`);
     }
     else {
-        console.log(`${icon}  ${chalk_1.default.bold(section.title)} ${chalk_1.default.dim(`(not declared in ${section.source})`)}`);
+        console.log(`${icon}  ${chalk.bold(section.title)} ${chalk.dim(`(not declared in ${section.source})`)}`);
     }
     for (const item of section.items) {
-        console.log(`  ${chalk_1.default.dim("•")} ${chalk_1.default.cyan(item)}`);
+        console.log(`  ${chalk.dim("•")} ${chalk.cyan(item)}`);
     }
 }
 function printSummary(errors, warnings) {
-    console.log(chalk_1.default.dim("─────────────"));
+    console.log(chalk.dim("─────────────"));
     if (errors === 0 && warnings === 0) {
-        console.log(chalk_1.default.dim("Summary: ") + chalk_1.default.green("No issues found"));
+        console.log(chalk.dim("Summary: ") + chalk.green("No issues found"));
         return;
     }
     const parts = [];
     if (errors > 0) {
-        parts.push(chalk_1.default.red(`${errors} error${errors > 1 ? "s" : ""}`));
+        parts.push(chalk.red(`${errors} error${errors > 1 ? "s" : ""}`));
     }
     if (warnings > 0) {
-        parts.push(chalk_1.default.yellow(`${warnings} warning${warnings > 1 ? "s" : ""}`));
+        parts.push(chalk.yellow(`${warnings} warning${warnings > 1 ? "s" : ""}`));
     }
-    console.log(chalk_1.default.dim("Summary: ") + parts.join(chalk_1.default.dim(", ")));
+    console.log(chalk.dim("Summary: ") + parts.join(chalk.dim(", ")));
 }

package/dist/output/types.js

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

package/dist/update.js

@@ -1,16 +1,10 @@
-"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)({
+import updateNotifier from "update-notifier";
+import { CLI_NAME, CLI_VERSION } from "./meta.js";
+export function notifyUpdate() {
+    updateNotifier({
         pkg: {
-            name: meta_1.CLI_NAME,
-            version: meta_1.CLI_VERSION,
+            name: CLI_NAME,
+            version: CLI_VERSION,
         },
         updateCheckInterval: 1000 * 60 * 60 * 24,
     }).notify({ isGlobal: true });

package/package.json

@@ -1,23 +1,43 @@
 {
   "name": "nero-env",
-  "version": "0.1.2",
-  "description": "Validate and compare .env files",
+  "version": "0.1.4",
+  "description": "Validate and compare .env files to catch missing, empty, and unused variables.",
+  "type": "module",
+  "main": "dist/index.js",
   "bin": {
     "nero-env": "dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "scripts": {
+    "dev": "tsx src/index.ts",
     "build": "tsc",
-    "dev": "ts-node src/index.ts"
+    "start": "node dist/index.js"
   },
+  "keywords": [
+    "env",
+    "dotenv",
+    "environment-variables",
+    "env-validation",
+    "env-check",
+    "env-compare",
+    "config",
+    "cli",
+    "node-cli",
+    "developer-tools",
+    "devtools",
+    "nero"
+  ],
+  "author": "alcanivorax",
   "license": "MIT",
   "packageManager": "pnpm@10.17.1",
   "devDependencies": {
     "@types/node": "^25.0.3",
     "@types/update-notifier": "^6.0.8",
     "ts-node": "^10.9.2",
+    "tsx": "^4.21.0",
     "typescript": "^5.9.3"
   },
   "dependencies": {

package/dist/cli/help.js

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