conf.js
========


conf.js allows you to get per-user and per-project configuration files out of the box.

Look how easy it is to use:

``sh


settings.coffee

# Your usual application settings
port: '9999'
name: 'My cool app!'
...
`

Now if $HOME/.myprojecrc exists, it's settings will override the defaults.

If then create a .myprojecrc file inside one of your projects directory and run the application from within that directory, the contents will override $HOME/.myprojecrc and defaults.

Notice that you can set a custom local configuration file within your user configuration and it'll be correctly used.

You can now get/set your settings with:

`sh
settings = require('./settings')
settings.get('port') # 9999
settings.set('name', 'My really cool app!')
`

Features
--------

- Per-user configuration file:

Specify userConfig to the user configuration file path.

- Per-project configuration files:

Specify localConfig to the local configuration file name.

Installation
------------

Install conf.js by running:

`sh
$ npm install --save conf.js
`

Methods
-------

$3

Create an instance of settings.

The following options are accepted:

- parse: The function used to parse inputs (defaults to JSON.parse).
- encoding: The encoding to be used when reading files (defaults to utf8).
- default: Default settings.
- userConfig: The user config file path.
- localConfig: The user local file name.

$3

Extend setting with the contents of a file.

$3

Set runtime value of a setting, or create a new one.

Notice you can set nested keys:

`coffee
settings.set('my.nested.key', 'value')
`

$3

Get the value of a setting.

Notice you can get nested keys:

`coffee
settings.get('my.nested.key')
`

If you pass no key to settings.get(), then you will get back all the settings.

$3

Check if settings has a specific key.

$3

Extend settings with object/s.

$3

Check if settings object is empty.

$3

Parse input given a function passed to options.parse.

Tests
-----

Run the test suite by doing:

`sh
$ gulp test
`

Contribute
----------

- Issue Tracker: github.com/resin-io/conf.js/issues
- Source Code: github.com/resin-io/conf.js

Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:

`sh
$ gulp lint
`

Support
-------

If you are having any problem, please raise an issue.

TODO
-------

- Allow to set a custom configuration file with a command line option.

ChangeLog
---------

$3

- Fix issue that prevented original default settings to be preserved.

$3

- The get()` function returns all settings if no key.

License
-------

The project is licensed under the MIT license.