Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

dotenv-expand

Package Overview
Dependencies
0
Maintainers
1
Versions
15
Issues
File Explorer

Advanced tools

dotenv-expand

Expand environment variables using dotenv

    9.0.0latest

Version published
Maintainers
1
Weekly downloads
9,790,612
decreased by-9.28%

Weekly downloads

Changelog

Source

9.0.0 (2022-08-30)

Added

  • Proper support for preload and cli args (#78)

Readme

Source

dotenv-vault

dotenv-expand

dotenv-expand

Dotenv-expand adds variable expansion on top of dotenv. If you find yourself needing to expand environment variables already existing on your machine, then dotenv-expand is your tool.

BuildStatus NPM version js-standard-style Featured on Openbase

Install

# Install locally (recommended) npm install dotenv-expand --save

Or installing with yarn? yarn add dotenv-expand

Usage

Create a .env file in the root of your project:

PASSWORD="s1mpl3" DB_PASS=$PASSWORD

As early as possible in your application, import and configure dotenv and then expand dotenv:

var dotenv = require('dotenv') var dotenvExpand = require('dotenv-expand') var myEnv = dotenv.config() dotenvExpand.expand(myEnv) console.log(process.env)

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 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.

$ 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

$ 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.

$ DOTENV_CONFIG_<OPTION>=value node -r dotenv-expand/config your_script.js $ DOTENV_CONFIG_ENCODING=latin1 node -r dotenv-expand/config your_script.js dotenv_config_path=/custom/path/to/.env

Examples

See tests/.env for simple and complex examples of variable expansion in your .env file.

Documentation

DotenvExpand exposes one function:

  • expand

Expand

expand will expand your environment variables.

const dotenv = { parsed: { BASIC: 'basic', BASIC_EXPAND: '${BASIC}', BASIC_EXPAND_SIMPLE: '$BASIC' } } const obj = dotenvExpand.expand(dotenv) console.log(obj)
Options
ignoreProcessEnv

Default: false

Turn off writing to process.env.

const dotenv = { ignoreProcessEnv: true, parsed: { SHOULD_NOT_EXIST: 'testing' } } const obj = dotenvExpand.expand(dotenv).parsed console.log(obj.SHOULD_NOT_EXIST) // testing console.log(process.env.SHOULD_NOT_EXIST) // undefined

FAQ

What rules does the expansion engine follow?

The expansion engine roughly has the following rules:

  • $KEY will expand any env with the name KEY
  • ${KEY} will expand any env with the name KEY
  • \$KEY will escape the $KEY rather than expand
  • ${KEY:-default} will first attempt to expand any env with the name KEY. If not one, then it will return default

You can see a full list of examples here.

Contributing Guide

See CONTRIBUTING.md

CHANGELOG

See CHANGELOG.md

Who's using dotenv-expand?

These npm modules depend on it.

Keywords

FAQs

What is dotenv-expand?

Expand environment variables using dotenv

Is dotenv-expand popular?

The npm package dotenv-expand receives a total of 9,300,854 weekly downloads. As such, dotenv-expand popularity was classified as popular.

Is dotenv-expand well maintained?

We found that dotenv-expand demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 30 Aug 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc