js-build-tools 1.1.0 → 1.2.0

package/README.md

@@ -105,16 +105,6 @@ Run any of the above commands with `gulp` or `npm run`.
 ## Constants
 
 <dl>
-<dt><a href="#build">build</a></dt>
-<dd><p>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.</p>
-</dd>
-<dt><a href="#compileReadme">compileReadme</a></dt>
-<dd><p>Generate the README.md file based off of the template, then append the generated documentation.</p>
-</dd>
-<dt><a href="#defaultCmd">defaultCmd</a></dt>
-<dd><p>Recommended as the default task, runs the simple dist and bundle tasks.</p>
-</dd>
 <dt><a href="#logObject">logObject</a></dt>
 <dd><p>Log out an object in a nicely formatted way.</p>
 </dd>
@@ -139,74 +129,65 @@ Cleans, distributes (lint and minify), bundles (lint and minify), creates the re
 <dt><a href="#nodeTree">nodeTree</a> : <code>Object.&lt;string, (string|Object|Array)&gt;</code></dt>
 <dd><p>Sample NodeTree for testing circular references and arrays.</p>
 </dd>
+<dt><a href="#defaultCmd">defaultCmd</a></dt>
+<dd><p>Recommended as the default task, runs the simple dist and bundle tasks.</p>
+</dd>
+<dt><a href="#compileReadme">compileReadme</a></dt>
+<dd><p>Generate the README.md file based off of the template, then append the generated documentation.</p>
+</dd>
+<dt><a href="#build">build</a></dt>
+<dd><p>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.</p>
+</dd>
 </dl>
 
 ## Functions
 
 <dl>
-<dt><a href="#addToReadme">addToReadme()</a> ⇒ <code>string</code> | <code>Uint8Array</code></dt>
-<dd><p>Appends all the jsdoc comments to the readme file. Assumes empty or templated file.</p>
-</dd>
-<dt><a href="#bundle">bundle()</a> ⇒ <code>*</code></dt>
-<dd><p>Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.</p>
+<dt><a href="#watchTest">watchTest()</a> ⇒ <code>*</code></dt>
+<dd><p>Watch for changes and run the tests.</p>
 </dd>
-<dt><a href="#bundleLint">bundleLint()</a> ⇒ <code>*</code></dt>
-<dd><p>Applies Standard code style linting to bundled file.</p>
+<dt><a href="#watchFull">watchFull()</a> ⇒ <code>*</code></dt>
+<dd><p>Watch for changes and run the distribution for the changed files, then bundle and test the changed files.</p>
 </dd>
-<dt><a href="#bundleMinify">bundleMinify()</a> ⇒ <code>*</code></dt>
-<dd><p>Creates the minified bundle file.</p>
+<dt><a href="#testQuick">testQuick()</a> ⇒ <code>Promise.&lt;*&gt;</code></dt>
+<dd><p>Run the Jest tests for files which have been modified (based on git status).</p>
 </dd>
-<dt><a href="#clean">clean()</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> | <code>*</code></dt>
-<dd><p>Deletes all the distribution and browser files (used before create a new build).</p>
+<dt><a href="#testFull">testFull()</a> ⇒ <code>Promise.&lt;*&gt;</code></dt>
+<dd><p>Run all tests with jest.</p>
 </dd>
-<dt><a href="#dist">dist()</a> ⇒ <code>*</code></dt>
-<dd><p>Simplified distribution tasks which will use arguments from distFor.</p>
+<dt><a href="#readmeTemplate">readmeTemplate()</a> ⇒ <code>*</code></dt>
+<dd><p>Copy a readme template into the README.md file.</p>
 </dd>
-<dt><a href="#distFor">distFor(srcPath, destPath)</a> ⇒ <code>*</code></dt>
-<dd><p>Build the distribution for a given source pattern.</p>
+<dt><a href="#distMinify">distMinify()</a> ⇒ <code>*</code></dt>
+<dd><p>Creates minified versions of the dist files.</p>
 </dd>
 <dt><a href="#distLint">distLint()</a> ⇒ <code>*</code></dt>
 <dd><p>Applies Standard code style linting to distribution files.</p>
 </dd>
