js-build-tools 5.0.0 → 5.1.1

package/dist/partials/tsFor.js

@@ -1,37 +1,58 @@
-"use strict";
-
-require("core-js/modules/esnext.weak-map.delete-all.js");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.tsFor = void 0;
-var _gulp = require("gulp");
-var _nodePath = _interopRequireDefault(require("node:path"));
-var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
-var _typescript = _interopRequireDefault(require("typescript"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// gulp-ts-compile ships ESM-only (no CJS build - see its own package.json) since it's meant to be consumed by
-// gulpfiles running under a real ESM loader, same as this project's own gulpfile.mjs does. This project also
-// compiles itself to a CommonJS build (dist/*.js, this file's own compiled counterpart) for consumers using
-// require() though, and even a dynamic `import()` gets downleveled by babel's CommonJS transform into a
-// require() call - which can't load a real ES module. Hiding the import() call inside a Function constructor is
-// the standard escape hatch: babel can't see (and so can't rewrite) an import expression that only exists as a
-// runtime-evaluated string, so it survives as a genuine dynamic import, capable of loading gulp-ts-compile from
-// either build.
-const importGulpTsCompile = new Function('return import(\'gulp-ts-compile\')');
-
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.tsFor = exports.loadTypescript = void 0;
+var _gulp = require("gulp");
+var _nodePath = _interopRequireDefault(require("node:path"));
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+var _nodeModule = require("node:module");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// gulp-ts-compile ships ESM-only (no CJS build - see its own package.json) since it's meant to be consumed by
+// gulpfiles running under a real ESM loader, same as this project's own gulpfile.mjs does. This project also
+// compiles itself to a CommonJS build (dist/*.js, this file's own compiled counterpart) for consumers using
+// require() though, and even a dynamic `import()` gets downleveled by babel's CommonJS transform into a
+// require() call - which can't load a real ES module. Hiding the import() call inside a Function constructor is
+// the standard escape hatch: babel can't see (and so can't rewrite) an import expression that only exists as a
+// runtime-evaluated string, so it survives as a genuine dynamic import, capable of loading gulp-ts-compile from
+// either build.
+const importGulpTsCompile = new Function('return import(\'gulp-ts-compile\')');
+
 /**
  * Wrap a stream in a promise that resolves once it finishes writing.
  * @memberOf module:partials
  * @param {import('node:stream').Stream} stream
  * @returns {Promise<void>}
- */
-const streamToPromise = stream => new Promise((resolve, reject) => {
-  stream.on('finish', resolve);
-  stream.on('error', reject);
-});
-
+ */
+const installHint = 'Install it in your project with: npm install --save-dev typescript';
+
+/**
+ * Load the project's own copy of TypeScript (an optional peer dependency, only needed when the typescript task is
+ * enabled) from the project being built, so projects which do not use TypeScript never need it installed.
+ * @memberOf module:partials
+ * @param {string} [projectPath=process.cwd()] The folder of the project (which has the package.json) being built.
+ * @returns {Object} The TypeScript compiler API module.
+ * @throws {Error} With install instructions when typescript is not installed.
+ */
+const loadTypescript = (projectPath = process.cwd()) => {
+  try {
+    return (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json'))('typescript');
+  } catch (error) {
+    if (error.code === 'MODULE_NOT_FOUND' && /Cannot find module 'typescript'/.test(error.message)) {
+      throw new Error(`The typescript task needs the optional peer dependency typescript, which is not installed. ${installHint}`);
+    }
+    throw error;
+  }
+};
+exports.loadTypescript = loadTypescript;
+const streamToPromise = stream => new Promise((resolve, reject) => {
+  stream.on('finish', resolve);
+  stream.on('error', reject);
+});
+
 /**
  * Read a tsconfig.json file into real typescript.CompilerOptions values, using only TypeScript's stable, current,
  * public config-reading API (the same one `tsc --project` itself uses internally) - never
@@ -40,13 +61,13 @@ const streamToPromise = stream => new Promise((resolve, reject) => {
  * @memberOf module:partials
  * @param {string} configPath - Path to a tsconfig.json file.
  * @returns {import('typescript').CompilerOptions}
- */
-const readCompilerOptions = configPath => {
-  const configFile = _typescript.default.readConfigFile(configPath, _typescript.default.sys.readFile);
-  const parsedConfig = _typescript.default.parseJsonConfigFileContent(configFile.config, _typescript.default.sys, _nodePath.default.dirname(configPath));
-  return parsedConfig.options;
-};
-
+ */
+const readCompilerOptions = (ts, configPath) => {
+  const configFile = ts.readConfigFile(configPath, ts.sys.readFile);
+  const parsedConfig = ts.parseJsonConfigFileContent(configFile.config, ts.sys, _nodePath.default.dirname(configPath));
+  return parsedConfig.options;
+};
+
 /**
  * Starting at the source directory, find all the ts files and convert them into the distribution directory.
  * @memberOf module:partials
@@ -59,35 +80,36 @@ const readCompilerOptions = configPath => {
  * suite already covers real TypeScript-compile correctness - this function's own tests only need to verify its
  * config resolution and stream wiring.
  * @returns {Function}
- */
-const tsFor = (srcPath = gulpConfig.get('typescript.from'), distPath = gulpConfig.get('typescript.to'), loadTsCompile = () => importGulpTsCompile().then(({
-  default: tsCompile
-}) => tsCompile)) => {
-  if (gulpConfig.get('typescript.enabled') === false) {
-    return () => {};
-  }
-  const configPath = gulpConfig.get('typescript.config');
-  // When no tsconfig.json is configured, target/module are pinned explicitly rather than left for TypeScript's
-  // own compiler defaults - those defaults have already shifted once across a TypeScript version bump in this
-  // project's own history (silently changing whether output keeps `const`/`let` or downlevels to `var`), and
-  // pinning them keeps this task's output stable across future TypeScript upgrades too. ES5/CommonJS matches
-  // what the downstream babel/browserify bundling pipeline has always assumed it receives.
-  const compilerOptions = configPath ? readCompilerOptions(configPath) : {
-    declaration: true,
-    target: _typescript.default.ScriptTarget.ES5,
-    module: _typescript.default.ModuleKind.CommonJS,
-    esModuleInterop: false
-  };
-  // Accepts gulp's own callback-style task convention (an optional `done`, called once finished) rather than
-  // just returning a Promise, since callers may invoke the returned function directly with a callback instead
-  // of relying on gulp's own runner to observe a returned Promise.
-  return done => {
-    const compile = async () => {
-      const tsCompile = await loadTsCompile();
-      const tsResult = (0, _gulp.src)(srcPath).pipe(tsCompile(compilerOptions));
-      await Promise.all([streamToPromise(tsResult.dts.pipe((0, _gulp.dest)(distPath))), streamToPromise(tsResult.js.pipe((0, _gulp.dest)(distPath)))]);
-    };
-    return typeof done === 'function' ? compile().then(() => done(), done) : compile();
-  };
-};
+ */
+const tsFor = (srcPath = gulpConfig.get('typescript.from'), distPath = gulpConfig.get('typescript.to'), loadTsCompile = () => importGulpTsCompile().then(({
+  default: tsCompile
+}) => tsCompile)) => {
+  if (gulpConfig.get('typescript.enabled') === false) {
+    return () => {};
+  }
+  const ts = loadTypescript();
+  const configPath = gulpConfig.get('typescript.config');
+  // When no tsconfig.json is configured, target/module are pinned explicitly rather than left for TypeScript's
+  // own compiler defaults - those defaults have already shifted once across a TypeScript version bump in this
+  // project's own history (silently changing whether output keeps `const`/`let` or downlevels to `var`), and
+  // pinning them keeps this task's output stable across future TypeScript upgrades too. ES5/CommonJS matches
+  // what the downstream babel/browserify bundling pipeline has always assumed it receives.
+  const compilerOptions = configPath ? readCompilerOptions(ts, configPath) : {
+    declaration: true,
+    target: ts.ScriptTarget.ES5,
+    module: ts.ModuleKind.CommonJS,
+    esModuleInterop: false
+  };
+  // Accepts gulp's own callback-style task convention (an optional `done`, called once finished) rather than
+  // just returning a Promise, since callers may invoke the returned function directly with a callback instead
+  // of relying on gulp's own runner to observe a returned Promise.
+  return done => {
+    const compile = async () => {
+      const tsCompile = await loadTsCompile();
+      const tsResult = (0, _gulp.src)(srcPath).pipe(tsCompile(compilerOptions));
+      await Promise.all([streamToPromise(tsResult.dts.pipe((0, _gulp.dest)(distPath))), streamToPromise(tsResult.js.pipe((0, _gulp.dest)(distPath)))]);
+    };
+    return typeof done === 'function' ? compile().then(() => done(), done) : compile();
+  };
+};
 exports.tsFor = tsFor;

package/dist/test-helpers/setUp.js

@@ -1,94 +1,94 @@
-"use strict";
-
-require("core-js/modules/esnext.weak-map.delete-all.js");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "afterEach", {
-  enumerable: true,
-  get: function () {
-    return _testFilesystem.afterEach;
-  }
-});
-Object.defineProperty(exports, "beforeEach", {
-  enumerable: true,
-  get: function () {
-    return _testFilesystem.beforeEach;
-  }
-});
-Object.defineProperty(exports, "countMatches", {
-  enumerable: true,
-  get: function () {
-    return _testFilesystem.countMatches;
-  }
-});
-Object.defineProperty(exports, "createTempDir", {
-  enumerable: true,
-  get: function () {
-    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.setDefaults = void 0;
-var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
-exports.gulpConfig = gulpConfig;
-var _testFilesystem = require("test-filesystem");
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-// Import the configurations and override some of them to direct to the temp directory.
-
-let tempDir = 'test-temp/';
-let srcPath = `${tempDir}src`;
-
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "afterEach", {
+  enumerable: true,
+  get: function () {
+    return _testFilesystem.afterEach;
+  }
+});
+Object.defineProperty(exports, "beforeEach", {
+  enumerable: true,
+  get: function () {
+    return _testFilesystem.beforeEach;
+  }
+});
+Object.defineProperty(exports, "countMatches", {
+  enumerable: true,
+  get: function () {
+    return _testFilesystem.countMatches;
+  }
+});
+Object.defineProperty(exports, "createTempDir", {
+  enumerable: true,
+  get: function () {
+    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.setDefaults = void 0;
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+exports.gulpConfig = gulpConfig;
+var _testFilesystem = require("test-filesystem");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+// Import the configurations and override some of them to direct to the temp directory.
+
+let tempDir = 'test-temp/';
+let srcPath = `${tempDir}src`;
+
 /**
  * Update the gulp configurations with the test data. Set the test directory where temp files will be created for testing.
  * @memberOf module:testHelpers
  * @param {string} testDir
- */
-const setDefaults = (testDir = 'test-temp') => {
-  tempDir = `${testDir}/`;
-  srcPath = `${tempDir}src`;
-  _testFilesystem.setUp.setDefaults(tempDir);
-  const distPath = `${tempDir}dist`;
-  const browserPath = `${tempDir}browser`;
-  const sassPath = `${tempDir}sass`;
-  gulpConfig.set('browser.from', `${distPath}/**/*.js`);
-  gulpConfig.set('browser.to', browserPath);
-  gulpConfig.set('cleanPaths', [distPath, browserPath]);
-  gulpConfig.set('dist.from', `${srcPath}/**/!(*.test).js`);
-  gulpConfig.set('dist.main', `${distPath}/main`);
-  gulpConfig.set('dist.to', distPath);
-  gulpConfig.set('fonts.from', `${srcPath}/fonts/**/*`);
-  gulpConfig.set('fonts.to', `${browserPath}/fonts`);
-  gulpConfig.set('images.from', `${srcPath}/img/**/*.+(png|jpg|jpeg|gif|svg)`);
-  gulpConfig.set('images.to', `${browserPath}/img`);
-  gulpConfig.set('readme.template', `${tempDir}MAIN.md`);
-  gulpConfig.set('readme.to', tempDir);
-  gulpConfig.set('readme.from', `${srcPath}/**/!(*.test).js`);
-  gulpConfig.set('rootPath', tempDir);
-  gulpConfig.set('sass.from', `${sassPath}/**/*.+(scss|sass)`);
-  gulpConfig.set('sass.path', sassPath);
-  gulpConfig.set('sass.to', `${browserPath}/css`);
-  gulpConfig.set('srcPath', srcPath);
-  gulpConfig.set('typescript.from', `${srcPath}/**/*.ts`);
-  gulpConfig.set('typescript.to', distPath);
-  gulpConfig.set('test.watch', `${srcPath}/**/*.js`);
-};
+ */
+const setDefaults = (testDir = 'test-temp') => {
+  tempDir = `${testDir}/`;
+  srcPath = `${tempDir}src`;
+  _testFilesystem.setUp.setDefaults(tempDir);
+  const distPath = `${tempDir}dist`;
+  const browserPath = `${tempDir}browser`;
+  const sassPath = `${tempDir}sass`;
+  gulpConfig.set('browser.from', `${distPath}/**/*.js`);
+  gulpConfig.set('browser.to', browserPath);
+  gulpConfig.set('cleanPaths', [distPath, browserPath]);
+  gulpConfig.set('dist.from', `${srcPath}/**/!(*.test).js`);
+  gulpConfig.set('dist.main', `${distPath}/main`);
+  gulpConfig.set('dist.to', distPath);
+  gulpConfig.set('fonts.from', `${srcPath}/fonts/**/*`);
+  gulpConfig.set('fonts.to', `${browserPath}/fonts`);
+  gulpConfig.set('images.from', `${srcPath}/img/**/*.+(png|jpg|jpeg|gif|svg)`);
+  gulpConfig.set('images.to', `${browserPath}/img`);
+  gulpConfig.set('readme.template', `${tempDir}MAIN.md`);
+  gulpConfig.set('readme.to', tempDir);
+  gulpConfig.set('readme.from', `${srcPath}/**/!(*.test).js`);
+  gulpConfig.set('rootPath', tempDir);
+  gulpConfig.set('sass.from', `${sassPath}/**/*.+(scss|sass)`);
+  gulpConfig.set('sass.path', sassPath);
+  gulpConfig.set('sass.to', `${browserPath}/css`);
+  gulpConfig.set('srcPath', srcPath);
+  gulpConfig.set('typescript.from', `${srcPath}/**/*.ts`);
+  gulpConfig.set('typescript.to', distPath);
+  gulpConfig.set('test.watch', `${srcPath}/**/*.js`);
+};
 exports.setDefaults = setDefaults;

package/dist/utilities/dotGet.js

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

package/dist/utilities/dotNotate.js

@@ -1,43 +1,43 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.dotNotate = void 0;
-require("core-js/modules/esnext.iterator.constructor.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.iterator.constructor.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 = (retainObjects = []) => {
-  if (!retainObjects.length) {
+ */
+const handleRetainObjects = (retainObjects = []) => {
+  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
@@ -45,29 +45,29 @@ const handleRetainObjects = (retainObjects = []) => {
  * @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 = (arrayObject, didRetain, prepend = '', results = {}) => {
-  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 = (arrayObject, didRetain, prepend = '', results = {}) => {
+  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 = (arrayObject, retainObjects = []) => performDotNotate(arrayObject, handleRetainObjects(retainObjects));
+ */
+const dotNotate = (arrayObject, retainObjects = []) => performDotNotate(arrayObject, handleRetainObjects(retainObjects));
 exports.dotNotate = dotNotate;