js-build-tools 5.3.1 → 5.3.2

package/README.md

@@ -444,7 +444,9 @@ module.exports = babelConfig
 the readme it generates. Instead, this can generate HTML documentation straight from the TypeScript source with
 [TypeDoc](https://typedoc.org/). Every folder in your source directory becomes a module of the documentation, the default
 export of each file (one function per file) is listed under the name of the file, and everything else a file exports (for
-example the types in a `types.ts`) is listed as it is. Index files, tests and declaration files are left out. The
+example the types in a `types.ts`) is listed as it is. Index files, tests and declaration files are left out. A file
+which sits directly in the source directory, beside the folders, is a module of its own (unless it is `index` or
+`main`). The first comment of a folder's `index.ts` (or the header comment of such a file) describes its module. The
 comments on your code are the documentation, and the types come from the code itself, so `@module`, `@memberOf`,
 `@typedef` and the `{Type}` of `@param` are not needed.
 

package/dist/partials/imagesFor.js

@@ -1,19 +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"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-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 _nodePath = _interopRequireDefault(require("node:path"));
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+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
@@ -22,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/loadPeer.js

@@ -1,34 +1,34 @@
-"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.
+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 +42,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 +75,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/standardLint.js

@@ -1,38 +1,38 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.standardLint = void 0;
-require("core-js/modules/esnext.iterator.constructor.js");
-require("core-js/modules/esnext.iterator.for-each.js");
-var _nodePath = _interopRequireDefault(require("node:path"));
-var _through = _interopRequireDefault(require("through2"));
-var _loadPeer = require("./loadPeer.js");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// `standard` (17+) ships ESM-only, see importModule for how it is imported.
-const importStandard = () => (0, _loadPeer.importModule)('standard');
-
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.standardLint = void 0;
+require("core-js/modules/esnext.iterator.constructor.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+var _nodePath = _interopRequireDefault(require("node:path"));
+var _through = _interopRequireDefault(require("through2"));
+var _loadPeer = require("./loadPeer.js");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// `standard` (17+) ships ESM-only, see importModule for how it is imported.
+const importStandard = () => (0, _loadPeer.importModule)('standard');
+
 /**
  * Print a file's lint messages, if it has any.
  * @memberOf module:partials
  * @param {import('vinyl')} file
  * @param {{messages: Array<{line: number, column: number, message: string}>, errorCount: number, warningCount: number}} result
  * @returns {undefined}
- */
-const printFileReport = (file, result) => {
-  if (!result.messages.length) {
-    return;
-  }
-  console.log(_nodePath.default.relative(file.cwd, file.path));
-  result.messages.forEach(({
-    line,
-    column,
-    message
-  }) => console.log(`line ${line}:${column}\t${message}`));
-  console.log(`✖ ${result.errorCount} error\t⚠ ${result.warningCount} warning\n`);
-};
-
+ */
+const printFileReport = (file, result) => {
+  if (!result.messages.length) {
+    return;
+  }
+  console.log(_nodePath.default.relative(file.cwd, file.path));
+  result.messages.forEach(({
+    line,
+    column,
+    message
+  }) => console.log(`line ${line}:${column}\t${message}`));
+  console.log(`✖ ${result.errorCount} error\t⚠ ${result.warningCount} warning\n`);
+};
+
 /**
  * Lint every file streaming through with JavaScript Standard Style and, unless `fix` is false, apply the automatic
  * fixes to the file's contents so a following `dest()` writes the fixed version. Remaining problems are printed
@@ -47,48 +47,48 @@ const printFileReport = (file, result) => {
  * should never need to pass this - it exists so tests can supply a stand-in, since this project's
  * CommonJS-transform-based Jest setup cannot execute a real dynamic import() of an ES module.
  * @returns {import('stream').Transform}
- */
-const standardLint = ({
-  fix = true
-} = {}, loadStandard = () => importStandard().then(({
-  default: standard
-}) => standard)) => {
-  const totals = {
-    errors: 0,
-    warnings: 0
-  };
-  return _through.default.obj(function (file, enc, callback) {
-    if (file.isNull()) {
-      callback(null, file);
-      return;
-    }
-    if (file.isStream()) {
-      callback(new Error('standardLint: streaming file contents are not supported.'));
-      return;
-    }
-    loadStandard().then(standard => standard.lintText(file.contents.toString(), {
-      filename: file.path,
-      cwd: file.cwd,
-      fix
-    })).then(results => {
-      // No result at all means the file is ignored by the project's Standard configuration.
-      const [result] = results;
-      if (result) {
-        if (typeof result.output === 'string') {
-          file.contents = Buffer.from(result.output);
-        }
-        totals.errors += result.errorCount;
-        totals.warnings += result.warningCount;
-        printFileReport(file, result);
-      }
-      callback(null, file);
-    }, callback);
-  }, function (callback) {
-    console.log('Standard linter results');
-    console.log('======================================');
-    console.log(`✖ Errors total: ${totals.errors}`);
-    console.log(`⚠ Warnings total: ${totals.warnings}\n`);
-    callback();
-  });
-};
+ */
+const standardLint = ({
+  fix = true
+} = {}, loadStandard = () => importStandard().then(({
+  default: standard
+}) => standard)) => {
+  const totals = {
+    errors: 0,
+    warnings: 0
+  };
+  return _through.default.obj(function (file, enc, callback) {
+    if (file.isNull()) {
+      callback(null, file);
+      return;
+    }
+    if (file.isStream()) {
+      callback(new Error('standardLint: streaming file contents are not supported.'));
+      return;
+    }
+    loadStandard().then(standard => standard.lintText(file.contents.toString(), {
+      filename: file.path,
+      cwd: file.cwd,
+      fix
+    })).then(results => {
+      // No result at all means the file is ignored by the project's Standard configuration.
+      const [result] = results;
+      if (result) {
+        if (typeof result.output === 'string') {
+          file.contents = Buffer.from(result.output);
+        }
+        totals.errors += result.errorCount;
+        totals.warnings += result.warningCount;
+        printFileReport(file, result);
+      }
+      callback(null, file);
+    }, callback);
+  }, function (callback) {
+    console.log('Standard linter results');
+    console.log('======================================');
+    console.log(`✖ Errors total: ${totals.errors}`);
+    console.log(`⚠ Warnings total: ${totals.warnings}\n`);
+    callback();
+  });
+};
 exports.standardLint = standardLint;

package/dist/partials/tsFor.js

@@ -1,27 +1,27 @@
-"use strict";
-
-require("core-js/modules/esnext.weak-map.delete-all.js");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.tsFor = exports.loadTypescript = void 0;
-var _gulp = require("gulp");
-var _nodePath = _interopRequireDefault(require("node:path"));
-var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
-var _loadPeer = require("./loadPeer.js");
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// gulp-ts-compile ships ESM-only (no CJS build - see its own package.json), see importModule for how it is imported.
-const importGulpTsCompile = () => (0, _loadPeer.importModule)('gulp-ts-compile');
-
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.tsFor = exports.loadTypescript = void 0;
+var _gulp = require("gulp");
+var _nodePath = _interopRequireDefault(require("node:path"));
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+var _loadPeer = require("./loadPeer.js");
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// gulp-ts-compile ships ESM-only (no CJS build - see its own package.json), see importModule for how it is imported.
+const importGulpTsCompile = () => (0, _loadPeer.importModule)('gulp-ts-compile');
+
 /**
  * Wrap a stream in a promise that resolves once it finishes writing.
  * @memberOf module:partials
  * @param {import('node:stream').Stream} stream
  * @returns {Promise<void>}
- */
-const installHint = 'Install it in your project with: npm install --save-dev typescript';
-
+ */
+const installHint = 'Install it in your project with: npm install --save-dev typescript';
+
 /**
  * Load the project's own copy of TypeScript (an optional peer dependency, only needed when the typescript task is
  * enabled) from the project being built, so projects which do not use TypeScript never need it installed.
@@ -29,18 +29,18 @@ const installHint = 'Install it in your project with: npm install --save-dev typ
  * @param {string} [projectPath=process.cwd()] The folder of the project (which has the package.json) being built.
  * @returns {Object} The TypeScript compiler API module.
  * @throws {Error} With install instructions when typescript is not installed.
- */
-const loadTypescript = (projectPath = process.cwd()) => (0, _loadPeer.requirePeer)('typescript', {
-  task: 'typescript',
-  installHint,
-  projectPath
-});
-exports.loadTypescript = loadTypescript;
-const streamToPromise = stream => new Promise((resolve, reject) => {
-  stream.on('finish', resolve);
-  stream.on('error', reject);
-});
-
+ */
+const loadTypescript = (projectPath = process.cwd()) => (0, _loadPeer.requirePeer)('typescript', {
+  task: 'typescript',
+  installHint,
+  projectPath
+});
+exports.loadTypescript = loadTypescript;
+const streamToPromise = stream => new Promise((resolve, reject) => {
+  stream.on('finish', resolve);
+  stream.on('error', reject);
+});
+
 /**
  * Read a tsconfig.json file into real typescript.CompilerOptions values, using only TypeScript's stable, current,
  * public config-reading API (the same one `tsc --project` itself uses internally) - never
@@ -49,13 +49,13 @@ const streamToPromise = stream => new Promise((resolve, reject) => {
  * @memberOf module:partials
  * @param {string} configPath - Path to a tsconfig.json file.
  * @returns {import('typescript').CompilerOptions}
- */
-const readCompilerOptions = (ts, configPath) => {
-  const configFile = ts.readConfigFile(configPath, ts.sys.readFile);
-  const parsedConfig = ts.parseJsonConfigFileContent(configFile.config, ts.sys, _nodePath.default.dirname(configPath));
-  return parsedConfig.options;
-};
-
+ */
+const readCompilerOptions = (ts, configPath) => {
+  const configFile = ts.readConfigFile(configPath, ts.sys.readFile);
+  const parsedConfig = ts.parseJsonConfigFileContent(configFile.config, ts.sys, _nodePath.default.dirname(configPath));
+  return parsedConfig.options;
+};
+
 /**
  * Starting at the source directory, find all the ts files and convert them into the distribution directory.
  * @memberOf module:partials
@@ -68,36 +68,36 @@ const readCompilerOptions = (ts, configPath) => {
  * suite already covers real TypeScript-compile correctness - this function's own tests only need to verify its
  * config resolution and stream wiring.
  * @returns {Function}
- */
-const tsFor = (srcPath = gulpConfig.get('typescript.from'), distPath = gulpConfig.get('typescript.to'), loadTsCompile = () => importGulpTsCompile().then(({
-  default: tsCompile
-}) => tsCompile)) => {
-  if (gulpConfig.get('typescript.enabled') === false) {
-    return () => {};
-  }
-  const ts = loadTypescript();
-  const configPath = gulpConfig.get('typescript.config');
-  // When no tsconfig.json is configured, target/module are pinned explicitly rather than left for TypeScript's
-  // own compiler defaults - those defaults have already shifted once across a TypeScript version bump in this
-  // project's own history (silently changing whether output keeps `const`/`let` or downlevels to `var`), and
-  // pinning them keeps this task's output stable across future TypeScript upgrades too. ES5/CommonJS matches
-  // what the downstream babel/browserify bundling pipeline has always assumed it receives.
-  const compilerOptions = configPath ? readCompilerOptions(ts, configPath) : {
-    declaration: true,
-    target: ts.ScriptTarget.ES5,
-    module: ts.ModuleKind.CommonJS,
-    esModuleInterop: false
-  };
-  // Accepts gulp's own callback-style task convention (an optional `done`, called once finished) rather than
-  // just returning a Promise, since callers may invoke the returned function directly with a callback instead
-  // of relying on gulp's own runner to observe a returned Promise.
-  return done => {
-    const compile = async () => {
-      const tsCompile = await loadTsCompile();
-      const tsResult = (0, _gulp.src)(srcPath).pipe(tsCompile(compilerOptions));
-      await Promise.all([streamToPromise(tsResult.dts.pipe((0, _gulp.dest)(distPath))), streamToPromise(tsResult.js.pipe((0, _gulp.dest)(distPath)))]);
-    };
-    return typeof done === 'function' ? compile().then(() => done(), done) : compile();
-  };
-};
+ */
+const tsFor = (srcPath = gulpConfig.get('typescript.from'), distPath = gulpConfig.get('typescript.to'), loadTsCompile = () => importGulpTsCompile().then(({
+  default: tsCompile
+}) => tsCompile)) => {
+  if (gulpConfig.get('typescript.enabled') === false) {
+    return () => {};
+  }
+  const ts = loadTypescript();
+  const configPath = gulpConfig.get('typescript.config');
+  // When no tsconfig.json is configured, target/module are pinned explicitly rather than left for TypeScript's
+  // own compiler defaults - those defaults have already shifted once across a TypeScript version bump in this
+  // project's own history (silently changing whether output keeps `const`/`let` or downlevels to `var`), and
+  // pinning them keeps this task's output stable across future TypeScript upgrades too. ES5/CommonJS matches
+  // what the downstream babel/browserify bundling pipeline has always assumed it receives.
+  const compilerOptions = configPath ? readCompilerOptions(ts, configPath) : {
+    declaration: true,
+    target: ts.ScriptTarget.ES5,
+    module: ts.ModuleKind.CommonJS,
+    esModuleInterop: false
+  };
+  // Accepts gulp's own callback-style task convention (an optional `done`, called once finished) rather than
+  // just returning a Promise, since callers may invoke the returned function directly with a callback instead
+  // of relying on gulp's own runner to observe a returned Promise.
+  return done => {
+    const compile = async () => {
+      const tsCompile = await loadTsCompile();
+      const tsResult = (0, _gulp.src)(srcPath).pipe(tsCompile(compilerOptions));
+      await Promise.all([streamToPromise(tsResult.dts.pipe((0, _gulp.dest)(distPath))), streamToPromise(tsResult.js.pipe((0, _gulp.dest)(distPath)))]);
+    };
+    return typeof done === 'function' ? compile().then(() => done(), done) : compile();
+  };
+};
 exports.tsFor = tsFor;

package/dist/partials/typeDocsFor.js

@@ -4,7 +4,7 @@ require("core-js/modules/esnext.weak-map.delete-all.js");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.writeDocEntries = exports.typeDocsFor = exports.loadTypeDoc = exports.describeFolder = exports.describeExports = void 0;
+exports.writeDocEntries = exports.typeDocsFor = exports.loadTypeDoc = exports.describeFolder = exports.describeFile = exports.describeExports = void 0;
 require("core-js/modules/es.json.stringify.js");
 require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.filter.js");
@@ -102,7 +102,20 @@ const describeExports = (ts, filePath) => {
 exports.describeExports = describeExports;
 const describeFolder = folderPath => {
   const indexFile = ['index.ts', 'index.tsx', 'index.mts', 'index.cts'].map(name => _nodePath.default.join(folderPath, name)).find(file => _nodeFs.default.existsSync(file));
-  const comment = indexFile && _nodeFs.default.readFileSync(indexFile, 'utf8').match(/^\s*\/\*\*([\s\S]*?)\*\//);
+  return indexFile ? describeFile(indexFile) : '';
+};
+
+/**
+ * The description of a source file for its module: its first doc comment without the tags (@module, @file, ...), when
+ * that comment is a header (it is followed by an import or export, so it does not document a declaration itself), or
+ * an empty string.
+ * @memberOf module:partials
+ * @param {string} filePath
+ * @returns {string}
+ */
+exports.describeFolder = describeFolder;
+const describeFile = filePath => {
+  const comment = _nodeFs.default.readFileSync(filePath, 'utf8').match(/^\s*\/\*\*([\s\S]*?)\*\/\s*(import\b|export\s+(\*|\{[^}]*\}\s+from)|$)/);
   if (!comment) {
     return '';
   }
@@ -116,14 +129,16 @@ const describeFolder = folderPath => {
  * entry file, so the modules of the documentation mirror the folders. The default export of each source file is
  * re-exported under the name of the file (the source files hold one function each), and anything else a file exports
  * is re-exported as it is (that is where the types.ts files go). Index files (the barrels), tests and declaration
- * files are left out, but the first doc comment of a folder's index file becomes the description of its module. A source directory with no folders gets a single entry called index.
+ * files are left out, but the first doc comment of a folder's index file becomes the description of its module.
+ * A file which sits beside the folders (not an index or main file) is a module of its own, described by its header
+ * comment. A source directory with no folders gets a single entry called index.
  * @memberOf module:partials
  * @param {Object} ts - The TypeScript compiler API.
  * @param {string} srcDir - The directory holding the TypeScript source.
  * @param {string} entryDir - The directory to write the entry files into.
  * @returns {Array<string>} The paths of the entry files.
  */
-exports.describeFolder = describeFolder;
+exports.describeFile = describeFile;
 const writeDocEntries = (ts, srcDir, entryDir) => {
   const absoluteSrc = _nodePath.default.resolve(srcDir);
   _nodeFs.default.mkdirSync(entryDir, {
@@ -136,10 +151,19 @@ const writeDocEntries = (ts, srcDir, entryDir) => {
     path: _nodePath.default.join(absoluteSrc, entry.name),
     files: listSources(_nodePath.default.join(absoluteSrc, entry.name))
   })).filter(folder => folder.files.length);
-  const groups = folders.length ? folders : [{
+  const rootFiles = _nodeFs.default.readdirSync(absoluteSrc, {
+    withFileTypes: true
+  }).filter(entry => entry.isFile() && isSource(entry.name) && !/^(index|main)\./.test(entry.name)).map(entry => _nodePath.default.join(absoluteSrc, entry.name));
+  // Folders make modules, and so do the files which sit beside them (except the barrel: index and main). A source
+  // directory with no folders gets a single module called index which holds its files.
+  const groups = folders.length ? [...folders, ...rootFiles.map(file => ({
+    name: toIdentifier(_nodePath.default.basename(file).replace(/\.[cm]?tsx?$/, '')),
+    files: [file],
+    description: describeFile(file)
+  })).filter(group => !folders.some(folder => folder.name === group.name))] : [{
     name: 'index',
     path: absoluteSrc,
-    files: listSources(absoluteSrc).filter(file => !/^(index|main)\./.test(_nodePath.default.basename(file)))
+    files: rootFiles
   }];
   return groups.map(group => {
     const lines = group.files.filter(file => !/^index\./.test(_nodePath.default.basename(file))).sort().flatMap(file => {
@@ -151,7 +175,7 @@ const writeDocEntries = (ts, srcDir, entryDir) => {
       const fileName = _nodePath.default.basename(file).replace(/\.[cm]?tsx?$/, '');
       return [...(hasDefault ? [`export { default as ${toIdentifier(fileName)} } from '${modulePath}'`] : []), ...(hasNamed ? [`export * from '${modulePath}'`] : [])];
     });
-    const description = group.path ? describeFolder(group.path) : '';
+    const description = group.description ?? (group.path ? describeFolder(group.path) : '');
     // TypeDoc takes the first comment of an entry file which has the @module tag as the description of the module
     const moduleComment = description ? `/**\n${description.split('\n').map(line => ` * ${line}`.trimEnd()).join('\n')}\n * @module\n */\n\n` : '';
     const entryPath = _nodePath.default.join(entryDir, `${group.name}.ts`);

package/dist/partials.js

@@ -1,136 +1,136 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-Object.defineProperty(exports, 'addToReadme', {
-  enumerable: true,
-  get: function () {
-    return _addToReadme.addToReadme
-  }
-})
-Object.defineProperty(exports, 'beginWatcher', {
-  enumerable: true,
-  get: function () {
-    return _beginWatcher.beginWatcher
-  }
-})
-Object.defineProperty(exports, 'clean', {
-  enumerable: true,
-  get: function () {
-    return _clean.clean
-  }
-})
-Object.defineProperty(exports, 'copyFor', {
-  enumerable: true,
-  get: function () {
-    return _copyFor.copyFor
-  }
-})
-Object.defineProperty(exports, 'distFor', {
-  enumerable: true,
-  get: function () {
-    return _distFor.distFor
-  }
-})
-Object.defineProperty(exports, 'distForSrc', {
-  enumerable: true,
-  get: function () {
-    return _distForSrc.distForSrc
-  }
-})
-Object.defineProperty(exports, 'distSeries', {
-  enumerable: true,
-  get: function () {
-    return _distSeries.distSeries
-  }
-})
-Object.defineProperty(exports, 'imagesFor', {
-  enumerable: true,
-  get: function () {
-    return _imagesFor.imagesFor
-  }
-})
-Object.defineProperty(exports, 'importModule', {
-  enumerable: true,
-  get: function () {
-    return _loadPeer.importModule
-  }
-})
-Object.defineProperty(exports, 'importPeer', {
-  enumerable: true,
-  get: function () {
-    return _loadPeer.importPeer
-  }
-})
-Object.defineProperty(exports, 'minifyFor', {
-  enumerable: true,
-  get: function () {
-    return _minifyFor.minifyFor
-  }
-})
-Object.defineProperty(exports, 'readmeTemplate', {
-  enumerable: true,
-  get: function () {
-    return _readmeTemplate.readmeTemplate
-  }
-})
-Object.defineProperty(exports, 'removeDirectory', {
-  enumerable: true,
-  get: function () {
-    return _removeDirectory.removeDirectory
-  }
-})
-Object.defineProperty(exports, 'requirePeer', {
-  enumerable: true,
-  get: function () {
-    return _loadPeer.requirePeer
-  }
-})
-Object.defineProperty(exports, 'runOnChange', {
-  enumerable: true,
-  get: function () {
-    return _runOnChange.runOnChange
-  }
-})
-Object.defineProperty(exports, 'sassFor', {
-  enumerable: true,
-  get: function () {
-    return _sassFor.sassFor
-  }
-})
-Object.defineProperty(exports, 'standardLint', {
-  enumerable: true,
-  get: function () {
-    return _standardLint.standardLint
-  }
-})
-Object.defineProperty(exports, 'tsFor', {
-  enumerable: true,
-  get: function () {
-    return _tsFor.tsFor
-  }
-})
-Object.defineProperty(exports, 'typeDocsFor', {
-  enumerable: true,
-  get: function () {
-    return _typeDocsFor.typeDocsFor
-  }
-})
-var _addToReadme = require('./partials/addToReadme.js')
-var _beginWatcher = require('./partials/beginWatcher.js')
-var _clean = require('./partials/clean.js')
-var _copyFor = require('./partials/copyFor.js')
-var _distFor = require('./partials/distFor.js')
-var _distForSrc = require('./partials/distForSrc.js')
-var _distSeries = require('./partials/distSeries.js')
-var _imagesFor = require('./partials/imagesFor.js')
-var _loadPeer = require('./partials/loadPeer.js')
-var _minifyFor = require('./partials/minifyFor.js')
-var _readmeTemplate = require('./partials/readmeTemplate.js')
-var _removeDirectory = require('./partials/removeDirectory.js')
-var _runOnChange = require('./partials/runOnChange.js')
-var _sassFor = require('./partials/sassFor.js')
-var _standardLint = require('./partials/standardLint.js')
-var _tsFor = require('./partials/tsFor.js')
-var _typeDocsFor = require('./partials/typeDocsFor.js')
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+Object.defineProperty(exports, 'addToReadme', {
+  enumerable: true,
+  get: function () {
+    return _addToReadme.addToReadme
+  }
+})
+Object.defineProperty(exports, 'beginWatcher', {
+  enumerable: true,
+  get: function () {
+    return _beginWatcher.beginWatcher
+  }
+})
+Object.defineProperty(exports, 'clean', {
+  enumerable: true,
+  get: function () {
+    return _clean.clean
+  }
+})
+Object.defineProperty(exports, 'copyFor', {
+  enumerable: true,
+  get: function () {
+    return _copyFor.copyFor
+  }
+})
+Object.defineProperty(exports, 'distFor', {
+  enumerable: true,
+  get: function () {
+    return _distFor.distFor
+  }
+})
+Object.defineProperty(exports, 'distForSrc', {
+  enumerable: true,
+  get: function () {
+    return _distForSrc.distForSrc
+  }
+})
+Object.defineProperty(exports, 'distSeries', {
+  enumerable: true,
+  get: function () {
+    return _distSeries.distSeries
+  }
+})
+Object.defineProperty(exports, 'imagesFor', {
+  enumerable: true,
+  get: function () {
+    return _imagesFor.imagesFor
+  }
+})
+Object.defineProperty(exports, 'importModule', {
+  enumerable: true,
+  get: function () {
+    return _loadPeer.importModule
+  }
+})
+Object.defineProperty(exports, 'importPeer', {
+  enumerable: true,
+  get: function () {
+    return _loadPeer.importPeer
+  }
+})
+Object.defineProperty(exports, 'minifyFor', {
+  enumerable: true,
+  get: function () {
+    return _minifyFor.minifyFor
+  }
+})
+Object.defineProperty(exports, 'readmeTemplate', {
+  enumerable: true,
+  get: function () {
+    return _readmeTemplate.readmeTemplate
+  }
+})
+Object.defineProperty(exports, 'removeDirectory', {
+  enumerable: true,
+  get: function () {
+    return _removeDirectory.removeDirectory
+  }
+})
+Object.defineProperty(exports, 'requirePeer', {
+  enumerable: true,
+  get: function () {
+    return _loadPeer.requirePeer
+  }
+})
+Object.defineProperty(exports, 'runOnChange', {
+  enumerable: true,
+  get: function () {
+    return _runOnChange.runOnChange
+  }
+})
+Object.defineProperty(exports, 'sassFor', {
+  enumerable: true,
+  get: function () {
+    return _sassFor.sassFor
+  }
+})
+Object.defineProperty(exports, 'standardLint', {
+  enumerable: true,
+  get: function () {
+    return _standardLint.standardLint
+  }
+})
+Object.defineProperty(exports, 'tsFor', {
+  enumerable: true,
+  get: function () {
+    return _tsFor.tsFor
+  }
+})
+Object.defineProperty(exports, 'typeDocsFor', {
+  enumerable: true,
+  get: function () {
+    return _typeDocsFor.typeDocsFor
+  }
+})
+var _addToReadme = require('./partials/addToReadme.js')
+var _beginWatcher = require('./partials/beginWatcher.js')
+var _clean = require('./partials/clean.js')
+var _copyFor = require('./partials/copyFor.js')
+var _distFor = require('./partials/distFor.js')
+var _distForSrc = require('./partials/distForSrc.js')
+var _distSeries = require('./partials/distSeries.js')
+var _imagesFor = require('./partials/imagesFor.js')
+var _loadPeer = require('./partials/loadPeer.js')
+var _minifyFor = require('./partials/minifyFor.js')
+var _readmeTemplate = require('./partials/readmeTemplate.js')
+var _removeDirectory = require('./partials/removeDirectory.js')
+var _runOnChange = require('./partials/runOnChange.js')
+var _sassFor = require('./partials/sassFor.js')
+var _standardLint = require('./partials/standardLint.js')
+var _tsFor = require('./partials/tsFor.js')
+var _typeDocsFor = require('./partials/typeDocsFor.js')

package/functions/partials/typeDocsFor.mjs

@@ -79,7 +79,19 @@ export const describeExports = (ts, filePath) => {
  */
 export const describeFolder = folderPath => {
   const indexFile = ['index.ts', 'index.tsx', 'index.mts', 'index.cts'].map(name => path.join(folderPath, name)).find(file => fs.existsSync(file))
-  const comment = indexFile && fs.readFileSync(indexFile, 'utf8').match(/^\s*\/\*\*([\s\S]*?)\*\//)
+  return indexFile ? describeFile(indexFile) : ''
+}
+
+/**
+ * The description of a source file for its module: its first doc comment without the tags (@module, @file, ...), when
+ * that comment is a header (it is followed by an import or export, so it does not document a declaration itself), or
+ * an empty string.
+ * @memberOf module:partials
+ * @param {string} filePath
+ * @returns {string}
+ */
+export const describeFile = filePath => {
+  const comment = fs.readFileSync(filePath, 'utf8').match(/^\s*\/\*\*([\s\S]*?)\*\/\s*(import\b|export\s+(\*|\{[^}]*\}\s+from)|$)/)
   if (!comment) {
     return ''
   }
@@ -93,7 +105,9 @@ export const describeFolder = folderPath => {
  * entry file, so the modules of the documentation mirror the folders. The default export of each source file is
  * re-exported under the name of the file (the source files hold one function each), and anything else a file exports
  * is re-exported as it is (that is where the types.ts files go). Index files (the barrels), tests and declaration
- * files are left out, but the first doc comment of a folder's index file becomes the description of its module. A source directory with no folders gets a single entry called index.
+ * files are left out, but the first doc comment of a folder's index file becomes the description of its module.
+ * A file which sits beside the folders (not an index or main file) is a module of its own, described by its header
+ * comment. A source directory with no folders gets a single entry called index.
  * @memberOf module:partials
  * @param {Object} ts - The TypeScript compiler API.
  * @param {string} srcDir - The directory holding the TypeScript source.
@@ -107,9 +121,19 @@ export const writeDocEntries = (ts, srcDir, entryDir) => {
     .filter(entry => entry.isDirectory() && entry.name !== 'node_modules')
     .map(entry => ({ name: entry.name, path: path.join(absoluteSrc, entry.name), files: listSources(path.join(absoluteSrc, entry.name)) }))
     .filter(folder => folder.files.length)
+  const rootFiles = fs.readdirSync(absoluteSrc, { withFileTypes: true })
+    .filter(entry => entry.isFile() && isSource(entry.name) && !/^(index|main)\./.test(entry.name))
+    .map(entry => path.join(absoluteSrc, entry.name))
+  // Folders make modules, and so do the files which sit beside them (except the barrel: index and main). A source
+  // directory with no folders gets a single module called index which holds its files.
   const groups = folders.length
-    ? folders
-    : [{ name: 'index', path: absoluteSrc, files: listSources(absoluteSrc).filter(file => !/^(index|main)\./.test(path.basename(file))) }]
+    ? [
+        ...folders,
+        ...rootFiles
+          .map(file => ({ name: toIdentifier(path.basename(file).replace(/\.[cm]?tsx?$/, '')), files: [file], description: describeFile(file) }))
+          .filter(group => !folders.some(folder => folder.name === group.name))
+      ]
+    : [{ name: 'index', path: absoluteSrc, files: rootFiles }]
   return groups.map(group => {
     const lines = group.files
       .filter(file => !/^index\./.test(path.basename(file)))
@@ -123,7 +147,7 @@ export const writeDocEntries = (ts, srcDir, entryDir) => {
           ...(hasNamed ? [`export * from '${modulePath}'`] : [])
         ]
       })
-    const description = group.path ? describeFolder(group.path) : ''
+    const description = group.description ?? (group.path ? describeFolder(group.path) : '')
     // TypeDoc takes the first comment of an entry file which has the @module tag as the description of the module
     const moduleComment = description ? `/**\n${description.split('\n').map(line => ` * ${line}`.trimEnd()).join('\n')}\n * @module\n */\n\n` : ''
     const entryPath = path.join(entryDir, `${group.name}.ts`)

package/functions/partials/typeDocsFor.test.mjs

@@ -2,7 +2,7 @@ import fs from 'fs'
 import path from 'node:path'
 import ts from 'typescript'
 import * as setUp from '../test-helpers/setUp.mjs'
-import { describeExports, describeFolder, loadTypeDoc, typeDocsFor, writeDocEntries } from './typeDocsFor.mjs'
+import { describeExports, describeFile, describeFolder, loadTypeDoc, typeDocsFor, writeDocEntries } from './typeDocsFor.mjs'
 
 setUp.setDefaults('test-type-docs-for')
 const gulpConfig = setUp.gulpConfig
@@ -66,6 +66,18 @@ describe('describeFolder', () => {
   })
 })
 
+describe('describeFile', () => {
+  test('is the header comment of a file, without its tags', () => {
+    write(`${gulpConfig.get('srcPath')}/header.ts`, "/**\n * Simulate what a user does.\n * @module simulate\n */\nimport a from './a'\nexport default a\n")
+    expect(describeFile(`${gulpConfig.get('srcPath')}/header.ts`)).toBe('Simulate what a user does.')
+  })
+
+  test('is empty when the first comment documents a declaration', () => {
+    write(`${gulpConfig.get('srcPath')}/declaration.ts`, '/**\n * Add two numbers.\n */\nconst add = (a: number, b: number) => a + b\nexport default add\n')
+    expect(describeFile(`${gulpConfig.get('srcPath')}/declaration.ts`)).toBe('')
+  })
+})
+
 describe('writeDocEntries', () => {
   test('writes one entry file for each folder which has source', () => {
     const entryDir = `${gulpConfig.get('srcPath')}/../entries`
@@ -104,6 +116,19 @@ describe('writeDocEntries', () => {
     expect(fs.readFileSync(`${entryDir}/line.ts`, 'utf8').startsWith('export')).toBe(true)
   })
 
+  test('makes a module of a file which sits beside the folders, but not of the barrel files', () => {
+    const srcPath = gulpConfig.get('srcPath')
+    write(`${srcPath}/simulate.ts`, "/**\n * Simulate what a user does.\n */\nimport add from './point/add'\nexport const click = () => add(1, 2)\nexport default { click }\n")
+    write(`${srcPath}/simulate.test.ts`, "test('x', () => {})\n")
+    const entryDir = `${srcPath}/../entries`
+    const entries = writeDocEntries(ts, srcPath, entryDir)
+    expect(entries.map(entry => path.basename(entry)).sort()).toEqual(['line.ts', 'point.ts', 'simulate.ts'])
+    const absoluteSrc = path.resolve(srcPath).split(path.sep).join('/')
+    expect(fs.readFileSync(`${entryDir}/simulate.ts`, 'utf8')).toBe(
+      `/**\n * Simulate what a user does.\n * @module\n */\n\nexport { default as simulate } from '${absoluteSrc}/simulate'\nexport * from '${absoluteSrc}/simulate'\n`
+    )
+  })
+
   test('makes one entry called index when the source has no folders', () => {
     const flat = `${gulpConfig.get('srcPath')}/../flat`
     write(`${flat}/one.ts`, 'export default 1\n')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "5.3.1",
+  "version": "5.3.2",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {