js-build-tools 6.6.0 → 6.7.0

package/functions/partials/addToReadme.test.mjs

@@ -1,34 +1,34 @@
-/* eslint-disable no-template-curly-in-string -- fixture source code, the ${...} is meant to stay literal */
-import fs from 'fs'
-import * as setUp from '../test-helpers/setUp.mjs'
-import { addToReadme } from './addToReadme.mjs'
-
-setUp.setDefaults('test-add-to-readme')
-const gulpConfig = setUp.gulpConfig
-gulpConfig.set('dist.from', 'test-temp/src/addToReadme.js')
-
-const rawContents = '/**\n' +
-  ' * Say hello with a given name.\n' +
-  ' * @param {string} name\n' +
-  ' * @returns {string}\n' +
-  ' */\n' +
-  'const sayHello = name => `Hello from ${name}`\n' +
-  '\n' +
-  'module.exports = sayHello\n'
-
-beforeEach(() => setUp.beforeEach()
-  .then(() => fs.writeFileSync(gulpConfig.get('srcPath') + '/addToReadme.js', rawContents)))
-
-afterEach(setUp.afterEach)
-
-describe('addToReadme', () => {
-  test('generates the documentation', async () => {
-    const readmeFilePath = gulpConfig.get('readme.to') + gulpConfig.get('readme.file')
-    expect.assertions(2)
-    await addToReadme()
-    await expect(fs.existsSync(readmeFilePath)).toBeTruthy()
-    const readme = await fs.readFileSync(readmeFilePath)
-    // At least the documentation will have the addToReadme documentation
-    await expect(readme.includes('sayHello')).toBeTruthy()
-  })
-})
+/* eslint-disable no-template-curly-in-string -- fixture source code, the ${...} is meant to stay literal */
+import fs from 'fs'
+import * as setUp from '../test-helpers/setUp.mjs'
+import { addToReadme } from './addToReadme.mjs'
+
+setUp.setDefaults('test-add-to-readme')
+const gulpConfig = setUp.gulpConfig
+gulpConfig.set('dist.from', 'test-temp/src/addToReadme.js')
+
+const rawContents = '/**\n' +
+  ' * Say hello with a given name.\n' +
+  ' * @param {string} name\n' +
+  ' * @returns {string}\n' +
+  ' */\n' +
+  'const sayHello = name => `Hello from ${name}`\n' +
+  '\n' +
+  'module.exports = sayHello\n'
+
+beforeEach(() => setUp.beforeEach()
+  .then(() => fs.writeFileSync(gulpConfig.get('srcPath') + '/addToReadme.js', rawContents)))
+
+afterEach(setUp.afterEach)
+
+describe('addToReadme', () => {
+  test('generates the documentation', async () => {
+    const readmeFilePath = gulpConfig.get('readme.to') + gulpConfig.get('readme.file')
+    expect.assertions(2)
+    await addToReadme()
+    await expect(fs.existsSync(readmeFilePath)).toBeTruthy()
+    const readme = await fs.readFileSync(readmeFilePath)
+    // At least the documentation will have the addToReadme documentation
+    await expect(readme.includes('sayHello')).toBeTruthy()
+  })
+})

package/functions/partials/beginWatcher.mjs

@@ -1,9 +1,9 @@
-import * as gulpConfig from '../../gulp.config.mjs'
-import { watch } from 'gulp'
-
-/**
- * Create a chokidar instance which watches and triggers change when the globed files are modified.
- * @memberOf module:partials
- * @returns {FSWatcher}
- */
-export const beginWatcher = () => watch(gulpConfig.get('test.watch'))
+import * as gulpConfig from '../../gulp.config.mjs'
+import { watch } from 'gulp'
+
+/**
+ * Create a chokidar instance which watches and triggers change when the globed files are modified.
+ * @memberOf module:partials
+ * @returns {FSWatcher}
+ */
+export const beginWatcher = () => watch(gulpConfig.get('test.watch'))

package/functions/partials/beginWatcher.test.mjs

@@ -1,19 +1,19 @@
-import * as setUp from '../test-helpers/setUp.mjs'
-import { beginWatcher } from './beginWatcher.mjs'
-import { EventEmitter } from 'node:events'
-
-setUp.setDefaults('test-begin-watcher')
-const gulpConfig = setUp.gulpConfig
-
-beforeEach(setUp.beforeEach)
-
-afterEach(setUp.afterEach)
-
-describe('beginWatcher', () => {
-  test('returns instance of EventEmitter / FSWatcher', () => {
-    gulpConfig.set('test.watch', 'test-begin-watcher/*.js')
-    const fsWatcher = beginWatcher()
-    expect(fsWatcher).toBeInstanceOf(EventEmitter)
-    fsWatcher.close()
-  })
-})
+import * as setUp from '../test-helpers/setUp.mjs'
+import { beginWatcher } from './beginWatcher.mjs'
+import { EventEmitter } from 'node:events'
+
+setUp.setDefaults('test-begin-watcher')
+const gulpConfig = setUp.gulpConfig
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('beginWatcher', () => {
+  test('returns instance of EventEmitter / FSWatcher', () => {
+    gulpConfig.set('test.watch', 'test-begin-watcher/*.js')
+    const fsWatcher = beginWatcher()
+    expect(fsWatcher).toBeInstanceOf(EventEmitter)
+    fsWatcher.close()
+  })
+})

