config-cev-generator

Custom environment variable generator for Node.js projects that use the "config" node module

Showing:

Popularity

Downloads/wk

2K

GitHub Stars

5

Maintenance

Last Commit

2yrs ago

Contributors

2

Package

Dependencies

2

Size (min+gzip)

0.7KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

Node.js Custom Environment Variable Generator for config-Based Projects

This is a handy little utility that will generate JSON suitable for use as a config-based project's config/custom-environment-variables.json. (Note that throughout this project "cev" stands for "custom environment variables".)

See blog post at http://www.scispike.com/blog/get-rid-of-node-js-config-grunt-work

It really comes in handy when your configuration starts to get big and you forget to keep your config/custom-environment-variables.json file in sync with the rest of your configuration.

Example

$ npm install -g config-cev-generator
# change into a config-based node.js project...
$ cev

If your project's configuration is

{
  "foo": {
    "bar": "snafu",
    "goo": "juju"
  }
}

then the preceding command will generate JSON to stdout suitable for use as your project's config/custom-environment-variables.json:

{
  "foo": {
    "bar": "NODE_APP_FOO_BAR",
    "goo": "NODE_APP_FOO_GOO"
  }
}

To save the output, just direct it to a file:

$ cev > config/custom-environment-variables.json

Prerequisites

The generator requires that your project have a valid config-based configuration in order to work properly.

Tips

  • The default environment variable prefix is NODE_APP. Customize with -p or --prefix.
  • The default word separator is _. Customize with -s or --separator.
  • Run cev --help for more information.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial