env-creator 1.0.0 → 1.1.0

package/README.md

@@ -1,36 +1,70 @@
 # env-creator
 
-A fast, lightweight CLI tool for managing and generating environment (`.env`) files.
+A fast, lightweight CLI tool for managing and generating custom environment (`.env`) files, designed to simplify development by enabling multiple .env configurations for different environments, as well as automatically generating JavaScript constants for direct use within the project.
 
 ## Installation
 
-You can install `env-creator` globally using npm:
+You can install `env-creator` locally in your project (recommended) or globally.
+
+### Local Installation
+
+Install as a development dependency:
 
 ```bash
-npm install -g env-creator
+npm install env-creator --save-dev
+# or
+pnpm add -D env-creator
+# or
+yarn add -D env-creator
+```
+
+Then run it using your package manager's runner:
+
+```bash
+npx env-creator create
+# or
+pnpx env-creator create
+# or (Yarn Berry)
+yarn dlx env-creator create
+# or (Yarn Classic)
+yarn env-creator create
 ```
 
-Alternatively, you can run it directly using `npx` without installing globally:
+### Global Installation
+
+If you prefer to use it across all projects:
 
 ```bash
-npx create-env <command> [options]
+npm install -g env-creator
 # or
-npx env-creator <command> [options]
+pnpm add -g env-creator
+# or
+yarn global add env-creator
 ```
 
-`env-creator` (also available as `create-env`) provides several commands to help you quickly set up or split your environment files.
+Then run it directly:
+
+```bash
+env-creator create
+```
 
-### 1. Create an empty or pre-filled `.env` file
+## Usage (examples for `pnpm`)
+
+`env-creator` (also available as `env`) provides several commands (along with their short aliases, e.g. `c` for `create`) to help you quickly set up or split your environment files.
+
+### 1. Create an empty or pre-filled `.env` file (alias: `c`)
 
 Generates a `.env` file in the current working directory. You can optionally pass `KEY=VALUE` pairs to pre-fill it. If a file already exists, it will not overwrite it.
 
 ```bash
-npx create-env create
+pnpx env-creator create
 ```
 
 **With initial fields:**
 ```bash
-npx create-env create PORT=3000 NODE_ENV=development
+pnpx env-creator create PORT=3000 NODE_ENV=development
+# or short version
+pnpx env c PORT=3000 NODE_ENV=development
 ```
 
 **Resulting `.env`:**
@@ -39,27 +73,27 @@ PORT=3000
 NODE_ENV=development
 ```
 
-### 2. Create from JSON
+### 2. Create from JSON (alias: `cfj`)
 
 Generates a `.env` target file from a provided JSON file. The keys and values in the JSON file will be converted into `KEY=VALUE` format.
 You can optionally provide an `--env <name>` flag to create a specific `.env.<name>` file (e.g., `.env.production`).
 
 ```bash
-npx create-env create-from-json <path-to-file.json> [--env <name>]
+pnpx env-creator create-from-json <path-to-file.json> [--env <name>]
 ```
 
 **Example `config.json`:**
 ```json
 {
-  "PORT": 3000,
-  "DB_HOST": "localhost",
-  "NODE_ENV": "development"
+	"PORT": 3000,
+	"DB_HOST": "localhost",
+	"NODE_ENV": "development"
 }
 ```
 
 **Command:**
 ```bash
-npx create-env create-from-json config.json --env production
+pnpx env-creator create-from-json config.json --env production
 ```
 
 **Resulting `.env.production`:**
@@ -69,12 +103,12 @@ DB_HOST=localhost
 NODE_ENV=development
 ```
 
-### 3. Split `.env` for specific environments
+### 3. Split `.env` for specific environments (alias: `s`)
 
 Reads your existing `.env` file, removes all comments and values, and creates a new target file containing **only the keys** (e.g., for creating a `.env.example` or `.env.production` template).
 
 ```bash
-npx create-env split --env <env-name>
+pnpx env-creator split --env <env-name>
 ```
 
 **Example:**
@@ -87,7 +121,7 @@ DB_PASS=secret
 
 Running the split command for production:
 ```bash
-npx create-env split --env production
+pnpx env-creator split --env production
 ```
 
 Will generate a new file named `.env.production` with empty values:
@@ -96,32 +130,32 @@ DB_USER=
 DB_PASS=
 ```
 
-### 4. Delete an `.env` file
+### 4. Delete an `.env` file (alias: `d`)
 
 Deletes a specific environment file. If no filename is provided, it defaults to deleting `.env`.
 
 ```bash
-npx create-env delete [file]
+pnpx env-creator delete [file]
 ```
 
 **Examples:**
 ```bash
