Parse and write environment files with Node.js
Switch branches/tags
Nothing to show
Clone or download

README.md

envfile

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

Parse and stringify the environment configuration files and format, also known as .env files and dotenv files

What are environment configuration files?

They are files use to configure environments by applications and servers that support them. Generally they look like this:

a=1
b:2
c = 3
d : 4

They are commonly also called envfiles, .env files, and dotenv files.

Install

NPM

  • Install: npm install --save envfile
  • Executables: envfile2json, json2envfile
  • Module: require('envfile')

Browserify

  • Install: npm install --save envfile
  • Module: require('envfile')
  • CDN URL: //wzrd.in/bundle/envfile@2.3.0

Ender

  • Install: ender add envfile
  • Module: require('envfile')

Editions

This package is published with the following editions:

  • envfile aliases envfile/index.js which uses Editions to automatically select the correct edition for the consumers environment
  • envfile/source/index.js is Source + ESNext + Require
  • envfile/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

Via the Command Line

Requires a global installation of envfile: npm install -g envfile

# envfile to JSON
echo -e "a=1\nb:2" | envfile2json > config.json

# JSON to envfile
echo '{"a":1,"b":2}' | json2envfile > config.env

Via Node.js

// Include envfile
const envfile = require('envfile')
const sourcePath = 'file.env'
const sourceString = "a=1\nb:2"
const sourceObject = {a:1, b:2}

// Parse an envfile path
// async
envfile.parseFile(sourcePath, function (err, obj) {
	console.log(err, obj)
})
// sync
console.log(
	envfile.parseFileSync(sourcePath)
)

// Parse an envfile string
// async
envfile.parse(sourceString, function (err, obj) {
	console.log(err, obj)
})
// sync
console.log(
	envfile.parseSync(sourceString)
)

// Stringify a javascript object to an envfile string
// async
envfile.stringify(sourceObject, function (err, str) {
	console.log(err, str)
})
// sync
console.log(
	envfile.stringifySync(sourceObject)
)

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: