readme.md

Easy Configuration

Install ezconf by typing npm install --save ezconf.

Setup

Create a config directory in the root of your project

project/
  config/
    production-config.js
    development-config.js
    test-config.js
  node_modules/
  	ezconf/
  index.js
  package.json

If you want, add a line /config/ to your gitignore to ignore the config folder.

production-config.js

module.exports = {
	USERNAME: 'prodadmin',
	PASSWORD: 'pav7ZuTr'
}

development-config.js

module.exports = {
  USERNAME: 'devadmin',
  PASSWORD: 'supersafe'
};

Usage

Using ezconf is very simple, you just require('ezconf') as shown below.

index.js

var config = require('ezconf');

console.log(config.USERNAME);

Just execute your application like so

$ node index.js
devadmin

Set the environment variable to production, test or development to select the right configuration

$ NODE_ENV=production node index.js
prodadmin

Additional information

Since the configuration files are javascript files you can also execute some code. Maybe you want to add a debug statement to log which configuration you are using.

development-config.js

var debug = require('debug');

debug('Loading development configuration');

module.exports = { /* ... */ };

Unfortunately ezconf does not support asynchronous config loading because I wanted to keep things simple. You could use promises to work around this in a decently-neat manner.