app-paths v0.0.2

app-paths

It helps to get the path relative to the root of the node app.

var basePaths = require('app-paths')();

console.log(basePaths.pathTo('lib')); // APP_PATH/lib

IMPORTANT

This module only works when you have a node_modules directory in the root of your node application.

Methods

To start using it require the module:

var basePaths = require('app-paths')();

console.log(basePaths.base()); // APP_PATH/

Or you can pass some options:

var options = {
    views: 'path/to/views',
    routes: 'path/to/routes'
}
var basePaths = require('app-paths')(options);

console.log(basePaths.pathTo('routes')); // APP_PATH/path/to/routes

base()

It returns the path to the application root path.

lib()

It returns the path to the lib path.

config()

It returns the path to the config path.

pathTo(dir)

It returns the path to the directory (dir) passed as a parameter relative to the node application.

fromRoot(filepath) or _(filepath)

It returns the application root path plus the filepath. Useful when you are requiring a module.

Basic example:

app
  - lib
  - config
  - node_modules
  - index.js

var basePaths = require('app-paths')();
console.log(basePaths.base());           // /path/to/app/
console.log(basePaths.pathTo('lib'));    // /path/to/app/lib
console.log(basePaths.lib());            // /path/to/app/lib
console.log(basePaths.config());         // /path/to/app/config
console.log(basePaths.pathTo('a/b/c'));  // /path/to/app/a/b/c

Another example:

app
  - lib
  - config
  - node_modules
  - index.js

var myPaths = {
    views: 'path/to/my/views',
    routes: 'path/to/my/routes',
    assets: 'path/to/my/assets'
}
var basePaths = require('app-paths')(myPaths);

console.log(basePaths.base());           // /path/to/app/
console.log(basePaths.pathTo('lib'));    // /path/to/app/lib
console.log(basePaths.pathTo('a/b/c'));  // /path/to/app/a/b/c

console.log(basePaths.pathTo('views'));  // /path/to/app/path/to/my/views
console.log(basePaths.pathTo('routes')); // /path/to/app/path/to/my/routes

.fromRoot(filepath) or ._(filepath) example:

app
  - lib
  - config
  - node_modules
  - index.js

var paths = require('app-paths')();

console.log(paths.fromRoot('/my/path/to/models/user'));  // /path/to/app/my/path/to/models/user
console.log(paths._('/my/path/to/models/user'));         // /path/to/app/my/path/to/models/user

Install

With npm do:

npm install app-paths --save

License

MIT