js-build-tools 6.3.0 → 6.4.0

package/README.md

@@ -592,8 +592,8 @@ using `<script type="module">`, which no DOM-simulation library executes at all)
 `playwright` is an optional peer dependency, install it in your project with `npm install --save-dev playwright`,
 then fetch a real browser binary once per machine (not per project) with `npx playwright install chromium` - if
 that fails with "Playwright does not support chromium on <your distro>", your OS is too old for the current
-release; either upgrade it or pin an older `playwright` version known to still support it (confirmed: `1.48.0`
-still installs and runs real headless Chromium on Ubuntu 20.04, which the current release has dropped).
+release; either upgrade it or pin an older `playwright` version known to still support it (confirmed: `1.62.1`
+is the newest release that still installs and runs real headless Chromium on Ubuntu 20.04).
 
 ```js
 const { launchBrowser, serveStatic } = require('js-build-tools').partials
@@ -689,6 +689,7 @@ Export these functions to your own project to customize your build pipeline.
     * [.testQuick()](#module_js-build-tools.testQuick) ⇒ <code>Promise.&lt;\*&gt;</code>
     * [.testFull()](#module_js-build-tools.testFull) ⇒ <code>Promise.&lt;\*&gt;</code>
     * [.sourceLint()](#module_js-build-tools.sourceLint) ⇒ <code>\*</code>
+    * [.lint()](#module_js-build-tools.lint) ⇒ <code>\*</code>
     * [.images()](#module_js-build-tools.images) ⇒ <code>stream.Stream</code>
     * [.docs([done])](#module_js-build-tools.docs) ⇒ <code>\*</code>
     * [.distMinify()](#module_js-build-tools.distMinify) ⇒ <code>\*</code>
@@ -751,7 +752,13 @@ Run all tests with jest.
 <a name="module_js-build-tools.sourceLint"></a>
 
 ### js-build-tools.sourceLint() ⇒ <code>\*</code>
-Applies neostandard linting (js-build-tools' chosen style) to the real, hand-written source - not the compiled
+Applies neostandard linting (js-build-tools' chosen style) to the real, hand-written source - not the compiled
+
+**Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
+<a name="module_js-build-tools.lint"></a>
+
+### js-build-tools.lint() ⇒ <code>\*</code>
+The standalone lint command (`gulp lint`, or `npm run lint`): the same linting and fixing as sourceLint, but it
 
 **Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
 <a name="module_js-build-tools.images"></a>

package/dist/lint.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.lint = void 0;
+var _lintSource = require("./partials/lintSource.js");
+/**
+ * The standalone lint command (`gulp lint`, or `npm run lint`): the same linting and fixing as sourceLint, but it
+ * fails (exits non-zero) when any errors remain that neostandard could not fix automatically.
+ * @memberOf module:js-build-tools
+ * @returns {*}
+ */
+const lint = () => (0, _lintSource.lintSource)({
+  failOnError: true
+});
+exports.lint = lint;

package/dist/lint.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.lint=void 0;var _lintSource=require("./partials/lintSource.js");const lint=()=>(0,_lintSource.lintSource)({failOnError:!0});exports.lint=lint;

package/dist/partials/imagesFor.js

@@ -1,20 +1,19 @@
-"use strict";
-
-require("core-js/modules/esnext.weak-map.delete-all.js");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.loadImagemin = exports.imagesFor = void 0;
-var _gulpCache = _interopRequireDefault(require("gulp-cache"));
-var _loadPeer = require("./loadPeer.js");
-var _gulp = require("gulp");
-var _nodePath = _interopRequireDefault(require("node:path"));
-var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
-var cache;
-function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var r, c, a = Object.defineProperty, n = { __proto__: null, default: e }; if (Object(e) !== e) return n; if (cache || "function" != typeof WeakMap || (cache = new WeakMap()), cache) { if (cache.has(e)) return cache.get(e); cache.set(e, n); } for (c in e) "default" !== c && {}.hasOwnProperty.call(e, c) && ((r = a && Object.getOwnPropertyDescriptor(e, c)) && (r.get || r.set) ? a(n, c, r) : n[c] = e[c]); return n; }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const installHint = 'Add it to your project with: npm install --save-dev github:jheagle/gulp-imagemin#common-js-compatibility ' + '(the CommonJS-compatible fork - upstream gulp-imagemin is ESM-only and cannot be require()d by this package\'s CommonJS build).';
-
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.loadImagemin = exports.imagesFor = void 0;
+var _gulpCache = _interopRequireDefault(require("gulp-cache"));
+var _loadPeer = require("./loadPeer.js");
+var _gulp = require("gulp");
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+var cache;
+function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var r, c, a = Object.defineProperty, n = { __proto__: null, default: e }; if (Object(e) !== e) return n; if (cache || "function" != typeof WeakMap || (cache = new WeakMap()), cache) { if (cache.has(e)) return cache.get(e); cache.set(e, n); } for (c in e) "default" !== c && {}.hasOwnProperty.call(e, c) && ((r = a && Object.getOwnPropertyDescriptor(e, c)) && (r.get || r.set) ? a(n, c, r) : n[c] = e[c]); return n; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const installHint = 'Add it to your project with: npm install --save-dev github:jheagle/gulp-imagemin#common-js-compatibility ' + '(the CommonJS-compatible fork - upstream gulp-imagemin is ESM-only and cannot be require()d by this package\'s CommonJS build).';
+
 /**
  * Load `gulp-imagemin`, an optional peer dependency: image optimization is off by default and its binary-download
  * dependency chain is heavy, so it is only required once the images task actually runs, and it is resolved from the
@@ -23,36 +22,36 @@ const installHint = 'Add it to your project with: npm install --save-dev github:
  * @param {string} [projectPath=process.cwd()] - The project directory to resolve `gulp-imagemin` from.
  * @returns {Function} The gulp-imagemin plugin factory.
  * @throws {Error} With install instructions when gulp-imagemin is missing or is the ESM-only upstream release.
- */
-const loadImagemin = (projectPath = process.cwd()) => {
-  const loaded = (0, _loadPeer.requirePeer)('gulp-imagemin', {
-    task: 'images',
-    installHint,
-    esmOnlyMessage: `gulp-imagemin could not be loaded because it is ESM-only. ${installHint}`,
-    projectPath
-  });
-  return loaded && (loaded.__esModule || loaded.default) ? loaded.default : loaded;
-};
-
+ */
+const loadImagemin = (projectPath = process.cwd()) => {
+  const loaded = (0, _loadPeer.requirePeer)('gulp-imagemin', {
+    task: 'images',
+    installHint,
+    esmOnlyMessage: `gulp-imagemin could not be loaded because it is ESM-only. ${installHint}`,
+    projectPath
+  });
+  return loaded && (loaded.__esModule || loaded.default) ? loaded.default : loaded;
+};
+
 /**
  * Move and optimize images into the browser directory.
  * @memberOf module:partials
  * @param {string|array} [imageSrc=src/images/pattern]
  * @param {string} [imageDest=dest/image/folder]
  * @return {stream.Stream}
- */
-exports.loadImagemin = loadImagemin;
-const imagesFor = (imageSrc = gulpConfig.get('images.from'), imageDest = gulpConfig.get('images.to')) => {
-  const imagemin = loadImagemin();
-  // Gulp 5 reads files as utf8 text unless told otherwise, which corrupts binary images (and makes gulp-cache drop them).
-  return (0, _gulp.src)(imageSrc, {
-    encoding: false
-  }).pipe(
-  // Caching images that ran through imagemin
-  (0, _gulpCache.default)(imagemin({
-    interlaced: true,
-    silent: true,
-    verbose: false
-  }))).pipe((0, _gulp.dest)(imageDest));
-};
+ */
+exports.loadImagemin = loadImagemin;
+const imagesFor = (imageSrc = gulpConfig.get('images.from'), imageDest = gulpConfig.get('images.to')) => {
+  const imagemin = loadImagemin();
+  // Gulp 5 reads files as utf8 text unless told otherwise, which corrupts binary images (and makes gulp-cache drop them).
+  return (0, _gulp.src)(imageSrc, {
+    encoding: false
+  }).pipe(
+  // Caching images that ran through imagemin
+  (0, _gulpCache.default)(imagemin({
+    interlaced: true,
+    silent: true,
+    verbose: false
+  }))).pipe((0, _gulp.dest)(imageDest));
+};
 exports.imagesFor = imagesFor;

package/dist/partials/jsdocDocsFor.js

@@ -136,11 +136,13 @@ const jsdocDocsFor = (srcPath = gulpConfig.get('docs.from'), outPath = gulpConfi
           // quick-start example, which sets this explicitly, not assumed from jsdoc's own classic defaults.
           recurse: true,
           template: themeDir,
-          // clean-jsdoc-theme's own option for the name in its header. Given as a link: a plain-text title links to the
-          // site root ("/"), while every page is in one folder, so index.html is the home page wherever they are served
+          // clean-jsdoc-theme's own options for the name in its header and the home page's <title> (otherwise "Home").
+          // The header is given as a link: a plain-text title links to the site root ("/"), while every page is in one
+          // folder, so index.html is the home page wherever they are served. Both are printed unescaped by the theme.
           ...(title ? {
             theme_opts: {
-              title: `<a href="index.html" class="sidebar-title sidebar-title-anchor">${escapeHtml(title)}</a>`
+              title: `<a href="index.html" class="sidebar-title sidebar-title-anchor">${escapeHtml(title)}</a>`,
+              homepageTitle: escapeHtml(title)
             }
           } : {}),
           ...(indexFile && _nodeFs.default.existsSync(indexFile) ? {

package/dist/partials/lintSource.js

@@ -0,0 +1,41 @@
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.lintSource = void 0;
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+var _gulp = require("gulp");
+var _neostandardLint = require("./neostandardLint.js");
+var cache;
+function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var r, c, a = Object.defineProperty, n = { __proto__: null, default: e }; if (Object(e) !== e) return n; if (cache || "function" != typeof WeakMap || (cache = new WeakMap()), cache) { if (cache.has(e)) return cache.get(e); cache.set(e, n); } for (c in e) "default" !== c && {}.hasOwnProperty.call(e, c) && ((r = a && Object.getOwnPropertyDescriptor(e, c)) && (r.get || r.set) ? a(n, c, r) : n[c] = e[c]); return n; }
+/**
+ * Lint the project's source (srcPath: .js, .mjs and .cjs, plus .ts when typescript.enabled) with neostandard and
+ * write the automatic fixes back in place. Shared by the sourceLint (build) and lint (standalone) tasks.
+ * @memberOf module:partials
+ * @param {Object} [options={}]
+ * @param {boolean} [options.failOnError=false] - Fail once linting finishes if any errors could not be fixed.
+ * @returns {stream.Stream}
+ */
+const lintSource = ({
+  failOnError = false
+} = {}) => {
+  const srcPath = gulpConfig.get('srcPath');
+  const ts = gulpConfig.get('typescript.enabled');
+  const patterns = [`${srcPath}/**/*.{js,mjs,cjs}`];
+  if (ts) {
+    patterns.push(`${srcPath}/**/*.ts`);
+  }
+  const linter = (0, _neostandardLint.neostandardLint)({
+    fix: true,
+    ts,
+    rules: gulpConfig.get('lint.rules'),
+    failOnError
+  });
+  const written = (0, _gulp.src)(patterns).pipe(linter).pipe((0, _gulp.dest)(srcPath));
+  // pipe() does not forward errors, and gulp only watches the returned stream, so pass the linter's failure along.
+  linter.on('error', error => written.emit('error', error));
+  return written;
+};
+exports.lintSource = lintSource;

package/dist/partials/loadPeer.js

@@ -1,34 +1,35 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.requirePeer = exports.importPeer = exports.importModule = void 0;
-require("core-js/modules/es.array.includes.js");
-var _nodeModule = require("node:module");
-var _nodePath = _interopRequireDefault(require("node:path"));
-var _nodeUrl = require("node:url");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// Several dependencies ship ESM-only (standard, gulp-ts-compile, typedoc), but this package also publishes a CommonJS
-// build (dist/*.js) whose babel transform would turn even a dynamic import() into a require() that cannot load an ES
-// module. Hiding the import() inside a Function constructor keeps it a genuine dynamic import that works from either
-// build, because babel cannot see (and so cannot rewrite) an import expression which only exists as a runtime string.
-const dynamicImport = new Function('specifier', 'return import(specifier)');
-
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.requirePeer = exports.importPeer = exports.importModule = void 0;
+require("core-js/modules/es.array.includes.js");
+var _nodeModule = require("node:module");
+var _nodePath = _interopRequireDefault(require("node:path"));
+var _nodeUrl = require("node:url");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Several dependencies ship ESM-only (standard, gulp-ts-compile, typedoc), but this package also publishes a CommonJS
+// build (dist/*.js) whose babel transform would turn even a dynamic import() into a require() that cannot load an ES
+// module. Hiding the import() inside a Function constructor keeps it a genuine dynamic import that works from either
+// build, because babel cannot see (and so cannot rewrite) an import expression which only exists as a runtime string.
+// eslint-disable-next-line no-new-func -- deliberate, see above
+const dynamicImport = new Function('specifier', 'return import(specifier)');
+
 /**
  * Import an ES module (or any module) with a real dynamic import(), whichever build (ESM or CommonJS) this runs from.
  * @memberOf module:partials
  * @param {string} specifier - The package name, or the URL of a file.
  * @returns {Promise<Object>} The module namespace.
- */
-const importModule = specifier => dynamicImport(specifier);
-exports.importModule = importModule;
-const isMissing = (error, name) => error.code === 'MODULE_NOT_FOUND' && error.message.includes(`'${name}'`);
-const notInstalled = (name, {
-  task,
-  installHint
-}) => new Error(`The ${task} task needs the optional peer dependency ${name}, which is not installed. ${installHint}`);
-
+ */
+const importModule = specifier => dynamicImport(specifier);
+exports.importModule = importModule;
+const isMissing = (error, name) => error.code === 'MODULE_NOT_FOUND' && error.message.includes(`'${name}'`);
+const notInstalled = (name, {
+  task,
+  installHint
+}) => new Error(`The ${task} task needs the optional peer dependency ${name}, which is not installed. ${installHint}`);
+
 /**
  * Load an optional peer dependency (one which is only needed once a task runs, so projects which never use that task
  * do not have to install it) with require(), from the project being built rather than from this package. When it is
@@ -42,29 +43,29 @@ const notInstalled = (name, {
  * @param {string} [options.projectPath=process.cwd()] - The folder of the project (which has the package.json) being built.
  * @returns {*} Whatever the package exports.
  * @throws {Error} With install instructions when the package is not installed.
- */
-const requirePeer = (name, {
-  task,
-  installHint,
-  esmOnlyMessage,
-  projectPath = process.cwd()
-}) => {
-  try {
-    return (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json'))(name);
-  } catch (error) {
-    if (isMissing(error, name)) {
-      throw notInstalled(name, {
-        task,
-        installHint
-      });
-    }
-    if (error.code === 'ERR_REQUIRE_ESM' && esmOnlyMessage) {
-      throw new Error(esmOnlyMessage);
-    }
-    throw error;
-  }
-};
-
+ */
+const requirePeer = (name, {
+  task,
+  installHint,
+  esmOnlyMessage,
+  projectPath = process.cwd()
+}) => {
+  try {
+    return (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json'))(name);
+  } catch (error) {
+    if (isMissing(error, name)) {
+      throw notInstalled(name, {
+        task,
+        installHint
+      });
+    }
+    if (error.code === 'ERR_REQUIRE_ESM' && esmOnlyMessage) {
+      throw new Error(esmOnlyMessage);
+    }
+    throw error;
+  }
+};
+
 /**
  * Import an optional peer dependency which ships ESM-only, from the project being built. See {@link requirePeer}.
  * @memberOf module:partials
@@ -75,25 +76,25 @@ const requirePeer = (name, {
  * @param {string} [options.projectPath=process.cwd()] - The folder of the project (which has the package.json) being built.
  * @returns {Promise<Object>} The module namespace.
  * @throws {Error} With install instructions when the package is not installed.
- */
-exports.requirePeer = requirePeer;
-const importPeer = async (name, {
-  task,
-  installHint,
-  projectPath = process.cwd()
-}) => {
-  let resolved;
-  try {
-    resolved = (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json')).resolve(name);
-  } catch (error) {
-    if (isMissing(error, name)) {
-      throw notInstalled(name, {
-        task,
-        installHint
-      });
-    }
-    throw error;
-  }
-  return importModule((0, _nodeUrl.pathToFileURL)(resolved).href);
-};
+ */
+exports.requirePeer = requirePeer;
+const importPeer = async (name, {
+  task,
+  installHint,
+  projectPath = process.cwd()
+}) => {
+  let resolved;
+  try {
+    resolved = (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json')).resolve(name);
+  } catch (error) {
+    if (isMissing(error, name)) {
+      throw notInstalled(name, {
+        task,
+        installHint
+      });
+    }
+    throw error;
+  }
+  return importModule((0, _nodeUrl.pathToFileURL)(resolved).href);
+};
 exports.importPeer = importPeer;

package/dist/partials/minifyFor.js

@@ -1,21 +1,21 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.minifyFor = void 0;
-var _gulp = require("gulp");
-var _gulpUglifyEs = _interopRequireDefault(require("gulp-uglify-es"));
-var _gulpRename = _interopRequireDefault(require("gulp-rename"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const uglify = _gulpUglifyEs.default.hasOwnProperty('default') ? _gulpUglifyEs.default.default : _gulpUglifyEs.default;
-
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.minifyFor = void 0;
+var _gulp = require("gulp");
+var _gulpUglifyEs = _interopRequireDefault(require("gulp-uglify-es"));
+var _gulpRename = _interopRequireDefault(require("gulp-rename"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+const uglify = Object.hasOwn(_gulpUglifyEs.default, 'default') ? _gulpUglifyEs.default.default : _gulpUglifyEs.default;
+
 /**
  * Minify files and rename the output with '.min' extension.
  * @memberOf module:partials
  * @returns {*}
- */
-const minifyFor = (srcSearch, destination) => (0, _gulp.src)(srcSearch).pipe(uglify()).pipe((0, _gulpRename.default)({
-  extname: '.min.js'
-})).pipe((0, _gulp.dest)(destination));
+ */
+const minifyFor = (srcSearch, destination) => (0, _gulp.src)(srcSearch).pipe(uglify()).pipe((0, _gulpRename.default)({
+  extname: '.min.js'
+})).pipe((0, _gulp.dest)(destination));
 exports.minifyFor = minifyFor;