js-build-tools 6.6.0 → 6.8.0

package/gulpfile.base.js

@@ -1,51 +1,51 @@
-/**
- * Export these functions to your own project to customize your build pipeline.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 3.0.0
- * @module js-build-tools
- */
-
-const build = require('./dist/build.js')
-const bundle = require('./dist/bundle.js')
-const bundleMinify = require('./dist/bundleMinify.js')
-const compileReadme = require('./dist/compileReadme.js')
-const copyFonts = require('./dist/copyFonts.js')
-const defaultCmd = require('./dist/default.js')
-const dist = require('./dist/dist.js')
-const distMinify = require('./dist/distMinify.js')
-const gulpConfig = require('./gulp.config.js')
-const images = require('./dist/images.js')
-const partials = require('./dist/partials.js')
-const sass = require('./dist/sass.js')
-const sourceLint = require('./dist/sourceLint.js')
-const testFull = require('./dist/testFull.js')
-const testHelpers = require('./dist/testHelpers.js')
-const testQuick = require('./dist/testQuick.js')
-const typeDocs = require('./dist/typeDocs.js')
-const typescript = require('./dist/typeScript')
-const watchFull = require('./dist/watchFull.js')
-const watchTest = require('./dist/watchTest.js')
-
-module.exports = {
-  build,
-  bundle,
-  bundleMinify,
-  copyFonts,
-  defaultCmd,
-  docs: typeDocs,
-  dist,
-  distMinify,
-  gulpConfig,
-  images,
-  partials,
-  readme: compileReadme,
-  sass,
-  sourceLint,
-  testFull,
-  testHelpers,
-  testQuick,
-  typescript,
-  watchFull,
-  watchTest
-}
+/**
+ * Export these functions to your own project to customize your build pipeline.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 3.0.0
+ * @module js-build-tools
+ */
+
+const build = require('./dist/build.js')
+const bundle = require('./dist/bundle.js')
+const bundleMinify = require('./dist/bundleMinify.js')
+const compileReadme = require('./dist/compileReadme.js')
+const copyFonts = require('./dist/copyFonts.js')
+const defaultCmd = require('./dist/default.js')
+const dist = require('./dist/dist.js')
+const distMinify = require('./dist/distMinify.js')
+const gulpConfig = require('./gulp.config.js')
+const images = require('./dist/images.js')
+const partials = require('./dist/partials.js')
+const sass = require('./dist/sass.js')
+const sourceLint = require('./dist/sourceLint.js')
+const testFull = require('./dist/testFull.js')
+const testHelpers = require('./dist/testHelpers.js')
+const testQuick = require('./dist/testQuick.js')
+const typeDocs = require('./dist/typeDocs.js')
+const typescript = require('./dist/typeScript')
+const watchFull = require('./dist/watchFull.js')
+const watchTest = require('./dist/watchTest.js')
+
+module.exports = {
+  build,
+  bundle,
+  bundleMinify,
+  copyFonts,
+  defaultCmd,
+  docs: typeDocs,
+  dist,
+  distMinify,
+  gulpConfig,
+  images,
+  partials,
+  readme: compileReadme,
+  sass,
+  sourceLint,
+  testFull,
+  testHelpers,
+  testQuick,
+  typescript,
+  watchFull,
+  watchTest
+}

package/gulpfile.base.mjs

