js-build-tools 4.0.1 → 4.0.3

package/README.md

@@ -138,7 +138,7 @@ const {
   typescript,
   watchFull,
   watchTest
-} = require('js-build-tools')
+} = require('js-build-tools/gulpfile.base.js')
 
 // Everything you export will be created as a gulp task.
 // You can build your own tasks here as well by using some of the functions `js-build-tools/functions`.
@@ -169,7 +169,7 @@ export {
   typescript,
   watchFull,
   watchTest
-} from 'js-build-tools'
+} from 'js-build-tools/gulpfile.base.mjs'
 
 // You can build your own tasks here as well by using some of the functions `js-build-tools/functions`.
 // You can list your available tasks by running `gulp --tasks`.

package/dist/test-helpers/setUp.js

@@ -7,26 +7,50 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "afterEach", {
   enumerable: true,
   get: function () {
-    return setUp.afterEach;
+    return _testFilesystem.afterEach;
   }
 });
 Object.defineProperty(exports, "beforeEach", {
   enumerable: true,
   get: function () {
-    return setUp.beforeEach;
+    return _testFilesystem.beforeEach;
+  }
+});
+Object.defineProperty(exports, "countMatches", {
+  enumerable: true,
+  get: function () {
+    return _testFilesystem.countMatches;
   }
 });
 Object.defineProperty(exports, "createTempDir", {
   enumerable: true,
   get: function () {
-    return setUp.createTempDir;
+    return _testFilesystem.createTempDir;
+  }
+});
+Object.defineProperty(exports, "fileExists", {
+  enumerable: true,
+  get: function () {
+    return _testFilesystem.fileExists;
+  }
+});
+exports.gulpConfig = void 0;
+Object.defineProperty(exports, "logObject", {
+  enumerable: true,
+  get: function () {
+    return _testFilesystem.logObject;
+  }
+});
+Object.defineProperty(exports, "removeDirectory", {
+  enumerable: true,
+  get: function () {
+    return _testFilesystem.removeDirectory;
   }
 });
-exports.setUp = exports.setDefaults = exports.gulpConfig = void 0;
+exports.setDefaults = void 0;
 var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
 exports.gulpConfig = gulpConfig;
-var setUp = _interopRequireWildcard(require("test-filesystem"));
-exports.setUp = setUp;
+var _testFilesystem = require("test-filesystem");
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.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; }
 // Import the configurations and override some of them to direct to the temp directory.
