@dotenvx/dotenvx 1.32.0 → 1.33.0

package/CHANGELOG.md

@@ -2,7 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.32.0...main)
+[Unreleased](https://github.com/dotenvx/dotenvx/compare/v1.33.0...main)
+
+## [1.33.0](https://github.com/dotenvx/dotenvx/compare/v1.32.1...v1.33.0)
+
+### Added
+
+* support ESM import convenience `import '@dotenvx/dotenvx/config'` ([#508](https://github.com/dotenvx/dotenvx/pull/508))
+
+## [1.32.1](https://github.com/dotenvx/dotenvx/compare/v1.32.0...v1.32.1)
+
+### Changed
+
+* remove duplicated help messages ([#504](https://github.com/dotenvx/dotenvx/pull/504))
 
 ## [1.32.0](https://github.com/dotenvx/dotenvx/compare/v1.31.3...v1.32.0)
 

package/README.md

@@ -19,6 +19,7 @@ npm install @dotenvx/dotenvx --save
 ```js
 // index.js
 require('@dotenvx/dotenvx').config()
+// or import('@dotenvx/dotenvx/config') if you're using esm
 
 console.log(`Hello ${process.env.HELLO}`)
 ```
@@ -80,7 +81,7 @@ tar -xzf dotenvx.tar.gz
 </details>
 
 
-<details><summary>or with windows 🪟</summary><br>
+<details><summary>or windows 🪟</summary><br>
 
 ```sh
 winget install dotenvx
@@ -427,7 +428,7 @@ More examples
   > start
   > ./node_modules/.bin/dotenvx run -- node index.js
 
-  [dotenvx][info] loading env (1) from .env
+  [dotenvx@1.X.X] injecting env (1) from .env.production
   Hello World
   ```
 
@@ -504,7 +505,7 @@ $ echo "HELLO=production" > .env.production
 $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
 $ dotenvx run -f .env.production -- node index.js
-[dotenvx][info] loading env (1) from .env.production
+[dotenvx@1.X.X] injecting env (1) from .env.production
 Hello production
 > ^^
 ```
@@ -519,7 +520,7 @@ More examples
   $ echo "HELLO=World" > .env
 
   $ dotenvx run -f .env.local -f .env -- node index.js
-  [dotenvx][info] loading env (1) from .env.local,.env
+  [dotenvx@1.X.X] injecting env (1) from .env.local,.env
   Hello local
   ```
 
@@ -533,7 +534,7 @@ More examples
   $ echo "HELLO=World" > .env
 
   $ dotenvx run -f .env.local -f .env --overload -- node index.js
-  [dotenvx][info] loading env (1) from .env.local,.env
+  [dotenvx@1.X.X] injecting env (1) from .env.local,.env
   Hello World
   ```
 
@@ -545,7 +546,7 @@ More examples
   $ dotenvx run -f .env.production --verbose -- node index.js
   [dotenvx][verbose] injecting env from /path/to/.env.production
   [dotenvx][verbose] HELLO set
-  [dotenvx][info] loading env (1) from .env.production
+  [dotenvx@1.X.X] injecting env (1) from .env.production
   Hello production
   ```
 
@@ -564,7 +565,7 @@ More examples
   [dotenvx][debug] writing env from /path/to/.env.production
   [dotenvx][verbose] HELLO set
   [dotenvx][debug] HELLO set to production
-  [dotenvx][info] loading env (1) from .env.production
+  [dotenvx@1.X.X] injecting env (1) from .env.production
   Hello production
   ```
 
@@ -638,7 +639,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ dotenvx run -- node index.js
-  [dotenvx] injecting env (2) from .env
+  [dotenvx@1.X.X] injecting env (2) from .env
   Hello World
   ```
 
@@ -651,7 +652,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ DOTENV_PRIVATE_KEY_PRODUCTION="<.env.production private key>" dotenvx run -- node index.js
-  [dotenvx] injecting env (2) from .env.production
+  [dotenvx@1.X.X] injecting env (2) from .env.production
   Hello Production
   ```
 
@@ -666,7 +667,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ DOTENV_PRIVATE_KEY_CI="<.env.ci private key>" dotenvx run -- node index.js
-  [dotenvx] injecting env (2) from .env.ci
+  [dotenvx@1.X.X] injecting env (2) from .env.ci
   Hello Ci
   ```
 
@@ -681,7 +682,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ DOTENV_PRIVATE_KEY="<.env private key>" DOTENV_PRIVATE_KEY_PRODUCTION="<.env.production private key>" dotenvx run -- node index.js
-  [dotenvx] injecting env (3) from .env, .env.production
+  [dotenvx@1.X.X] injecting env (3) from .env, .env.production
   Hello World
   ```
 
@@ -698,11 +699,11 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ DOTENV_PRIVATE_KEY_CI="<app1/privat ci key>,<app2/private ci key>" dotenvx run -f app1/.env.ci -f app2/.env.ci -- node index.js
-  [dotenvx] injecting env (2) from app1/.env.ci,app2/.env.ci
+  [dotenvx@1.X.X] injecting env (2) from app1/.env.ci,app2/.env.ci
   Hello app1
 
   $ DOTENV_PRIVATE_KEY_CI="<app1/privat ci key>,<app2/private ci key>" dotenvx run -f app1/.env.ci -f app2/.env.ci --overload -- node index.js
-  [dotenvx] injecting env (2) from app1/.env.ci,app2/.env.ci
+  [dotenvx@1.X.X] injecting env (2) from app1/.env.ci,app2/.env.ci
   Hello app2
   ```
 
@@ -749,7 +750,7 @@ More examples
   ```
   ```sh
   $ dotenvx run --debug -- node index.js
-  [dotenvx] injecting env (2) from .env
+  [dotenvx@1.X.X] injecting env (2) from .env
   DATABASE_URL postgres://username@localhost/my_database
   ```
 
@@ -768,7 +769,7 @@ More examples
   ```
   ```sh
   $ dotenvx run --debug -- node index.js
-  [dotenvx] injecting env (1) from .env
+  [dotenvx@1.X.X] injecting env (1) from .env
   DATABASE_URL postgres://yourusername@localhost/my_database
   ```
 
@@ -793,7 +794,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ dotenvx run -f .env.local -f .env -- node index.js
-  [dotenvx] injecting env (1) from .env.local, .env
+  [dotenvx@1.X.X] injecting env (1) from .env.local, .env
   Hello local
   ```
 
@@ -807,7 +808,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ dotenvx run --env HELLO=String -f .env -- node index.js
-  [dotenvx] injecting env (1) from .env, and --env flag
+  [dotenvx@1.X.X] injecting env (1) from .env, and --env flag
   Hello String
   ```
 
@@ -822,7 +823,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ dotenvx run -f .env.local -f .env --overload -- node index.js
-  [dotenvx] injecting env (1) from .env.local, .env
+  [dotenvx@1.X.X] injecting env (1) from .env.local, .env
   Hello World
   ```
 
@@ -838,7 +839,7 @@ More examples
 
   # check your .env.keys files for your privateKey
   $ DOTENV_PRIVATE_KEY="122...0b8" dotenvx run -- node index.js
-  [dotenvx] injecting env (2) from .env
+  [dotenvx@1.X.X] injecting env (2) from .env
   Hello encrypted
   ```
 
@@ -854,7 +855,7 @@ More examples
 
   # check .env.keys for your privateKey
   $ DOTENV_PRIVATE_KEY_PRODUCTION="122...0b8" dotenvx run -- node index.js
-  [dotenvx] injecting env (2) from .env.production
+  [dotenvx@1.X.X] injecting env (2) from .env.production
   Hello production encrypted
   ```
 
@@ -872,7 +873,7 @@ More examples
 
   # check .env.keys for your privateKey
   $ DOTENV_PRIVATE_KEY_CI="122...0b8" dotenvx run -- node index.js
-  [dotenvx] injecting env (2) from .env.ci
+  [dotenvx@1.X.X] injecting env (2) from .env.ci
   Hello ci encrypted
   ```
 
@@ -892,11 +893,11 @@ More examples
 
   # check .env.keys for your privateKeys
   $ DOTENV_PRIVATE_KEY="122...0b8" DOTENV_PRIVATE_KEY_PRODUCTION="122...0b8" dotenvx run -- node index.js
-  [dotenvx] injecting env (3) from .env, .env.production
+  [dotenvx@1.X.X] injecting env (3) from .env, .env.production
   Hello encrypted
 
   $ DOTENV_PRIVATE_KEY_PRODUCTION="122...0b8" DOTENV_PRIVATE_KEY="122...0b8" dotenvx run -- node index.js
-  [dotenvx] injecting env (3) from .env.production, .env
+  [dotenvx@1.X.X] injecting env (3) from .env.production, .env
   Hello production encrypted
   ```
 
@@ -914,7 +915,7 @@ More examples
   $ dotenvx run -f .env.production --verbose -- node index.js
   loading env from .env.production (/path/to/.env.production)
   HELLO set
-  [dotenvx] injecting env (1) from .env.production
+  [dotenvx@1.X.X] injecting env (1) from .env.production
   Hello production
   ```
 
@@ -934,7 +935,7 @@ More examples
   {"HELLO":"production"}
   HELLO set
   HELLO set to production
-  [dotenvx] injecting env (1) from .env.production
+  [dotenvx@1.X.X] injecting env (1) from .env.production
   executing process command [node index.js]
   expanding process command to [/opt/homebrew/bin/node index.js]
   Hello production
@@ -1008,7 +1009,7 @@ More examples
   $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
   $ dotenvx run --convention=nextjs -- node index.js
-  [dotenvx] injecting env (1) from .env.development.local, .env.local, .env.development, .env
+  [dotenvx@1.X.X] injecting env (1) from .env.development.local, .env.local, .env.development, .env
   Hello development local
   ```
 
@@ -1736,7 +1737,7 @@ More examples
     $ echo "console.log('Hello ' + process.env.HELLO)" > index.js
 
     $ dotenvx run -- node index.js
-    [dotenvx] injecting env (1) from .env
+    [dotenvx@1.X.X] injecting env (1) from .env
     Hello World
   ```
 
@@ -1905,7 +1906,7 @@ More examples
 
   ```sh
   $ node index.js
-  [dotenvx@1.24.5] injecting env (1) from .env
+  [dotenvx@1.X.X] injecting env (1) from .env
   Hello World
   ```
 
@@ -1935,7 +1936,7 @@ More examples
 
   ```sh
   $ node index.js
-  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
+  [dotenvx@1.X.X] injecting env (1) from .env.local, .env
   Hello Me
   ```
 
@@ -1963,7 +1964,7 @@ More examples
 
   ```sh
   $ node index.js
-  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
+  [dotenvx@1.X.X] injecting env (1) from .env.local, .env
   Hello World
   ```
 
@@ -2008,7 +2009,7 @@ More examples
 
   ```sh
   $ node index.js
-  [dotenvx@1.24.5] injecting env (1) from .env.local, .env
+  [dotenvx@1.X.X] injecting env (1) from .env
   Hello World
   ```
 
@@ -2024,7 +2025,7 @@ More examples
 
   ```js
   // index.js
-  require('@dotenvx/dotenvx').config({envKeysFile: '../../.env.keys'})
+  require('@dotenvx/dotenvx').config({path: ['.env'], envKeysFile: '../../.env.keys'})
   ```
 
   </details>

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.32.0",
+  "version": "1.33.0",
   "name": "@dotenvx/dotenvx",
   "description": "a better dotenv–from the creator of `dotenv`",
   "author": "@motdotla",
@@ -19,6 +19,16 @@
   ],
   "main": "src/lib/main.js",
   "types": "src/lib/main.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/lib/main.d.ts",
+      "require": "./src/lib/main.js",
+      "default": "./src/lib/main.js"
+    },
+    "./config": "./src/lib/config.js",
+    "./config.js": "./src/lib/config.js",
+    "./package.json": "./package.json"
+  },
   "bin": {
     "dotenvx": "./src/cli/dotenvx.js",
     "git-dotenvx": "./src/cli/dotenvx.js"

package/src/cli/dotenvx.js

@@ -59,7 +59,7 @@ program.command('run')
   .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
   .option('-fv, --env-vault-file <paths...>', 'path(s) to your .env.vault file(s)', collectEnvs('envVaultFile'), [])
   .option('-o, --overload', 'override existing env variables')
-  .option('--strict', 'process.exit(1) on any errors (default: false)', false)
+  .option('--strict', 'process.exit(1) on any errors', false)
   .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\'])')
   .option('--ignore <errorCodes...>', 'error code(s) to ignore (example: --ignore=MISSING_ENV_FILE)')
   .action(function (...args) {
@@ -78,7 +78,7 @@ program.command('get')
   .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
   .option('-fv, --env-vault-file <paths...>', 'path(s) to your .env.vault file(s)', collectEnvs('envVaultFile'), [])
   .option('-o, --overload', 'override existing env variables')
-  .option('--strict', 'process.exit(1) on any errors (default: false)', false)
+  .option('--strict', 'process.exit(1) on any errors', false)
   .option('--convention <name>', 'load a .env convention (available conventions: [\'nextjs\'])')
   .option('--ignore <errorCodes...>', 'error code(s) to ignore (example: --ignore=MISSING_ENV_FILE)')
   .option('-a, --all', 'include all machine envs as well')
@@ -100,7 +100,7 @@ program.command('set')
   .argument('value', 'value')
   .option('-f, --env-file <paths...>', 'path(s) to your env file(s)', collectEnvs('envFile'), [])
   .option('-fk, --env-keys-file <path>', 'path to your .env.keys file (default: same path as your env file)')
-  .option('-c, --encrypt', 'encrypt value (default: true)', true)
+  .option('-c, --encrypt', 'encrypt value', true)
   .option('-p, --plain', 'store value as plain text', false)
   .action(function (...args) {
     this.envs = envs

package/src/lib/config.js

@@ -0,0 +1 @@
+require('./main.js').config()