3 Commits
3 changed files with 46 additions and 6 deletions
+22 -2
View File
@@ -48,12 +48,19 @@ hari@hari-VirtualBox:~app$ env NODE_ENV=production node xyz.js
#### Set any configuration variable using Environtment variable.
By setting an Environtment variable '<Prefix><key>=<value>', we can set config[key] as value.
Default prefix is `TC_`
** First we will try to parse value as json. It it is failed value will be treated as string **
** If a values if parsable as JSON object, then it will be deep merged with default configuration **
Default prefix is `TC_` ( Can be changed by setting TC_PREFIX` env variable `)
For eg:
* `TC_port` will set config.port
* `TC_a.b.c` will set config.a.b.c
* `TC_a='{"a":{"b":{"c": 123546 }}}'` will also set `config.a.b.c`
* `TC_port=8000` will set `{ port: 8000 }` By default, number will parsed as json number.
* `TC_port='"8000"'` will set `{ port: '8000' }` ( **now port is a string** because double quoted value will be parsed as string in json )
```bash
hari@hari-VirtualBox:~app$ env NODE_ENV=production TC_db.mysql.user=root node xyz.js
@@ -80,6 +87,19 @@ hari@hari-VirtualBox:~app$ env CONFIG_DIR=../config TC_PREFIX=MYAPP_ NODE_ENV=pr
```
#### printing debug messages
set `DEBUG` environment variable to `tconfig`
```bash
export DEBUG=tconfig
# OR
export DEBUG='*'
```
#### Config directory search path
* Directory pointed by `CONFIG_DIR` environment variable
* < directory or main script >/config
* < current working directory >/config
+23 -3
View File
@@ -7,9 +7,14 @@ var envPrefix = process.env.TC_PREFIX || 'TC_';
var envRegex = new RegExp( '^' + envPrefix + '(.*)' );
var finalConfig = {};
var configDirLookupPath = [
path.resolve( path.join( require.main.paths[0], '..', 'config' ) ),
path.join( process.env.PWD, 'config' )
];
var beVerbose = process.env.DEBUG && 'tconfig'.match( process.env.DEBUG.replace( /\*/g, '.*' ) );
var log = beVerbose ? console.log.bind( console, 'tconfig:: ' ) : function(){};
if( require.main ){
configDirLookupPath.unshift( path.resolve( path.join( require.main.paths[0], '..', 'config' ) ) );
}
if( process.env.CONFIG_DIR ){
configDirLookupPath.unshift( process.env.CONFIG_DIR );
}
@@ -18,6 +23,7 @@ for (var i = 0, l = configDirLookupPath.length; i < l; i ++) {
var v = configDirLookupPath[i];
if( fs.existsSync(v) ){
configDir = v;
log( 'Found config dir: ' + configDir );
break;
}
}
@@ -28,13 +34,23 @@ if( !configDir ){
'\n Please set CONFIG_DIR env variable');
}
function processSpecial( str ){
var out;
try {
out = JSON.parse(str);
} catch (e) {
out = str;
}
return out;
}
function loadConfig( name ){
log('Loading config ' + name );
var out = {};
try{
out = require( configDir + '/' + name );
} catch(e){
log( 'Error loading config ' + name, e );
out = {};
}
return out;
@@ -66,6 +82,9 @@ function setProp( object, keys, val ){
object[keys[0]] = object[keys[0]] || {};
return setProp( object[keys[0]], keys.slice(1), val );
}
if( val instanceof Object ){
return assignDeep( object[keys[0]], val );
}
object[keys[0]] = val;
}
@@ -74,9 +93,10 @@ assignDeep( finalConfig, loadConfig('default'), loadConfig( env ) );
Object.keys( process.env ).filter( function(v){
var match = v.match( envRegex );
if( match ){
setProp( finalConfig, match[1], process.env[v] );
setProp( finalConfig, match[1], processSpecial( process.env[v] ) );
}
});
log('Final config ', JSON.stringify(finalConfig, null, 2 ) );
module.exports = finalConfig;
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "tconfig",
"version": "0.1.3",
"version": "0.1.4",
"description": "A simple transparent config file loader for Nodejs applications. any config field can be overriden using environmen variables",
"main": "index.js",
"scripts": {