https://github.com/shinnn/load-from-cwd-or-npm

Load a module from either CWD or npm CLI directory
https://github.com/shinnn/load-from-cwd-or-npm

async fallback import javascript loading module-loader nodejs npm promise

Last synced: 27 days ago
JSON representation

Load a module from either CWD or npm CLI directory

• Host: GitHub
• URL: https://github.com/shinnn/load-from-cwd-or-npm
• Owner: shinnn
• License: isc
• Created: 2015-12-09T06:56:28.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2019-07-12T12:06:55.000Z (over 5 years ago)
• Last Synced: 2024-09-16T04:52:16.658Z (about 2 months ago)
• Topics: async, fallback, import, javascript, loading, module-loader, nodejs, npm, promise
• Language: JavaScript
• Size: 224 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# load-from-cwd-or-npm

[![npm version](https://img.shields.io/npm/v/load-from-cwd-or-npm.svg)](https://www.npmjs.com/package/load-from-cwd-or-npm)

[![Build Status](https://travis-ci.com/shinnn/load-from-cwd-or-npm.svg?branch=master)](https://travis-ci.com/shinnn/load-from-cwd-or-npm)

[![Coverage Status](https://img.shields.io/coveralls/shinnn/load-from-cwd-or-npm.svg)](https://coveralls.io/github/shinnn/load-from-cwd-or-npm?branch=master)

Load a module from either CWD or [`npm` CLI](https://github.com/npm/cli) directory

```javascript

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

// $ npm ls validate-npm-package-name

// > └── (empty)

(async () => {

  require('validate-npm-package-name'); // throws a `MODULE_NOT_FOUND` error

  const RegistryClient = await loadFromCwdOrNpm('validate-npm-package-name'); // doesn't throw

})();

```

## Installation

[Use](https://docs.npmjs.com/cli/install) [npm](https://docs.npmjs.com/about-npm/).

```

npm install load-from-cwd-or-npm

```

## API

```javascript

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

```

### loadFromCwdOrNpm(*moduleId*)

*moduleId*: `string` (a module ID without path separators (`/`, `\\`))  

Return: `Promise`

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

1. [`node_modules`](https://docs.npmjs.com/files/folders#node-modules) in the [current working directory](https://nodejs.org/api/process.html#process_process_cwd)

2. `node_modules` in the directory where [`npm` CLI](https://github.com/npm/npm) is installed

If the module ins't installed in CWD but included in the [npm CLI dependencies](https://github.com/npm/npm/blob/v5.5.1/package.json#L36-L129), it loads the module from npm CLI directory.

```javascript

// $ npm ls nopt

// > └── (empty)

(async () => {

  const nopt = await loadFromCwdOrNpm('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.

```javascript

// $ npm ls eslint

// > └── [email protected]

(async () => {

  // npm doesn't depend on `eslint` module.

  const eslint = await loadFromCwdOrNpm('eslint'); //=> {linter: EventEmitter { ... }, ...}

})();

```

If the module exists in both directories, it compares their [package versions](https://docs.npmjs.com/files/package.json#version) and loads the newer one.

```javascript

// $ npm ls rimraf

// > └── [email protected]

(async () => {

  // Loaded from npm CLI directory because the CWD version is older

  const rimraf = await loadFromCwdOrNpm('rimraf');

})();

```

The returned promise will be [fulfilled](http://promisesaplus.com/#point-26) with the loaded module, or [rejected](http://promisesaplus.com/#point-30) when it fails to find the module from either directories.

## License

[ISC License](./LICENSE) © 2017 - 2018 Shinnosuke Watanabe