Exporting the depcheck ‘special’ property so it can be used in the options

Author: edj-boston

README.md

@@ -38,6 +38,17 @@ gulp.task('depcheck', depcheck({
 }));
 ```
 
+Access [special depcheck parsers](https://github.com/depcheck/depcheck#special) via the `special` property. Pass them as options to recognize the dependencies outside of the normal syntax.
+
+```javascript
+gulp.task('depcheck', depcheck({
+    specials : [
+        depcheck.special.babel,
+        depcheck.special.webpack
+    ]
+}));
+```
+
 ### Configuring the report
 
 By default, gulp-depcheck fails on any issue it finds. From time to time you might want to adjust this, e.g. to allow unused packages in the `devDependencies` section of your `package.json` file, or to only report packages that are missing from your `package.json` file.
@@ -61,6 +72,21 @@ If you want to configure the version of depcheck to use explicitly provide a ref
 
 Additionally, you are allowed to set a default value for the directories to ignore. For that use the `ignoreDirsDefault` property and hand over the names of the directories to ignore as an array. The default value is `['node_modules', 'bower_components']`.
 
+Note that if you use a custom version of depcheck you must pass any special parsers explicitly.
+
+```javascript
+const depcheck = require('gulp-depcheck');
+const myCustomDepcheck = require('depcheck');
+
+gulp.task('depcheck', depcheck({
+    depcheck : myCustomDepcheck,
+    specials : [
+        myCustomDepcheck.special.babel,
+        myCustomDepcheck.special.webpack
+    ]
+}));
+```
+
 ## Running the build
 
 To build this module use [roboter](https://www.npmjs.com/package/roboter).

lib/gulpDepcheck.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const _ = require('lodash'),
+      dc = require('depcheck'),
       gutil = require('gulp-util');
 
 const PluginError = gutil.PluginError;
@@ -14,9 +15,7 @@ const pluginError = function (message) {
 const gulpDepcheck = function (options) {
   options = options || {};
 
-  /* eslint-disable global-require */
-  const depcheck = options.depcheck || require('depcheck');
-  /* eslint-enable global-require */
+  const depcheck = options.hasOwnProperty('depcheck') ? options.depcheck : dc;
 
   const ignoreMissing = options.missing === false,
         ignoreUnusedDependencies = options.dependencies === false,
@@ -71,4 +70,6 @@ const gulpDepcheck = function (options) {
   };
 };
 
+gulpDepcheck.special = dc.special;
+
 module.exports = gulpDepcheck;

test/units/gulpDepcheckTests.js

@@ -314,4 +314,10 @@ suite('gulpDepcheck', () => {
     }).is.not.throwing();
     done();
   });
+
+  test('returns a special property that is an object.', done => {
+    assert.that(depcheck.special).is.not.undefined();
+    assert.that(depcheck.special).is.ofType('object');
+    done();
+  });
 });