https://github.com/mrsteele/dotenv-defaults
dotenv... but with defaults!
https://github.com/mrsteele/dotenv-defaults
defaults dotenv environment environment-variables
Last synced: 4 months ago
JSON representation
dotenv... but with defaults!
- Host: GitHub
- URL: https://github.com/mrsteele/dotenv-defaults
- Owner: mrsteele
- License: mit
- Created: 2018-04-05T15:02:29.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T07:14:47.000Z (over 3 years ago)
- Last Synced: 2025-03-29T16:10:01.497Z (about 1 year ago)
- Topics: defaults, dotenv, environment, environment-variables
- Language: JavaScript
- Size: 524 KB
- Stars: 77
- Watchers: 1
- Forks: 8
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - dotenv-defaults - A dotenv system that supports defaults. (Backend frameworks & libraries)
README
# dotenv-defaults
A dotenv system that supports defaults.
### Status
[](https://github.com/mrsteele/dotenv-defaults/actions/workflows/main.yml)
[](https://www.dotenv.org/get-started?r=3)
### Installation
Use the following to install this module:
```
npm i dotenv-defaults --save
```
### Usage
This module supports all the features from the original [dotenv](https://www.npmjs.com/package/dotenv) module, so usage should be simple enough:
```
# .env.defaults, safe to commit
HOST=website.com
EMAIL=test@email.com
```
```
# .env, DO NOT COMMIT
HOST=mrsteele.dev
```
The result
```js
// ESM (Node.js 18+)
import { config } from 'dotenv-defaults'
config()
// Or load it directly like this
import 'dotenv-defaults/config'
console.log(process.env.HOST)
// Outputs: mrsteele.dev
console.log(process.env.EMAIL)
// Outputs: test@email.com
```
##### TypeScript
This module now includes full TypeScript type definitions and works seamlessly with TypeScript:
```typescript
import { config, parse, type ConfigOptions } from 'dotenv-defaults'
// Or load directly
import 'dotenv-defaults/config'
const options: ConfigOptions = {
path: './.env',
defaults: './.env.defaults'
}
config(options)
```
##### CLI
You can also call this module directly when using the node executable.
So, for example if you are running a custom script with node and you want to load your environment variables you can do the following `node --import dotenv-defaults/config your-script.js`. (_When using this method, please make sure that you have installed dotenv-defaults with npm or yarn in the same directory_)
> **Note:** For Node.js versions that don't support `--import`, you can use `node --loader dotenv-defaults/config your-script.js`
### Differences
The only thing to note is that the original module supported an `options` argument in the `config` function.
This module supports that as well, but there is an added `defaults` property that can allow you to define where that file is located. An example is shown below:
```js
// ESM
import { config } from 'dotenv-defaults'
// all of these are the default values...
config({
path: './.env',
encoding: 'utf8',
defaults: './.env.defaults' // This is new
})
```
### License
MIT