velise

Easy access to your project's config files

velise

noun: A small traveling bag or suitcase

Velise provides easy access to your project's config files, libs, schemas, etc... no more require ( "../......../../myConf.json" )

(soon) Install the module with: npm install velise

var velise = require( "velise" )
    , dbConf = velise( "db" );
 
// Do something with your db config 

Velise is essentially a hash of locations you would like to require from. It is tailored for granting convenient access to your config files and other such resources that for whatever reason don't live in your node_modules folder.

By default velise assumes you have a conf folder next to your node_modules folder and will fetch resources from there.

var velise = require( "velise" )
    , dbConf = velise( "db" ); // fetches ./conf/db.json relative to app root 
 
// Do something with your db config 

You can register multiple resource locations using velise.mixin

/* From app root */
var velise = require( "velise" );
velise.mixin({
    "models": __dirname + "/models"
});
 
/* Then from any other file... */
 
// fetches ./models/User.js relative to app root 
var velise = require( "velise" )
    , User = velise( "modles:User" );
 
// Do something with your user schema 

Note that the default notation is just a convenience for leaving off the resource hash key, observe...

var velise = require( "velise" );
 
// Assuming you have a file db.json file at ./conf/db.json of course 
console.log(
    velise( "db" ) === velise( "conf:db" )
);

You can even change the default resource location if you want

var velise = require( "velise" )
    , awesomeLib;
 
velise
    .mixin({"lib": __dirname + "/lib"})
    .setDefault( "lib" );
 
awesomeLib = velise( "awesome" );

npm test

See test/velise_test.js

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

(Nothing yet)

Copyright (c) 2013 Justin Russell
Licensed under the MIT license.