-<dt><a href="#distMinify">distMinify()</a> ⇒ <code>*</code></dt>
-<dd><p>Creates minified versions of the dist files.</p>
+<dt><a href="#distFor">distFor(srcPath, destPath)</a> ⇒ <code>*</code></dt>
+<dd><p>Build the distribution for a given source pattern.</p>
 </dd>
-<dt><a href="#readmeTemplate">readmeTemplate()</a> ⇒ <code>*</code></dt>
-<dd><p>Copy a readme template into the README.md file.</p>
+<dt><a href="#dist">dist()</a> ⇒ <code>*</code></dt>
+<dd><p>Simplified distribution tasks which will use arguments from distFor.</p>
 </dd>
-<dt><a href="#testFull">testFull()</a> ⇒ <code>Promise.&lt;*&gt;</code></dt>
-<dd><p>Run all tests with jest.</p>
+<dt><a href="#clean">clean()</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> | <code>*</code></dt>
+<dd><p>Deletes all the distribution and browser files (used before create a new build).</p>
 </dd>
-<dt><a href="#testQuick">testQuick()</a> ⇒ <code>Promise.&lt;*&gt;</code></dt>
-<dd><p>Run the Jest tests for files which have been modified (based on git status).</p>
+<dt><a href="#bundleMinify">bundleMinify()</a> ⇒ <code>*</code></dt>
+<dd><p>Creates the minified bundle file.</p>
 </dd>
-<dt><a href="#watchFull">watchFull()</a> ⇒ <code>*</code></dt>
-<dd><p>Watch for changes and run the distribution for the changed files, then bundle and test the changed files.</p>
+<dt><a href="#bundleLint">bundleLint()</a> ⇒ <code>*</code></dt>
+<dd><p>Applies Standard code style linting to bundled file.</p>
 </dd>
-<dt><a href="#watchTest">watchTest()</a> ⇒ <code>*</code></dt>
-<dd><p>Watch for changes and run the tests.</p>
+<dt><a href="#bundle">bundle()</a> ⇒ <code>*</code></dt>
+<dd><p>Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.</p>
+</dd>
+<dt><a href="#addToReadme">addToReadme()</a> ⇒ <code>string</code> | <code>Uint8Array</code></dt>
+<dd><p>Appends all the jsdoc comments to the readme file. Assumes empty or templated file.</p>
 </dd>
 </dl>
 
-<a name="build"></a>
-
-## build
-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.
-
-**Kind**: global constant  
-<a name="compileReadme"></a>
-
-## compileReadme
-Generate the README.md file based off of the template, then append the generated documentation.
-
-**Kind**: global constant  
-<a name="defaultCmd"></a>
-
-## defaultCmd
-Recommended as the default task, runs the simple dist and bundle tasks.
-
-**Kind**: global constant  
 <a name="logObject"></a>
 
 ## logObject
@@ -261,40 +242,65 @@ Sample of object containing multiple references.
 Sample NodeTree for testing circular references and arrays.
 
 **Kind**: global constant  
-<a name="addToReadme"></a>
+<a name="defaultCmd"></a>
 
-## addToReadme() ⇒ <code>string</code> \| <code>Uint8Array</code>
-Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
+## defaultCmd
+Recommended as the default task, runs the simple dist and bundle tasks.
+
+**Kind**: global constant  
+<a name="compileReadme"></a>
+
+## compileReadme
+Generate the README.md file based off of the template, then append the generated documentation.
+
+**Kind**: global constant  
+<a name="build"></a>
+
+## build
+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.
+
+**Kind**: global constant  
+<a name="watchTest"></a>
+
+## watchTest() ⇒ <code>\*</code>
+Watch for changes and run the tests.
 
 **Kind**: global function  
