make-json-to-env 1.0.5 → 1.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ajay Vishwakarma
+
+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,82 +1,137 @@
-# make-json-to-env 🚀
+# 🚀 make-json-to-env
 
-A lightweight CLI tool to transform your `JSON` configuration files into `.env` templates instantly. Perfect for generating `.env.example` files without manual typing.
+**The ultimate zero-dependency CLI tool to transform complex, nested JSON into clean, production-ready `.env` files.**
+
+---
+
+## 💡 Why `make-json-to-env`?
+
+Most JSON-to-ENV converters stop at the first level or handle arrays poorly. `make-json-to-env` was built to solve the "Deep Config" problem. Whether you have a 10-level nested Firebase config or a simple flat JSON, this tool generates a standard, predictable `.env` structure that works with `dotenv`, Docker, and Shell scripts.
+
+---
+
+## 🔥 Features
+
+* **⚡ Ultra-Lightweight** – Zero dependencies. It uses native Node.js `fs` and `path` modules.
+* **🌳 Infinite Recursion** – No depth limits. It flattens deep objects into a `PARENT_CHILD_KEY` convention.
+* **🔢 Intelligent Array Mapping** – Converts arrays into indexed variables (e.g., `TAGS_0`, `TAGS_1`).
+* **🛡️ Built with TypeScript** – Fully type-safe with robust error handling for invalid JSON.
+* **⚙️ Prefix Support** – Prepend `export `, `SET `, or `REACT_APP_` to every variable automatically.
+* **🚫 Smart Flattening Toggle** – Use `--no-flatten` if you want nested objects to stay as JSON strings.
 
 ---
 
 ## 📦 Installation
 
-You can run it directly without installing using `npx`:
+### Use without installing (Recommended)
 
 ```bash
-npx make-json-to-env <filename.json>
+npx make-json-to-env config.json
 
 ```
 
-Or install it globally to use the command anywhere:
+### Global Installation
 
 ```bash
 npm install -g make-json-to-env
 
 ```
 
-## 🛠 Usage
+---
+
+## 🛠 Usage & Commands
 
-Once installed, use the `convert-json-env` command followed by your JSON file:
+The tool provides the `make-json-to-env` command.
 
-### Basic Conversion
+### 1. Basic Conversion
+
+Converts `config.json` to `config.env`.
 
 ```bash
-convert-json-env config.json
+make-json-to-env config.json
 
 ```
 
-*This will create a `config.env` file in the same directory.*
+### 2. Using Custom Prefixes
+
+Great for shell scripts or specific frameworks (like Create React App).
+
+```bash
+make-json-to-env config.json --prefix="export "
+
+```
 
-### With a Prefix
+### 3. Disabling Flattening
 
-Use the `--prefix` flag to prepend strings to every line (useful for shell scripts or specific frameworks).
+Keep nested objects as serialized strings.
 
 ```bash
-convert-json-env firebaseConfig.json --prefix="export "
+make-json-to-env data.json --no-flatten
 
 ```
 
 ---
 
-## 📋 Example
+## 📋 Deep-Flattening Example
 
-**Input (`example.json`):**
+**Input (`settings.json`):**
 
 ```json
 {
-  "apiKey": "12345",
-  "authDomain": "app.firebaseapp.com",
-  "projectId": "my-app"
+  "server": {
+    "port": 3000,
+    "auth": {
+      "methods": ["google", "github"],
+      "enabled": true
+    }
+  },
+  "log_level": "info"
 }
 
 ```
 
-**Command:**
+**Output (`settings.env`):**
 
-```bash
-convert-json-env example.json --prefix="export "
+```env
+SERVER_PORT=3000
+SERVER_AUTH_METHODS_0=google
+SERVER_AUTH_METHODS_1=github
+SERVER_AUTH_ENABLED=true
+LOG_LEVEL=info
 
 ```
 
-**Output (`example.env`):**
+---
 
-```env
-APP_NAME="My Cool App"
-PORT=8080
-DB_ENABLED=true
-```
+## 🚀 Advanced Flag Reference
+
+| Flag | Type | Description |
+| --- | --- | --- |
+| `<filename>` | `string` | **Required.** The path to your JSON source file. |
+| `--prefix` | `string` | Prepend a string to every key (e.g., `--prefix="VITE_"`). |
+| `--no-flatten` | `boolean` | Stops recursion. Nested objects are saved as JSON strings. |
+
+---
+
+## 🛠 Development & Contributing
+
+Contributions are welcome! To set up the project locally:
+
+1. **Clone the repo:** `git clone https://github.com/ajay-vish/make-json-to-env.git`
+2. **Install types:** `npm install`
+3. **Build from TS:** `npm run build`
+4. **Test locally:** `node dist/index.js example.json`
+
+---
+
+## 📄 License
+
+Distributed under the **MIT License**. See the `LICENSE` file for full text.
 
 ---
 
-## ✨ Features
+## ⭐️ Support
+
+If this tool saved you time, please give it a star on [GitHub](https://github.com/ajay-vish/make-json-to-env)!
 
-* **No Dependencies:** Light as a feather, uses native Node.js modules.
-* **Smart Naming:** Automatically generates the output filename based on your input.
-* **Case Formatting:** Automatically converts keys to `UPPER_CASE` for standard `.env` compliance.
-* **Security First:** Helps you create `.env.example` files so you never accidentally commit your real secrets.
+---

package/package.json

@@ -1,19 +1,30 @@
 {
   "name": "make-json-to-env",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Infinite recursive JSON to ENV flattener written in TypeScript.",
   "main": "./dist/index.js",
   "bin": {
     "make-json-to-env": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "LICENSE"
   ],
   "scripts": {
     "build": "tsc",
     "prepare": "npm run build",
-    "start": "ts-node src/index.ts"
+    "start": "ts-node src/index.ts",
+    "prepublishOnly": "npm run build"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ajay-vish/make-json-to-env.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ajay-vish/make-json-to-env/issues"
+  },
+  "homepage": "https://github.com/ajay-vish/make-json-to-env#readme",
   "devDependencies": {
     "@types/node": "^20.19.35",
     "ts-node": "^10.9.2",
@@ -23,19 +34,19 @@
     "env",
     "json",
     "converter",
-    "template",
+    "recursive",
+    "flatten",
     "dot-env",
     "environment-variables",
     "config-to-env",
     "cli",
     "devtools",
     "automation",
-    "boilerplate",
     "env-example",
     "dotenv-generator",
     "configuration",
     "secrets-management"
   ],
-  "author": "Your Name",
+  "author": "Ajay Vishwakarma",
   "license": "MIT"
 }