@goto-bus-stop/envify

This fork of envify supports modern JavaScript syntax.

Selectively replace Node-style environment variables with plain strings. Available as a standalone CLI tool and a Browserify v2 transform.

Works best in combination with uglifyify.

Installation

If you're using the module with Browserify:

1npm install @goto-bus-stop/envify browserify

Or, for the CLI:

1sudo npm install -g @goto-bus-stop/envify

Usage

envify will replace your environment variable checks with ordinary strings - only the variables you use will be included, so you don't have to worry about, say, AWS_SECRET_KEY leaking through either. Take this example script:

1if (process.env.NODE_ENV === "development") {
2  console.log('development only')
3}

After running it through envify with NODE_ENV set to production, you'll get this:

1if ("production" === "development") {
2  console.log('development only')
3}

By running this through a good minifier (e.g. terser), the above code would be stripped out completely.

However, if you bundled the same script with NODE_ENV set to development:

1if ("development" === "development") {
2  console.log('development only')
3}

The if statement will evaluate to true, so the code won't be removed.

CLI Usage

With browserify:

1browserify index.js -t envify > bundle.js

Or standalone:

1envify index.js > bundle.js

You can also specify additional custom environment variables using browserify's subarg syntax, which is available in versions 3.25.0 and above:

1browserify index.js -t [ envify --NODE_ENV development ] > bundle.js
2browserify index.js -t [ envify --NODE_ENV production  ] > bundle.js

Module Usage

require('envify')

Returns a transform stream that updates based on the Node process' process.env object.

require('envify/custom')([environment])

If you want to stay away from your environment variables, you can supply your own object to use in its place:

1var browserify = require('browserify')
2  , envify = require('envify/custom')
3  , fs = require('fs')
4
5var b = browserify('main.js')
6  , output = fs.createWriteStream('bundle.js')
7
8b.transform(envify({
9  NODE_ENV: 'development'
10}))
11b.bundle().pipe(output)

Purging process.env

By default, environment variables that are not defined will be left untouched. This is because in some cases, you might want to run an envify transform over your source more than once, and removing these values would make that impossible.

However, if any references to process.env are remaining after transforming your source with envify, browserify will automatically insert its shim for Node's process object, which will increase the size of your bundle. This weighs in at around 2KB, so if you're trying to be conservative with your bundle size you can "purge" these remaining variables such that any missing ones are simply replaced with undefined.

To do so through the command-line, simply use the subarg syntax and include purge after envify, e.g.:

1browserify index.js -t [ envify purge --NODE_ENV development ]

Or if you're using the module API, you can pass _: "purge" into your arguments like so:

1b.transform(envify({
2    _: 'purge'
3  , NODE_ENV: 'development'
4}))

Contributors

• hughsk
• benjamn
• zag2art
• bjoerge
• andreypopp
• jupl