-<a name="bundle"></a>
+<a name="watchFull"></a>
 
-## bundle() ⇒ <code>\*</code>
-Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
+## watchFull() ⇒ <code>\*</code>
+Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
 
 **Kind**: global function  
-<a name="bundleLint"></a>
+<a name="testQuick"></a>
 
-## bundleLint() ⇒ <code>\*</code>
-Applies Standard code style linting to bundled file.
+## testQuick() ⇒ <code>Promise.&lt;\*&gt;</code>
+Run the Jest tests for files which have been modified (based on git status).
 
 **Kind**: global function  
-<a name="bundleMinify"></a>
+<a name="testFull"></a>
 
-## bundleMinify() ⇒ <code>\*</code>
-Creates the minified bundle file.
+## testFull() ⇒ <code>Promise.&lt;\*&gt;</code>
+Run all tests with jest.
 
 **Kind**: global function  
-<a name="clean"></a>
+<a name="readmeTemplate"></a>
 
-## clean() ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>\*</code>
-Deletes all the distribution and browser files (used before create a new build).
+## readmeTemplate() ⇒ <code>\*</code>
+Copy a readme template into the README.md file.
 
 **Kind**: global function  
-<a name="dist"></a>
+<a name="distMinify"></a>
 
-## dist() ⇒ <code>\*</code>
-Simplified distribution tasks which will use arguments from distFor.
+## distMinify() ⇒ <code>\*</code>
+Creates minified versions of the dist files.
+
+**Kind**: global function  
+<a name="distLint"></a>
+
+## distLint() ⇒ <code>\*</code>
+Applies Standard code style linting to distribution files.
 
 **Kind**: global function  
 <a name="distFor"></a>
@@ -309,45 +315,39 @@ Build the distribution for a given source pattern.
 | srcPath | <code>string</code> \| <code>array</code> | 
 | destPath | <code>string</code> | 
 
-<a name="distLint"></a>
-
-## distLint() ⇒ <code>\*</code>
-Applies Standard code style linting to distribution files.
-
-**Kind**: global function  
-<a name="distMinify"></a>
+<a name="dist"></a>
 
-## distMinify() ⇒ <code>\*</code>
-Creates minified versions of the dist files.
+## dist() ⇒ <code>\*</code>
+Simplified distribution tasks which will use arguments from distFor.
 
 **Kind**: global function  
-<a name="readmeTemplate"></a>
+<a name="clean"></a>
 
-## readmeTemplate() ⇒ <code>\*</code>
-Copy a readme template into the README.md file.
+## clean() ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>\*</code>
+Deletes all the distribution and browser files (used before create a new build).
 
 **Kind**: global function  
-<a name="testFull"></a>
+<a name="bundleMinify"></a>
 
-## testFull() ⇒ <code>Promise.&lt;\*&gt;</code>
-Run all tests with jest.
+## bundleMinify() ⇒ <code>\*</code>
+Creates the minified bundle file.
 
 **Kind**: global function  
-<a name="testQuick"></a>
+<a name="bundleLint"></a>
 
-## testQuick() ⇒ <code>Promise.&lt;\*&gt;</code>
-Run the Jest tests for files which have been modified (based on git status).
+## bundleLint() ⇒ <code>\*</code>
+Applies Standard code style linting to bundled file.
 
 **Kind**: global function  
-<a name="watchFull"></a>
+<a name="bundle"></a>
 
-## watchFull() ⇒ <code>\*</code>
-Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
+## bundle() ⇒ <code>\*</code>
+Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
 
 **Kind**: global function  
-<a name="watchTest"></a>
+<a name="addToReadme"></a>
 
-## watchTest() ⇒ <code>\*</code>
-Watch for changes and run the tests.
+## addToReadme() ⇒ <code>string</code> \| <code>Uint8Array</code>
+Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
 
 **Kind**: global function  

package/dist/addToReadme.js

