js-build-tools 6.3.1 → 6.4.1

package/functions/sourceLint.test.mjs

@@ -1,5 +1,7 @@
+/* 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 { lint } from './lint.mjs'
 import { sourceLint } from './sourceLint.mjs'
 import { countMatches } from 'test-filesystem'
 
@@ -51,6 +53,23 @@ describe('sourceLint', () => {
       })
   }, 20000)
 
+  test('also lints .mjs and .cjs source, not just .js', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    fs.writeFileSync(`${srcPath}/example.mjs`, 'const m = "d";\n\nexport default m;\n')
+    fs.writeFileSync(`${srcPath}/example.cjs`, 'const c = "e";\n\nmodule.exports = c;\n')
+    expect.assertions(2)
+    sourceLint()
+      .on('finish', () => {
+        expect(fs.readFileSync(`${srcPath}/example.mjs`).toString()).toEqual('const m = \'d\'\n\nexport default m\n')
+        expect(fs.readFileSync(`${srcPath}/example.cjs`).toString()).toEqual('const c = \'e\'\n\nmodule.exports = c\n')
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done(error)
+      })
+  }, 20000)
+
   test('lint.rules actually suppresses a real neostandard finding', done => {
     const srcPath = gulpConfig.get('srcPath')
     // A fixture string containing literal ${...} text (simulating real module source, not an accidental
@@ -95,3 +114,53 @@ describe('sourceLint', () => {
       })
   }, 20000)
 })
+
+describe('lint', () => {
+  test('fixes the source and finishes without error when nothing unfixable remains', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    expect.assertions(1)
+    lint()
+      .on('finish', () => {
+        expect(countMatches(fs.readFileSync(`${srcPath}/example.js`).toString(), ';')).toEqual(0)
+        done()
+      })
+      .on('error', error => done(error))
+  }, 20000)
+
+  test('fails when an error remains that neostandard cannot fix', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    fs.writeFileSync(`${srcPath}/unfixable.js`, 'const unused = 1\n')
+    const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {})
+    expect.assertions(1)
+    lint()
+      .on('error', error => {
+        logSpy.mockRestore()
+        expect(error.message).toMatch('neostandard found 1 lint error(s)')
+        done()
+      })
+      .on('finish', () => {
+        logSpy.mockRestore()
+        done(new Error('lint should have failed on the unused variable'))
+      })
+  }, 20000)
+
+  test('only fails once every fixed file has been written back', done => {
+    // gulp exits as soon as a task fails, so failing while a file is still being written can leave that file empty.
+    const srcPath = gulpConfig.get('srcPath')
+    const fixable = ['a', 'b', 'c'].map(name => `${srcPath}/fixable-${name}.js`)
+    fixable.forEach(file => fs.writeFileSync(file, 'const x = "y";\n\nmodule.exports = x;\n'))
+    fs.writeFileSync(`${srcPath}/unfixable.js`, 'const unused = 1\n')
+    const logSpy = jest.spyOn(console, 'log').mockImplementation(() => {})
+    expect.assertions(fixable.length)
+    lint()
+      .on('error', () => {
+        logSpy.mockRestore()
+        fixable.forEach(file => expect(fs.readFileSync(file).toString()).toEqual('const x = \'y\'\n\nmodule.exports = x\n'))
+        done()
+      })
+      .on('finish', () => {
+        logSpy.mockRestore()
+        done(new Error('lint should have failed on the unused variable'))
+      })
+  }, 30000)
+})

package/functions/test-helpers/isolateGulpCache.mjs

@@ -0,0 +1,16 @@
+import cache from 'gulp-cache'
+
+/**
+ * Give this test file its own gulp-cache folder, and return a function that clears only that folder. gulp-cache
+ * otherwise keeps one cache in os.tmpdir() for every process, so a cache.clearAll() in one Jest worker could wipe it
+ * while another worker's images task was still using it, and gulp-cache then silently dropped that worker's
+ * images. Jest loads gulp-cache separately for each test file, so this only changes the copy that file uses.
+ * @memberOf module:testHelpers
+ * @param {string} name - Unique per test file, used in the cache folder name.
+ * @returns {function(): Promise<void>} Clears this test file's cache.
+ */
+export const isolateGulpCache = name => {
+  const fileCache = new cache.Cache({ cacheDirName: `js-build-tools-test-${name}` })
+  cache.defaultOptions.fileCache = fileCache
+  return () => new Promise((resolve, reject) => fileCache.clear(null, error => error ? reject(error) : resolve()))
+}

package/functions/test-helpers/setUp.mjs

@@ -60,41 +60,41 @@ export {
    * @param {boolean} [exists=true]
    * @returns {Promise<*|void>}
    */
-    createTempDir,
+  createTempDir,
   /**
    * In the Jest.beforeEach function call this one to set up the temp directory.
    * @memberOf module:testHelpers
    * @returns {Promise<*|void>}
    */
-    beforeEach,
+  beforeEach,
   /**
    * In the Jest.afterEach function call this one to clean up and remove the temp directory.
    * @memberOf module:testHelpers
    * @returns {Promise<*>}
    */
-    afterEach,
+  afterEach,
   /**
    * Return number of occurrences of substring in another string.
    * @memberOf module:testHelpers
    * @returns {int}
    */
-    countMatches,
+  countMatches,
   /**
    * Returns true if the given file or directory exists, otherwise false.
    * @memberOf module:testHelpers
    * @returns {boolean}
    */
-    fileExists,
+  fileExists,
   /**
    * Console log objects in a readable format, returns the given object.
    * @memberOf module:testHelpers
    * @returns {*}
    */
-    logObject,
+  logObject,
   /**
    * Delete a directory and subcontents.
    * @memberOf module:testHelpers
    * @returns {Promise<*>}
    */
-    removeDirectory,
+  removeDirectory,
 } from 'test-filesystem'