@@ -1,29 +1,29 @@
-/**
- * Import these functions to your own project to customize your build pipeline.
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @module js-build-tools
- */
-export { build } from './functions/build.mjs'
-export { bundle } from './functions/bundle.mjs'
-export { bundleMinify } from './functions/bundleMinify.mjs'
-export { compileReadme as readme } from './functions/compileReadme.mjs'
-export { copyFiles } from './functions/copyFiles.mjs'
-export { copyFonts } from './functions/copyFonts.mjs'
-export { defaultCmd } from './functions/default.mjs'
-export { dist } from './functions/dist.mjs'
-export { docs } from './functions/docs.mjs'
-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'
-export { testFull } from './functions/testFull.mjs'
-export * as testHelpers from './functions/testHelpers.mjs'
-export { testQuick } from './functions/testQuick.mjs'
-export { typeDocs } from './functions/typeDocs.mjs'
-export { typeScript as typescript } from './functions/typeScript.mjs'
-export { watchFull } from './functions/watchFull.mjs'
-export { watchTest } from './functions/watchTest.mjs'
+/**
+ * Import these functions to your own project to customize your build pipeline.
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @module js-build-tools
+ */
+export { build } from './functions/build.mjs'
+export { bundle } from './functions/bundle.mjs'
+export { bundleMinify } from './functions/bundleMinify.mjs'
+export { compileReadme as readme } from './functions/compileReadme.mjs'
+export { copyFiles } from './functions/copyFiles.mjs'
+export { copyFonts } from './functions/copyFonts.mjs'
+export { defaultCmd } from './functions/default.mjs'
+export { dist } from './functions/dist.mjs'
+export { docs } from './functions/docs.mjs'
+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'
+export { testFull } from './functions/testFull.mjs'
+export * as testHelpers from './functions/testHelpers.mjs'
+export { testQuick } from './functions/testQuick.mjs'
+export { typeDocs } from './functions/typeDocs.mjs'
+export { typeScript as typescript } from './functions/typeScript.mjs'
+export { watchFull } from './functions/watchFull.mjs'
+export { watchTest } from './functions/watchTest.mjs'

package/jsdoc.base.js

@@ -1,16 +1,16 @@
-const path = require('path')
-const gulpConfig = require('./gulp.config.js')
-
-module.exports = {
-  plugins: ['plugins/markdown', path.join(__dirname, 'jsdoc.esmExports.js')],
-  // Give markdown headings ids (the README / docs.index front page), so they can be linked to and a theme's
-  // table of contents can follow them
-  markdown: { idInHeadings: true },
-  source: {
-    include: [gulpConfig.get('dist.to')],
-    // .mjs / .cjs too, so ES module source can be documented as it is, not only its compiled CommonJS
-    includePattern: '.+\\.[cm]?js(doc|x)?$',
-    // Files starting with _, tests, and minified copies (which only repeat what their unminified file documents)
-    excludePattern: '((^|\\/|\\\\)_|.+\\.test\\..*|.+\\.min\\.[cm]?js$)'
-  },
-}
+const path = require('path')
+const gulpConfig = require('./gulp.config.js')
+
+module.exports = {
+  plugins: ['plugins/markdown', path.join(__dirname, 'jsdoc.esmExports.js')],
+  // Give markdown headings ids (the README / docs.index front page), so they can be linked to and a theme's
+  // table of contents can follow them
+  markdown: { idInHeadings: true },
+  source: {
+    include: [gulpConfig.get('dist.to')],
+    // .mjs / .cjs too, so ES module source can be documented as it is, not only its compiled CommonJS
+    includePattern: '.+\\.[cm]?js(doc|x)?$',
+    // Files starting with _, tests, and minified copies (which only repeat what their unminified file documents)
+    excludePattern: '((^|\\/|\\\\)_|.+\\.test\\..*|.+\\.min\\.[cm]?js$)'
+  },
+}

package/jsdoc.esmExports.js

