docs: update packages' README

chihab · Jan 13, 2024 · 872a679 · 872a679
1 parent 78058ce
commit 872a679
Show file tree

Hide file tree

Showing 24 changed files with 159 additions and 110 deletions.
diff --git a/README.md b/README.md
@@ -88,7 +88,7 @@ and the following `dotenv.run` options:
 
 ### @dotenv-run/cli
 
-`@dotenv-run/cli` is a standalone CLI that can be used to run a script.
+[`@dotenv-run/cli`](https://www.npmjs.com/package/@dotenv-run/cli) is a standalone CLI that can be used to run a script.
 
 ```sh
 ❯ npx dotenv-run
@@ -112,7 +112,7 @@ and the following `dotenv.run` options:
 
 ### @dotenv-run/esbuild
 
-`@dotenv-run/esbuild` is a plugin for esbuild that can be used to inject environment variables into your applications.
+[`@dotenv-run/esbuild`](https://www.npmjs.com/package/@dotenv-run/esbuild) is a plugin for esbuild that can be used to inject environment variables into your applications.
 
 ```ts
 import { dotenvRun } from "@dotenv-run/esbuild";
@@ -133,7 +133,7 @@ await build({
 
 ### @ngx-env/builder
 
-`@ngx-env/builder` is a plugin for Angular CLI and a wrapper around `@dotenv-run/esbuild` or `@dotenv-run/webpack` that can be used to inject environment variables into your Angular applications.
+[`@ngx-env/builder`](https://www.npmjs.com/package/@ngx-env/builder) is a plugin for Angular CLI and a wrapper around `@dotenv-run/esbuild` or `@dotenv-run/webpack` that can be used to inject environment variables into your Angular applications.
 
 - ✅ Official recommendation in [dotenv documentation](https://www.dotenv.org/docs/frameworks/angular/vercel) 🔥
 - ✅ Webpack and ESBuild support 🚀
@@ -204,7 +204,7 @@ You can find the full `@ngx-env/builder` documentation [here](https://github.com
 
 ### @dotenv-run/webpack
 
-`@dotenv-run/webpack` is a plugin for webpack that can be used to inject environment variables into your applications.
+[`@dotenv-run/webpack`](https://www.npmjs.com/package/@dotenv-run/webpack) is a plugin for webpack that can be used to inject environment variables into your applications.
 
 ```ts
 import { DotenvRunPlugin } from "@dotenv-run/webpack";
@@ -229,7 +229,7 @@ export default {
 
 ### @dotenv-run/rollup
 
-`@dotenv-run/rollup` is a plugin for rollup that can be used to inject environment variables into your applications.
+[`@dotenv-run/rollup`](https://www.npmjs.com/package/@dotenv-run/rollup) is a plugin for rollup that can be used to inject environment variables into your applications.
 
 ```js
 import env from "@dotenv-run/rollup";
@@ -245,7 +245,7 @@ export default {
 
 ### @dotenv-run/core
 
-`@dotenv-run/core` is the core package that can be used to load environment variables from `.env` files.
+[`@dotenv-run/core`](https://www.npmjs.com/package/@dotenv-run/core) is the core package that can be used to load environment variables from `.env` files.
 
 ```ts
 env({

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @dotenv-run/docs
 
+## 0.1.4
+
+### Patch Changes
+
+- docs: updates packages' README files
+
 ## 0.1.3
 
 ### Patch Changes

diff --git a/docs/package.json b/docs/package.json
@@ -2,7 +2,7 @@
   "name": "@dotenv-run/docs",
   "private": true,
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",

diff --git a/examples/apps/ng-app-webpack/package.json b/examples/apps/ng-app-webpack/package.json
@@ -29,7 +29,7 @@
     "@angular/compiler-cli": "^16.0.0",
     "@types/node": "^16.0.0",
     "cross-env": "^7.0.3",
-    "@dotenv-run/webpack": "^1.3.3",
+    "@dotenv-run/webpack": "^1.3.4",
     "typescript": "~4.9.3"
   }
 }
diff --git a/examples/package.json b/examples/package.json
@@ -8,10 +8,10 @@
     "e2e:all": "nx run-many --target=e2e --all --parallel"
   },
   "devDependencies": {
-    "@dotenv-run/cli": "^1.3.4",
-    "@dotenv-run/load": "^1.3.3",
-    "@dotenv-run/webpack": "^1.3.3",
-    "@dotenv-run/rollup": "^1.3.3",
+    "@dotenv-run/cli": "^1.3.5",
+    "@dotenv-run/load": "^1.3.4",
+    "@dotenv-run/webpack": "^1.3.4",
+    "@dotenv-run/rollup": "^1.3.4",
     "webpack": "^5.0.0",
     "serve": "^14.2.1",
     "@playwright/test": "^1.37.1",

diff --git a/packages/angular/package.json b/packages/angular/package.json
@@ -29,8 +29,8 @@
     "copy-dist": "ts-node tools/schema-dist.ts"
   },
   "dependencies": {
-    "@dotenv-run/esbuild": "^1.3.3",
-    "@dotenv-run/webpack": "^1.3.3",
+    "@dotenv-run/esbuild": "^1.3.4",
+    "@dotenv-run/webpack": "^1.3.4",
     "glob": "^10.3.10"
   },
   "devDependencies": {
@@ -40,7 +40,7 @@
     "@angular-devkit/architect": "^0.1700.8",
     "@angular-devkit/core": "^17.0.0",
     "@angular/compiler": "^17.0.2",
-    "@dotenv-run/core": "^1.3.3",
+    "@dotenv-run/core": "^1.3.4",
     "cpy": "^8.1.2",
     "karma": "^6.4.2",
     "ts-node": "^10.8.0",

diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @dotenv-run/cli
 
+## 1.3.5
+
+### Patch Changes
+
+- docs: updates packages' README files
+- Updated dependencies
+  - @dotenv-run/core@1.3.4
+
 ## 1.3.4
 
 ### Patch Changes

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -22,22 +22,23 @@ npm add -D @dotenv-run/cli
 ## Prompt
 
 ```sh
-$> dotenv-run -h
+❯ npx dotenv-run
 
-Usage: dotenv-run [options] -- <command>
+  Usage: dotenv-run [options] -- <command>
 
-Options:
-
-    -h, --help     output usage information
-    -e, --env      environment name (e.g. dev, prod)
-    -s, --silent   do not print .env file paths
-    -r, --root     root directory to search for .env files
-
-Examples:
+  Options:
+    -v, --verbose [regexp]         display debug information
+    -u, --unsecure                 display environment variables values
+    -e, --env [environment]        environment to load (default: NODE_ENV)
+    -r, --root                     root directory to search for .env files
+    -f, --file [.env,.secrets]     .env files to load (default: .env)
+    -h, --help                     output usage information
 
+  Examples:
+    dotenv-run -d
     dotenv-run -- npm start
-    dotenv-run -r ../.. -- npm start
-    dotenv-run -e prod -- npm start
+    dotenv-run -r ../.. -p .env,.secrets -- npm start
+    dotenv-run -f ../.env,../.env.api -- npm start
 ```
 
 ## Usage

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@dotenv-run/cli",
-  "version": "1.3.4",
+  "version": "1.3.5",
   "description": "cli to load environment variables with monorepo support",
   "homepage": "https://github.com/chihab/dotenv-run",
   "type": "module",
@@ -25,7 +25,7 @@
   "author": "Chihab Otmani <chihab@gmail.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotenv-run/core": "^1.3.3",
+    "@dotenv-run/core": "^1.3.4",
     "chalk": "^4.1.0",
     "cross-spawn": "^7.0.3",
     "minimist": "^1.2.8"

diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @dotenv-run/core
 
+## 1.3.4
+
+### Patch Changes
+
+- docs: updates packages' README files
+
 ## 1.3.3
 
 ### Patch Changes

diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,14 +1,12 @@
-
 # @dotenv-run/core
 
-* ✅ Load environment variables from the command line `API_BASE=/v1/ core`
-* ✅ Load environment variables from `.env` files
-* ✅ Expand environment variables `API_URL=$API_BASE/users`
-* ✅ Define environment variables for a specific environment (e.g. `.env.production`)
-* ✅ Load priorities of `.env.*` files (e.g. `.env.production` > `.env`)
-* ✅ Hierarchical cascading configuration in monorepo projects ([Nx](https://nx.dev), [Turbo](https://turbo.build/), etc.) 
- `apps/next-app/.env` > `apps/.env` > `.env`
-
+- ✅ Load environment variables from the command line `API_BASE=/v1/ core`
+- ✅ Load environment variables from `.env` files
+- ✅ Expand environment variables `API_URL=$API_BASE/users`
+- ✅ Define environment variables for a specific environment (e.g. `.env.production`)
+- ✅ Load priorities of `.env.*` files (e.g. `.env.production` > `.env`)
+- ✅ Hierarchical cascading configuration in monorepo projects ([Nx](https://nx.dev), [Turbo](https://turbo.build/), etc.)
+  `apps/next-app/.env` > `apps/.env` > `.env`
 
 # Install
 
@@ -20,8 +18,13 @@ npm add @dotenv-run/core
 
 ```js
 // index.js
-import { expand, paths } from "@dotenv-run/core";
-expand(paths(process.env.NODE_ENV, '../../'));
+import { env } from "@dotenv-run/core";
+env({
+  root: "../..",
+  verbose: true,
+  prefix: "^API_",
+  files: [".env"],
+});
 console.log(process.env.API_USERS);
 ```
 
@@ -33,7 +36,7 @@ given the following files:
     API_AUTH=$API_BASE/v1/auth
 .env.dev
     API_BASE=https://localhost:3000
-.env.prod 
+.env.prod
     API_BASE=https://dotenv-run.app
 ```
 

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@dotenv-run/core",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "core library to load environment variables with monorepo support",
   "homepage": "https://github.com/chihab/dotenv-run",
   "main": "dist/cjs/index.js",

diff --git a/packages/esbuild/CHANGELOG.md b/packages/esbuild/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @dotenv-run/esbuild
 
+## 1.3.4
+
+### Patch Changes
+
+- docs: updates packages' README files
+- Updated dependencies
+  - @dotenv-run/core@1.3.4
+
 ## 1.3.3
 
 ### Patch Changes

diff --git a/packages/esbuild/README.md b/packages/esbuild/README.md
@@ -24,10 +24,11 @@ import { env } from "@dotenv-run/esbuild";
 
 const { full } = env({
   prefix: "MY_",
-  verbose: true,
+  verbose: false,
+  files: [".env"],
 });
 
-await build({
+const results = await build({
   bundle: true,
   write: false,
   entryPoints: [`test/app.js`],
@@ -39,17 +40,18 @@ await build({
 
 ```js
 import { build } from "esbuild";
-import { env } from "@dotenv-run/esbuild";
-
-const { full } = env({
-  prefix: "MY_",
-  verbose: true,
-});
+import { dotenvRun } from "@dotenv-run/esbuild";
 
 await build({
-  bundle: true,
   write: false,
+  bundle: true,
   entryPoints: [`test/app.js`],
-  define: full,
+  plugins: [
+    dotenvRun({
+      verbose: true,
+      root: "../../",
+      prefix: "^API",
+    }),
+  ],
 });
 ```
diff --git a/packages/esbuild/package.json b/packages/esbuild/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@dotenv-run/esbuild",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "Run your scripts with dotenv variables",
   "homepage": "https://github.com/chihab/dotenv-run",
   "main": "dist/cjs/index.js",
@@ -26,7 +26,7 @@
   "author": "Chihab Otmani <chihab@gmail.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotenv-run/core": "^1.3.3"
+    "@dotenv-run/core": "^1.3.4"
   },
   "peerDependencies": {
     "esbuild": "0.19.5"

diff --git a/packages/load/CHANGELOG.md b/packages/load/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @dotenv-run/load
 
+## 1.3.4
+
+### Patch Changes
+
+- docs: updates packages' README files
+- Updated dependencies
+  - @dotenv-run/core@1.3.4
+
 ## 1.3.3
 
 ### Patch Changes

diff --git a/packages/load/package.json b/packages/load/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@dotenv-run/load",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "Perload your scripts with dotenv variables",
   "homepage": "https://github.com/chihab/dotenv-run",
   "main": "dist/index.js",
@@ -22,7 +22,7 @@
   "author": "Chihab Otmani <chihab@gmail.com>",
   "license": "ISC",
   "dependencies": {
-    "@dotenv-run/core": "^1.3.3"
+    "@dotenv-run/core": "^1.3.4"
   },
   "devDependencies": {
     "@types/node": "^16.0.0"

diff --git a/packages/rollup/CHANGELOG.md b/packages/rollup/CHANGELOG.md
@@ -1,5 +1,13 @@
 # @dotenv-run/rollup
 
+## 1.3.4
+
+### Patch Changes
+
+- docs: updates packages' README files
+- Updated dependencies
+  - @dotenv-run/core@1.3.4
+
 ## 1.3.3
 
 ### Patch Changes