oconf

OConf

Load cjson (JSON + c-style) commentaries, with inheritance-sugar on top:

> var oconf = require('oconf');
> oconf.load('config/my-config.cjson');
{
     "some-setting": "default-value",
     "value": 50
}

Format

The basic idea is to experiment with applying #include-statements recusively inside JSON/cJSON documents:

// default-settings.cjson
{
	"some-setting": "default value",
	"value": 100
}

// my-config.cjson
{
	"#include": "./default-settings.json",
	"value": 50
}

Will result in a config with:

{
	"some-setting": "default-value",
	"value": 50
}

The extension of objects also work recursively, so setting a single sub-key somewhere doesn't override the entire thing.

Structure

There are no restrictions in how includes work (except no loops). Usually a structure like this is used:

• project/config/default.cjson has project-wide defaults.
• project/config/{dev,test,staging,production}.cjson inherits the default and set keys relevant to respective environments
• project/config/$HOSTNAME.cjson (optinal) machine-specifics that inherit from the relevant environment-file.
• /etc/$WORKNAME/$PROJECTNAME-secrets.cjson inherits the machine-specific things and typically adds production secrets.

Binary

To help resolve configuration on the command line oconf exports a CLI tool called oconf. It takes a path to an cjson file, and outputs the resolved JSON object.

 $ oconf config.cjson
{
  "someConfig": "someValue",
  "obj": {
    "foo": "bar"
  }
}

You can lint your configuration files by using oconf-lint. It will not output any of the resolved configuration, but only exit with an error in case of any formatting errors in the files.

 $ oconf-lint config.cjson

By using oconf-extract-option you can supply a path to a value as well:

 $ oconf-extract-option config.cjson obj.foo
bar

The output from the above is the raw data. That is useful when you need to pass the configuration to other CLI tools. If you need the JSON formatted data, you can pass the --json option.

 $ oconf-extract-option --json config.cjson obj.foo
"bar"

If the key is missing oconf-extract-option will exit with status code 1. If you need to overwrite that behaviour you can pass the --allowmissing flag to oconf which will make it exit with status code 0 if no value is found at the given path.

Tests

Download/clone, run npm install and then npm test.

License

The software is provided under the Modified BSD License; See LICENSE for further details.