Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 2.09 KB

.verb.md

File metadata and controls

116 lines (80 loc) · 2.09 KB

{%= name %} {%= badge("fury") %} {%= badge("travis") %}

{%= description %}

Install

{%= include("install-npm", {save: true}) %}

Usage

with gulp

var plugin = require('load-plugins')('gulp-*');

gulp.task('default', function () {
  gulp.src('test/*.js')
    .pipe(plugin.jshint());
    .pipe(plugin.mocha());
});

with assemble

var plugin = require('load-plugins')('assemble-*');

assemble.task('default', function () {
  assemble.src('templates/*.hbs')
    .pipe(plugin.paginate());
    .pipe(plugin.collections());
    .pipe(assemble.dest('dist/'));
});

with verb

var plugin = require('load-plugins')('verb-*');

verb.task('default', function () {
  verb.src('docs/*.md')
    .pipe(plugin.toc());
    .pipe(plugin.reflinks());
    .pipe(verb.dest('./'));
});

Options

See resolve-dep for additional options.

options.require

Pass a custom function for requireing files.

plugins('gulp-*', {
  require: function(filepath) {
    // do stuff to filepath
  }
});

options.camelize

Make plugin names camelcased. By default this is true.

options.rename

Pass a rename function to change how plugins are named.

plugins('my-plugins-*', {
  rename: function (filepath) {
    return path.basename(filepath);
  }
});

options.strip

Omit strings from plugin names. This is a complement to the .rename() option, it's easiest to understand by way of example:

plugins('gulp-*', {strip: 'gulp'});

Returns {mocha: [Function]} instead of {'gulp-mocha': [Function]}, and so on.

You may also pass an array of strings to strip, e.g.:

// note that the `strip` option doesn't work with full glob patterns, just braces
plugins('{foo,bar}-*', {strip: ['foo', 'bar']});

Related

{%= related(['plugins', 'load-templates']) %}

Running tests

{%= include("tests") %}

Contributing

{%= include("contributing") %}

Author

{%= include("author") %}

License

{%= copyright({start: 2014, linkify: true}) %} {%= license({linkify: true}) %}


{%= include("footer") %}