Easy access to your project's config files
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
By default velise assumes you have a
conf folder next to your
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
/* From app root */var velise = require "velise" ;velisemixin"models": __dirname + "/models";/* Then from any other file... */// fetches ./models/User.js relative to app rootvar 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 courseconsole.logvelise "db" === velise "conf:db";
You can even change the default resource location if you want
var velise = require "velise"awesomeLib;velisemixin"lib": __dirname + "/lib"setDefault "lib" ;awesomeLib = velise "awesome" ;
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.
Copyright (c) 2013 Justin Russell
Licensed under the MIT license.