requiring

requiring

Main use case is to avoid errors when requiring files from current working directory that may not exist. e.g. You want to build a module that reads a config file from the user's project root (not node_modules/my-module/ directory).

This only works on file & folder modules -not core modules or modules installed in node_modules directory

npm install requiring

npm test

####require a module async

var requiring = require('requiring');

requiring.async('./cool-tool', function(err, mod) {
  if (err !== null) {
    return console.log(err);
  }
  mod.doStuff();
});

// specify a different base directory to look for a module (default is current working directory)
requiring.async('./another-tool', {
  directory: __dirname // `__dirname` returns directory of current executing script.
}, function(err, mod) {
  if (err !== null) {
    return console.log(err);
  }
  mod.doStuff();
});

####require a module sync

var coolTool = requiring.sync('./cool-tool'); // undefined if there is no 'cool-tool'

// pass a default value to return if no module is found
var configFile = requiring.sync('./config-file', {}); //returns {} if there is no 'config-file'

// specify a different base directory to look for a module (default is current working directory)
var anotherTool = requiring.sync('./another-tool', {
  directory: __dirname // path is resolved via `path.resolve()`
});

####other info

This utility attempts to resolve using a full path so requiring('./cool-tool'); turns into something like this requiring('/Users/johndoe/projects/my-project/cool-tool');

To specify a different base directory use the options hash which is passed in as 2nd parameter in both sync and async (see examples) (TO BE CHANGED IN 0.1.0).

It will validate the path before requiring the module. If no file extension is given, it validates the path in this order: ./cool-tool, ./cool-tool.js, ./cool-tool.json, ./cool-took.node

for the case of ./cool-tool This utility will leverage node's module loading pattern and look for ./cool-tool/index.js or the main file defined in ./cool-tool/package.json

requiring a module async is really just validating the path async, then requiring the module sync.

All paths passed to requiring(path) are looked for relative to the current working directory

supports iojs and is backwards compatible with at least node v0.10.0

Changelog

v0.0.5

[FEATURE] an options hash can be passed into async and sync where you can specify a directory to use as base directory for searching.

      This API will be deprecated soon in favor of using an options hash 
      for defining default modules in `sync` mode. (removing the 3rd param).