Package.loader NPM

package.loader

Search/loads/mocks dependencies from three specific locations EXTERNAL, ROOT or SELF. Enables to create a plugin system for apps.

SELF: some library, the package which has package.loader as dependency
ROOT: some application, the first package in the package hierarchy
EXTERNAL: the deploy folder of the ROOT package

SELF and ROOT may be the same packages.

Each provided method is to be found in three flavors (except mocking): directed towards SELF, ROOT or EXTERNAL.

This library can be used to implement support for a plugin system based on package names conventions.

Installation

Node Dependencies

Execute following line

npm install package.loader --save

Require module

var loader = require('package.loader');

Usage

match, matchInRoot, matchInExternal

Parameters:

regexp: a regular expression

Return an Array with matching package names or an empty Array if no match was found.

// return a list of dependencies which name starts with 'service'
loader.match(/^service.*/);

require, requireFromRoot, requireFromExternal

Parameters:

package: a regular expression or a string
force optional: boolean, disabling cache and force the loading of the wanted package

Loads one requested plugin, but the regexp has to have an unique match.

Throws an error if too many or no plugin was found.

loader.require('mypackage');
loader.require('../tools/mytool');
loader.require(/^service.*/);

// force reload mytool
loader.require('../tools/mytool', true);

load, loadFromRoot, loadFromExternal

Parameters:

regexp: a regular expression
target optional: an object in which the packages will be loaded into. Packages will be available under .<package_name>
doThrow optional: boolean, if no package was found and throwing is enabled an error will be raised

Loads one requested plugin, but the regexp has to have a at least one match.

Throws an error if no plugin was found.

// return a list of dependencies which name starts with 'service'
var myplugin = loader.load(/^service.*/);

unload, unloadFromRoot, unloadFromExternal

Parameters:

package: a regular expression or a string
target optional: an object in which the packages will be removed from.

Loads one requested plugin, but the regexp has to have a at least one match.

Throws an error if no plugin was found.

// return a list of dependencies which name starts with 'service'
var myplugin = loader.load(/^service.*/);

mock, mockInRoot, mockInExternal

Parameters:

packageName: a package name
packageExport: the Object to be returned by the mocked package

Enables to mock packages in the dependencies from SELF or ROOT. This can be used for testing.

// define a mock in SELF
loader.mock('hello.world', function () {console.log('hello world')});

// access mock
var mock = loader.require('hello.world')

mock(); // prints "hello world"

isMocked

Parameters:

absolutePackagePath: a package path

Check whether or not this package is mocked. Returns a boolean.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.