Package Exports

load-from-cwd-or-npm

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (load-from-cwd-or-npm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

load-from-cwd-or-npm

Load a module from either CWD or npm CLI directory

const loadFromCwdOrNpm = require('load-from-cwd-or-npm');

// $ npm ls npm-regustry-client
// > └── (empty)

loadFromCwdOrNpm('npm-regustry-client').then(RegClient => {
  const client = new RegClient();
  client.get('https://registry.npmjs.org/npm', {timeout: 1000}, (error, data, raw, res) => {
    // ...
  });
});

Installation

Use npm.

npm install load-from-cwd-or-npm

API

const loadFromCwdOrNpm = require('load-from-cwd-or-npm');

loadFromCwdOrNpm(moduleId, [compareFn])

moduleId: String (a module ID without path separators (/, \\))
compareFn: Function (a function to compare two package versions)
Return: Object (a Promise instance)

It loads a module with the given module ID from either of these two directories:

node_modules in the current working directory
node_modules in the directory where npm CLI is installed

If the module ins't installed in CWD but included in the npm CLI dependencies, it loads the module from npm CLI directory.

// $ npm ls nopt
// > └── (empty)

loadFromCwdOrNpm('nopt').then(nopt => {
  nopt; //=> {[Function: nopt], clean: [Function: clean] ...}
});

If the module ins't included in the npm CLI dependencies but installed in CWD, it loads the module from CWD.

// $ npm ls eslint
// > └── eslint@2.13.1

// npm doesn't depend on `eslint` module.
loadFromCwdOrNpm('eslint').then(eslint => {
  eslint; //=> {linter: EventEmitter { ... }, ...}
});

If the module exists in both directories, it compares their package versions and loads the newer one.

// $ npm ls rimraf
// > └── rimraf@1.0.0

loadFromCwdOrNpm('rimraf').then(rimraf => {
  rimraf; // Loaded from npm CLI directory because the CWD version is older
});

The returned promise will be fulfilled with the loaded module, or rejected when it fails to find the module from either directories.

compareFn(cwdPackageVersion, npmPackageVersion)

Default: node-semver's gte method

Used as a comparison function when a module with the given ID exists in both directories.

It takes two String arguments, package versions of the CWD one and the npm dependency one. the former will be loaded when compareFn returns true, otherwise the latter will be loaded.

const loadFromCwdOrNpm = require('load-from-cwd-or-npm');
const semver = require('semver');

loadFromCwdOrNpm('rimraf', semver.lt);
// inverse to the default behavior (the older will be loaded)

License

Licensed under the MIT License.