configuror

Table of Contents

• 1. Configuror
  • 1.1. Quick start
    • 1.1.1. Global/Local style configuration
    • 1.1.2. Environment style configuration
  • 1.2. Details
    • 1.2.1. File formats

Configuror

Config file loader based on 2 different configuration styles:

• Global/Local
• Environment (dev/test/staging/prod/etc…)

Supporting multiple file formats:

• .js
• .json
• .yml

Sane defaults included…

Quick start

Given the following directory structure in your project root:

config/
  db.js
  api.js

var config = require('configuror')();

config will contain values from files in config/ merged.

Global/Local style configuration

by adding files with .local. preceding the extension allows overriding config options with machine specific values.

config/
  db.js
  api.js
  db.local.js

Environment style configuration

by adding files with .env. preceding the extension allows overriding config options with environment specific values.

config/
  db.js
  api.js
  api.test.js

NODE_ENV=test node app.js

With NODE_ENV set to test the api.test.js will override values in api.js

Details

Both global/local and environment style configurations can be mixed.

There are no predefined environments such as dev/test/staging/production so you can use any name desired for the environments.

Any of the above mentioned file formats can be used. db.local.yml will override db.js.

File formats

• JS

  module.exports = {
    host: "example.com"
  }
  

• JSON

  {
    "user": "jim"
  }
  

• YAML

  ipaddress: 127.0.0.1