js-build-tools 6.6.0 → 6.8.0

package/functions/utilities/esmNamedExportsToCjs.test.mjs

@@ -1,47 +1,47 @@
-import { esmNamedExportsToCjs } from './esmNamedExportsToCjs.mjs'
-
-describe('esmNamedExportsToCjs', () => {
-  test('rewrites a single export const to a plain declaration plus a trailing module.exports', () => {
-    const source = 'export const get = (path) => path\n'
-    const result = esmNamedExportsToCjs(source)
-    expect(result).toContain('const get = (path) => path')
-    expect(result).toContain('module.exports = { get }')
-    expect(result).not.toContain('export const')
-  })
-
-  test('rewrites multiple export const declarations into one module.exports with all the names', () => {
-    const source = 'export const get = () => {}\nexport const set = () => {}\n'
-    const result = esmNamedExportsToCjs(source)
-    expect(result).toContain('const get = () => {}')
-    expect(result).toContain('const set = () => {}')
-    expect(result).toContain('module.exports = { get, set }')
-  })
-
-  test('rewrites export function and export class the same way', () => {
-    const source = 'export function doThing() {}\nexport class Thing {}\n'
-    const result = esmNamedExportsToCjs(source)
-    expect(result).toContain('function doThing() {}')
-    expect(result).toContain('class Thing {}')
-    expect(result).toContain('module.exports = { doThing, Thing }')
-  })
-
-  test('leaves non-export lines and JSDoc comments untouched', () => {
-    const source = '/**\n * A function.\n * @memberOf module:gulpConfig\n */\nexport const get = () => {}\n'
-    const result = esmNamedExportsToCjs(source)
-    expect(result).toContain('/**\n * A function.\n * @memberOf module:gulpConfig\n */\nconst get = () => {}')
-  })
-
-  test('does not add a module.exports block when there is nothing to export', () => {
-    const source = 'import { thing } from \'./thing.mjs\'\nconst local = 1\n'
-    const result = esmNamedExportsToCjs(source)
-    expect(result).toBe(source)
-    expect(result).not.toContain('module.exports')
-  })
-
-  test('leaves export default and other export forms untouched', () => {
-    const source = 'const value = 1\nexport default value\n'
-    const result = esmNamedExportsToCjs(source)
-    expect(result).toContain('export default value')
-    expect(result).not.toContain('module.exports')
-  })
-})
+import { esmNamedExportsToCjs } from './esmNamedExportsToCjs.mjs'
+
+describe('esmNamedExportsToCjs', () => {
+  test('rewrites a single export const to a plain declaration plus a trailing module.exports', () => {
+    const source = 'export const get = (path) => path\n'
+    const result = esmNamedExportsToCjs(source)
+    expect(result).toContain('const get = (path) => path')
+    expect(result).toContain('module.exports = { get }')
+    expect(result).not.toContain('export const')
+  })
+
+  test('rewrites multiple export const declarations into one module.exports with all the names', () => {
+    const source = 'export const get = () => {}\nexport const set = () => {}\n'
+    const result = esmNamedExportsToCjs(source)
+    expect(result).toContain('const get = () => {}')
+    expect(result).toContain('const set = () => {}')
+    expect(result).toContain('module.exports = { get, set }')
+  })
+
+  test('rewrites export function and export class the same way', () => {
+    const source = 'export function doThing() {}\nexport class Thing {}\n'
+    const result = esmNamedExportsToCjs(source)
+    expect(result).toContain('function doThing() {}')
+    expect(result).toContain('class Thing {}')
+    expect(result).toContain('module.exports = { doThing, Thing }')
+  })
+
+  test('leaves non-export lines and JSDoc comments untouched', () => {
+    const source = '/**\n * A function.\n * @memberOf module:gulpConfig\n */\nexport const get = () => {}\n'
+    const result = esmNamedExportsToCjs(source)
+    expect(result).toContain('/**\n * A function.\n * @memberOf module:gulpConfig\n */\nconst get = () => {}')
+  })
+
+  test('does not add a module.exports block when there is nothing to export', () => {
+    const source = 'import { thing } from \'./thing.mjs\'\nconst local = 1\n'
+    const result = esmNamedExportsToCjs(source)
+    expect(result).toBe(source)
+    expect(result).not.toContain('module.exports')
+  })
+
+  test('leaves export default and other export forms untouched', () => {
+    const source = 'const value = 1\nexport default value\n'
+    const result = esmNamedExportsToCjs(source)
+    expect(result).toContain('export default value')
+    expect(result).not.toContain('module.exports')
+  })
+})

