https://github.com/tunnckocore/load-deps
Just load devDependencies of the current project or any other dependencies. Useful for any node.js app that needs to load plugins from node_modules. Faster alternative to `load-plugins`.
https://github.com/tunnckocore/load-deps
Last synced: about 1 year ago
JSON representation
Just load devDependencies of the current project or any other dependencies. Useful for any node.js app that needs to load plugins from node_modules. Faster alternative to `load-plugins`.
- Host: GitHub
- URL: https://github.com/tunnckocore/load-deps
- Owner: tunnckoCore
- License: mit
- Created: 2015-05-04T23:21:20.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-22T05:44:30.000Z (about 10 years ago)
- Last Synced: 2025-06-09T00:57:19.822Z (about 1 year ago)
- Language: JavaScript
- Homepage: http://j.mp/1GO6Mv7
- Size: 37.1 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# [load-deps][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url]
> Just load devDependencies of the current project or any other dependencies. Useful for any node.js app that needs to load plugins from node_modules. 15-20x times faster alternative to [load-plugins][] and [gulp-load-plugins][].
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]
## Install
```
npm i load-deps --save
```
## Usage
> For more use-cases see the [tests](./test.js)
```js
const loadDeps = require('load-deps')
```
### [loadDeps](index.js#L46)
> Load modules of the current project, by default loads dependencies from `devDependency` property from `package.json`, but can be customized.
**Params**
* `patterns` **{String|Array|Function|RegExp|Object}**
* `opts` **{Object}**: see [options section](#options)
* `returns` **{Object}**
**Example**
```js
var appname = require('app-name')
var loadDeps = require('load-deps')
var strip = ['gulp', 'handlebars', 'helpers']
var rename = function renameFn(name) {
return appname(name, strip)
}
var plugin = loadDeps('gulp-*', {renameKey: rename})
gulp.task('default', function () {
gulp.src('test/*.js')
.pipe(plugin.jshint())
.pipe(plugin.mocha())
.pipe(plugin.stylus())
.pipe(plugin.mustache())
.pipe(plugin.istanbul())
})
```
## Options
### options.require
> Pass a custom function for `require`ing files.
```js
var loadDeps = require('load-deps')
var plugin = loadDeps('gulp-*', {
require: function (name) {
// do stuff to name
}
})
```
### options.renameKey
> Pass a renameKey function to change how plugins are named.
```js
var loadDeps = require('load-deps')
var plugin = loadDeps('my-plugins-*', {
renameKey: function (name) {
return path.resolve(name)
}
})
```
## Benchmark
> It is 15-20x faster than [load-plugins][] and [gulp-load-plugins][].
```
npm run benchmark
```
results as of `22 April, 2016`
```
[charlike@voltaire load-deps]$ npm run benchmark
load-plugins x 205 ops/sec ±3.09% (61 runs sampled)
load-deps x 14,297 ops/sec ±10.74% (63 runs sampled)
gulp-load-plugins x 813 ops/sec ±2.27% (62 runs sampled)
Fastest is load-deps
```
## Related
* [gulp-load-plugins](https://www.npmjs.com/package/gulp-load-plugins): Automatically load any gulp plugins in your package.json | [homepage](https://github.com/jackfranklin/gulp-load-plugins)
* [is-match](https://www.npmjs.com/package/is-match): Create a matching function from a glob pattern, regex, string, array,… [more](https://www.npmjs.com/package/is-match) | [homepage](https://github.com/jonschlinkert/is-match)
* [load-pkg](https://www.npmjs.com/package/load-pkg): Loads the package.json from the root of the user's current project. | [homepage](https://github.com/jonschlinkert/load-pkg)
* [load-plugins](https://www.npmjs.com/package/load-plugins): Load plugins for gulp, grunt, assemble, verb any node.js app that… [more](https://www.npmjs.com/package/load-plugins) | [homepage](https://github.com/jonschlinkert/load-plugins)
* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to… [more](https://www.npmjs.com/package/micromatch) | [homepage](https://github.com/jonschlinkert/micromatch)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/load-deps/issues/new).
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.
## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]
[![tunnckoCore.tk][author-www-img]][author-www-url] [![keybase tunnckoCore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]
[load-plugins]: https://github.com/jonschlinkert/load-plugins
[gulp-load-plugins]: https://github.com/jackfranklin/gulp-load-plugins
[npmjs-url]: https://www.npmjs.com/package/load-deps
[npmjs-img]: https://img.shields.io/npm/v/load-deps.svg?label=load-deps
[license-url]: https://github.com/tunnckoCore/load-deps/blob/master/LICENSE
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg
[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/load-deps
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/load-deps.svg
[travis-url]: https://travis-ci.org/tunnckoCore/load-deps
[travis-img]: https://img.shields.io/travis/tunnckoCore/load-deps/master.svg
[coveralls-url]: https://coveralls.io/r/tunnckoCore/load-deps
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/load-deps.svg
[david-url]: https://david-dm.org/tunnckoCore/load-deps
[david-img]: https://img.shields.io/david/tunnckoCore/load-deps.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg
[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg
[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg
[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg
[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg
[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg
[new-message-url]: https://github.com/tunnckoCore/ama
[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg