js-build-tools 4.0.0 → 4.0.2

package/dist/utilities/dotNotate.js

@@ -1,44 +1,44 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.dotNotate = void 0;
-require("core-js/modules/esnext.async-iterator.map.js");
-require("core-js/modules/esnext.iterator.map.js");
-var _isObject = require("./isObject.js");
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.dotNotate = void 0;
+require("core-js/modules/esnext.async-iterator.map.js");
+require("core-js/modules/esnext.iterator.map.js");
+var _isObject = require("./isObject.js");
 /**
  * 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) {
+ */
+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(`(${retainObjects.join('|')})$`);
+     */
+    return (currentKey, value, results) => false;
+  }
+  retainObjects = retainObjects.map(key => key.replace('\.', '\\.'));
+  const retainRegex = new RegExp(`(${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;
-  };
-};
-
+   */
+  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
@@ -46,34 +46,34 @@ const handleRetainObjects = function () {
  * @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 = `${prepend}${key}`;
-    if (didRetain(currentKey, value, results)) {
-      continue;
-    }
-    if ((0, _isObject.isObject)(value)) {
-      performDotNotate(value, didRetain, `${currentKey}.`, results);
-      continue;
-    }
-    results[currentKey] = value;
-  }
-  return results;
-};
-
+ */
+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 = `${prepend}${key}`;
+    if (didRetain(currentKey, value, results)) {
+      continue;
+    }
+    if ((0, _isObject.isObject)(value)) {
+      performDotNotate(value, didRetain, `${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));
-};
+ */
+const dotNotate = function (arrayObject) {
+  let retainObjects = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return performDotNotate(arrayObject, handleRetainObjects(retainObjects));
+};
 exports.dotNotate = dotNotate;

package/dist/utilities/dotSet.js

@@ -1,12 +1,12 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.dotSet = void 0;
-var _isObject = require("./isObject.js");
-var _strAfter = require("./strAfter.js");
-var _strBefore = require("./strBefore.js");
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.dotSet = void 0;
+var _isObject = require("./isObject.js");
+var _strAfter = require("./strAfter.js");
+var _strBefore = require("./strBefore.js");
 /**
  * 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}
@@ -14,33 +14,33 @@ var _strBefore = require("./strBefore.js");
  * @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) {
-  let value = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
-  let key = (0, _strBefore.strBefore)(dotNotation, '.');
-  const lastKey = !key;
-  if (lastKey) {
-    key = dotNotation;
-  }
-  if (key === '*') {
-    for (let wildKey in arrayObject) {
-      if (lastKey) {
-        arrayObject[wildKey] = value;
-        continue;
-      }
-      if (!(0, _isObject.isObject)(arrayObject[wildKey])) {
-        continue;
-      }
-      dotSet(arrayObject[wildKey], (0, _strAfter.strAfter)(dotNotation, '.'), value);
-    }
-    return arrayObject;
-  }
-  if (lastKey) {
-    arrayObject[dotNotation] = value;
-    return arrayObject;
-  }
-  const next = arrayObject[key] ?? [];
-  arrayObject[key] = dotSet(next, (0, _strAfter.strAfter)(dotNotation, '.'), value);
-  return arrayObject;
-};
+ */
+const dotSet = function (arrayObject, dotNotation) {
+  let value = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  let key = (0, _strBefore.strBefore)(dotNotation, '.');
+  const lastKey = !key;
+  if (lastKey) {
+    key = dotNotation;
+  }
+  if (key === '*') {
+    for (let wildKey in arrayObject) {
+      if (lastKey) {
+        arrayObject[wildKey] = value;
+        continue;
+      }
+      if (!(0, _isObject.isObject)(arrayObject[wildKey])) {
+        continue;
+      }
+      dotSet(arrayObject[wildKey], (0, _strAfter.strAfter)(dotNotation, '.'), value);
+    }
+    return arrayObject;
+  }
+  if (lastKey) {
+    arrayObject[dotNotation] = value;
+    return arrayObject;
+  }
+  const next = arrayObject[key] ?? [];
+  arrayObject[key] = dotSet(next, (0, _strAfter.strAfter)(dotNotation, '.'), value);
+  return arrayObject;
+};
 exports.dotSet = dotSet;