package/functions/utilities/getBundleConfigs.mjs

@@ -1,30 +1,30 @@
-import * as gulpConfig from '../../gulp.config.mjs'
-
-/**
- * Build the full list of bundles to produce for this project: the primary bundle (browser.name /
- * dist.main / browser.ignore / browser.exclude, exactly as before browser.bundles existed) plus
- * any additional bundles from browser.bundles - each falling back to the primary's main / ignore /
- * exclude whenever its own isn't given, so a render-only (or any other variant) bundle only has to
- * specify what's actually different about it.
- * @memberOf module:utilities
- * @returns {Array<{name: string, main: string, ignore: Array, exclude: Array}>}
- * @private
- */
-export const getBundleConfigs = () => {
-  const primary = {
-    name: gulpConfig.get('browser.name'),
-    main: gulpConfig.get('dist.main'),
-    ignore: gulpConfig.get('browser.ignore'),
-    exclude: gulpConfig.get('browser.exclude')
-  }
-  const additional = gulpConfig.get('browser.bundles')
-  return [
-    primary,
-    ...additional.map((bundleConfig) => ({
-      name: bundleConfig.name,
-      main: bundleConfig.main || primary.main,
-      ignore: bundleConfig.ignore || primary.ignore,
-      exclude: bundleConfig.exclude || primary.exclude
-    }))
-  ]
-}
+import * as gulpConfig from '../../gulp.config.mjs'
+
+/**
+ * Build the full list of bundles to produce for this project: the primary bundle (browser.name /
+ * dist.main / browser.ignore / browser.exclude, exactly as before browser.bundles existed) plus
+ * any additional bundles from browser.bundles - each falling back to the primary's main / ignore /
+ * exclude whenever its own isn't given, so a render-only (or any other variant) bundle only has to
+ * specify what's actually different about it.
+ * @memberOf module:utilities
+ * @returns {Array<{name: string, main: string, ignore: Array, exclude: Array}>}
+ * @private
+ */
+export const getBundleConfigs = () => {
+  const primary = {
+    name: gulpConfig.get('browser.name'),
+    main: gulpConfig.get('dist.main'),
+    ignore: gulpConfig.get('browser.ignore'),
+    exclude: gulpConfig.get('browser.exclude')
+  }
+  const additional = gulpConfig.get('browser.bundles')
+  return [
+    primary,
+    ...additional.map((bundleConfig) => ({
+      name: bundleConfig.name,
+      main: bundleConfig.main || primary.main,
+      ignore: bundleConfig.ignore || primary.ignore,
+      exclude: bundleConfig.exclude || primary.exclude
+    }))
+  ]
+}

package/functions/utilities/isObject.mjs

@@ -1,8 +1,8 @@
-/**
- * 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}
- * @private
- */
-export const isObject = (object) => typeof object === 'object' && object !== null
+/**
+ * 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}
+ * @private
+ */
+export const isObject = (object) => typeof object === 'object' && object !== null

package/functions/utilities/strAfter.mjs

@@ -1,12 +1,12 @@
-/**
- * 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}
- * @private
- */
-export const strAfter = (str, search) => {
-  const index = str.indexOf(search)
-  return index === -1 ? '' : str.substring(index + search.length)
-}
+/**
+ * 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}
+ * @private
+ */
+export const strAfter = (str, search) => {
+  const index = str.indexOf(search)
+  return index === -1 ? '' : str.substring(index + search.length)
+}

package/functions/utilities/strBefore.mjs

@@ -1,12 +1,12 @@
-/**
- * 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}
- * @private
- */
-export const strBefore = (str, search) => {
-  const index = str.indexOf(search)
-  return index === -1 ? '' : str.slice(0, index)
-}
+/**
+ * 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}
+ * @private
+ */
+export const strBefore = (str, search) => {
+  const index = str.indexOf(search)
+  return index === -1 ? '' : str.slice(0, index)
+}

package/functions/watchFull.mjs

@@ -1,9 +1,9 @@
-import { beginWatcher, runOnChange } from './partials.mjs'
-
-/**
- * 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}
- */
-export const watchFull = () => beginWatcher()
-  .on('change', runOnChange)
+import { beginWatcher, runOnChange } from './partials.mjs'
+
+/**
+ * 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}
+ */
+export const watchFull = () => beginWatcher()
+  .on('change', runOnChange)

package/functions/watchFull.test.mjs