@@ -1,38 +1,21 @@
 'use strict'
 
-require('core-js/modules/es.array.map.js')
-
-require('core-js/modules/esnext.async-iterator.map.js')
-
-require('core-js/modules/esnext.iterator.map.js')
-
-require('core-js/modules/es.array.concat.js')
-
-var filenames = require('gulp-filenames')
-
 var fs = require('fs')
-
 var gulpConfig = require('../gulp.config.js')
-
 var jsdoc2md = require('jsdoc-to-markdown')
+var _require = require('glob')
+var globSync = _require.globSync
 
-var _require = require('gulp')
-var src = _require.src
 /**
  * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
  * @returns {string|Uint8Array}
  */
-
-var addToReadme = function addToReadme () {
-  return src(gulpConfig.srcSearch).pipe(filenames('readme')).on('end', function () {
-    var readme = jsdoc2md.renderSync({
-      files: filenames.get('readme').map(function (file) {
-        return ''.concat(gulpConfig.srcPath, '/').concat(file)
-      })
-    })
-    fs.appendFileSync('README.md', readme, 'utf8')
-    return readme
+var addToReadme = function addToReadme (done) {
+  var files = globSync(gulpConfig.srcSearch)
+  var readme = jsdoc2md.renderSync({
+    files: files
   })
+  fs.appendFileSync('README.md', readme, 'utf8')
+  done()
 }
-
 module.exports = addToReadme

package/dist/addToReadme.min.js

@@ -1 +1 @@
-"use strict";require("core-js/modules/es.array.map.js"),require("core-js/modules/esnext.async-iterator.map.js"),require("core-js/modules/esnext.iterator.map.js"),require("core-js/modules/es.array.concat.js");var filenames=require("gulp-filenames"),fs=require("fs"),gulpConfig=require("../gulp.config.js"),jsdoc2md=require("jsdoc-to-markdown"),_require=require("gulp"),src=_require.src,addToReadme=function(){return src(gulpConfig.srcSearch).pipe(filenames("readme")).on("end",(function(){var e=jsdoc2md.renderSync({files:filenames.get("readme").map((function(e){return"".concat(gulpConfig.srcPath,"/").concat(e)}))});return fs.appendFileSync("README.md",e,"utf8"),e}))};module.exports=addToReadme;
+"use strict";var fs=require("fs"),gulpConfig=require("../gulp.config.js"),jsdoc2md=require("jsdoc-to-markdown"),_require=require("glob"),globSync=_require.globSync,addToReadme=function(e){var r=globSync(gulpConfig.srcSearch),o=jsdoc2md.renderSync({files:r});fs.appendFileSync("README.md",o,"utf8"),e()};module.exports=addToReadme;

package/dist/build.js

@@ -1,32 +1,22 @@
 'use strict'
 
 var bundle = require('./bundle')
-
 var bundleLint = require('./bundleLint')
-
 var bundleMinify = require('./bundleMinify')
-
 var clean = require('./clean')
-
 var compileReadme = require('./compileReadme')
-
 var dist = require('./dist')
-
 var distLint = require('./distLint')
-
 var distMinify = require('./distMinify')
-
 var _require = require('gulp')
 var parallel = _require.parallel
 var series = _require.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.
  */
-
 var build = parallel(gulpConfig.nodeOnly ? series(clean, dist, parallel(distLint, distMinify)) : series(clean, dist, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)), compileReadme, testFull)
 module.exports = build

package/dist/bundle.js

@@ -1,20 +1,16 @@
 '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.
  * @returns {*}
  */
-
 var bundle = function bundle () {
   return browserify(gulpConfig.distMain).bundle().pipe(source(''.concat(gulpConfig.browserName, '.js'))).pipe(dest(gulpConfig.browserPath))
 }
-
 module.exports = bundle

package/dist/bundleLint.js

@@ -1,19 +1,16 @@
 '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.
  * @returns {*}
  */
-
 var bundleLint = function bundleLint () {
   return src(''.concat(gulpConfig.browserPath, '/').concat(gulpConfig.browserName, '.js')).pipe(standard({
     fix: true
@@ -22,5 +19,4 @@ var bundleLint = function bundleLint () {
     quiet: true
   })).pipe(dest(gulpConfig.browserPath))
 }
-
 module.exports = bundleLint

package/dist/bundleMinify.js

@@ -1,26 +1,21 @@
 '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 _require2 = require('gulp-uglify-es')
 var uglify = _require2.default
-
 var rename = require('gulp-rename')
+
 /**
  * Creates the minified bundle file.
  * @returns {*}
  */
-
 var bundleMinify = function bundleMinify () {
   return src(''.concat(gulpConfig.browserPath, '/').concat(gulpConfig.browserName, '.js')).pipe(uglify()).pipe(rename({
     extname: '.min.js'
   })).pipe(dest(gulpConfig.browserPath))
 }
-
 module.exports = bundleMinify

package/dist/clean.js

@@ -1,15 +1,13 @@
 '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).
- * @returns {Promise<string[]> | *}
- */
 
+/**
+ * Deletes all the distribution and browser files (used before create a new build).
+ * @returns {Promise<string[]> | *}
+ */
 var clean = function clean () {
   return del([gulpConfig.distPath, gulpConfig.browserPath])
 }
-
 module.exports = clean

package/dist/compileReadme.js

@@ -1,14 +1,12 @@
 'use strict'
 
 var addToReadme = require('./addToReadme')
-
 var readmeTemplate = require('./readmeTemplate')
-
 var _require = require('gulp')
 var series = _require.series
+
 /**
  * Generate the README.md file based off of the template, then append the generated documentation.
  */
-
 var compileReadme = series(readmeTemplate, addToReadme)
 module.exports = compileReadme

package/dist/default.js

@@ -2,15 +2,12 @@
 
 var _require = require('gulp')
 var series = _require.series
-
 var dist = require('./dist')
-
 var bundle = require('./bundle')
-
 var gulpConfig = require('../gulp.config')
+
 /**
  * Recommended as the default task, runs the simple dist and bundle tasks.
  */
-
 var defaultCmd = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
 module.exports = defaultCmd

package/dist/dist.js

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

package/dist/distFor.js

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

package/dist/distLint.js

@@ -1,17 +1,15 @@
 '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.
  * @returns {*}
  */
-
 var distLint = function distLint () {
   return src(gulpConfig.distSearch).pipe(standard({
     fix: true
@@ -20,5 +18,4 @@ var distLint = function distLint () {
     quiet: true
   })).pipe(dest(gulpConfig.distPath))
 }
-
 module.exports = distLint

package/dist/distMinify.js

@@ -3,22 +3,18 @@
 var _require = require('gulp')
 var dest = _require.dest
 var src = _require.src
-
 var gulpConfig = require('../gulp.config.js')
-
 var _require2 = require('gulp-uglify-es')
 var uglify = _require2.default
-
 var rename = require('gulp-rename')
+
 /**
  * Creates minified versions of the dist files.
  * @returns {*}
  */
-
 var distMinify = function distMinify () {
   return src(gulpConfig.distSearch).pipe(uglify()).pipe(rename({
     extname: '.min.js'
   })).pipe(dest(gulpConfig.distPath))
 }
-
 module.exports = distMinify

package/dist/readmeTemplate.js

@@ -3,17 +3,14 @@
 var _require = require('gulp')
 var dest = _require.dest
 var src = _require.src
-
 var gulpConfig = require('../gulp.config.js')
-
 var rename = require('gulp-rename')
+
 /**
  * Copy a readme template into the README.md file.
  * @returns {*}
  */
-
 var readmeTemplate = function readmeTemplate () {
   return src(gulpConfig.readmeTemplate).pipe(rename('README.md')).pipe(dest('.'))
 }
-
 module.exports = readmeTemplate