@@ -43,7 +67,7 @@ const setDefaults = function () {
   let testDir = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'test-temp';
   tempDir = `${testDir}/`;
   srcPath = `${tempDir}src`;
-  setUp.setDefaults(tempDir);
+  _testFilesystem.setUp.setDefaults(tempDir);
   const distPath = `${tempDir}dist`;
   const browserPath = `${tempDir}browser`;
   const sassPath = `${tempDir}sass`;

package/dist/utilities/dotGet.js

@@ -10,13 +10,18 @@ var _strBefore = require("./strBefore.js");
 /**
  * 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
  */
-const dotGet = function (arrayObject, dotNotation) {
+const dotGet = function () {
+  let arrayObject = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  let dotNotation = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
   let defaultValue = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : null;
+  if (!dotNotation) {
+    return arrayObject;
+  }
   let key = (0, _strBefore.strBefore)(dotNotation, '.');
   const lastKey = !key;
   if (lastKey) {

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/gulp.config.mjs

@@ -12,22 +12,18 @@ import { fileExists } from 'test-filesystem'
  * A setting that may be an array of strings or a string only.
  * @typedef {Array<string>|string} module:gulpConfig~ArrayableSetting
  */
-
 /**
  * A setting that may be true or false.
  * @typedef {boolean} module:gulpConfig~BooleanSetting
  */
-
 /**
  * A setting that may be flag 'false' or provide a StringSetting
  * @typedef {false|StringSetting} module:gulpConfig~FlagStringSetting
  */
-
 /**
  * An object of boolean settings used as flags.
  * @typedef {Object<string, BooleanSetting>} module:gulpConfig~FlagsSetting
  */
-
 /**
  * Configure cli options for running Jest.
  * @typedef {FlagsSetting} module:gulpConfig~JestTestFlags
@@ -41,17 +37,14 @@ import { fileExists } from 'test-filesystem'
  * @property {BooleanSetting} watch
  * @property {BooleanSetting} watchAll
  */
-
 /**
  * A setting that may only be a string.
  * @typedef {string} module:gulpConfig~StringSetting
  */
-
 /**
  * Any single configuration option is a Setting.
  * @typedef {ArrayableSetting|BooleanSetting|FlagsSetting|StringSetting} Setting
  */
-
 /**
  * Configurations for building the browser files.
  * @typedef {Object<string, Setting>} module:gulpConfig~BrowserConfig
@@ -60,7 +53,6 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} name - The search pattern used for retrieving compiled distribution files.
  * @property {StringSetting} to - The output directory for browser-bundled files.
  */
-
 /**
  * Configurations for building the node distribution files.
  * @typedef {Object<string, Setting>} module:gulpConfig~DistConfig
@@ -68,7 +60,6 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} main - Name of the entry the distribution file.
  * @property {StringSetting} to - The output directory for the distribution files.
  */
-
 /**
  * Configurations for copying the font files.
  * @typedef {Object<string, Setting>} module:gulpConfig~FontConfig
@@ -76,7 +67,6 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} from - Path to search for fonts.
  * @property {StringSetting} to - Path to output fonts.
  */
-
 /**
  * Configurations to minify and copy the images.
  * @typedef {Object<string, Setting>} module:gulpConfig~ImageConfig
@@ -84,7 +74,6 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} from - Path to search for images.
  * @property {StringSetting} to - Path to output images.
  */
-
 /**
  * Configurations to compile and generate the Readme file.
  * @typedef {Object<string, Setting>} module:gulpConfig~ReadmeConfig
@@ -94,7 +83,6 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} template - The file which will be pre-fixed to your README.md output.
  * @property {StringSetting} to - The directory to output the readme file in.
  */
-
 /**
  * Configurations to compile and copy the sass files into css.
  * @typedef {Object<string, Setting>} module:gulpConfig~SassConfig
@@ -103,7 +91,6 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} path - The directory were sass files will be stored.
  * @property {StringSetting} to - The destination path for where generated CSS (from SASS files) should go.
  */
-
 /**
  * Configurations for running the test suite.
  * @typedef {Object<string, Setting>} module:gulpConfig~TestConfig
@@ -112,7 +99,6 @@ import { fileExists } from 'test-filesystem'
  * By default, stored as *.test.js adjacent to the files they are testing.
  * @property {ArrayableSetting} watch - The search pattern for watching files for changes.
  */
-
 /**
  * Configurations for compiling typescript into JS files.
  * @typedef {Object<string, Setting>} module:gulpConfig~TsConfig
@@ -121,7 +107,6 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} from - Pattern for finding the TypeScript files.
  * @property {StringSetting} to - Directory where parsed typescript files go.
  */
-
 /**
  * A set of Configurations options defined by Settings.
  * @typedef {Object<string, Setting>} module:gulpConfig~Configurations
@@ -137,7 +122,6 @@ import { fileExists } from 'test-filesystem'
  * @property {TestConfig} test - Run test suite configuration.
  * @property {TsConfig} typescript - Compile from typescript configuration.
  */
-
 import { dotGet } from './functions/utilities/dotGet.mjs'
 import { dotSet } from './functions/utilities/dotSet.mjs'
 import { dotNotate } from './functions/utilities/dotNotate.mjs'
@@ -210,9 +194,8 @@ const setDefaults = {
  * @type {Configurations}
  */
 let gulpConfigurations = null
-
-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,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "4.0.1",
+  "version": "4.0.3",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {
@@ -13,7 +13,9 @@
     "./gulp.config.mjs": "./gulp.config.mjs",
     "./gulpfile.base": "./gulpfile.base.js",
     "./gulpfile.base.mjs": "./gulpfile.base.mjs",
-    "./jsdoc.base": "./jsdoc.base.js"
+    "./jsdoc.base": "./jsdoc.base.js",
+    "./testHelpers": "./dist/testHelpers",
+    "./testHelpers.mjs": "./functions/testHelpers.mjs"
   },
   "scripts": {
     "build": "gulp build",
@@ -44,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",