@@ -1,41 +1,41 @@
-import fs from 'fs'
-import * as setUp from './test-helpers/setUp.mjs'
-import { watchFull } from './watchFull.mjs'
-import { beginWatcher } from './partials/beginWatcher.mjs'
-import { runOnChange } from './partials/runOnChange.mjs'
-
-setUp.setDefaults('test-watch-full')
-const gulpConfig = setUp.gulpConfig
-
-jest.mock('./partials/beginWatcher.mjs', () => ({ beginWatcher: jest.fn(() => ({ on: (event, fn) => fn() })) }))
-jest.mock('./partials/runOnChange.mjs', () => ({ runOnChange: jest.fn() }))
-
-const rawContents = 'const { beginWatcher, runOnChange } = require(\'./partials\')\n' +
-  '\n' +
-  '/**\n' +
-  ' * Watch for changes and run the distribution for the changed files, then bundle and test the changed files.\n' +
-  ' * @function\n' +
-  ' * @memberOf module:js-build-tools\n' +
-  ' * @returns {FSWatcher}\n' +
-  ' */\n' +
-  'const watchFull = () => beginWatcher()\n' +
-  '  .on(\'change\', runOnChange)\n' +
-  '\n' +
-  'module.exports = watchFull\n'
-
-beforeEach(setUp.beforeEach)
-
-afterEach(setUp.afterEach)
-
-describe('watchFull', () => {
-  test('should call beginWatcher and runOnChange for change event', () => {
-    const srcPath = gulpConfig.get('srcPath')
-    gulpConfig.set('test.watch', `${srcPath}/*.js`)
-    const srcFile = `${srcPath}/watchFull.js`
-    fs.writeFileSync(srcFile, rawContents)
-    expect.assertions(2)
-    watchFull()
-    expect(beginWatcher).toHaveBeenCalled()
-    expect(runOnChange).toHaveBeenCalled()
-  })
-})
+import fs from 'fs'
+import * as setUp from './test-helpers/setUp.mjs'
+import { watchFull } from './watchFull.mjs'
+import { beginWatcher } from './partials/beginWatcher.mjs'
+import { runOnChange } from './partials/runOnChange.mjs'
+
+setUp.setDefaults('test-watch-full')
+const gulpConfig = setUp.gulpConfig
+
+jest.mock('./partials/beginWatcher.mjs', () => ({ beginWatcher: jest.fn(() => ({ on: (event, fn) => fn() })) }))
+jest.mock('./partials/runOnChange.mjs', () => ({ runOnChange: jest.fn() }))
+
+const rawContents = 'const { beginWatcher, runOnChange } = require(\'./partials\')\n' +
+  '\n' +
+  '/**\n' +
+  ' * Watch for changes and run the distribution for the changed files, then bundle and test the changed files.\n' +
+  ' * @function\n' +
+  ' * @memberOf module:js-build-tools\n' +
+  ' * @returns {FSWatcher}\n' +
+  ' */\n' +
+  'const watchFull = () => beginWatcher()\n' +
+  '  .on(\'change\', runOnChange)\n' +
+  '\n' +
+  'module.exports = watchFull\n'
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('watchFull', () => {
+  test('should call beginWatcher and runOnChange for change event', () => {
+    const srcPath = gulpConfig.get('srcPath')
+    gulpConfig.set('test.watch', `${srcPath}/*.js`)
+    const srcFile = `${srcPath}/watchFull.js`
+    fs.writeFileSync(srcFile, rawContents)
+    expect.assertions(2)
+    watchFull()
+    expect(beginWatcher).toHaveBeenCalled()
+    expect(runOnChange).toHaveBeenCalled()
+  })
+})

package/functions/watchTest.mjs

@@ -1,10 +1,10 @@
-import * as gulpConfig from '../gulp.config.mjs'
-import { watch } from 'gulp'
-import { testQuick } from './testQuick.mjs'
-
-/**
- * Watch for changes and run the tests.
- * @memberOf module:js-build-tools
- * @returns {*}
- */
-export const watchTest = () => watch(gulpConfig.get('test.watch'), { ignoreInitial: false }, testQuick)
+import * as gulpConfig from '../gulp.config.mjs'
+import { watch } from 'gulp'
+import { testQuick } from './testQuick.mjs'
+
+/**
+ * Watch for changes and run the tests.
+ * @memberOf module:js-build-tools
+ * @returns {*}
+ */
+export const watchTest = () => watch(gulpConfig.get('test.watch'), { ignoreInitial: false }, testQuick)

package/functions/watchTest.test.mjs