package/dist/utilities/isObject.js

@@ -1,14 +1,14 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isObject = void 0;
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isObject = void 0;
 /**
  * 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;
+ */
+const isObject = object => typeof object === 'object' && object !== null;
 exports.isObject = isObject;

package/dist/utilities/strAfter.js

@@ -1,18 +1,18 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.strAfter = void 0;
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.strAfter = void 0;
 /**
  * Retrieve the string part after the search match.
  * Original source from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/strings/strAfter.ts Sí, funciona}
  * @param {string} str
  * @param {string} search
  * @returns {string}
- */
-const strAfter = (str, search) => {
-  const index = str.indexOf(search);
-  return index === -1 ? '' : str.substring(index + search.length);
-};
+ */
+const strAfter = (str, search) => {
+  const index = str.indexOf(search);
+  return index === -1 ? '' : str.substring(index + search.length);
+};
 exports.strAfter = strAfter;

package/dist/utilities/strBefore.js

@@ -1,18 +1,18 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.strBefore = void 0;
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.strBefore = void 0;
 /**
  * Retrieve the string part before the search match.
  * Original source from {@link https://github.com/jheagle/si-funciona/blob/main/src/helpers/strings/strBefore.ts Sí, funciona}
  * @param {string} str
  * @param {string} search
  * @returns {string}
- */
-const strBefore = (str, search) => {
-  const index = str.indexOf(search);
-  return index === -1 ? '' : str.slice(0, index);
-};
+ */
+const strBefore = (str, search) => {
+  const index = str.indexOf(search);
+  return index === -1 ? '' : str.slice(0, index);
+};
 exports.strBefore = strBefore;

package/dist/watchFull.js

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

package/dist/watchTest.js

@@ -1,21 +1,21 @@
-'use strict'
-
-require('core-js/modules/esnext.weak-map.delete-all.js')
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.watchTest = void 0
-var gulpConfig = _interopRequireWildcard(require('../gulp.config.js'))
-var _gulp = require('gulp')
-var _testQuick = require('./testQuick.js')
-function _getRequireWildcardCache (e) { if (typeof WeakMap !== 'function') return null; var r = new WeakMap(); var t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r })(e) }
-function _interopRequireWildcard (e, r) { if (!r && e && e.__esModule) return e; if (e === null || typeof e !== 'object' && typeof e !== 'function') return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }; var a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if (u !== 'default' && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u] } return n.default = e, t && t.set(e, n), n }
+'use strict'
+
+require('core-js/modules/esnext.weak-map.delete-all.js')
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.watchTest = void 0
+var gulpConfig = _interopRequireWildcard(require('../gulp.config.js'))
+var _gulp = require('gulp')
+var _testQuick = require('./testQuick.js')
+function _getRequireWildcardCache (e) { if (typeof WeakMap !== 'function') return null; var r = new WeakMap(); var t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r })(e) }
+function _interopRequireWildcard (e, r) { if (!r && e && e.__esModule) return e; if (e === null || typeof e !== 'object' && typeof e !== 'function') return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }; var a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if (u !== 'default' && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u] } return n.default = e, t && t.set(e, n), n }
 /**
  * Watch for changes and run the tests.
  * @memberOf module:js-build-tools
  * @returns {*}
- */
-const watchTest = () => (0, _gulp.watch)(gulpConfig.get('test.watch'), {
-  ignoreInitial: false
-}, _testQuick.testQuick)
-exports.watchTest = watchTest
+ */
+const watchTest = () => (0, _gulp.watch)(gulpConfig.get('test.watch'), {
+  ignoreInitial: false
+}, _testQuick.testQuick)
+exports.watchTest = watchTest

package/functions/test-helpers/setUp.mjs

@@ -1,6 +1,6 @@
 // Import the configurations and override some of them to direct to the temp directory.
 import * as gulpConfig from '../../gulp.config.mjs'
-import * as setUp from 'test-filesystem'
+import { setUp } from 'test-filesystem'
 
 let tempDir = 'test-temp/'
 let srcPath = `${tempDir}src`
@@ -40,7 +40,7 @@ export const setDefaults = (testDir = 'test-temp') => {
   gulpConfig.set('test.watch', `${srcPath}/**/*.js`)
 }
 