-npx create-env delete            	# Deletes .env
-npx create-env delete .env.production  # Deletes .env.production
+pnpx env-creator delete				# Deletes .env
+pnpx env-creator delete .env.production		# Deletes .env.production
 ```
 
-### 5. Sort `.env` keys alphabetically
+### 5. Sort `.env` keys alphabetically (alias: `srt`)
 
 Reads an environment file and reorders all `KEY=VALUE` lines alphabetically. Comments and empty lines are preserved at the top of the file. Defaults to `.env` if no file is specified.
 
 ```bash
-npx create-env sort [file]
+pnpx env-creator sort [file]
 ```
 
 **Examples:**
 ```bash
-npx create-env sort               	# Sorts .env
-npx create-env sort .env.production	# Sorts .env.production
+pnpx env-creator sort               	# Sorts .env
+pnpx env-creator sort .env.production	# Sorts .env.production
 ```
 
 **Before:**
@@ -140,6 +174,68 @@ DB_HOST=localhost
 PORT=3000
 ```
 
+### 6. Generate environment constants (alias: `gc`)
+
+Reads an environment file (defaults to `.env`), extracts the keys, and creates a JavaScript file exporting each key inside a constant object (defaults to `envConstants.js`). You can specify a custom output file using the `--out` flag.
+
+```bash
+pnpx env-creator generate-constants [file] [--out <filename>]
+```
+
+**Examples:**
+```bash
+pnpx env gc					# Generates envConstants.js from .env by default
+pnpx env gc .env.production			# Generates envConstants.js from .env.production
+pnpx env gc --out myConfig.js			# Generates myConfig.js from .env
+pnpx env gc .env.production --out config/env.js # Generates config/env.js from .env.production
+```
+
+**Resulting `envConstants.js`:**
+```javascript
+export const ENV = {
+	API_URL: process.env.API_URL,
+	JWT_SECRET: process.env.JWT_SECRET,
+};
+```
+
+> [!IMPORTANT]
+> There is no `process` object in the browser. To use these constants on the client-side, you must inject the environment variables using your bundler.
+>
+> **Example for Webpack** (other bundlers like Vite or Rollup will require their own specific configuration):
+>
+> ```javascript
+> import webpack from "webpack";
+> import dotenv from "dotenv";
+> import path from "path"; // if needed
+>
+> // load environment variables from .env
+> const env = dotenv.config().parsed;
+> // load environment variables from a specific .env file (for example, .env.production)
+> // const env = dotenv.config({ path: path.resolve(__dirname, `../.env.${envName}`) }).parsed;
+>
+> // convert to an object for DefinePlugin
+> const envKeys = Object.keys(env).reduce((acc, key) => {
+>   acc[`process.env.${key}`] = JSON.stringify(env[key]);
+>   return acc;
+> }, {});
+>
+> // inject variables passing them into DefinePlugin
+> export default {
+>   // ...
+>   plugins: [
+>     new webpack.DefinePlugin({ ...envKeys }),
+>   ],
+> };
+> ```
+
+Now you can easily import these constants anywhere in your project:
+
+```javascript
+import { ENV } from "[pathToFile]/envConstants";
+
+console.log(`API URL: ${ENV.API_URL}`); // delete after checking
+```
+
 ## Development
 
 If you want to contribute or modify the tool, you can clone the repository and use the built-in npm scripts:
@@ -147,13 +243,13 @@ If you want to contribute or modify the tool, you can clone the repository and u
 ### Linting
 To check the code for syntax and style errors using ESLint:
 ```bash
-npm run lint
+pnpx run lint
 ```
 
 ### Building
 The project uses `esbuild` to bundle and minify the code into a single executable file in the `dist/` directory:
 ```bash
-npm run build
+pnpx run build
 ```
 
 ## License

package/dist/index.js

