js-build-tools 2.4.0 → 3.0.0

package/dist/test-helpers/setUp.js

@@ -1,77 +1,69 @@
 "use strict";
 
-const fs = require('fs');
-// Import the configurations and override some of them in order to direct to the temp directory.
+// Import the configurations and override some of them to direct to the temp directory.
 const gulpConfig = require('../../gulp.config.js');
 const {
-  removeDirectory
-} = require('../partials');
+  setUp
+} = require('test-filesystem');
 let tempDir = 'test-temp/';
-let srcPath = `${tempDir}src`;
+let srcPath = "".concat(tempDir, "src");
 
 /**
  * Update the gulp configurations with the test data. Set the test directory where temp files will be created for testing.
- * @function
  * @memberOf module:testHelpers
  * @param {string} testDir
  */
 const setDefaults = function () {
   let testDir = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'test-temp';
-  tempDir = `${testDir}/`;
-  srcPath = `${tempDir}src`;
-  const distPath = `${tempDir}dist`;
-  const browserPath = `${tempDir}browser`;
-  const sassPath = `${tempDir}sass`;
-  gulpConfig.set('browserPath', browserPath);
+  tempDir = "".concat(testDir, "/");
+  srcPath = "".concat(tempDir, "src");
+  setUp.setDefaults(tempDir);
+  const distPath = "".concat(tempDir, "dist");
+  const browserPath = "".concat(tempDir, "browser");
+  const sassPath = "".concat(tempDir, "sass");
+  gulpConfig.set('browser.from', "".concat(distPath, "/**/*.js"));
+  gulpConfig.set('browser.to', browserPath);
   gulpConfig.set('cleanPaths', [distPath, browserPath]);
-  gulpConfig.set('cssPath', `${browserPath}/css`);
-  gulpConfig.set('distMain', `${distPath}/main`);
-  gulpConfig.set('distPath', distPath);
-  gulpConfig.set('distSearch', `${distPath}/**/*.js`);
-  gulpConfig.set('readmeTemplate', `${tempDir}MAIN.md`);
-  gulpConfig.set('readmePath', tempDir);
-  gulpConfig.set('readmeSearch', `${srcPath}/**/!(*.test).js`);
+  gulpConfig.set('dist.from', "".concat(srcPath, "/**/!(*.test).js"));
+  gulpConfig.set('dist.main', "".concat(distPath, "/main"));
+  gulpConfig.set('dist.to', distPath);
+  gulpConfig.set('fonts.from', "".concat(srcPath, "/fonts/**/*"));
+  gulpConfig.set('fonts.to', "".concat(browserPath, "/fonts"));
+  gulpConfig.set('images.from', "".concat(srcPath, "/img/**/*.+(png|jpg|jpeg|gif|svg)"));
+  gulpConfig.set('images.to', "".concat(browserPath, "/img"));
+  gulpConfig.set('readme.template', "".concat(tempDir, "MAIN.md"));
+  gulpConfig.set('readme.to', tempDir);
+  gulpConfig.set('readme.from', "".concat(srcPath, "/**/!(*.test).js"));
   gulpConfig.set('rootPath', tempDir);
-  gulpConfig.set('sassPath', sassPath);
-  gulpConfig.set('sassSearch', `${sassPath}/**/*.+(scss|sass)`);
+  gulpConfig.set('sass.from', "".concat(sassPath, "/**/*.+(scss|sass)"));
+  gulpConfig.set('sass.path', sassPath);
+  gulpConfig.set('sass.to', "".concat(browserPath, "/css"));
   gulpConfig.set('srcPath', srcPath);
-  gulpConfig.set('srcSearch', `${srcPath}/**/!(*.test).js`);
-  gulpConfig.set('tsSearch', `${srcPath}/**/*.ts`);
-  gulpConfig.set('watchSearch', `${srcPath}/**/*.js`);
+  gulpConfig.set('typescript.from', "".concat(srcPath, "/**/*.ts"));
+  gulpConfig.set('typescript.to', distPath);
+  gulpConfig.set('test.watch', "".concat(srcPath, "/**/*.js"));
 };
 exports.setDefaults = setDefaults;
 exports.gulpConfig = gulpConfig;
 
 /**
  * Ensure that the del has completed, recursively attempt to delete and recreate
- * @function
  * @memberOf module:testHelpers
  * @param {boolean} [exists=true]
  * @returns {Promise<*|void>}
  */