package/functions/partials/clean.mjs

@@ -1,13 +1,13 @@
-import * as gulpConfig from '../../gulp.config.mjs'
-import { removeDirectory } from './removeDirectory.mjs'
-
-/**
- * Deletes all the distribution and browser files (used before create a new build).
- * Configure array of directories to remove with 'cleanPaths'.
- * @memberOf module:partials
- * @returns {Promise<string[]> | *}
- */
-export const clean = () => gulpConfig.get('cleanPaths').reduce(
-  (promise, path) => promise.then(() => removeDirectory(path)),
-  Promise.resolve()
-)
+import * as gulpConfig from '../../gulp.config.mjs'
+import { removeDirectory } from './removeDirectory.mjs'
+
+/**
+ * Deletes all the distribution and browser files (used before create a new build).
+ * Configure array of directories to remove with 'cleanPaths'.
+ * @memberOf module:partials
+ * @returns {Promise<string[]> | *}
+ */
+export const clean = () => gulpConfig.get('cleanPaths').reduce(
+  (promise, path) => promise.then(() => removeDirectory(path)),
+  Promise.resolve()
+)

package/functions/partials/clean.test.mjs

@@ -1,22 +1,22 @@
-import fs from 'fs'
-import * as setUp from '../test-helpers/setUp.mjs'
-import { clean } from './clean.mjs'
-
-setUp.setDefaults('test-clean')
-const gulpConfig = setUp.gulpConfig
-const srcPath = gulpConfig.get('srcPath')
-gulpConfig.set('cleanPaths', [srcPath])
-
-beforeEach(setUp.beforeEach)
-
-afterEach(setUp.afterEach)
-
-describe('clean', () => {
-  test('removes all contents of directories specified', async () => {
-    expect.assertions(2)
-    expect(fs.readdirSync(srcPath)).toBeTruthy()
-    // Run the clean script to empty the directories
-    await clean()
-    expect(fs.existsSync(srcPath)).toBeFalsy()
-  })
-})
+import fs from 'fs'
+import * as setUp from '../test-helpers/setUp.mjs'
+import { clean } from './clean.mjs'
+
+setUp.setDefaults('test-clean')
+const gulpConfig = setUp.gulpConfig
+const srcPath = gulpConfig.get('srcPath')
+gulpConfig.set('cleanPaths', [srcPath])
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('clean', () => {
+  test('removes all contents of directories specified', async () => {
+    expect.assertions(2)
+    expect(fs.readdirSync(srcPath)).toBeTruthy()
+    // Run the clean script to empty the directories
+    await clean()
+    expect(fs.existsSync(srcPath)).toBeFalsy()
+  })
+})

package/functions/partials/copyFor.mjs

@@ -1,15 +1,15 @@
-import { dest, src } from 'gulp'
-
-/**
- * Copy some files to a different location.
- * @memberOf module:partials
- * @param {string|array} srcPath
- * @param {string} destPath
- * @param {Object} [options]
- * @param {string} [options.base] - Passed through to gulp's own src(pattern, {base}), to preserve srcPath's own
- * subdirectory structure in destPath instead of flattening it.
- * @returns {stream.Stream}
- */
-// encoding: false copies the bytes untouched - Gulp 5's default utf8 handling corrupts binary files such as fonts.
-export const copyFor = (srcPath, destPath, { base } = {}) => src(srcPath, { encoding: false, ...(base ? { base } : {}) })
-  .pipe(dest(destPath))
+import { dest, src } from 'gulp'
+
+/**
+ * Copy some files to a different location.
+ * @memberOf module:partials
+ * @param {string|array} srcPath
+ * @param {string} destPath
+ * @param {Object} [options]
+ * @param {string} [options.base] - Passed through to gulp's own src(pattern, {base}), to preserve srcPath's own
+ * subdirectory structure in destPath instead of flattening it.
+ * @returns {stream.Stream}
+ */
+// encoding: false copies the bytes untouched - Gulp 5's default utf8 handling corrupts binary files such as fonts.
+export const copyFor = (srcPath, destPath, { base } = {}) => src(srcPath, { encoding: false, ...(base ? { base } : {}) })
+  .pipe(dest(destPath))

package/functions/partials/copyFor.test.mjs

