js-build-tools 5.0.0 → 5.1.1

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,32 +14,32 @@ 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 = (arrayObject, dotNotation, value = 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 = (arrayObject, dotNotation, value = 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/functions/partials/tsFor.mjs

@@ -1,7 +1,7 @@
 import { dest, src } from 'gulp'
 import path from 'node:path'
 import * as gulpConfig from '../../gulp.config.mjs'
-import ts from 'typescript'
+import { createRequire } from 'node:module'
 
 // 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
@@ -19,6 +19,27 @@ const importGulpTsCompile = new Function('return import(\'gulp-ts-compile\')')
  * @param {import('node:stream').Stream} stream
  * @returns {Promise<void>}
  */
+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.
+ */
+export const loadTypescript = (projectPath = process.cwd()) => {
+  try {
+    return createRequire(path.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
+  }
+}
+
 const streamToPromise = (stream) => new Promise((resolve, reject) => {
   stream.on('finish', resolve)
   stream.on('error', reject)
@@ -33,7 +54,7 @@ const streamToPromise = (stream) => new Promise((resolve, reject) => {
  * @param {string} configPath - Path to a tsconfig.json file.
  * @returns {import('typescript').CompilerOptions}
  */
-const readCompilerOptions = (configPath) => {
+const readCompilerOptions = (ts, configPath) => {
   const configFile = ts.readConfigFile(configPath, ts.sys.readFile)
   const parsedConfig = ts.parseJsonConfigFileContent(configFile.config, ts.sys, path.dirname(configPath))
   return parsedConfig.options
@@ -60,6 +81,7 @@ export const tsFor = (
   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
@@ -67,7 +89,7 @@ export const tsFor = (
   // 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)
+    ? 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

package/functions/partials/tsFor.test.mjs

@@ -3,7 +3,7 @@ import { Transform, PassThrough } from 'node:stream'
 import ts from 'typescript'
 import File from 'vinyl'
 import * as setUp from '../test-helpers/setUp.mjs'
-import { tsFor } from './tsFor.mjs'
+import { tsFor, loadTypescript } from './tsFor.mjs'
 import { countMatches } from 'test-filesystem'
 
 setUp.setDefaults('test-ts-for')
@@ -75,3 +75,13 @@ describe('tsFor', () => {
     expect(result).toBeInstanceOf(Function)
   })
 })
+
+describe('loadTypescript', () => {
+  test('loads the typescript of the project being built', () => {
+    expect(loadTypescript().version).toBe(ts.version)
+  })
+
+  test('explains how to install typescript when the project does not have it', () => {
+    expect(() => loadTypescript('/')).toThrow(/optional peer dependency typescript.*npm install --save-dev typescript/)
+  })
+})

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "5.0.0",
+  "version": "5.1.1",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {
@@ -77,11 +77,15 @@
     "vinyl-source-stream": "^2.0.0"
   },
   "peerDependencies": {
-    "gulp-imagemin": ">=9.0.0"
+    "gulp-imagemin": ">=9.0.0",
+    "typescript": ">=5.0.0 <7.0.0"
   },
   "peerDependenciesMeta": {
     "gulp-imagemin": {
       "optional": true
+    },
+    "typescript": {
+      "optional": true
     }
   },
   "files": [