ini-config v0.1.1

ini-config

OOTB solution for constructing a config array from main and environment INI files.

What you get

In your project root directory:

config/main.ini        # non-environment-specific settings
config/env.ini         # local settings, ignored by git
config/env.example.ini # optional example of env.ini
config/.gitignore

In your app:

// an array of merged settings
var config = require('ini-config');

// for test environment you can override settings using a specific section
config.apply('test');

Installation

$ npm install ini-config --save

Configuration

1) Create config folder in your project root directory:

$ mkdir config

2) Create 2 ini files:

$ touch config/main.ini
$ touch config/env.ini

3) Ignore env.ini file:

$ echo 'env.ini' > config/.gitignore

4) Add default and non-environment-specific settings into main.ini.

;example
[web]
host = localhost
port = 3000
[mongodb]
connectionString = mongodb://localhost:27017/app

5) Add settings for the current environment into env.ini.

;example
[web]
port = 3008
[mongodb]
connectionString = mongodb://user:password@dbhost:27017/app

6) Optionally, you can save an example of env.ini as env.example.ini.

Usage

var config = require('ini-config');

console.log(config.web.host);  // get string parameter
console.log(+config.web.port); // get int parameter
console.log(config.mongodb);   // get section

Settings from env.ini will override settings from main.ini.

Test Environment

In order to keep logic simple and straightforward, there is no option for using different INI files. Instead, you can specify changes for test environment in env.ini under section test:

[test.web]
port = 3008

[test.mongodb]
connectionString = mongodb://localhost:27017/test

Apply changes before running tests:

var config = require('ini-config');
config.apply('test');

Note: Do not use section "apply" in INI files, a function will replace it.