js-build-tools 2.1.0 → 2.1.2

package/README.md

@@ -558,7 +558,7 @@ Micro-functions used as components for the main gulp functions.
     * [.minifyFor()](#module_partials.minifyFor) ⇒ <code>\*</code>
     * [.distSeries([srcPath], [distFinalPath], [tsSearch])](#module_partials.distSeries) ⇒ <code>function</code>
     * [.distForSrc([useTs])](#module_partials.distForSrc) ⇒ <code>string</code>
-    * [.distFor([srcPath], [destPath])](#module_partials.distFor) ⇒ <code>\*</code>
+    * [.distFor([srcPath], [destPath])](#module_partials.distFor) ⇒ <code>stream.Stream</code>
     * [.clean([done], [paths])](#module_partials.clean) ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>\*</code>
     * [.beginWatcher()](#module_partials.beginWatcher) ⇒ <code>FSWatcher</code>
     * [.addToReadme([done])](#module_partials.addToReadme) ⇒ <code>string</code> \| <code>Uint8Array</code>
@@ -635,7 +635,7 @@ Retrieve the correct distFor search path based on TS Config.
 
 <a name="module_partials.distFor"></a>
 
-### partials.distFor([srcPath], [destPath]) ⇒ <code>\*</code>
+### partials.distFor([srcPath], [destPath]) ⇒ <code>stream.Stream</code>
 Build the distribution for a given source pattern.
 
 **Kind**: static method of [<code>partials</code>](#module_partials)  

package/dist/build.js

@@ -1,30 +1,30 @@
-'use strict'
-
-var bundle = require('./bundle')
-var bundleLint = require('./bundleLint')
-var bundleMinify = require('./bundleMinify')
-var _require = require('./partials')
-var clean = _require.clean
-var distSeries = _require.distSeries
-var compileReadme = require('./compileReadme')
-var dist = require('./dist')
-var distLint = require('./distLint')
-var distMinify = require('./distMinify')
-var _require2 = require('gulp')
-var parallel = _require2.parallel
-var series = _require2.series
-var gulpConfig = require('../gulp.config.js')
-var testFull = require('./testFull')
-
+'use strict'
+
+var bundle = require('./bundle')
+var bundleLint = require('./bundleLint')
+var bundleMinify = require('./bundleMinify')
+var _require = require('./partials')
+var clean = _require.clean
+var distSeries = _require.distSeries
+var compileReadme = require('./compileReadme')
+var dist = require('./dist')
+var distLint = require('./distLint')
+var distMinify = require('./distMinify')
+var _require2 = require('gulp')
+var parallel = _require2.parallel
+var series = _require2.series
+var gulpConfig = require('../gulp.config.js')
+var testFull = require('./testFull')
+
 /**
  * Runs several processes to build and validate the project.
  * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
  * @memberOf module:js-build-tools
  * @param {function} [done=null]
  * @returns {stream.Stream}
- */
-var build = function build () {
-  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
-  return parallel(gulpConfig.get('nodeOnly') ? series(clean, dist, parallel(distLint, distMinify)) : series(clean, distSeries, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)), compileReadme, testFull)(done)
-}
-module.exports = build
+ */
+var build = function build () {
+  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
+  return parallel(gulpConfig.get('nodeOnly') ? series(clean, dist, parallel(distLint, distMinify)) : series(clean, distSeries(), parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)), compileReadme, testFull)(done)
+}
+module.exports = build

package/dist/build.min.js

@@ -1 +1 @@
-"use strict";var bundle=require("./bundle"),bundleLint=require("./bundleLint"),bundleMinify=require("./bundleMinify"),_require=require("./partials"),clean=_require.clean,distSeries=_require.distSeries,compileReadme=require("./compileReadme"),dist=require("./dist"),distLint=require("./distLint"),distMinify=require("./distMinify"),_require2=require("gulp"),parallel=_require2.parallel,series=_require2.series,gulpConfig=require("../gulp.config.js"),testFull=require("./testFull"),build=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null;return parallel(gulpConfig.get("nodeOnly")?series(clean,dist,parallel(distLint,distMinify)):series(clean,distSeries,parallel(distLint,distMinify),bundle,parallel(bundleLint,bundleMinify)),compileReadme,testFull)(e)};module.exports=build;
+"use strict";var bundle=require("./bundle"),bundleLint=require("./bundleLint"),bundleMinify=require("./bundleMinify"),_require=require("./partials"),clean=_require.clean,distSeries=_require.distSeries,compileReadme=require("./compileReadme"),dist=require("./dist"),distLint=require("./distLint"),distMinify=require("./distMinify"),_require2=require("gulp"),parallel=_require2.parallel,series=_require2.series,gulpConfig=require("../gulp.config.js"),testFull=require("./testFull"),build=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null;return parallel(gulpConfig.get("nodeOnly")?series(clean,dist,parallel(distLint,distMinify)):series(clean,distSeries(),parallel(distLint,distMinify),bundle,parallel(bundleLint,bundleMinify)),compileReadme,testFull)(e)};module.exports=build;

package/dist/bundle.js

@@ -1,18 +1,18 @@
-'use strict'
-
-var browserify = require('browserify')
-var _require = require('gulp')
-var dest = _require.dest
-var gulpConfig = require('../gulp.config.js')
-var source = require('vinyl-source-stream')
-
+'use strict'
+
+var browserify = require('browserify')
+var _require = require('gulp')
+var dest = _require.dest
+var gulpConfig = require('../gulp.config.js')
+var source = require('vinyl-source-stream')
+
 /**
  * Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
  * @function
  * @memberOf module:js-build-tools
  * @returns {stream.Stream}
- */
-var bundle = function bundle () {
-  return browserify(gulpConfig.get('distMain')).bundle().pipe(source(''.concat(gulpConfig.get('browserName'), '.js'))).pipe(dest(gulpConfig.get('browserPath')))
-}
-module.exports = bundle
+ */
+var bundle = function bundle () {
+  return browserify(gulpConfig.get('distMain')).bundle().pipe(source(''.concat(gulpConfig.get('browserName'), '.js'))).pipe(dest(gulpConfig.get('browserPath')))
+}
+module.exports = bundle

package/dist/bundleLint.js

@@ -1,24 +1,24 @@
-'use strict'
-
-require('core-js/modules/es.array.concat.js')
-var _require = require('gulp')
-var dest = _require.dest
-var src = _require.src
-var gulpConfig = require('../gulp.config.js')
-var standard = require('gulp-standard')
-
+'use strict'
+
+require('core-js/modules/es.array.concat.js')
+var _require = require('gulp')
+var dest = _require.dest
+var src = _require.src
+var gulpConfig = require('../gulp.config.js')
+var standard = require('gulp-standard')
+
 /**
  * Applies Standard code style linting to bundled file.
  * @function
  * @memberOf module:js-build-tools
  * @returns {stream.Stream}
- */
-var bundleLint = function bundleLint () {
-  return src(''.concat(gulpConfig.get('browserPath'), '/').concat(gulpConfig.get('browserName'), '.js')).pipe(standard({
-    fix: true
-  })).pipe(standard.reporter('default', {
-    fix: true,
-    quiet: true
-  })).pipe(dest(gulpConfig.get('browserPath')))
-}
-module.exports = bundleLint
+ */
+var bundleLint = function bundleLint () {
+  return src(''.concat(gulpConfig.get('browserPath'), '/').concat(gulpConfig.get('browserName'), '.js')).pipe(standard({
+    fix: true
+  })).pipe(standard.reporter('default', {
+    fix: true,
+    quiet: true
+  })).pipe(dest(gulpConfig.get('browserPath')))
+}
+module.exports = bundleLint

package/dist/bundleMinify.js

@@ -1,16 +1,16 @@
-'use strict'
-
-require('core-js/modules/es.array.concat.js')
-var gulpConfig = require('../gulp.config.js')
-var minifyFor = require('./partials/minifyFor')
-
+'use strict'
+
+require('core-js/modules/es.array.concat.js')
+var gulpConfig = require('../gulp.config.js')
+var minifyFor = require('./partials/minifyFor')
+
 /**
  * Creates the minified bundle file.
  * @function
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-var bundleMinify = function bundleMinify () {
-  return minifyFor(''.concat(gulpConfig.get('browserPath'), '/').concat(gulpConfig.get('browserName'), '.js'), gulpConfig.get('browserPath'))
-}
-module.exports = bundleMinify
+ */
+var bundleMinify = function bundleMinify () {
+  return minifyFor(''.concat(gulpConfig.get('browserPath'), '/').concat(gulpConfig.get('browserName'), '.js'), gulpConfig.get('browserPath'))
+}
+module.exports = bundleMinify

package/dist/compileReadme.js

@@ -1,15 +1,15 @@
-'use strict'
-
-var _require = require('./partials')
-var addToReadme = _require.addToReadme
-var readmeTemplate = _require.readmeTemplate
-var _require2 = require('gulp')
-var series = _require2.series
-
+'use strict'
+
+var _require = require('./partials')
+var addToReadme = _require.addToReadme
+var readmeTemplate = _require.readmeTemplate
+var _require2 = require('gulp')
+var series = _require2.series
+
 /**
  * Generate the README.md file based off of the template, then append the generated documentation.
  * @memberOf module:js-build-tools
  * @returns {stream.Stream}
- */
-var compileReadme = series(readmeTemplate, addToReadme)
-module.exports = compileReadme
+ */
+var compileReadme = series(readmeTemplate, addToReadme)
+module.exports = compileReadme

package/dist/default.js

@@ -1,19 +1,19 @@
-'use strict'
-
-var dist = require('./dist')
-var bundle = require('./bundle')
-var gulpConfig = require('../gulp.config')
-var _require = require('gulp')
-var series = _require.series
-
+'use strict'
+
+var dist = require('./dist')
+var bundle = require('./bundle')
+var gulpConfig = require('../gulp.config')
+var _require = require('gulp')
+var series = _require.series
+
 /**
  * Recommended as the default task, runs the simple dist and bundle tasks.
  * @memberOf module:js-build-tools
  * @param {function} [done=null]
  * @returns {stream.Stream}
- */
-var defaultCmd = function defaultCmd () {
-  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
-  return gulpConfig.get('nodeOnly') ? series(dist)(done) : series(dist, bundle)(done)
-}
-module.exports = defaultCmd
+ */
+var defaultCmd = function defaultCmd () {
+  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
+  return gulpConfig.get('nodeOnly') ? series(dist)(done) : series(dist, bundle)(done)
+}
+module.exports = defaultCmd

package/dist/dist.js

@@ -1,14 +1,14 @@
-'use strict'
-
-var distFor = require('./partials/distFor.js')
-
+'use strict'
+
+var distFor = require('./partials/distFor.js')
+
 /**
  * Simplified distribution tasks which will use arguments from distFor.
  * @function
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-var dist = function dist () {
-  return distFor()
-}
-module.exports = dist
+ */
+var dist = function dist () {
+  return distFor()
+}
+module.exports = dist

package/dist/distLint.js

@@ -1,23 +1,23 @@
-'use strict'
-
-var gulpConfig = require('../gulp.config.js')
-var _require = require('gulp')
-var dest = _require.dest
-var src = _require.src
-var standard = require('gulp-standard')
-
+'use strict'
+
+var gulpConfig = require('../gulp.config.js')
+var _require = require('gulp')
+var dest = _require.dest
+var src = _require.src
+var standard = require('gulp-standard')
+
 /**
  * Applies Standard code style linting to distribution files.
  * @function
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-var distLint = function distLint () {
-  return src(gulpConfig.get('distSearch')).pipe(standard({
-    fix: true
-  })).pipe(standard.reporter('default', {
-    fix: true,
-    quiet: true
-  })).pipe(dest(gulpConfig.get('distPath')))
-}
-module.exports = distLint
+ */
+var distLint = function distLint () {
+  return src(gulpConfig.get('distSearch')).pipe(standard({
+    fix: true
+  })).pipe(standard.reporter('default', {
+    fix: true,
+    quiet: true
+  })).pipe(dest(gulpConfig.get('distPath')))
+}
+module.exports = distLint

package/dist/distMinify.js

@@ -1,15 +1,15 @@
-'use strict'
-
-var gulpConfig = require('../gulp.config.js')
-var minifyFor = require('./partials/minifyFor')
-
+'use strict'
+
+var gulpConfig = require('../gulp.config.js')
+var minifyFor = require('./partials/minifyFor')
+
 /**
  * Creates minified versions of the dist files.
  * @function
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-var distMinify = function distMinify () {
-  return minifyFor(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
-}
-module.exports = distMinify
+ */
+var distMinify = function distMinify () {
+  return minifyFor(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
+}
+module.exports = distMinify

package/dist/partials/addToReadme.js

@@ -1,25 +1,25 @@
-"use strict";
-
-var fs = require('fs');
-var gulpConfig = require('../../gulp.config.js');
-var jsdoc2md = require('jsdoc-to-markdown');
-var _require = require('glob'),
-  globSync = _require.globSync;
-
+"use strict";
+
+var fs = require('fs');
+var gulpConfig = require('../../gulp.config.js');
+var jsdoc2md = require('jsdoc-to-markdown');
+var _require = require('glob'),
+  globSync = _require.globSync;
+
 /**
  * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
  * @function
  * @memberOf module:partials
  * @param {function|null} [done=null]
  * @returns {string|Uint8Array}
- */
-var addToReadme = function addToReadme() {
-  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
-  var files = globSync(gulpConfig.get('readmeSearch'));
-  var readme = jsdoc2md.renderSync({
-    files: files
-  });
-  fs.appendFileSync(gulpConfig.get('readmePath') + gulpConfig.get('readmeFile'), readme, gulpConfig.get('readmeOptions'));
-  return done && done();
-};
+ */
+var addToReadme = function addToReadme() {
+  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+  var files = globSync(gulpConfig.get('readmeSearch'));
+  var readme = jsdoc2md.renderSync({
+    files: files
+  });
+  fs.appendFileSync(gulpConfig.get('readmePath') + gulpConfig.get('readmeFile'), readme, gulpConfig.get('readmeOptions'));
+  return done && done();
+};
 module.exports = addToReadme;

package/dist/partials/beginWatcher.js

@@ -1,16 +1,16 @@
-"use strict";
-
-var gulpConfig = require('../../gulp.config.js');
-var _require = require('gulp'),
-  watch = _require.watch;
-
+"use strict";
+
+var gulpConfig = require('../../gulp.config.js');
+var _require = require('gulp'),
+  watch = _require.watch;
+
 /**
  * Create a chokidar instance which watches and triggers change when the globed files are modified.
  * @function
  * @memberOf module:partials
  * @returns {FSWatcher}
- */
-var beginWatcher = function beginWatcher() {
-  return watch(gulpConfig.get('watchSearch'));
-};
+ */
+var beginWatcher = function beginWatcher() {
+  return watch(gulpConfig.get('watchSearch'));
+};
 module.exports = beginWatcher;

package/dist/partials/clean.js

@@ -1,8 +1,8 @@
-"use strict";
-
-var del = require('del');
-var gulpConfig = require('../../gulp.config.js');
-
+"use strict";
+
+var del = require('del');
+var gulpConfig = require('../../gulp.config.js');
+
 /**
  * Deletes all the distribution and browser files (used before create a new build).
  * @function
@@ -10,12 +10,12 @@ var gulpConfig = require('../../gulp.config.js');
  * @param {function} [done=null]
  * @param {string[]} [paths=['dist/config/path', 'browser/config/path']]
  * @returns {Promise<string[]> | *}
- */
-var clean = function clean() {
-  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
-  var paths = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [gulpConfig.get('distPath'), gulpConfig.get('browserPath')];
-  return del(paths).then(function () {
-    return done && done();
-  });
-};
+ */
+var clean = function clean() {
+  var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+  var paths = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [gulpConfig.get('distPath'), gulpConfig.get('browserPath')];
+  return del(paths).then(function () {
+    return done && done();
+  });
+};
 module.exports = clean;

package/dist/partials/distFor.js

@@ -1,23 +1,23 @@
-"use strict";
-
-var babel = require('gulp-babel');
-var _require = require('gulp'),
-  dest = _require.dest,
-  src = _require.src;
-var distForSrc = require('./distForSrc');
-var gulpConfig = require('../../gulp.config.js');
-
+"use strict";
+
+var babel = require('gulp-babel');
+var _require = require('gulp'),
+  dest = _require.dest,
+  src = _require.src;
+var distForSrc = require('./distForSrc');
+var gulpConfig = require('../../gulp.config.js');
+
 /**
  * Build the distribution for a given source pattern.
  * @function
  * @memberOf module:partials
  * @param {string|array} [srcPath='src/config/path/dist/for']
  * @param {string} [destPath='dist/config/path']
- * @returns {*}
- */
-var distFor = function distFor() {
-  var srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
-  var destPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
-  return src(srcPath).pipe(babel()).pipe(dest(destPath));
-};
+ * @returns {stream.Stream}
+ */
+var distFor = function distFor() {
+  var srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
+  var destPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
+  return src(srcPath).pipe(babel()).pipe(dest(destPath));
+};
 module.exports = distFor;

package/dist/partials/distForSrc.js

@@ -1,16 +1,16 @@
-"use strict";
-
-var gulpConfig = require('../../gulp.config');
-
+"use strict";
+
+var gulpConfig = require('../../gulp.config');
+
 /**
  * Retrieve the correct distFor search path based on TS Config.
  * @function
  * @memberOf module:partials
  * @param {module:gulpConfig~FlagStringSetting} [useTs='config/for/ts']
  * @returns {string}
- */
-var distForSrc = function distForSrc() {
-  var useTs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('useTsConfig');
-  return useTs ? gulpConfig.get('distSearch') : gulpConfig.get('srcSearch');
-};
+ */
+var distForSrc = function distForSrc() {
+  var useTs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('useTsConfig');
+  return useTs ? gulpConfig.get('distSearch') : gulpConfig.get('srcSearch');
+};
 module.exports = distForSrc;

package/dist/partials/distSeries.js

@@ -1,12 +1,12 @@
-"use strict";
-
-var gulpConfig = require('../../gulp.config');
-var distFor = require('./distFor');
-var distForSrc = require('./distForSrc');
-var _require = require('gulp'),
-  series = _require.series;
-var tsFor = require('./tsFor');
-
+"use strict";
+
+var gulpConfig = require('../../gulp.config');
+var distFor = require('./distFor');
+var distForSrc = require('./distForSrc');
+var _require = require('gulp'),
+  series = _require.series;
+var tsFor = require('./tsFor');
+
 /**
  * When using TypeScript, ensure that we process the ts first then run babel (dist)
  * @function
@@ -15,17 +15,18 @@ var tsFor = require('./tsFor');
  * @param {string} [distFinalPath='dist/config/path']
  * @param {string} [tsSearch='ts/search/config/path']
  * @returns {Function}
- */
-var distSeries = function distSeries() {
-  var srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
-  var distFinalPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
-  var tsSearch = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : gulpConfig.get('tsSearch');
-  return gulpConfig.get('useTsConfig') ? series(function () {
-    return tsFor(tsSearch, distFinalPath);
-  }, function () {
-    return distFor(srcPath, distFinalPath);
-  }) : function () {
-    return distFor(srcPath, distFinalPath);
-  };
-};
+ */
+var distSeries = function distSeries() {
+  var srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
+  var distFinalPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
+  var tsSearch = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : gulpConfig.get('tsSearch');
+  return function () {
+    var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+    return gulpConfig.get('useTsConfig') ? series(function () {
+      return tsFor(tsSearch, distFinalPath);
+    }, function () {
+      return distFor(srcPath, distFinalPath);
+    })(done) : distFor(srcPath, distFinalPath);
+  };
+};
 module.exports = distSeries;

package/dist/partials/minifyFor.js

@@ -1,21 +1,21 @@
-"use strict";
-
-var _require = require('gulp'),
-  dest = _require.dest,
-  src = _require.src;
-var _require2 = require('gulp-uglify-es'),
-  uglify = _require2.default;
-var rename = require('gulp-rename');
-
+"use strict";
+
+var _require = require('gulp'),
+  dest = _require.dest,
+  src = _require.src;
+var _require2 = require('gulp-uglify-es'),
+  uglify = _require2.default;
+var rename = require('gulp-rename');
+
 /**
  * Minify files and rename the output with '.min' extension.
  * @function
  * @memberOf module:partials
  * @returns {*}
- */
-var minifyFor = function minifyFor(srcSearch, destination) {
-  return src(srcSearch).pipe(uglify()).pipe(rename({
-    extname: '.min.js'
-  })).pipe(dest(destination));
-};
+ */
+var minifyFor = function minifyFor(srcSearch, destination) {
+  return src(srcSearch).pipe(uglify()).pipe(rename({
+    extname: '.min.js'
+  })).pipe(dest(destination));
+};
 module.exports = minifyFor;

package/dist/partials/readmeTemplate.js

@@ -1,18 +1,18 @@
-"use strict";
-
-var _require = require('gulp'),
-  dest = _require.dest,
-  src = _require.src;
-var gulpConfig = require('../../gulp.config.js');
-var rename = require('gulp-rename');
-
+"use strict";
+
+var _require = require('gulp'),
+  dest = _require.dest,
+  src = _require.src;
+var gulpConfig = require('../../gulp.config.js');
+var rename = require('gulp-rename');
+
 /**
  * Copy a readme template into the README.md file.
  * @function
  * @memberOf module:partials
  * @returns {*}
- */
-var readmeTemplate = function readmeTemplate() {
-  return src(gulpConfig.get('readmeTemplate')).pipe(rename(gulpConfig.get('readmeFile'))).pipe(dest(gulpConfig.get('readmePath')));
-};
+ */
+var readmeTemplate = function readmeTemplate() {
+  return src(gulpConfig.get('readmeTemplate')).pipe(rename(gulpConfig.get('readmeFile'))).pipe(dest(gulpConfig.get('readmePath')));
+};
 module.exports = readmeTemplate;