@@ -1,49 +1,49 @@
-import * as setUp from './test-helpers/setUp.mjs'
-import { watchTest } from './watchTest.mjs'
-import { EventEmitter } from 'node:events'
-import fs from 'fs'
-import { testQuick } from './testQuick.mjs'
-
-setUp.setDefaults('test-watch-test')
-const gulpConfig = setUp.gulpConfig
-gulpConfig.set('test.watch', 'test-begin-watcher/*.js')
-
-jest.mock('./testQuick.mjs', () => ({ testQuick: jest.fn(() => Promise.resolve(true)) }))
-
-const rawContents = 'const gulpConfig = require(\'../gulp.config.js\')\n' +
-  'const { watch } = require(\'gulp\')\n' +
-  'const testQuick = require(\'./testQuick\')\n' +
-  '\n' +
-  '/**\n' +
-  ' * Watch for changes and run the tests.\n' +
-  ' * @function\n' +
-  ' * @memberOf module:js-build-tools\n' +
-  ' * @returns {*}\n' +
-  ' */\n' +
-  'const watchTest = () => watch(gulpConfig.get(\'watchSearch\'), { ignoreInitial: false }, testQuick)\n' +
-  '\n' +
-  'module.exports = watchTest\n'
-
-const filePath = gulpConfig.get('srcPath') + '/watchTest.js'
-
-beforeEach(() => setUp.beforeEach()
-  .then(
-    () => fs.writeFileSync(filePath, rawContents)
-  )
-)
-
-afterEach(setUp.afterEach)
-
-describe('watchTest', () => {
-  test('returns instance of EventEmitter / FSWatcher and calls testQuick on change', done => {
-    expect.assertions(2)
-    const fsWatcher = watchTest()
-    expect(fsWatcher).toBeInstanceOf(EventEmitter)
-    fsWatcher.emit('change')
-    setTimeout(() => {
-      expect(testQuick).toHaveBeenCalled()
-      done()
-    }, 500)
-    fsWatcher.close()
-  })
-})
+import * as setUp from './test-helpers/setUp.mjs'
+import { watchTest } from './watchTest.mjs'
+import { EventEmitter } from 'node:events'
+import fs from 'fs'
+import { testQuick } from './testQuick.mjs'
+
+setUp.setDefaults('test-watch-test')
+const gulpConfig = setUp.gulpConfig
+gulpConfig.set('test.watch', 'test-begin-watcher/*.js')
+
+jest.mock('./testQuick.mjs', () => ({ testQuick: jest.fn(() => Promise.resolve(true)) }))
+
+const rawContents = 'const gulpConfig = require(\'../gulp.config.js\')\n' +
+  'const { watch } = require(\'gulp\')\n' +
+  'const testQuick = require(\'./testQuick\')\n' +
+  '\n' +
+  '/**\n' +
+  ' * Watch for changes and run the tests.\n' +
+  ' * @function\n' +
+  ' * @memberOf module:js-build-tools\n' +
+  ' * @returns {*}\n' +
+  ' */\n' +
+  'const watchTest = () => watch(gulpConfig.get(\'watchSearch\'), { ignoreInitial: false }, testQuick)\n' +
+  '\n' +
+  'module.exports = watchTest\n'
+
+const filePath = gulpConfig.get('srcPath') + '/watchTest.js'
+
+beforeEach(() => setUp.beforeEach()
+  .then(
+    () => fs.writeFileSync(filePath, rawContents)
+  )
+)
+
+afterEach(setUp.afterEach)
+
+describe('watchTest', () => {
+  test('returns instance of EventEmitter / FSWatcher and calls testQuick on change', done => {
+    expect.assertions(2)
+    const fsWatcher = watchTest()
+    expect(fsWatcher).toBeInstanceOf(EventEmitter)
+    fsWatcher.emit('change')
+    setTimeout(() => {
+      expect(testQuick).toHaveBeenCalled()
+      done()
+    }, 500)
+    fsWatcher.close()
+  })
+})

package/gulp.config.js

@@ -1,4 +1,4 @@
-// gulp.config.mjs is the single source of truth. This CommonJS entry re-exports it, so CommonJS consumers
-// (dist/*.js, jsdoc.base.js, require('js-build-tools/gulp.config')) read exactly the same configuration.
-// Relies on require(esm), which Node 22.12+ supports natively.
-module.exports = require('./gulp.config.mjs')
+// gulp.config.mjs is the single source of truth. This CommonJS entry re-exports it, so CommonJS consumers
+// (dist/*.js, jsdoc.base.js, require('js-build-tools/gulp.config')) read exactly the same configuration.
+// Relies on require(esm), which Node 22.12+ supports natively.
+module.exports = require('./gulp.config.mjs')