envlocalify v1.1.1

envlocalify

envify and localenv combined as a browserify transform

envlocalify

hughsk/envify and defunctzombie/localenv combined for substack/node-browserify modules.

Installation

npm install envlocalify --save-dev

USAGE

This browserify transform can be used like envify, but in addition, if you use atomify, then:

// [index.js]
var foo = process.env.FOO;
console.log(foo);

And a .env file sitting in your current working dir.

# [.env]
FOO=bar

Running atomify with the envlocalify transform:
(if you change environment files in atomify server and/or watch mode, you need to restart atomify)

atomify --envlocalify

results in

// [index.js]
var foo = "bar";
console.log(foo);

.env should be checked into the repository. Locally, you can overwrite properties specified in it, by creating a .env.local file, which should be added to .gitignore, so every contributor can his own file.

Advanced

This is useful if you want to create npm tasks for atomify, e.g.:

// [package.json]
//...
"scripts": {
  "start": "atomify <see usage below>"
//...

# replaces ".env" as the default env file
atomify --envlocalify [ --envfile .envCustom ]

# overwrites ".env.local" as the default file which extends '.env'
atomify --envlocalify [ --localenvfile .env.mylocal ]

# disables extending '.env'
atomify --envlocalify [ --localenvfile false ]

You can combine both parameters.

Specifying a custom env file

defunctzombie/localenv only loads .env files when NODE_PRODUCTION !== 'production'.

You can pass transform options to envlocalify to load custom .env files.

.env files

.env file format is described in defunctzombie/localenv readme.

You should use .env files for developer or test environments, not for production* environments.