my-config

Node module to handle configuration files for all the different environments (dev, qa, val, prod) a project/application could have

Installation

npm install my-config

Example

Create your configuration file (only JSON format) under any path and any name.

config.json

  {
    "defaults" : {
        "account-types" : ["employee" , "admin" , "cooker"],
        "database" : "example"
    },
    "dev" : {
        "database" : {
            "name" : "example dev",
            "example" : "example",
            "password" : "$Path"
        },
        "client" : {
            "name" : "example.com"
        },
        "dbshards" : [
            {
                "host" : "example.dbshard.1.com",
                "name" : "idk",
                "pass" : "123"
            },
            {
                "host" : "example.dbshard.2.com",
                "name" : "idk",
                "pass" : "$Path"
            }
        ]
    },
    "test" : {
        "database" : "example qa"
    },
    "production" : {
        "database" : "example prod"
    }
}

Example code

var path = require('path'),
    myconfig = require('my-config').init({
          path : path.resolve(__dirname , './config.json'),
          env : process.env('NODE_ENV')
        });
 
console.log(myconfig);

Since a NODE_ENV environment variable hasn't been set yet, dev configuration will be taken by default.

This would display a JSON like this:

{
    "account-types" : ["employee" , "admin" , "cooker"],
    "database" : {
            "name" : "example dev",
            "example" : "example",
            "password" : "C:\\Windows\\system32;C:\\...."
    },
    "client" : {
            "name" : "example.com"
    },
    "dbshards" : [
            {
                "host" : "example.dbshard.1.com",
                "name" : "idk",
                    "pass" : "123"
            },
            {
                "host" : "example.dbshard.2.com",
                "name" : "idk",
                "pass" : "C:\\Windows\\system32;C:\\...."
            }
        ]
}

Defaults and Environment variables support

If you want to store sensitve information inside an environment variable you can let your config file know about it and use it by just prefixing the $ symbol, for instance:

```json { "password" : "$DB_PASS" } ```

this would be transformed to:

```json { "password" : "whatever the environment variable's value is" } ```

If you have some default configuration, you can use the defaults property in your config file, like this:

```json { "defaults" : { "account-types" : ["employee" , "admin" , "cooker"], "database" : "example" }, "dev" : { "database" : { "name" : "example dev", "example" : "example", "password" : "$Path" } } } ```

It's important to know that any property that is being duplicated by defaults and any specific environment configuration, would be overwritten by the specific one.

For instance the database property within "defaults" and the database property within "dev", when you get your configuration object, you'll see something like this:

```json { "account-types" : ["employee" , "admin" , "cooker"], "database" : { "name" : "example dev", "example" : "example", "password" : "C:\\Windows\\system32;C:\\...." } } ```

Test

npm test

License

The MIT License (MIT)

Copyright (c) 2015 Luis Alonso Valdovinos Valencia

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.