gulp-unused

Opinionated gulp plugin that takes an array of method names and creates a report with many times each is used. Don't expect miracles, this is very naive.

Install

Install with npm:

$ npm install --save gulp-unused

Usage

Heads up! The matching is naive, but it works well for quick checks.

var gulp = require('gulp');
var unused = require('gulp-unused');

gulp.task('unused', function() {
  return gulp.src(['index.js', 'lib/*.js'])
    .pipe(unused([options]));
});

Options

.keys

Array of method names to check for.

Example

var keys = Object.keys(require('./utils'));

gulp.src(['index.js', 'lib/*.js'])
  .pipe(unused({keys: keys}));

.utils

As a more comprehensive alternative to options.keys, you may pass glob patterns or file paths of the files with "utils" to search for.

Example

gulp.src(['index.js', 'lib/*.js'])
  .pipe(unused({utils: 'lib/utils.js'}));

Example usage

Given the following project files:

// --lib/utils.js--
exports.foo = function(){};
exports.bar = function(){};
exports.baz = function(){};

// --index.js--
var utils = require('./lib/utils.js');
module.exports = function(str) {
  // do some "foo" and "bar" stuff, but not "baz"
  utils.foo();
  utils.bar();
  utils.bar();
};

With the following gulpfile.js:

var gulp = require('gulp');
var unused = require('gulp-unused');

gulp.task('unused', function() {
  return gulp.src(['index.js', 'lib/*.js'])
    .pipe(unused({utils: 'lib/utils.js'}));
});

Unless options.silent is true, the following would be logged out:

Method | Times used
------ | ----------
bar    | 2
foo    | 1
baz    | 0
------ | ---
unused | .baz

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This document was generated by verb-generate-readme (a verb generator), please don't edit the readme directly. Any changes to the readme must be made in .verb.md.)

To generate the readme and API documentation with verb:

$ npm install -g verb verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.1.30, on August 21, 2016.

Package detail

readme