package/functions/testFull.test.mjs

@@ -5,7 +5,7 @@ import { testFull } from './testFull.mjs'
 const gulpConfig = testHelpers.gulpConfig
 
 jest.mock('jest', () => ({
-  'runCLI': jest.fn(() => Promise.resolve(true))
+  runCLI: jest.fn(() => Promise.resolve(true))
 }))
 
 describe('testFull', () => {

package/functions/testQuick.test.mjs

@@ -5,7 +5,7 @@ import { testQuick } from './testQuick.mjs'
 const gulpConfig = testHelpers.gulpConfig
 
 jest.mock('jest', () => ({
-  'runCLI': jest.fn(() => Promise.resolve(true))
+  runCLI: jest.fn(() => Promise.resolve(true))
 }))
 
 describe('testQuick', () => {

package/functions/utilities/convertMjsFilesForDocs.test.mjs

@@ -1,3 +1,4 @@
+/* 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 { convertMjsFilesForDocs } from './convertMjsFilesForDocs.mjs'

package/functions/utilities/dotGet.mjs

@@ -11,7 +11,7 @@ import { strBefore } from './strBefore.mjs'
  * @returns {*} The value of the property
  * @private
  */
-export const dotGet = (arrayObject = {}, dotNotation= '', defaultValue = null) => {
+export const dotGet = (arrayObject = {}, dotNotation = '', defaultValue = null) => {
   if (!dotNotation) {
     return arrayObject
   }
@@ -22,7 +22,7 @@ export const dotGet = (arrayObject = {}, dotNotation= '', defaultValue = null) =
   }
   if (key === '*') {
     const result = []
-    for (let wildKey in arrayObject) {
+    for (const wildKey in arrayObject) {
       const wildValue = arrayObject[wildKey]
       if (lastKey) {
         result[wildKey] = wildValue

package/functions/utilities/dotNotate.mjs

@@ -15,7 +15,7 @@ const handleRetainObjects = (retainObjects = []) => {
      */
     return (currentKey, value, results) => false
   }
-  retainObjects = retainObjects.map(key => key.replace('\.', '\\.'))
+  retainObjects = retainObjects.map(key => key.replaceAll('.', '\\.'))
   const retainRegex = new RegExp(`(${retainObjects.join('|')})$`)
   /**
    * Test if a key should be retained as an object.
@@ -44,7 +44,7 @@ const handleRetainObjects = (retainObjects = []) => {
  * @private
  */
 const performDotNotate = (arrayObject, didRetain, prepend = '', results = {}) => {
-  for (let key in arrayObject) {
+  for (const key in arrayObject) {
     const value = arrayObject[key]
     const currentKey = `${prepend}${key}`
     if (didRetain(currentKey, value, results)) {

package/functions/utilities/dotNotate.test.mjs

@@ -31,4 +31,11 @@ describe('dotNotate', () => {
       options: { fix: true }
     })
   })
+
+  test('treats every dot in a retained key literally, not as a regex wildcard', () => {
+    expect(dotNotate({ a: { bXc: { d: 1 }, b: { c: { d: 2 } } } }, ['a.b.c'])).toEqual({
+      'a.bXc.d': 1,
+      'a.b.c': { d: 2 }
+    })
+  })
 })

package/functions/utilities/dotSet.mjs

@@ -18,7 +18,7 @@ export const dotSet = (arrayObject, dotNotation, value = null) => {
     key = dotNotation
   }
   if (key === '*') {
-    for (let wildKey in arrayObject) {
+    for (const wildKey in arrayObject) {
       if (lastKey) {
         arrayObject[wildKey] = value
         continue

package/gulpfile.base.mjs

@@ -16,6 +16,7 @@ export { distMinify } from './functions/distMinify.mjs'
 export * as gulpConfig from './gulp.config.mjs'
 export { images } from './functions/images.mjs'
 export { jsdocDocs } from './functions/jsdocDocs.mjs'
+export { lint } from './functions/lint.mjs'
 export * as partials from './functions/partials.mjs'
 export { sass } from './functions/sass.mjs'
 export { sourceLint } from './functions/sourceLint.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "6.3.1",
+  "version": "6.4.1",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {
@@ -21,6 +21,7 @@
     "build": "gulp build",
     "dev": "gulp",
     "docs": "gulp docs",
+    "lint": "gulp lint",
     "readme": "gulp readme",
     "release": "release-it",
     "release:dry-run": "release-it --dry-run",
@@ -124,12 +125,21 @@
     "clean-jsdoc-theme": "^4.3.3",
     "gulp-imagemin": "github:jheagle/gulp-imagemin#common-js-compatibility",
     "jsdoc": "^4.0.5",
-    "playwright": "~1.62.1",
+    "playwright": "^1.64.1",
     "release-it": "^21.1.1",
     "typedoc": "^0.28.20",
     "typescript": "^6.0.3"
   },
   "engines": {
     "node": ">=22.12.0"
+  },
+  "allowScripts": {
+    "gifsicle@5.3.0": true,
+    "mozjpeg@8.0.0": true,
+    "optipng-bin@7.0.1": true,
+    "core-js": false,
+    "core-js-pure": false,
+    "@parcel/watcher": false,
+    "unrs-resolver": false
   }
 }