H.E.C.L.

Hierarchical Environment Config Loader - for node.

Load your configuration files in a hierachical order. Supported formats:

• Yaml
• JSON
• INI
• Environment variable via JSON string

Installation

npm install hecl

Configuration files

config.yml

# config.yml
default:
  server:
    port: 3000
production:
  server:
    port: 8000

config.json

{
  "default": {
    "server": {
      "port": 3000
    }
  },
  "production": {
    "server": {
      "port": 8000
    }
  }
}

config.ini

[default]
server.port = 3000

[production]
server.port = 8000

Usage

Load a single config file

var Hecl = require('hecl');
var cfg = new Hecl();

var config = cfg.load(__dirname + '/config/config.yml');

console.log(config.getData()); 

Load multiple config files at once

var Hecl = require('hecl');
var cfg1 = new Hecl();
var cfg2 = new Hecl();

// Register configuration as environment variable
var envConfig = {
  "default": {
    "server": {
      "port": 3000
    }
  },
  "production": {
    "server": {
      "port": 8000
    }
  }
};

process.env.envConfig = JSON.stringify(envConfig);

// order is important
var cfgFiles = [
  __dirname + '/config/config.yml',
  __dirname + '/config/config.yaml',
  __dirname + '/config/config.json'
  __dirname + '/config/config.js',
  'envConfig',
  __dirname + '/config/config.ini'
];

var config = cfg1.load(cfgFiles).getData();
console.log(config.server.port); // 3000 

// Merge configuration and overwrite default values
// with production settings
var config2 = cfg2.load(cfgFiles, 'production').getData();
console.log(config.server.port); // 8000, taken from config.ini  

API

load(filename[, env])

Load the configuration found in filename with the environment based on NODE_ENV. The environment can be forced with the env argument. The files are loaded synchronously.

reload()

Reload the configuration provided during the loadstep. Later calls to getData will show the new configuration.

The file is loaded synchronously.

getData()

Merge configuration files and return a JSON object containing the configuration data based an h

License

MIT

Copyright (c) 2015 Alexander Pirsig <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.