@@ -1,8 +1,12 @@
-import n from"fs";import f from"path";var t=process.argv.slice(2);t.length===0&&(p(),process.exit(0));function p(){console.log("Usage: env-creator <command> [options]"),console.log("Commands:"),console.log("  create [KEY=value...]   Create a .env file (optionally with values)"),console.log("  create-from-json <json> [--env <name>] Create .env or .env.<name> from JSON"),console.log("  split --env <dev|prod>  Create environment-specific file from .env"),console.log("  delete [file]           Delete an environment file (default: .env)"),console.log("  sort [file]             Sort keys alphabetically in an env file (default: .env)"),console.log("Options:"),console.log("  -h, --help              Show this help message")}var d=t[0];(d==="--help"||d==="-h"||d==="help")&&(p(),process.exit(0));switch(d){case"create":{let e=f.join(process.cwd(),".env");if(n.existsSync(e))console.log(".env already exists");else{let o=t.slice(1),s="";if(o.length>0){let i=o.filter(c=>c.includes("="));s=i.join(`
-`)+(i.length>0?`
-`:"")}n.writeFileSync(e,s),console.log(s?"Created .env with specified fields":"Created empty .env")}break}case"create-from-json":{let e=t[1];e||(console.error("Please provide a JSON file"),process.exit(1)),n.existsSync(e)||(console.error("JSON file not found"),process.exit(1));let o=t.indexOf("--env"),i=`.env${o!==-1&&t[o+1]?`.${t[o+1]}`:""}`;if(n.existsSync(i)){console.log(`${i} already exists`);break}let c=JSON.parse(n.readFileSync(e,"utf-8")),a="";for(let r in c)a+=`${r}=${c[r]}
-`;n.writeFileSync(i,a),console.log(`Created ${i} from JSON`);break}case"split":{let e=t.indexOf("--env");(e===-1||!t[e+1])&&(console.error("Please specify environment with --env <dev|prod>"),process.exit(1));let o=t[e+1],s=f.join(process.cwd(),".env");n.existsSync(s)||(console.error(".env file not found"),process.exit(1));let c=n.readFileSync(s,"utf-8").split(/\r?\n/).filter(r=>r.trim()!==""&&!r.startsWith("#")).map(r=>r.split("=")[0]+"=").join(`
-`),a=f.join(process.cwd(),`.env.${o}`);if(n.existsSync(a)){console.log(`.env.${o} already exists`);break}n.writeFileSync(a,c),console.log(`Created .env.${o} with keys only`);break}case"delete":{let e=t[1]||".env",o=f.join(process.cwd(),e);n.existsSync(o)?(n.unlinkSync(o),console.log(`Deleted ${e}`)):console.log(`File ${e} does not exist`);break}case"sort":{let e=t[1]||".env",o=f.join(process.cwd(),e);n.existsSync(o)||(console.error(`File ${e} does not exist`),process.exit(1));let s=n.readFileSync(o,"utf-8").split(/\r?\n/),i=s[s.length-1]===""?s.slice(0,-1):s,c=i.filter(l=>!l.startsWith("#")&&l.trim()!==""&&l.includes("=")).sort((l,v)=>l.localeCompare(v)),a=0,r=i.map(l=>!l.startsWith("#")&&l.trim()!==""&&l.includes("=")?c[a++]:l);n.writeFileSync(o,r.join(`
+import n from"fs";import d from"path";import u from"readline";var t=process.argv.slice(2);t.length===0&&(h(),process.exit(0));function h(){console.log("Usage: env-creator <command> [options]"),console.log("   or: env <command> [options]"),console.log("Commands:"),console.log("  c, create [KEY=value...]   Create a .env file (optionally with values)"),console.log("  cfj, create-from-json <json> [--env <name>] Create .env or .env.<name> from JSON"),console.log("  s, split --env <dev|prod>  Create environment-specific file from .env"),console.log("  d, delete [file]           Delete an environment file (default: .env)"),console.log("  srt, sort [file]           Sort keys alphabetically in an env file (default: .env)"),console.log("  gc, generate-constants [file] [--out <file>] Generate a JS file with env variable constants"),console.log("Options:"),console.log("  -h, --help              Show this help message")}var g=t[0];(g==="--help"||g==="-h"||g==="help")&&(h(),process.exit(0));switch(g){case"c":case"create":{let e=d.join(process.cwd(),".env");if(n.existsSync(e))console.log(".env already exists");else{let s=t.slice(1),i="";if(s.length>0){let o=s.filter(c=>c.includes("="));i=o.join(`
+`)+(o.length>0?`
+`:"")}n.writeFileSync(e,i),console.log(i?"Created .env with specified fields":"Created empty .env")}break}case"cfj":case"create-from-json":{let e=t[1];e||(console.error("Please provide a JSON file"),process.exit(1)),n.existsSync(e)||(console.error("JSON file not found"),process.exit(1));let s=t.indexOf("--env"),o=`.env${s!==-1&&t[s+1]?`.${t[s+1]}`:""}`;if(n.existsSync(o)){console.log(`${o} already exists`);break}let c=JSON.parse(n.readFileSync(e,"utf-8")),f="";for(let l in c)f+=`${l}=${c[l]}
+`;n.writeFileSync(o,f),console.log(`Created ${o} from JSON`);break}case"s":case"split":{let e=t.indexOf("--env");(e===-1||!t[e+1])&&(console.error("Please specify environment with --env <dev|prod>"),process.exit(1));let s=t[e+1],i=d.join(process.cwd(),".env");n.existsSync(i)||(console.error(".env file not found"),process.exit(1));let c=n.readFileSync(i,"utf-8").split(/\r?\n/).filter(l=>l.trim()!==""&&!l.startsWith("#")).map(l=>l.split("=")[0]+"=").join(`
+`),f=d.join(process.cwd(),`.env.${s}`);if(n.existsSync(f)){console.log(`.env.${s} already exists`);break}n.writeFileSync(f,c),console.log(`Created .env.${s} with keys only`);break}case"d":case"delete":{let e=t[1]||".env",s=d.join(process.cwd(),e);n.existsSync(s)?(n.unlinkSync(s),console.log(`Deleted ${e}`)):console.log(`File ${e} does not exist`);break}case"srt":case"sort":{let e=t[1]||".env",s=d.join(process.cwd(),e);n.existsSync(s)||(console.error(`File ${e} does not exist`),process.exit(1));let i=n.readFileSync(s,"utf-8").split(/\r?\n/),o=i[i.length-1]===""?i.slice(0,-1):i,c=o.filter(a=>!a.startsWith("#")&&a.trim()!==""&&a.includes("=")).sort((a,m)=>a.localeCompare(m)),f=0,l=o.map(a=>!a.startsWith("#")&&a.trim()!==""&&a.includes("=")?c[f++]:a);n.writeFileSync(s,l.join(`
 `)+`
-`),console.log(`Sorted keys in ${e}`);break}default:console.error(`Unknown command: "${d}"
-`),p(),process.exit(1)}
+`),console.log(`Sorted keys in ${e}`);break}case"gc":case"generate-constants":{let e=t.indexOf("--out"),s=e!==-1&&t[e+1]?t[e+1]:"envConstants.js",o=(e!==-1?t.filter((r,p)=>p!==e&&p!==e+1):t)[1]||".env",c=d.join(process.cwd(),o);if(!n.existsSync(c)){let p=n.readdirSync(process.cwd()).filter(v=>v.startsWith(".env")&&!v.endsWith(".example"));p.length>0?(o=p[0],c=d.join(process.cwd(),o),console.log(`File ${t[1]||".env"} not found. Using ${o} instead.`)):(console.error(`File ${o} does not exist and no fallback .env* files were found`),process.exit(1))}let l=n.readFileSync(c,"utf-8").split(/\r?\n/).filter(r=>!r.startsWith("#")&&r.trim()!==""&&r.includes("=")).map(r=>r.split("=")[0].trim());if(l.length===0){console.log(`No variables found in ${o}`);break}let m=`export const ENV = {
+${l.map(r=>`	${r}: process.env.${r},`).join(`
+`)}
+};
+`,y=d.join(process.cwd(),s);if(n.existsSync(y)){let r=u.createInterface({input:process.stdin,output:process.stdout});r.question(`File ${s} already exists. Overwrite? (y/n) `,p=>{let v=p.trim().toLowerCase();v==="y"||v==="yes"?(n.writeFileSync(y,m),console.log(`Overwrote ${s} from ${o}`)):console.log("Action cancelled. File was not overwritten."),r.close()})}else n.writeFileSync(y,m),console.log(`Generated ${s} from ${o}`);break}default:console.error(`Unknown command: "${g}"
+`),h(),process.exit(1)}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "env-creator",
-  "version": "1.0.0",
-  "description": "Environment variable generator CLI",
+  "version": "1.1.0",
+  "description": "A fast, lightweight CLI tool for managing and generating custom environment (`.env`) files",
   "type": "module",
   "bin": {
     "env-creator": "./dist/cli.js",
-    "create-env": "./dist/cli.js"
+    "env": "./dist/cli.js"
   },
   "exports": {
     ".": "./dist/index.js"
@@ -16,17 +16,15 @@
   "engines": {
     "node": ">=20"
   },
-  "scripts": {
-    "lint": "eslint .",
-    "build": "esbuild src/index.js --bundle --platform=node --format=esm --target=node20 --minify --outfile=dist/index.js && printf '#!/usr/bin/env node\nimport(\"./index.js\");\n' > dist/cli.js && chmod +x dist/cli.js",
-    "prepublishOnly": "npm run lint && npm run build",
-    "release": "npm version patch && npm publish"
-  },
   "keywords": [
     "env",
+    ".env",
     "dotenv",
-    "cli",
     "environment",
+    "variables",
+    "node",
+    "custom",
+    "cli",
     "generator"
   ],
   "author": "Kyrylo Voronoi",
@@ -41,5 +39,11 @@
     "esbuild": "^0.27.3",
     "eslint": "^10.0.3",
     "globals": "^17.4.0"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "build": "esbuild src/index.js --bundle --platform=node --format=esm --target=node20 --minify --outfile=dist/index.js && printf '#!/usr/bin/env node\nimport(\"./index.js\");\n' > dist/cli.js && chmod +x dist/cli.js",
+    "build:pack": "pnpm run build && pnpm pack",
+    "release": "pnpm version patch && pnpm publish"
   }
 }