dominictarr

  "description": "hardwired configuration loader",

    "test": "set -e; node test/test.js; node test/ini.js; node test/nested-env-vars.js"

    "url": "https://github.com/dominictarr/rc.git"

  "license": "(BSD-2-Clause OR MIT OR Apache-2.0)",

  "author": "Dominic Tarr <dominic.tarr@gmail.com> (dominictarr.com)",

The non-configurable configuration loader for lazy people.

The only option is to pass rc the name of your app, and your default configuration.

  //defaults which are objects will be merged, not replaced

`rc` will return your configuration options merged with the defaults you specify.

If you pass in a predefined defaults object, it will be mutated:

If `rc` finds any config files for your app, the returned config object will have

a `configs` array containing their paths:

var appCfg = require('rc')(appname, conf);

appCfg.configs[1] // /home/dominictarr/.config/appname

appCfg.config // same as appCfg.configs[appCfg.configs.length - 1]

Given your application name (`appname`), rc will look in all the obvious places for configuration.

  * command line arguments (parsed by minimist)

  * command line arguments, parsed by minimist _(e.g. `--foo baz`, also nested: `--foo.bar=baz`)_

  * environment variables prefixed with `${appname}_`

    * or use "\_\_" to indicate nested properties <br/> _(e.g. `appname_foo__bar__baz` => `foo.bar.baz`)_

  * if you passed an option `--config file` then from that file

  * a local `.${appname}rc` or the first found looking in `./ ../ ../../ ../../../` etc.

All configuration sources that were found will be flattened into one object,

so that sources **earlier** in this list override later ones.

Configuration files (e.g. `.appnamerc`) may be in either [json](http://json.org/example) or [ini](http://en.wikipedia.org/wiki/INI_file) format. **No** file extension (`.json` or `.ini`) should be used. The example configurations below are equivalent:

; You can include comments in `ini` format if you want.

; `rc` has built-in support for ini sections, see?

  // You can even comment your JSON, if you want

Comments are stripped from JSON config via [strip-json-comments](https://github.com/sindresorhus/strip-json-comments).

> Since ini, and env variables do not have a standard for types, your application needs be prepared for strings.

## Simple example demonstrating precedence

Assume you have an application like this (notice the hard-coded defaults passed to rc):

console.log(JSON.stringify(conf, null, 2));

You also have a file `config.json`, with these contents:

And a file `.myapprc` in the same folder, with these contents:

Here is the expected output from various commands:

		{
		"name": "rc",
		"version": "1.2.4",
		"version": "1.2.5",
		"description": "hardwired configuration loader",
		@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

Fixed alerts

Improved metrics

Worsened metrics

		@@ -43,3 +43,3 @@ # rc

		* command line arguments (parsed by minimist)
		* command line arguments, parsed by minimist _(e.g. `--foo baz`, also nested: `--foo.bar=baz`)_
		* environment variables prefixed with `${appname}_`
		@@ -46,0 +46,0 @@ * or use "\_\_" to indicate nested properties <br/> _(e.g. `appname_foo__bar__baz` => `foo.bar.baz`)_