Merge branch 'master' into yeti-or.fix-build

CHANGELOG.md

@@ -2,8 +2,17 @@
 
 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/motdotla/dotenv-expand/compare/v6.0.1...master)
+## [Unreleased](https://github.com/motdotla/dotenv-expand/compare/v8.0.0...master)
 
+## [8.0.0](https://github.com/motdotla/dotenv-expand/compare/v7.0.0...v8.0.0) (2022-02-03)
+
+### Changed
+
+- _Breaking:_ Bump to `v16.0.0` of dotenv
+
+### Added
+
+- Preload support 🎉 ([#31](https://github.com/motdotla/dotenv-expand/pull/31))
 
 ## [7.0.0](https://github.com/motdotla/dotenv-expand/compare/v6.0.1...v7.0.0) (2022-01-17)
 

README.md

@@ -19,32 +19,24 @@ dotenv-expand is your tool.
 
 ```bash
 # Install locally (recommended)
-npm install dotenv --save
 npm install dotenv-expand --save
 ```
 
 Or installing with yarn? `yarn add dotenv-expand`
 
 ## Usage
 
-Usage is a cinch!
-
-### 1. Create a .env file with variable expansions in the root directory of your project
+Create a `.env` file in the root of your project:
 
 ```dosini
-# .env file
-#
-# Add environment-specific variables on new lines in the form of NAME=VALUE
-#
-PASSWORD=s1mpl3
-DB_HOST=localhost
-DB_USER=root
+PASSWORD="s1mpl3"
 DB_PASS=$PASSWORD
+
 ```
 
-### 2. As early as possible in your application, import dotenv and expand with dotenv-expand
+As early as possible in your application, import and configure dotenv and then expand dotenv:
 
-```js
+```javascript
 var dotenv = require('dotenv')
 var dotenvExpand = require('dotenv-expand')
 
@@ -54,9 +46,32 @@ dotenvExpand.expand(myEnv)
 console.log(process.env)
 ```
 
-### 3. That's it! 👏
+That's it. `process.env` now has the expanded keys and values you defined in your `.env` file.
+
+### Preload
+
+You can use the `--require` (`-r`) [command line option](https://nodejs.org/api/cli.html#cli_r_require_module) to preload dotenv & dotenv-
+. By doing this, you do not need to require and load dotenv or dotenv-expand in your application code. This is the preferred approach when using `import` instead of `require`.
+
+```bash
+$ node -r dotenv-expand/config your_script.js
+```
+
+The configuration options below are supported as command line arguments in the format `dotenv_config_<option>=value`
+
+```bash
+$ node -r dotenv-expand/config your_script.js dotenv_config_path=/custom/path/to/your/env/vars
+```
+
+Additionally, you can use environment variables to set configuration options. Command line arguments will precede these.
+
+```bash
+$ DOTENV_CONFIG_<OPTION>=value node -r dotenv-expand/config your_script.js
+```
 
-`process.env` now has the expanded keys and values you defined in your `.env` file.
+```bash
+$ DOTENV_CONFIG_ENCODING=latin1 node -r dotenv-expand/config your_script.js dotenv_config_path=/custom/path/to/.env
+```
 
 ## Examples
 
@@ -129,30 +144,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md)
 
 See [CHANGELOG.md](CHANGELOG.md)
 
-### Preload
-
-You can use the `--require` (`-r`) [command line option](https://nodejs.org/api/cli.html#cli_r_require_module) to preload dotenv & dotenv-expand. By doing this, you do not need to require and load dotenv or dotenv-expand in your application code. This is the preferred approach when using `import` instead of `require`.
-
-```bash
-$ node -r dotenv-expand/config your_script.js
-```
-
-The configuration options below are supported as command line arguments in the format `dotenv_config_<option>=value`
-
-```bash
-$ node -r dotenv-expand/config your_script.js dotenv_config_path=/custom/path/to/your/env/vars
-```
-
-Additionally, you can use environment variables to set configuration options. Command line arguments will precede these.
-
-```bash
-$ DOTENV_CONFIG_<OPTION>=value node -r dotenv-expand/config your_script.js
-```
-
-```bash
-$ DOTENV_CONFIG_ENCODING=latin1 node -r dotenv-expand/config your_script.js dotenv_config_path=/custom/path/to/.env
-```
-
 ## Who's using dotenv-expand?
 
 [These npm modules depend on it.](https://www.npmjs.com/browse/depended/dotenv-expand)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotenv-expand",
-  "version": "7.0.0",
+  "version": "8.0.0",
   "description": "Expand environment variables using dotenv",
   "main": "lib/main.js",
   "types": "lib/main.d.ts",
@@ -36,7 +36,7 @@
   "license": "BSD-2-Clause",
   "devDependencies": {
     "@types/node": "^17.0.8",
-    "dotenv": "^15.0.0",
+    "dotenv": "^16.0.0",
     "lab": "^14.3.4",
     "should": "^11.2.1",
     "standard": "^16.0.4",