ericdouglas / rooted

:open_file_folder: Require modules/folders/files in the right way

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

rooted

Build Status Coverage Status npm version

NPM

Requiring modules/folders/files in the right way

Installation

npm i rooted --save

Usage

////// bad
var data    = require('../../../../data.json');
var helpers = require('../../../helpers');

///// good
// will build the path starting from the root directory of your application
// and require the respective file/folder/module
var rooted  = require('rooted');
var data    = rooted('data.json');
var helpers = rooted('helpers');

You can also get string representing the absolute path of the file/folder, passing true as the second argument.

var rooted  = require('rooted');
var data    = rooted('data.json', true);

console.log(typeof data); // "string"

Tests

make test

License

MIT License © Eric Douglas

About

:open_file_folder: Require modules/folders/files in the right way


Languages

Language:JavaScript 80.8%Language:Makefile 19.2%