load-from-cwd-or-npm
Load a module from either CWD or npm
CLI directory
const loadFromCwdOrNpm = ; // $ npm ls validate-npm-package-name// > └── (empty) async { ; // throws a `MODULE_NOT_FOUND` error const RegistryClient = await ; // doesn't throw};
Installation
npm install load-from-cwd-or-npm
API
const loadFromCwdOrNpm = ;
loadFromCwdOrNpm(moduleId)
moduleId: string
(a module ID without path separators (/
, \\
))
Return: Promise<any>
It loads a module with the given module ID from either of these two directories:
node_modules
in the current working directorynode_modules
in the directory wherenpm
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) async { const nopt = await ; //=> {[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@4.11.0 async { // npm doesn't depend on `eslint` module. const eslint = await ; //=> {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 async { // Loaded from npm CLI directory because the CWD version is older const rimraf = await ;};
The returned promise will be fulfilled with the loaded module, or rejected when it fails to find the module from either directories.
License
ISC License © 2017 - 2018 Shinnosuke Watanabe