-export { gulpConfig, setUp }
+export { gulpConfig }
 
 export {
   /**
@@ -61,5 +61,29 @@ export {
    * @memberOf module:testHelpers
    * @returns {Promise<*>}
    */
-    afterEach
+    afterEach,
+  /**
+   * Return number of occurrences of substring in another string.
+   * @memberOf module:testHelpers
+   * @returns {int}
+   */
+    countMatches,
+  /**
+   * Returns true if the given file or directory exists, otherwise false.
+   * @memberOf module:testHelpers
+   * @returns {boolean}
+   */
+    fileExists,
+  /**
+   * Console log objects in a readable format, returns the given object.
+   * @memberOf module:testHelpers
+   * @returns {*}
+   */
+    logObject,
+  /**
+   * Delete a directory and subcontents.
+   * @memberOf module:testHelpers
+   * @returns {Promise<*>}
+   */
+    removeDirectory,
 } from 'test-filesystem'

package/functions/testHelpers.test.mjs

@@ -2,6 +2,6 @@ import { testHelpers } from './testHelpers.mjs'
 
 describe('testHelpers', () => {
   test('is object with all helper exports', () => {
-    expect(Object.keys(testHelpers).length).toBe(6)
+    expect(Object.keys(testHelpers).length).toBe(9)
   })
 })

package/functions/utilities/dotGet.mjs

@@ -5,12 +5,15 @@ import { strBefore } from './strBefore.mjs'
 /**
  * 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 {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
  */
-export const dotGet = (arrayObject, dotNotation, defaultValue = null) => {
+export const dotGet = (arrayObject = {}, dotNotation= '', defaultValue = null) => {
+  if (!dotNotation) {
+    return arrayObject
+  }
   let key = strBefore(dotNotation, '.')
   const lastKey = !key
   if (lastKey) {

package/gulp.config.js

@@ -209,8 +209,8 @@ const setDefaults = {
  * @type {Configurations}
  */
 let gulpConfigurations = {}
-if (fileExists('../../build-tools.config.json')) {
-  gulpConfigurations = JSON.parse(readFileSync('../../build-tools.config.json').toString())
+if (fileExists(process.cwd() + '/build-tools.config.json')) {
+  gulpConfigurations = JSON.parse(readFileSync(process.cwd() + '/build-tools.config.json').toString())
 } else {
   if (fileExists('./build-tools.config.json')) {
     gulpConfigurations = JSON.parse(readFileSync('./build-tools.config.json').toString())

package/package.json

@@ -1,11 +1,21 @@
 {
   "name": "js-build-tools",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {
-    "import": "./gulpfile.base.mjs",
-    "require": "./gulpfile.base.js"
+    ".": {
+      "node": "./gulpfile.base.js",
+      "default": "./gulpfile.base.mjs"
+    },
+    "./babel.config": "./babel.config.js",
+    "./gulp.config": "./gulp.config.js",
+    "./gulp.config.mjs": "./gulp.config.mjs",
+    "./gulpfile.base": "./gulpfile.base.js",
+    "./gulpfile.base.mjs": "./gulpfile.base.mjs",
+    "./jsdoc.base": "./jsdoc.base.js",
+    "./testHelpers": "./dist/testHelpers",
+    "./testHelpers.mjs": "./functions/testHelpers.mjs"
   },
   "scripts": {
     "build": "gulp build",
@@ -36,11 +46,11 @@
     ]
   },
   "dependencies": {
-    "@babel/core": "^7.24.6",
-    "@babel/plugin-transform-modules-commonjs": "^7.24.6",
-    "@babel/preset-env": "^7.24.6",
-    "@babel/preset-typescript": "^7.24.6",
-    "@babel/runtime-corejs3": "^7.24.6",
+    "@babel/core": "^7.24.7",
+    "@babel/plugin-transform-modules-commonjs": "^7.24.7",
+    "@babel/preset-env": "^7.24.7",
+    "@babel/preset-typescript": "^7.24.7",
+    "@babel/runtime-corejs3": "^7.24.7",
     "babel-jest": "^29.7.0",
     "browserify": "^17.0.0",
     "core-js": "^3.37.1",