@@ -1,17 +1,17 @@
-/**
- * A jsdoc plugin for ES module source. When a file has no @module tag of its own, jsdoc names each
- * `export const x` it documents `exports.x`, so with `@memberOf module:name` it becomes `module:name.exports.x`
- * (shown as "exports.x"). This drops that `exports.` so it is `module:name.x`, the name it is used by.
- */
-const prefix = 'exports.'
-
-exports.handlers = {
-  newDoclet ({ doclet }) {
-    if (doclet.name && doclet.name.startsWith(prefix)) {
-      doclet.name = doclet.name.slice(prefix.length)
-    }
-    if (doclet.longname && doclet.longname.includes(`.${prefix}`)) {
-      doclet.longname = doclet.longname.replace(`.${prefix}`, '.')
-    }
-  }
-}
+/**
+ * A jsdoc plugin for ES module source. When a file has no @module tag of its own, jsdoc names each
+ * `export const x` it documents `exports.x`, so with `@memberOf module:name` it becomes `module:name.exports.x`
+ * (shown as "exports.x"). This drops that `exports.` so it is `module:name.x`, the name it is used by.
+ */
+const prefix = 'exports.'
+
+exports.handlers = {
+  newDoclet ({ doclet }) {
+    if (doclet.name && doclet.name.startsWith(prefix)) {
+      doclet.name = doclet.name.slice(prefix.length)
+    }
+    if (doclet.longname && doclet.longname.includes(`.${prefix}`)) {
+      doclet.longname = doclet.longname.replace(`.${prefix}`, '.')
+    }
+  }
+}

package/package.json