@@ -1,53 +1,53 @@
-import fs from 'fs'
-import * as setUp from '../test-helpers/setUp.mjs'
-import { copyFor } from './copyFor.mjs'
-
-setUp.setDefaults('test-copy-for')
-const gulpConfig = setUp.gulpConfig
-
-const fileContents = 'some file contents'
-
-beforeEach(setUp.beforeEach)
-
-afterEach(setUp.afterEach)
-
-describe('copyFor', () => {
-  test('copies the file and ', done => {
-    const srcPath = gulpConfig.get('srcPath')
-    const copyFile = `${srcPath}/fileToCopy.txt`
-    fs.writeFileSync(copyFile, fileContents)
-    expect.assertions(3)
-    const oldContents = fs.readFileSync(copyFile).toString()
-    expect(oldContents).toEqual(fileContents)
-    const browserPath = gulpConfig.get('browser.to')
-    copyFor(copyFile, browserPath)
-      .on('finish', () => {
-        expect(fs.existsSync(browserPath)).toBeTruthy()
-        const movedContents = fs.readFileSync(`${browserPath}/fileToCopy.txt`).toString()
-        expect(movedContents).toEqual(fileContents)
-        done()
-      })
-      .on('error', error => {
-        console.error('Encountered error', error)
-        done()
-      })
-  })
-
-  test('copies binary files byte for byte, including a leading BOM and bytes above 0x7f', done => {
-    const srcPath = gulpConfig.get('srcPath')
-    const binaryFile = `${srcPath}/font.woff`
-    const original = Buffer.concat([Buffer.from([0xef, 0xbb, 0xbf]), Buffer.from(Array.from({ length: 512 }, (_, i) => i % 256))])
-    fs.writeFileSync(binaryFile, original)
-    expect.assertions(1)
-    const browserPath = gulpConfig.get('browser.to')
-    copyFor(binaryFile, browserPath)
-      .on('finish', () => {
-        expect(fs.readFileSync(`${browserPath}/font.woff`).equals(original)).toBeTruthy()
-        done()
-      })
-      .on('error', error => {
-        console.error('Encountered error', error)
-        done()
-      })
-  })
-})
+import fs from 'fs'
+import * as setUp from '../test-helpers/setUp.mjs'
+import { copyFor } from './copyFor.mjs'
+
+setUp.setDefaults('test-copy-for')
+const gulpConfig = setUp.gulpConfig
+
+const fileContents = 'some file contents'
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('copyFor', () => {
+  test('copies the file and ', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    const copyFile = `${srcPath}/fileToCopy.txt`
+    fs.writeFileSync(copyFile, fileContents)
+    expect.assertions(3)
+    const oldContents = fs.readFileSync(copyFile).toString()
+    expect(oldContents).toEqual(fileContents)
+    const browserPath = gulpConfig.get('browser.to')
+    copyFor(copyFile, browserPath)
+      .on('finish', () => {
+        expect(fs.existsSync(browserPath)).toBeTruthy()
+        const movedContents = fs.readFileSync(`${browserPath}/fileToCopy.txt`).toString()
+        expect(movedContents).toEqual(fileContents)
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  })
+
+  test('copies binary files byte for byte, including a leading BOM and bytes above 0x7f', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    const binaryFile = `${srcPath}/font.woff`
+    const original = Buffer.concat([Buffer.from([0xef, 0xbb, 0xbf]), Buffer.from(Array.from({ length: 512 }, (_, i) => i % 256))])
+    fs.writeFileSync(binaryFile, original)
+    expect.assertions(1)
+    const browserPath = gulpConfig.get('browser.to')
+    copyFor(binaryFile, browserPath)
+      .on('finish', () => {
+        expect(fs.readFileSync(`${browserPath}/font.woff`).equals(original)).toBeTruthy()
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  })
+})

package/functions/partials/distFor.mjs

@@ -1,22 +1,22 @@
-import babel from 'gulp-babel'
-import { dest, src } from 'gulp'
-import { distForSrc } from './distForSrc.mjs'
-import * as gulpConfig from '../../gulp.config.mjs'
-import through from 'through2'
-
-/**
- * Build the distribution for a given source pattern.
- * @memberOf module:partials
- * @param {string|array} [srcPath='src/config/path/dist/for']
- * @param {string} [destPath='dist/config/path']
- * @returns {stream.Stream}
- */
-export const distFor = (srcPath = distForSrc(), destPath = gulpConfig.get('dist.to')) => src(srcPath)
-  .pipe(babel())
-  .pipe(through.obj(function (file, enc, callback) {
-    const regex = /\.mjs(['"]\s*\))/gi
-    file.contents = Buffer.from(file.contents.toString().replaceAll(regex, '.js$1'))
-    this.push(file)
-    callback()
-  }))
-  .pipe(dest(destPath))
+import babel from 'gulp-babel'
+import { dest, src } from 'gulp'
+import { distForSrc } from './distForSrc.mjs'
+import * as gulpConfig from '../../gulp.config.mjs'
+import through from 'through2'
+
+/**
+ * Build the distribution for a given source pattern.
+ * @memberOf module:partials
+ * @param {string|array} [srcPath='src/config/path/dist/for']
+ * @param {string} [destPath='dist/config/path']
+ * @returns {stream.Stream}
+ */
+export const distFor = (srcPath = distForSrc(), destPath = gulpConfig.get('dist.to')) => src(srcPath)
+  .pipe(babel())
+  .pipe(through.obj(function (file, enc, callback) {
+    const regex = /\.mjs(['"]\s*\))/gi
+    file.contents = Buffer.from(file.contents.toString().replaceAll(regex, '.js$1'))
+    this.push(file)
+    callback()
+  }))
+  .pipe(dest(destPath))