-const createTempDir = async function () {
-  let exists = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
-  if (exists) {
-    return removeDirectory(tempDir).then(removedDir => createTempDir(fs.existsSync(removedDir))).catch(error => console.error('Error: ', error));
-  }
-  return fs.mkdirSync(srcPath, {
-    recursive: true
-  });
-};
-exports.createTempDir = createTempDir;
+exports.createTempDir = setUp.createTempDir;
 
 /**
  * In the Jest.beforeEach function call this one to set up the temp directory.
- * @function
  * @memberOf module:testHelpers
  * @returns {Promise<*|void>}
  */
-exports.beforeEach = () => createTempDir();
+exports.beforeEach = setUp.beforeEach;
 
 /**
  * In the Jest.afterEach function call this one to clean up and remove the temp directory.
- * @function
  * @memberOf module:testHelpers
  * @returns {Promise<*>}
  */
-exports.afterEach = () => removeDirectory(tempDir);
+exports.afterEach = setUp.afterEach;

package/dist/testFull.js

@@ -8,16 +8,15 @@ const {
 /**
  * Run all tests with jest.
  * Configure where tests are located by using 'testPath'.
- * @function
  * @memberOf module:js-build-tools
  * @returns {Promise<*>}
  */
 const testFull = () => {
-  let testPath = gulpConfig.get('testPath')
+  let testPath = gulpConfig.get('test.path')
   if (!Array.isArray(testPath)) {
     // The testPath must be an array of strings
     testPath = [testPath]
   }
-  return runCLI(gulpConfig.get('testOptions'), testPath)
+  return runCLI(gulpConfig.get('test.options'), testPath)
 }
 module.exports = testFull

package/dist/testFull.min.js

@@ -1 +1 @@
-"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testFull=()=>{let t=gulpConfig.get("testPath");return Array.isArray(t)||(t=[t]),runCLI(gulpConfig.get("testOptions"),t)};module.exports=testFull;
+"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testFull=()=>{let t=gulpConfig.get("test.path");return Array.isArray(t)||(t=[t]),runCLI(gulpConfig.get("test.options"),t)};module.exports=testFull;

package/dist/testHelpers.js

@@ -1,33 +1,15 @@
 'use strict'
 
 /**
- * An assortment of objects that can be used in tests and some functions to help debug and write tests.
+ * Export the setUp helper.
  * @file
  * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 2.0.0
+ * @version 3.0.0
  * @module testHelpers
  * @memberOf module:js-build-tools
  */
 
-const circularObject = require('./test-helpers/circularObject')
-const countMatches = require('./test-helpers/countMatches')
-const deepReferenceObject = require('./test-helpers/deepReferenceObject')
-const domItem = require('./test-helpers/domItem')
-const jsonDom = require('./test-helpers/jsonDom')
-const linkedList = require('./test-helpers/linkedList')
-const logObject = require('./test-helpers/logObject')
-const multiReferenceObject = require('./test-helpers/multiReferenceObject')
-const nodeTree = require('./test-helpers/nodeTree')
 const setUp = require('./test-helpers/setUp')
 module.exports = {
-  circularObject,
-  countMatches,
-  deepReferenceObject,
-  domItem,
-  jsonDom,
-  linkedList,
-  logObject,
-  multiReferenceObject,
-  nodeTree,
   setUp
 }

package/dist/testHelpers.min.js

@@ -1 +1 @@
-"use strict";const circularObject=require("./test-helpers/circularObject"),countMatches=require("./test-helpers/countMatches"),deepReferenceObject=require("./test-helpers/deepReferenceObject"),domItem=require("./test-helpers/domItem"),jsonDom=require("./test-helpers/jsonDom"),linkedList=require("./test-helpers/linkedList"),logObject=require("./test-helpers/logObject"),multiReferenceObject=require("./test-helpers/multiReferenceObject"),nodeTree=require("./test-helpers/nodeTree"),setUp=require("./test-helpers/setUp");module.exports={circularObject:circularObject,countMatches:countMatches,deepReferenceObject:deepReferenceObject,domItem:domItem,jsonDom:jsonDom,linkedList:linkedList,logObject:logObject,multiReferenceObject:multiReferenceObject,nodeTree:nodeTree,setUp:setUp};
+"use strict";const setUp=require("./test-helpers/setUp");module.exports={setUp:setUp};

package/dist/testQuick.js

@@ -8,12 +8,11 @@ const {
 /**
  * Run the Jest tests for files which have been modified (based on git status).
  * Configure where tests are located by using 'testPath'.
- * @function
  * @memberOf module:js-build-tools
  * @returns {Promise<*>}
  */
 const testQuick = () => {
-  let testPath = gulpConfig.get('testPath')
+  let testPath = gulpConfig.get('test.path')
   if (!Array.isArray(testPath)) {
     // The testPath must be an array of strings
     testPath = [testPath]

package/dist/testQuick.min.js

@@ -1 +1 @@
-"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testQuick=()=>{let e=gulpConfig.get("testPath");return Array.isArray(e)||(e=[e]),runCLI({onlyChanged:!0},e)};module.exports=testQuick;
+"use strict";const gulpConfig=require("../gulp.config.js"),{runCLI:runCLI}=require("jest"),testQuick=()=>{let e=gulpConfig.get("test.path");return Array.isArray(e)||(e=[e]),runCLI({onlyChanged:!0},e)};module.exports=testQuick;

package/dist/typeScript.js

@@ -1,12 +1,11 @@
-'use strict'
-
-const tsFor = require('./partials/tsFor')
-
+'use strict'
+
+const tsFor = require('./partials/tsFor')
+
 /**
  * Simplified typescript task using tsFor.
- * @function
  * @memberOf module:js-build-tools
  * @returns {Function}
- */
-const typeScript = tsFor()
-module.exports = typeScript
+ */
+const typeScript = tsFor()
+module.exports = typeScript

package/dist/utilities/dotGet.js

@@ -0,0 +1,50 @@
+"use strict";
+
+const isObject = require('./isObject');
+const strAfter = require('common-exports/dist/utilities/strAfter').default;
+const strBefore = require('common-exports/dist/utilities/strBefore').default;
+
+/**
+ * Get a nested property value from an object.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/dotGet.ts Sí, funciona}
+ * @param {Object} arrayObject - The array or object to get the property from
+ * @param {string} dotNotation - The path to the property
+ * @param {string|null} [defaultValue=null] - The default value to return if the property is not found
+ * @returns {*} The value of the property
+ */
+const dotGet = function (arrayObject, dotNotation) {
+  let defaultValue = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  let key = strBefore(dotNotation, '.');
+  const lastKey = !key;
+  if (lastKey) {
+    key = dotNotation;
+  }
+  if (key === '*') {
+    const result = [];
+    for (let wildKey in arrayObject) {
+      const wildValue = arrayObject[wildKey];
+      if (lastKey) {
+        result[wildKey] = wildValue;
+        continue;
+      }
+      if (!isObject(wildValue)) {
+        continue;
+      }
+      result[wildKey] = dotGet(wildValue, strAfter(dotNotation, '.'), defaultValue);
+    }
+    return result;
+  }
+  if (lastKey) {
+    var _arrayObject$dotNotat;
+    return (_arrayObject$dotNotat = arrayObject[dotNotation]) !== null && _arrayObject$dotNotat !== void 0 ? _arrayObject$dotNotat : defaultValue;
+  }
+  if (typeof arrayObject[key] === 'undefined') {
+    return defaultValue;
+  }
+  const next = arrayObject[key];
+  if (!isObject(next)) {
+    return defaultValue;
+  }
+  return dotGet(next, strAfter(dotNotation, '.'), defaultValue);
+};
+module.exports = dotGet;

package/dist/utilities/dotNotate.js

@@ -0,0 +1,77 @@
+"use strict";
+
+require("core-js/modules/es.string.replace.js");
+require("core-js/modules/esnext.async-iterator.map.js");
+require("core-js/modules/esnext.iterator.map.js");
+const isObject = require('./isObject');
+
+/**
+ * Convert an array of keys into a regex, return a function to test if incoming keys match.
+ * @param {Array.<string>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {Function} The dot-notated array
+ */
+const handleRetainObjects = function () {
+  let retainObjects = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  if (!retainObjects.length) {
+    /**
+     * Bypass the test function if there are no retainObjects.
+     * @returns {false}
+     */
+    return (currentKey, value, results) => false;
+  }
+  retainObjects = retainObjects.map(key => key.replace('\.', '\\.'));
+  const retainRegex = new RegExp("(".concat(retainObjects.join('|'), ")$"));
+  /**
+   * Test if a key should be retained as an object.
+   * @param {string} currentKey - The key to test
+   * @param {*} value - The value of the key
+   * @param {Object} results - The result object to add to
+   * @returns {boolean}
+   */
+  return (currentKey, value, results) => {
+    if (!currentKey.match(retainRegex)) {
+      return false;
+    }
+    results[currentKey] = value;
+    return true;
+  };
+};
+
+/**
+ * The underlying logic function for converting arrays to dot-notation.
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Function} didRetain - The test function to see if a key should be retained
+ * @param {string} [prepend=''] - The path for the property being processed
+ * @param {Object<string, *>} [results={}] - The final notated object to return
+ * @returns {Object<string, *>} The dot-notated object
+ */
+const performDotNotate = function (arrayObject, didRetain) {
+  let prepend = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
+  let results = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  for (let key in arrayObject) {
+    const value = arrayObject[key];
+    const currentKey = "".concat(prepend).concat(key);
+    if (didRetain(currentKey, value, results)) {
+      continue;
+    }
+    if (isObject(value)) {
+      performDotNotate(value, didRetain, "".concat(currentKey, "."), results);
+      continue;
+    }
+    results[currentKey] = value;
+  }
+  return results;
+};
+
+/**
+ * Convert an array or object to a single dimensional associative array with dot notation.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/dotNotate.ts Sí, funciona}
+ * @param {Object} arrayObject - The array or object to dot-notate
+ * @param {Array.<string>} [retainObjects=[]] - An array of keys to retain as objects
+ * @returns {Object<string, *>} The dot-notated object
+ */
+const dotNotate = function (arrayObject) {
+  let retainObjects = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return performDotNotate(arrayObject, handleRetainObjects(retainObjects));
+};
+module.exports = dotNotate;

package/dist/utilities/dotSet.js

@@ -0,0 +1,44 @@
+"use strict";
+
+const isObject = require('./isObject');
+const strAfter = require('common-exports/dist/utilities/strAfter').default;
+const strBefore = require('common-exports/dist/utilities/strBefore').default;
+
+/**
+ * Set a nested property value an object.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/dotSet.ts Sí, funciona}
+ * @param {Object} arrayObject - The array or object to set the property on
+ * @param {string} dotNotation - The path for the property
+ * @param {*} value - The default value to return if the property is not found
+ * @returns {Object} The modified object
+ */
+const dotSet = function (arrayObject, dotNotation) {
+  var _arrayObject$key;
+  let value = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  let key = strBefore(dotNotation, '.');
+  const lastKey = !key;
+  if (lastKey) {
+    key = dotNotation;
+  }
+  if (key === '*') {
+    for (let wildKey in arrayObject) {
+      if (lastKey) {
+        arrayObject[wildKey] = value;
+        continue;
+      }
+      if (!isObject(arrayObject[wildKey])) {
+        continue;
+      }
+      dotSet(arrayObject[wildKey], strAfter(dotNotation, '.'), value);
+    }
+    return arrayObject;
+  }
+  if (lastKey) {
+    arrayObject[dotNotation] = value;
+    return arrayObject;
+  }
+  const next = (_arrayObject$key = arrayObject[key]) !== null && _arrayObject$key !== void 0 ? _arrayObject$key : [];
+  arrayObject[key] = dotSet(next, strAfter(dotNotation, '.'), value);
+  return arrayObject;
+};
+module.exports = dotSet;

package/dist/utilities/isObject.js

@@ -0,0 +1,10 @@
+"use strict";
+
+/**
+ * Check if the provided thing is an object / array.
+ * Original source concepts from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/objects/isObject.ts Sí, funciona}
+ * @param {*} object
+ * @returns {boolean}
+ */
+const isObject = object => typeof object === 'object' && object !== null;
+module.exports = isObject;

package/dist/watchFull.js

@@ -1,15 +1,14 @@
-'use strict'
-
-const {
-  beginWatcher,
-  runOnChange
-} = require('./partials')
-
+'use strict'
+
+const {
+  beginWatcher,
+  runOnChange
+} = require('./partials')
+
 /**
  * Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
- * @function
  * @memberOf module:js-build-tools
  * @returns {FSWatcher}
- */
-const watchFull = () => beginWatcher().on('change', runOnChange)
-module.exports = watchFull
+ */
+const watchFull = () => beginWatcher().on('change', runOnChange)
+module.exports = watchFull

package/dist/watchTest.js

@@ -8,11 +8,10 @@ const testQuick = require('./testQuick')
 
 /**
  * Watch for changes and run the tests.
- * @function
  * @memberOf module:js-build-tools
  * @returns {*}
  */
-const watchTest = () => watch(gulpConfig.get('watchSearch'), {
+const watchTest = () => watch(gulpConfig.get('test.watch'), {
   ignoreInitial: false
 }, testQuick)
 module.exports = watchTest

package/dist/watchTest.min.js

@@ -1 +1 @@
-"use strict";const gulpConfig=require("../gulp.config.js"),{watch:watch}=require("gulp"),testQuick=require("./testQuick"),watchTest=()=>watch(gulpConfig.get("watchSearch"),{ignoreInitial:!1},testQuick);module.exports=watchTest;
+"use strict";const gulpConfig=require("../gulp.config.js"),{watch:watch}=require("gulp"),testQuick=require("./testQuick"),watchTest=()=>watch(gulpConfig.get("test.watch"),{ignoreInitial:!1},testQuick);module.exports=watchTest;

package/functions/build.js

@@ -7,6 +7,8 @@ const distLint = require('./distLint')
 const distMinify = require('./distMinify')
 const { parallel, series } = require('gulp')
 const gulpConfig = require('../gulp.config.js')
+const copyFonts = require('./copyFonts.js')
+const images = require('./images.js')
 const sass = require('./sass.js')
 const testFull = require('./testFull')
 
@@ -20,11 +22,11 @@ const build = (done = null) => {
   const distLintMinify = parallel(distLint, distMinify)
   const bundleLintMinify = parallel(bundleLint, bundleMinify)
   const buildActions = [clean, distSeries(), distLintMinify]
-  if (gulpConfig.get('useTsConfig')) {
+  if (gulpConfig.get('typescript.enabled')) {
     // For ts usage, we need to run the readme on the dist directly since that is where the .js files are located
     buildActions.push(compileReadme)
   }
-  if (!gulpConfig.get('nodeOnly')) {
+  if (gulpConfig.get('browser.enabled')) {
     // If not 'nodeOnly' then we also want to bundle for browser after we complete the dist directory
     buildActions.push(bundle)
     buildActions.push(bundleLintMinify)
@@ -32,13 +34,21 @@ const build = (done = null) => {
   const runActions = [
     series(...buildActions),
   ]
-  if (!gulpConfig.get('useTsConfig')) {
+  if (!gulpConfig.get('typescript.enabled')) {
     // Since we didn't run this in series after dist because of typescript, we need to run it now. Potentially faster here.
     runActions.push(compileReadme)
   }
   runActions.push(testFull)
-  if (gulpConfig.get('useSass')) {
-    // Since we didn't run this in series after dist because of typescript, we need to run it now. Potentially faster here.
+  if (gulpConfig.get('fonts.enabled')) {
+    // Conditionally add Fonts process
+    runActions.push(copyFonts)
+  }
+  if (gulpConfig.get('images.enabled')) {
+    // Conditionally add Images process
+    runActions.push(images)
+  }
+  if (gulpConfig.get('sass.enabled')) {
+    // Conditionally add SASS process
     runActions.push(sass)
   }
   return parallel(