@@ -1,145 +1,146 @@
-{
-  "name": "js-build-tools",
-  "version": "6.6.0",
-  "description": "Standardised build process with gulp.",
-  "main": "gulpfile.base.js",
-  "exports": {
-    ".": {
-      "node": "./gulpfile.base.js",
-      "default": "./gulpfile.base.mjs"
-    },
-    "./babel.config": "./babel.config.js",
-    "./gulp.config": "./gulp.config.js",
-    "./gulp.config.mjs": "./gulp.config.mjs",
-    "./gulpfile.base": "./gulpfile.base.js",
-    "./gulpfile.base.mjs": "./gulpfile.base.mjs",
-    "./jsdoc.base": "./jsdoc.base.js",
-    "./testHelpers": "./dist/testHelpers",
-    "./testHelpers.mjs": "./functions/testHelpers.mjs"
-  },
-  "scripts": {
-    "build": "gulp build",
-    "dev": "gulp",
-    "docs": "gulp docs",
-    "lint": "gulp lint",
-    "readme": "gulp readme",
-    "release": "release-it",
-    "release:dry-run": "release-it --dry-run",
-    "test": "gulp testFull",
-    "test:quick": "gulp testQuick",
-    "watch": "gulp watchFull",
-    "watch:test": "gulp watchTest"
-  },
-  "repository": "github:jheagle/js-build-tools",
-  "keywords": [
-    "gulp",
-    "build",
-    "node",
-    "bundler"
-  ],
-  "author": "Joshua Heagle <joshuaheagle@gmail.com> (https://joshuaheagle.com)",
-  "license": "GPL-3.0-or-later",
-  "bugs": {
-    "url": "https://github.com/jheagle/js-build-tools/issues"
-  },
-  "homepage": "https://github.com/jheagle/js-build-tools#readme",
-  "standard": {
-    "env": [
-      "jest"
-    ]
-  },
-  "dependencies": {
-    "@babel/core": "^7.29.7",
-    "@babel/plugin-transform-modules-commonjs": "^7.29.7",
-    "@babel/preset-env": "^7.29.7",
-    "@babel/preset-typescript": "^7.29.7",
-    "@babel/runtime-corejs3": "^8.0.7",
-    "autoprefixer": "^10.6.1",
-    "babel-jest": "^30.5.2",
-    "browserify": "^17.0.1",
-    "core-js": "^3.51.0",
-    "cssnano": "^6.1.2",
-    "eslint": "^10.13.0",
-    "glob": "^13.0.6",
-    "gulp": "^5.0.1",
-    "gulp-babel": "^8.1.0",
-    "gulp-cache": "^1.1.3",
-    "gulp-postcss": "^10.0.0",
-    "gulp-rename": "^2.1.0",
-    "gulp-sass": "^6.0.1",
-    "gulp-ts-compile": "^1.0.2",
-    "gulp-uglify-es": "^3.0.0",
-    "jest": "^30.5.2",
-    "jest-environment-jsdom": "^30.5.2",
-    "jsdoc-to-markdown": "^9.1.3",
-    "merge-stream": "^2.0.0",
-    "neostandard": "^0.14.1",
-    "postcss": "^8.5.31",
-    "regenerator-runtime": "^0.14.1",
-    "sass": "^1.105.2",
-    "test-filesystem": "^2.0.2",
-    "through2": "^4.0.2",
-    "vinyl-source-stream": "^2.0.0"
-  },
-  "peerDependencies": {
-    "clean-jsdoc-theme": ">=4.0.0",
-    "gulp-imagemin": ">=9.0.0",
-    "jsdoc": ">=4.0.0",
-    "playwright": ">=1.40.0",
-    "typedoc": ">=0.28.0",
-    "typescript": ">=5.0.0 <7.0.0"
-  },
-  "peerDependenciesMeta": {
-    "clean-jsdoc-theme": {
-      "optional": true
-    },
-    "gulp-imagemin": {
-      "optional": true
-    },
-    "jsdoc": {
-      "optional": true
-    },
-    "playwright": {
-      "optional": true
-    },
-    "typedoc": {
-      "optional": true
-    },
-    "typescript": {
-      "optional": true
-    }
-  },
-  "files": [
-    "babel.config.js",
-    "dist",
-    "functions",
-    "gulpfile.base.js",
-    "gulpfile.base.mjs",
-    "gulp.config.js",
-    "gulp.config.mjs",
-    "jsdoc.base.js",
-    "jsdoc.esmExports.js"
-  ],
-  "funding": "https://www.paypal.com/donate/?business=LRYR6SZRWKXVY&no_recurring=0&item_name=Let%27s+build+together+today+to+simplify+our+jobs+tomorrow.&currency_code=CAD",
-  "devDependencies": {
-    "clean-jsdoc-theme": "^4.3.3",
-    "gulp-imagemin": "github:jheagle/gulp-imagemin#common-js-compatibility",
-    "jsdoc": "^4.0.5",
-    "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
-  }
-}
+{
+  "name": "js-build-tools",
+  "version": "6.8.0",
+  "description": "Standardised build process with gulp.",
+  "main": "gulpfile.base.js",
+  "exports": {
+    ".": {
+      "node": "./gulpfile.base.js",
+      "default": "./gulpfile.base.mjs"
+    },
+    "./babel.config": "./babel.config.js",
+    "./gulp.config": "./gulp.config.js",
+    "./gulp.config.mjs": "./gulp.config.mjs",
+    "./gulpfile.base": "./gulpfile.base.js",
+    "./gulpfile.base.mjs": "./gulpfile.base.mjs",
+    "./jsdoc.base": "./jsdoc.base.js",
+    "./testHelpers": "./dist/testHelpers",
+    "./testHelpers.mjs": "./functions/testHelpers.mjs"
+  },
+  "scripts": {
+    "build": "gulp build",
+    "dev": "gulp",
+    "docs": "gulp docs",
+    "lint": "gulp lint",
+    "prepublishOnly": "npm run build",
+    "readme": "gulp readme",
+    "release": "release-it",
+    "release:dry-run": "release-it --dry-run",
+    "test": "gulp testFull",
+    "test:quick": "gulp testQuick",
+    "watch": "gulp watchFull",
+    "watch:test": "gulp watchTest"
+  },
+  "repository": "github:jheagle/js-build-tools",
+  "keywords": [
+    "gulp",
+    "build",
+    "node",
+    "bundler"
+  ],
+  "author": "Joshua Heagle <joshuaheagle@gmail.com> (https://joshuaheagle.com)",
+  "license": "GPL-3.0-or-later",
+  "bugs": {
+    "url": "https://github.com/jheagle/js-build-tools/issues"
+  },
+  "homepage": "https://github.com/jheagle/js-build-tools#readme",
+  "standard": {
+    "env": [
+      "jest"
+    ]
+  },
+  "dependencies": {
+    "@babel/core": "^7.29.7",
+    "@babel/plugin-transform-modules-commonjs": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@babel/preset-typescript": "^7.29.7",
+    "@babel/runtime-corejs3": "^8.0.7",
+    "autoprefixer": "^10.6.1",
+    "babel-jest": "^30.5.2",
+    "browserify": "^17.0.1",
+    "core-js": "^3.51.0",
+    "cssnano": "^6.1.2",
+    "eslint": "^10.13.0",
+    "glob": "^14.0.2",
+    "gulp": "^5.0.1",
+    "gulp-babel": "^8.1.0",
+    "gulp-postcss": "^10.0.0",
+    "gulp-rename": "^2.1.0",
+    "gulp-sass": "^6.0.1",
+    "gulp-ts-compile": "^1.0.2",
+    "gulp-uglify-es": "^3.0.0",
+    "jest": "^30.5.2",
+    "jest-environment-jsdom": "^30.5.2",
+    "jsdoc-to-markdown": "^9.1.3",
+    "merge-stream": "^2.0.0",
+    "neostandard": "^0.14.1",
+    "postcss": "^8.5.31",
+    "regenerator-runtime": "^0.14.1",
+    "sass": "^1.105.2",
+    "test-filesystem": "^2.0.2",
+    "through2": "^4.0.2",
+    "vinyl-source-stream": "^2.0.0"
+  },
+  "peerDependencies": {
+    "clean-jsdoc-theme": ">=4.0.0",
+    "gulp-imagemin": ">=9.0.0",
+    "jsdoc": ">=4.0.0",
+    "playwright": ">=1.40.0",
+    "typedoc": ">=0.28.0",
+    "typescript": ">=5.0.0 <7.0.0"
+  },
+  "peerDependenciesMeta": {
+    "clean-jsdoc-theme": {
+      "optional": true
+    },
+    "gulp-imagemin": {
+      "optional": true
+    },
+    "jsdoc": {
+      "optional": true
+    },
+    "playwright": {
+      "optional": true
+    },
+    "typedoc": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "files": [
+    "babel.config.js",
+    "dist",
+    "functions",
+    "gulpfile.base.js",
+    "gulpfile.base.mjs",
+    "gulp.config.js",
+    "gulp.config.mjs",
+    "jsdoc.base.js",
+    "jsdoc.esmExports.js"
+  ],
+  "funding": "https://www.paypal.com/donate/?business=LRYR6SZRWKXVY&no_recurring=0&item_name=Let%27s+build+together+today+to+simplify+our+jobs+tomorrow.&currency_code=CAD",
+  "devDependencies": {
+    "clean-jsdoc-theme": "^5.2.1",
+    "gulp-imagemin": "github:jheagle/gulp-imagemin#common-js-compatibility",
+    "jsdoc": "^4.0.5",
+    "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,
+    "esbuild": false
+  }
+}

package/dist/test-helpers/isolateGulpCache.js

@@ -1,25 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isolateGulpCache = void 0;
-var _gulpCache = _interopRequireDefault(require("gulp-cache"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * 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.
- */
-const isolateGulpCache = name => {
-  const fileCache = new _gulpCache.default.Cache({
-    cacheDirName: `js-build-tools-test-${name}`
-  });
-  _gulpCache.default.defaultOptions.fileCache = fileCache;
-  return () => new Promise((resolve, reject) => fileCache.clear(null, error => error ? reject(error) : resolve()));
-};
-exports.isolateGulpCache = isolateGulpCache;

package/functions/test-helpers/isolateGulpCache.mjs

@@ -1,16 +0,0 @@
-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()))
-}