js-build-tools 2.3.0 → 2.4.0

package/dist/bundle.js

@@ -1,17 +1,17 @@
-'use strict'
-
-const browserify = require('browserify')
-const {
-  dest
-} = require('gulp')
-const gulpConfig = require('../gulp.config.js')
-const source = require('vinyl-source-stream')
-
+'use strict'
+
+const browserify = require('browserify')
+const {
+  dest
+} = require('gulp')
+const gulpConfig = require('../gulp.config.js')
+const 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}
- */
-const bundle = () => browserify(gulpConfig.get('distMain')).bundle().pipe(source(`${gulpConfig.get('browserName')}.js`)).pipe(dest(gulpConfig.get('browserPath')))
-module.exports = bundle
+ */
+const bundle = () => browserify(gulpConfig.get('distMain')).bundle().pipe(source(`${gulpConfig.get('browserName')}.js`)).pipe(dest(gulpConfig.get('browserPath')))
+module.exports = bundle

package/dist/bundleLint.js

@@ -1,22 +1,22 @@
-'use strict'
-
-const {
-  dest,
-  src
-} = require('gulp')
-const gulpConfig = require('../gulp.config.js')
-const standard = require('gulp-standard')
-
+'use strict'
+
+const {
+  dest,
+  src
+} = require('gulp')
+const gulpConfig = require('../gulp.config.js')
+const standard = require('gulp-standard')
+
 /**
  * Applies Standard code style linting to bundled file.
  * @function
  * @memberOf module:js-build-tools
  * @returns {stream.Stream}
- */
-const bundleLint = () => src(`${gulpConfig.get('browserPath')}/${gulpConfig.get('browserName')}.js`).pipe(standard({
-  fix: true
-})).pipe(standard.reporter('default', {
-  fix: true,
-  quiet: true
-})).pipe(dest(gulpConfig.get('browserPath')))
-module.exports = bundleLint
+ */
+const bundleLint = () => src(`${gulpConfig.get('browserPath')}/${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,13 +1,13 @@
-'use strict'
-
-const gulpConfig = require('../gulp.config.js')
-const minifyFor = require('./partials/minifyFor')
-
+'use strict'
+
+const gulpConfig = require('../gulp.config.js')
+const minifyFor = require('./partials/minifyFor')
+
 /**
  * Creates the minified bundle file.
  * @function
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-const bundleMinify = () => minifyFor(`${gulpConfig.get('browserPath')}/${gulpConfig.get('browserName')}.js`, gulpConfig.get('browserPath'))
-module.exports = bundleMinify
+ */
+const bundleMinify = () => minifyFor(`${gulpConfig.get('browserPath')}/${gulpConfig.get('browserName')}.js`, gulpConfig.get('browserPath'))
+module.exports = bundleMinify

package/dist/dist.js

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

package/dist/distLint.js

@@ -1,22 +1,22 @@
-'use strict'
-
-const gulpConfig = require('../gulp.config.js')
-const {
-  dest,
-  src
-} = require('gulp')
-const standard = require('gulp-standard')
-
+'use strict'
+
+const gulpConfig = require('../gulp.config.js')
+const {
+  dest,
+  src
+} = require('gulp')
+const standard = require('gulp-standard')
+
 /**
  * Applies Standard code style linting to distribution files.
  * @function
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-const distLint = () => src(gulpConfig.get('distSearch')).pipe(standard({
-  fix: true
-})).pipe(standard.reporter('default', {
-  fix: true,
-  quiet: true
-})).pipe(dest(gulpConfig.get('distPath')))
-module.exports = distLint
+ */
+const distLint = () => 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,13 +1,13 @@
-'use strict'
-
-const gulpConfig = require('../gulp.config.js')
-const minifyFor = require('./partials/minifyFor')
-
+'use strict'
+
+const gulpConfig = require('../gulp.config.js')
+const minifyFor = require('./partials/minifyFor')
+
 /**
  * Creates minified versions of the dist files.
  * @function
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-const distMinify = () => minifyFor(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
-module.exports = distMinify
+ */
+const distMinify = () => minifyFor(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
+module.exports = distMinify

package/dist/partials/addToReadme.js

@@ -1,20 +1,20 @@
-"use strict";
-
-const fs = require('fs');
-const gulpConfig = require('../../gulp.config.js');
-const jsdoc2md = require('jsdoc-to-markdown');
-const {
-  globSync
-} = require('glob');
-
+"use strict";
+
+const fs = require('fs');
+const gulpConfig = require('../../gulp.config.js');
+const jsdoc2md = require('jsdoc-to-markdown');
+const {
+  globSync
+} = require('glob');
+
 /**
  * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
  * Configure this with 'readmeSearch', 'readmePath', 'readmeFile', and 'readmeOptions'.
  * @function
  * @memberOf module:partials
  * @returns {string|Uint8Array}
- */
-const addToReadme = () => jsdoc2md.render({
-  files: globSync(gulpConfig.get('readmeSearch'))
-}).then(readme => fs.appendFileSync(gulpConfig.get('readmePath') + gulpConfig.get('readmeFile'), readme, gulpConfig.get('readmeOptions')));
+ */
+const addToReadme = () => jsdoc2md.render({
+  files: globSync(gulpConfig.get('readmeSearch'))
+}).then(readme => fs.appendFileSync(gulpConfig.get('readmePath') + gulpConfig.get('readmeFile'), readme, gulpConfig.get('readmeOptions')));
 module.exports = addToReadme;

package/dist/partials/beginWatcher.js

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

package/dist/partials/clean.js

@@ -1,17 +1,17 @@
-"use strict";
-
-require("core-js/modules/esnext.async-iterator.reduce.js");
-require("core-js/modules/esnext.iterator.constructor.js");
-require("core-js/modules/esnext.iterator.reduce.js");
-const gulpConfig = require('../../gulp.config.js');
-const removeDirectory = require('./removeDirectory');
-
+"use strict";
+
+require("core-js/modules/esnext.async-iterator.reduce.js");
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.reduce.js");
+const gulpConfig = require('../../gulp.config.js');
+const removeDirectory = require('./removeDirectory');
+
 /**
  * Deletes all the distribution and browser files (used before create a new build).
  * Configure array of directories to remove with 'cleanPaths'.
  * @function
  * @memberOf module:partials
  * @returns {Promise<string[]> | *}
- */
-const clean = () => gulpConfig.get('cleanPaths').reduce((promise, path) => promise.then(() => removeDirectory(path)), Promise.resolve());
+ */
+const clean = () => gulpConfig.get('cleanPaths').reduce((promise, path) => promise.then(() => removeDirectory(path)), Promise.resolve());
 module.exports = clean;

package/dist/partials/distFor.js

@@ -1,13 +1,13 @@
-"use strict";
-
-const babel = require('gulp-babel');
-const {
-  dest,
-  src
-} = require('gulp');
-const distForSrc = require('./distForSrc');
-const gulpConfig = require('../../gulp.config.js');
-
+"use strict";
+
+const babel = require('gulp-babel');
+const {
+  dest,
+  src
+} = require('gulp');
+const distForSrc = require('./distForSrc');
+const gulpConfig = require('../../gulp.config.js');
+
 /**
  * Build the distribution for a given source pattern.
  * @function
@@ -15,10 +15,10 @@ const gulpConfig = require('../../gulp.config.js');
  * @param {string|array} [srcPath='src/config/path/dist/for']
  * @param {string} [destPath='dist/config/path']
  * @returns {stream.Stream}
- */
-const distFor = function () {
-  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
-  let destPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
-  return src(srcPath).pipe(babel()).pipe(dest(destPath));
-};
+ */
+const distFor = function () {
+  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
+  let 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";
-
-const gulpConfig = require('../../gulp.config');
-
+"use strict";
+
+const 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}
- */
-const distForSrc = function () {
-  let useTs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('useTsConfig');
-  return useTs ? gulpConfig.get('distSearch') : gulpConfig.get('srcSearch');
-};
+ */
+const distForSrc = function () {
+  let 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,13 +1,13 @@
-"use strict";
-
-const gulpConfig = require('../../gulp.config');
-const distFor = require('./distFor');
-const distForSrc = require('./distForSrc');
-const {
-  series
-} = require('gulp');
-const tsFor = require('./tsFor');
-
+"use strict";
+
+const gulpConfig = require('../../gulp.config');
+const distFor = require('./distFor');
+const distForSrc = require('./distForSrc');
+const {
+  series
+} = require('gulp');
+const tsFor = require('./tsFor');
+
 /**
  * When using TypeScript, ensure that we process the ts first then run babel (dist)
  * @function
@@ -16,13 +16,13 @@ const tsFor = require('./tsFor');
  * @param {string} [distFinalPath='dist/config/path']
  * @param {string} [tsSearch='ts/search/config/path']
  * @returns {function(null=): stream.Stream}
- */
-const distSeries = function () {
-  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
-  let distFinalPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
-  let tsSearch = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : gulpConfig.get('tsSearch');
-  const typescript = tsFor(tsSearch, distFinalPath);
-  const dist = () => distFor(srcPath, distFinalPath);
-  return gulpConfig.get('useTsConfig') ? series(typescript, dist) : dist;
-};
+ */
+const distSeries = function () {
+  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : distForSrc();
+  let distFinalPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
+  let tsSearch = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : gulpConfig.get('tsSearch');
+  const typescript = tsFor(tsSearch, distFinalPath);
+  const dist = () => distFor(srcPath, distFinalPath);
+  return gulpConfig.get('useTsConfig') ? series(typescript, dist) : dist;
+};
 module.exports = distSeries;

package/dist/partials/minifyFor.js

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

package/dist/partials/readmeTemplate.js

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

package/dist/partials/removeDirectory.js

@@ -1,18 +1,18 @@
-"use strict";
-
-const {
-  rm,
-  exists
-} = require('fs');
-
-/**
- * Return a promise to be completed once the specified directory is deleted.
- * @function
- * @memberOf module:partials
- * @param {string} dirPath
- * @returns {Promise<*>}
- */
-const removeDirectory = dirPath => new Promise((resolve, reject) => exists(dirPath, doesExist => doesExist ? rm(dirPath, {
-  recursive: true
-}, error => error ? reject(error) : resolve(dirPath)) : resolve(dirPath)));
+"use strict";
+
+const {
+  rm,
+  exists
+} = require('fs');
+
+/**
+ * Return a promise to be completed once the specified directory is deleted.
+ * @function
+ * @memberOf module:partials
+ * @param {string} dirPath
+ * @returns {Promise<*>}
+ */
+const removeDirectory = dirPath => new Promise((resolve, reject) => exists(dirPath, doesExist => doesExist ? rm(dirPath, {
+  recursive: true
+}, error => error ? reject(error) : resolve(dirPath)) : resolve(dirPath)));
 module.exports = removeDirectory;

package/dist/partials/runOnChange.js

@@ -1,14 +1,14 @@
-"use strict";
-
-const gulpConfig = require('../../gulp.config.js');
-const bundle = require('../bundle');
-const distSeries = require('./distSeries');
-const {
-  parallel,
-  series
-} = require('gulp');
-const testQuick = require('../testQuick');
-
+"use strict";
+
+const gulpConfig = require('../../gulp.config.js');
+const bundle = require('../bundle');
+const distSeries = require('./distSeries');
+const {
+  parallel,
+  series
+} = require('gulp');
+const testQuick = require('../testQuick');
+
 /**
  * Run this function when the watched files are modified.
  * 1. Find the sub-folders within src path
@@ -34,11 +34,11 @@ const testQuick = require('../testQuick');
  * @memberOf module:partials
  * @param {string} path
  * @returns {stream.Stream}
- */
-const runOnChange = path => {
-  const useTs = gulpConfig.get('useTsConfig');
-  const distPath = gulpConfig.get('distPath');
-  const srcPath = gulpConfig.get('srcPath');
+ */
+const runOnChange = path => {
+  const useTs = gulpConfig.get('useTsConfig');
+  const distPath = gulpConfig.get('distPath');
+  const srcPath = gulpConfig.get('srcPath');
   /**
    * 1. The original path comes in from src and is a .ts
    * 2. Discover the outgoing dist path where that file should go
@@ -46,14 +46,14 @@ const runOnChange = path => {
    * 4. Take the original path, convert to full file path in dist
    * 5. Use the dist path found previously in #2
    * 6. Use the full dist path and the dist outgoing path in distFor
-   */
-  const pathRegex = new RegExp(`^${srcPath}(.*\\/)(.+)\\.(js|ts)$`, 'i');
-  const distPathResult = path.replace(pathRegex, `${distPath}$1`);
-  let distSrcPath = path;
-  if (useTs) {
-    distSrcPath = path.replace(pathRegex, `${distPath}$1$2.js`);
-  }
-  const runSeries = distSeries(distSrcPath, distPathResult, path);
-  return gulpConfig.get('nodeOnly') ? series(testQuick, runSeries)() : parallel(testQuick, series(runSeries, bundle))();
-};
+   */
+  const pathRegex = new RegExp(`^${srcPath}(.*\\/)(.+)\\.(js|ts)$`, 'i');
+  const distPathResult = path.replace(pathRegex, `${distPath}$1`);
+  let distSrcPath = path;
+  if (useTs) {
+    distSrcPath = path.replace(pathRegex, `${distPath}$1$2.js`);
+  }
+  const runSeries = distSeries(distSrcPath, distPathResult, path);
+  return gulpConfig.get('nodeOnly') ? series(testQuick, runSeries)() : parallel(testQuick, series(runSeries, bundle))();
+};
 module.exports = runOnChange;

package/dist/partials/tsFor.js

@@ -1,13 +1,13 @@
-"use strict";
-
-const {
-  dest,
-  parallel,
-  src
-} = require('gulp');
-const gulpConfig = require('../../gulp.config.js');
-const ts = require('gulp-typescript');
-
+"use strict";
+
+const {
+  dest,
+  parallel,
+  src
+} = require('gulp');
+const gulpConfig = require('../../gulp.config.js');
+const ts = require('gulp-typescript');
+
 /**
  * Starting at the source directory, find all the ts files and convert them into the distribution directory.
  * @function
@@ -16,14 +16,14 @@ const ts = require('gulp-typescript');
  * @param {string} [distPath='']
  * @returns {Function}
  * @see `https://www.typescriptlang.org/docs/handbook/gulp.html` for more info
- */
-const tsFor = function () {
-  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('tsSearch');
-  let distPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
-  const declarationProject = ts.createProject(gulpConfig.get('useTsConfig'));
-  const tsProject = ts.createProject(gulpConfig.get('useTsConfig'));
-  const makeDeclarations = () => src(srcPath).pipe(declarationProject()).dts.pipe(dest(distPath));
-  const compileJS = () => src(srcPath).pipe(tsProject()).js.pipe(dest(distPath));
-  return parallel(makeDeclarations, compileJS);
-};
+ */
+const tsFor = function () {
+  let srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.get('tsSearch');
+  let distPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.get('distPath');
+  const declarationProject = ts.createProject(gulpConfig.get('useTsConfig'));
+  const tsProject = ts.createProject(gulpConfig.get('useTsConfig'));
+  const makeDeclarations = () => src(srcPath).pipe(declarationProject()).dts.pipe(dest(distPath));
+  const compileJS = () => src(srcPath).pipe(tsProject()).js.pipe(dest(distPath));
+  return parallel(makeDeclarations, compileJS);
+};
 module.exports = tsFor;

package/dist/sass.js

@@ -1,7 +1,7 @@
-'use strict'
-
-const sassFor = require('./partials/sassFor')
-
-// Compile sass into CSS & auto-inject into browsers
-const sass = () => sassFor()
-module.exports = sass
+'use strict'
+
+const sassFor = require('./partials/sassFor')
+
+// Compile sass into CSS & auto-inject into browsers
+const sass = () => sassFor()
+module.exports = sass