js-build-tools 6.2.2 → 6.3.0

package/dist/partials/resolveDocsMethod.js

@@ -1,19 +1,19 @@
-"use strict";
-
-require("core-js/modules/esnext.weak-map.delete-all.js");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.resolveDocsMethod = void 0;
-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; }
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.resolveDocsMethod = void 0;
+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; }
 /**
  * Pick which engine generates the HTML documentation: docs.method picks it explicitly; left unset (false, the
  * default), it's inferred from typescript.enabled - every existing TypeScript project's config, which never
  * sets method, keeps producing TypeDoc output exactly as it always has.
  * @memberOf module:partials
  * @returns {'typedoc'|'jsdoc'}
- */
-const resolveDocsMethod = () => gulpConfig.get('docs.method') || (gulpConfig.get('typescript.enabled') ? 'typedoc' : 'jsdoc');
+ */
+const resolveDocsMethod = () => gulpConfig.get('docs.method') || (gulpConfig.get('typescript.enabled') ? 'typedoc' : 'jsdoc');
 exports.resolveDocsMethod = resolveDocsMethod;

package/dist/partials/serveStatic.js

@@ -0,0 +1,57 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.serveStatic = void 0;
+var _nodeFs = _interopRequireDefault(require("node:fs"));
+var _nodeHttp = _interopRequireDefault(require("node:http"));
+var _nodePath = _interopRequireDefault(require("node:path"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// A real, previously-undiscovered bug fixed here: without a Content-Type header, a browser enforces strict MIME
+// checking on <script type="module"> and refuses to load it at all - exactly the case this partial exists for.
+const contentTypes = {
+  '.css': 'text/css',
+  '.gif': 'image/gif',
+  '.html': 'text/html',
+  '.ico': 'image/x-icon',
+  '.jpeg': 'image/jpeg',
+  '.jpg': 'image/jpeg',
+  '.js': 'text/javascript',
+  '.json': 'application/json',
+  '.mjs': 'text/javascript',
+  '.png': 'image/png',
+  '.svg': 'image/svg+xml',
+  '.woff': 'font/woff',
+  '.woff2': 'font/woff2'
+};
+
+/**
+ * Serve a directory's real files over plain HTTP, for anything that needs a page loaded from a real URL rather
+ * than a bare file:// path - most commonly, a page using root-relative asset paths (/browser/...), which a
+ * file:// load resolves against the filesystem root instead of the page's own directory.
+ * @memberOf module:partials
+ * @param {string} rootDir - The directory to serve.
+ * @param {number} [port=0] - The port to listen on; 0 picks any free port.
+ * @returns {Promise<{server: http.Server, url: string}>} The running server, and its base URL - close the
+ * server yourself (server.close()) once done with it.
+ */
+const serveStatic = (rootDir, port = 0) => new Promise((resolve, reject) => {
+  const server = _nodeHttp.default.createServer((req, res) => {
+    const filePath = _nodePath.default.join(rootDir, decodeURIComponent(req.url.split('?')[0]));
+    _nodeFs.default.readFile(filePath, (error, data) => {
+      if (error) {
+        res.statusCode = 404;
+        return res.end(`Not found: ${req.url}`);
+      }
+      res.setHeader('Content-Type', contentTypes[_nodePath.default.extname(filePath)] || 'application/octet-stream');
+      res.end(data);
+    });
+  });
+  server.once('error', reject);
+  server.listen(port, '127.0.0.1', () => resolve({
+    server,
+    url: `http://127.0.0.1:${server.address().port}`
+  }));
+});
+exports.serveStatic = serveStatic;

package/dist/partials/tsFor.js

@@ -18,7 +18,7 @@ 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
+ * @param {stream.Stream} stream
  * @returns {Promise<void>}
  */
 const installHint = 'Install it in your project with: npm install --save-dev typescript';
@@ -49,7 +49,7 @@ const streamToPromise = stream => new Promise((resolve, reject) => {
  * gulp-typescript when a removed API call started throwing under TypeScript 7.
  * @memberOf module:partials
  * @param {string} configPath - Path to a tsconfig.json file.
- * @returns {import('typescript').CompilerOptions}
+ * @returns {ts.CompilerOptions} TypeScript's compiler options
  */
 const readCompilerOptions = (ts, configPath) => {
   const configFile = ts.readConfigFile(configPath, ts.sys.readFile);

package/dist/partials/typeDocsFor.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.writeDocEntries = exports.typeDocsFor = exports.loadTypeDoc = exports.describeFolder = exports.describeFile = exports.describeExports = void 0;
+require("core-js/modules/es.array.includes.js");
 require("core-js/modules/es.json.stringify.js");
 require("core-js/modules/esnext.iterator.constructor.js");
 require("core-js/modules/esnext.iterator.filter.js");
@@ -42,12 +43,19 @@ exports.loadTypeDoc = loadTypeDoc;
 const isSource = fileName => /\.(ts|tsx|mts|cts)$/.test(fileName) && !/\.d\.[cm]?ts$/.test(fileName) && !/\.(test|spec)\./.test(fileName);
 const listSources = dirPath => _nodeFs.default.readdirSync(dirPath, {
   withFileTypes: true
-}).flatMap(entry => {
-  const entryPath = _nodePath.default.join(dirPath, entry.name);
-  if (entry.isDirectory()) {
-    return entry.name === 'node_modules' ? [] : listSources(entryPath);
-  }
-  return isSource(entry.name) ? [entryPath] : [];
+}).filter(entry => entry.isFile() && isSource(entry.name)).map(entry => _nodePath.default.join(dirPath, entry.name));
+
+// Every folder below dirPath (at any depth), named by its path from dirPath, with the source files directly in it
+const listFolders = (dirPath, prefix = '') => _nodeFs.default.readdirSync(dirPath, {
+  withFileTypes: true
+}).filter(entry => entry.isDirectory() && entry.name !== 'node_modules').flatMap(entry => {
+  const folderPath = _nodePath.default.join(dirPath, entry.name);
+  const name = `${prefix}${entry.name}`;
+  return [{
+    name,
+    path: folderPath,
+    files: listSources(folderPath)
+  }, ...listFolders(folderPath, `${name}/`)];
 });
 const toIdentifier = fileName => fileName.replace(/[^\w$]+(\w)?/g, (match, letter) => (letter || '').toUpperCase()).replace(/^(\d)/, '_$1');
 const toModulePath = filePath => filePath.replace(/\.[cm]?tsx?$/, '').split(_nodePath.default.sep).join('/');
@@ -127,11 +135,12 @@ const describeFile = filePath => {
 
 /**
  * Write one entry file per folder of the source directory into the entry directory. TypeDoc makes a module of every
- * entry file, so the modules of the documentation mirror the folders. The default export of each source file is
+ * entry file, so the modules of the documentation mirror the folders. Nested folders are modules of their own, named
+ * by their path (utilities/parsers), and a folder's module holds only the files directly in it. 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 file which sits beside the folders (not an index or main file) is a module of its own, described by its header
+ * A file which sits beside the folders (not an index, main or browser 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.
@@ -145,18 +154,10 @@ const writeDocEntries = (ts, srcDir, entryDir) => {
   _nodeFs.default.mkdirSync(entryDir, {
     recursive: true
   });
-  const folders = _nodeFs.default.readdirSync(absoluteSrc, {
-    withFileTypes: true
-  }).filter(entry => entry.isDirectory() && entry.name !== 'node_modules').map(entry => ({
-    name: entry.name,
-    path: _nodePath.default.join(absoluteSrc, entry.name),
-    files: listSources(_nodePath.default.join(absoluteSrc, entry.name))
-  })).filter(folder => folder.files.length);
-  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 folders = listFolders(absoluteSrc).filter(folder => folder.files.some(file => !/^index\./.test(_nodePath.default.basename(file))));
+  const rootFiles = listSources(absoluteSrc).filter(file => !/^(index|main|browser)\./.test(_nodePath.default.basename(file)));
+  // Folders make modules, and so do the files which sit beside them (except the barrels: index, main and browser, the
+  // browser bundle's entry). 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],
@@ -178,8 +179,13 @@ const writeDocEntries = (ts, srcDir, entryDir) => {
     });
     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` : '';
+    // A nested folder's module is named by its path (utilities/parsers), so it is not mistaken for its parent's
+    const moduleName = group.name.includes('/') ? ` ${group.name}` : '';
+    const moduleComment = description || moduleName ? `/**\n${description ? description.split('\n').map(line => ` * ${line}`.trimEnd()).join('\n') + '\n' : ''} * @module${moduleName}\n */\n\n` : '';
     const entryPath = _nodePath.default.join(entryDir, `${group.name}.ts`);
+    _nodeFs.default.mkdirSync(_nodePath.default.dirname(entryPath), {
+      recursive: true
+    });
     _nodeFs.default.writeFileSync(entryPath, moduleComment + lines.join('\n') + '\n');
     return entryPath;
   });
@@ -225,7 +231,7 @@ const typeDocsFor = (srcPath = gulpConfig.get('docs.from'), outPath = gulpConfig
           ...(projectConfig ? {
             extends: _nodePath.default.resolve(projectConfig)
           } : {}),
-          include: [_nodePath.default.join(workDir, 'entries', '*.ts').split(_nodePath.default.sep).join('/'), _nodePath.default.resolve(srcPath).split(_nodePath.default.sep).join('/') + '/**/*.ts'],
+          include: [_nodePath.default.join(workDir, 'entries', '**', '*.ts').split(_nodePath.default.sep).join('/'), _nodePath.default.resolve(srcPath).split(_nodePath.default.sep).join('/') + '/**/*.ts'],
           exclude: [_nodePath.default.resolve(srcPath).split(_nodePath.default.sep).join('/') + '/**/*.test.*']
         }));
         const indexFile = gulpConfig.get('docs.index');

package/dist/partials.js

@@ -1,150 +1,170 @@
-"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, "jsdocDocsFor", {
-  enumerable: true,
-  get: function () {
-    return _jsdocDocsFor.jsdocDocsFor;
-  }
-});
-Object.defineProperty(exports, "minifyFor", {
-  enumerable: true,
-  get: function () {
-    return _minifyFor.minifyFor;
-  }
-});
-Object.defineProperty(exports, "neostandardLint", {
-  enumerable: true,
-  get: function () {
-    return _neostandardLint.neostandardLint;
-  }
-});
-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, "resolveDocsMethod", {
-  enumerable: true,
-  get: function () {
-    return _resolveDocsMethod.resolveDocsMethod;
-  }
-});
-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, "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 _jsdocDocsFor = require("./partials/jsdocDocsFor.js");
-var _minifyFor = require("./partials/minifyFor.js");
-var _neostandardLint = require("./partials/neostandardLint.js");
-var _readmeTemplate = require("./partials/readmeTemplate.js");
-var _removeDirectory = require("./partials/removeDirectory.js");
-var _resolveDocsMethod = require("./partials/resolveDocsMethod.js");
-var _runOnChange = require("./partials/runOnChange.js");
-var _sassFor = require("./partials/sassFor.js");
-var _tsFor = require("./partials/tsFor.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, "jsdocDocsFor", {
+  enumerable: true,
+  get: function () {
+    return _jsdocDocsFor.jsdocDocsFor;
+  }
+});
+Object.defineProperty(exports, "launchBrowser", {
+  enumerable: true,
+  get: function () {
+    return _loadPlaywright.launchBrowser;
+  }
+});
+Object.defineProperty(exports, "loadPlaywright", {
+  enumerable: true,
+  get: function () {
+    return _loadPlaywright.loadPlaywright;
+  }
+});
+Object.defineProperty(exports, "minifyFor", {
+  enumerable: true,
+  get: function () {
+    return _minifyFor.minifyFor;
+  }
+});
+Object.defineProperty(exports, "neostandardLint", {
+  enumerable: true,
+  get: function () {
+    return _neostandardLint.neostandardLint;
+  }
+});
+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, "resolveDocsMethod", {
+  enumerable: true,
+  get: function () {
+    return _resolveDocsMethod.resolveDocsMethod;
+  }
+});
+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, "serveStatic", {
+  enumerable: true,
+  get: function () {
+    return _serveStatic.serveStatic;
+  }
+});
+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 _jsdocDocsFor = require("./partials/jsdocDocsFor.js");
+var _loadPlaywright = require("./partials/loadPlaywright.js");
+var _minifyFor = require("./partials/minifyFor.js");
+var _neostandardLint = require("./partials/neostandardLint.js");
+var _readmeTemplate = require("./partials/readmeTemplate.js");
+var _removeDirectory = require("./partials/removeDirectory.js");
+var _resolveDocsMethod = require("./partials/resolveDocsMethod.js");
+var _runOnChange = require("./partials/runOnChange.js");
+var _sassFor = require("./partials/sassFor.js");
+var _serveStatic = require("./partials/serveStatic.js");
+var _tsFor = require("./partials/tsFor.js");
 var _typeDocsFor = require("./partials/typeDocsFor.js");

package/dist/partials.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"addToReadme",{enumerable:!0,get:function(){return _addToReadme.addToReadme}}),Object.defineProperty(exports,"beginWatcher",{enumerable:!0,get:function(){return _beginWatcher.beginWatcher}}),Object.defineProperty(exports,"clean",{enumerable:!0,get:function(){return _clean.clean}}),Object.defineProperty(exports,"copyFor",{enumerable:!0,get:function(){return _copyFor.copyFor}}),Object.defineProperty(exports,"distFor",{enumerable:!0,get:function(){return _distFor.distFor}}),Object.defineProperty(exports,"distForSrc",{enumerable:!0,get:function(){return _distForSrc.distForSrc}}),Object.defineProperty(exports,"distSeries",{enumerable:!0,get:function(){return _distSeries.distSeries}}),Object.defineProperty(exports,"imagesFor",{enumerable:!0,get:function(){return _imagesFor.imagesFor}}),Object.defineProperty(exports,"importModule",{enumerable:!0,get:function(){return _loadPeer.importModule}}),Object.defineProperty(exports,"importPeer",{enumerable:!0,get:function(){return _loadPeer.importPeer}}),Object.defineProperty(exports,"jsdocDocsFor",{enumerable:!0,get:function(){return _jsdocDocsFor.jsdocDocsFor}}),Object.defineProperty(exports,"minifyFor",{enumerable:!0,get:function(){return _minifyFor.minifyFor}}),Object.defineProperty(exports,"neostandardLint",{enumerable:!0,get:function(){return _neostandardLint.neostandardLint}}),Object.defineProperty(exports,"readmeTemplate",{enumerable:!0,get:function(){return _readmeTemplate.readmeTemplate}}),Object.defineProperty(exports,"removeDirectory",{enumerable:!0,get:function(){return _removeDirectory.removeDirectory}}),Object.defineProperty(exports,"requirePeer",{enumerable:!0,get:function(){return _loadPeer.requirePeer}}),Object.defineProperty(exports,"resolveDocsMethod",{enumerable:!0,get:function(){return _resolveDocsMethod.resolveDocsMethod}}),Object.defineProperty(exports,"runOnChange",{enumerable:!0,get:function(){return _runOnChange.runOnChange}}),Object.defineProperty(exports,"sassFor",{enumerable:!0,get:function(){return _sassFor.sassFor}}),Object.defineProperty(exports,"tsFor",{enumerable:!0,get:function(){return _tsFor.tsFor}}),Object.defineProperty(exports,"typeDocsFor",{enumerable:!0,get:function(){return _typeDocsFor.typeDocsFor}});var _addToReadme=require("./partials/addToReadme.js"),_beginWatcher=require("./partials/beginWatcher.js"),_clean=require("./partials/clean.js"),_copyFor=require("./partials/copyFor.js"),_distFor=require("./partials/distFor.js"),_distForSrc=require("./partials/distForSrc.js"),_distSeries=require("./partials/distSeries.js"),_imagesFor=require("./partials/imagesFor.js"),_loadPeer=require("./partials/loadPeer.js"),_jsdocDocsFor=require("./partials/jsdocDocsFor.js"),_minifyFor=require("./partials/minifyFor.js"),_neostandardLint=require("./partials/neostandardLint.js"),_readmeTemplate=require("./partials/readmeTemplate.js"),_removeDirectory=require("./partials/removeDirectory.js"),_resolveDocsMethod=require("./partials/resolveDocsMethod.js"),_runOnChange=require("./partials/runOnChange.js"),_sassFor=require("./partials/sassFor.js"),_tsFor=require("./partials/tsFor.js"),_typeDocsFor=require("./partials/typeDocsFor.js");
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"addToReadme",{enumerable:!0,get:function(){return _addToReadme.addToReadme}}),Object.defineProperty(exports,"beginWatcher",{enumerable:!0,get:function(){return _beginWatcher.beginWatcher}}),Object.defineProperty(exports,"clean",{enumerable:!0,get:function(){return _clean.clean}}),Object.defineProperty(exports,"copyFor",{enumerable:!0,get:function(){return _copyFor.copyFor}}),Object.defineProperty(exports,"distFor",{enumerable:!0,get:function(){return _distFor.distFor}}),Object.defineProperty(exports,"distForSrc",{enumerable:!0,get:function(){return _distForSrc.distForSrc}}),Object.defineProperty(exports,"distSeries",{enumerable:!0,get:function(){return _distSeries.distSeries}}),Object.defineProperty(exports,"imagesFor",{enumerable:!0,get:function(){return _imagesFor.imagesFor}}),Object.defineProperty(exports,"importModule",{enumerable:!0,get:function(){return _loadPeer.importModule}}),Object.defineProperty(exports,"importPeer",{enumerable:!0,get:function(){return _loadPeer.importPeer}}),Object.defineProperty(exports,"jsdocDocsFor",{enumerable:!0,get:function(){return _jsdocDocsFor.jsdocDocsFor}}),Object.defineProperty(exports,"launchBrowser",{enumerable:!0,get:function(){return _loadPlaywright.launchBrowser}}),Object.defineProperty(exports,"loadPlaywright",{enumerable:!0,get:function(){return _loadPlaywright.loadPlaywright}}),Object.defineProperty(exports,"minifyFor",{enumerable:!0,get:function(){return _minifyFor.minifyFor}}),Object.defineProperty(exports,"neostandardLint",{enumerable:!0,get:function(){return _neostandardLint.neostandardLint}}),Object.defineProperty(exports,"readmeTemplate",{enumerable:!0,get:function(){return _readmeTemplate.readmeTemplate}}),Object.defineProperty(exports,"removeDirectory",{enumerable:!0,get:function(){return _removeDirectory.removeDirectory}}),Object.defineProperty(exports,"requirePeer",{enumerable:!0,get:function(){return _loadPeer.requirePeer}}),Object.defineProperty(exports,"resolveDocsMethod",{enumerable:!0,get:function(){return _resolveDocsMethod.resolveDocsMethod}}),Object.defineProperty(exports,"runOnChange",{enumerable:!0,get:function(){return _runOnChange.runOnChange}}),Object.defineProperty(exports,"sassFor",{enumerable:!0,get:function(){return _sassFor.sassFor}}),Object.defineProperty(exports,"serveStatic",{enumerable:!0,get:function(){return _serveStatic.serveStatic}}),Object.defineProperty(exports,"tsFor",{enumerable:!0,get:function(){return _tsFor.tsFor}}),Object.defineProperty(exports,"typeDocsFor",{enumerable:!0,get:function(){return _typeDocsFor.typeDocsFor}});var _addToReadme=require("./partials/addToReadme.js"),_beginWatcher=require("./partials/beginWatcher.js"),_clean=require("./partials/clean.js"),_copyFor=require("./partials/copyFor.js"),_distFor=require("./partials/distFor.js"),_distForSrc=require("./partials/distForSrc.js"),_distSeries=require("./partials/distSeries.js"),_imagesFor=require("./partials/imagesFor.js"),_loadPeer=require("./partials/loadPeer.js"),_jsdocDocsFor=require("./partials/jsdocDocsFor.js"),_loadPlaywright=require("./partials/loadPlaywright.js"),_minifyFor=require("./partials/minifyFor.js"),_neostandardLint=require("./partials/neostandardLint.js"),_readmeTemplate=require("./partials/readmeTemplate.js"),_removeDirectory=require("./partials/removeDirectory.js"),_resolveDocsMethod=require("./partials/resolveDocsMethod.js"),_runOnChange=require("./partials/runOnChange.js"),_sassFor=require("./partials/sassFor.js"),_serveStatic=require("./partials/serveStatic.js"),_tsFor=require("./partials/tsFor.js"),_typeDocsFor=require("./partials/typeDocsFor.js");

package/dist/test-helpers/setUp.js

@@ -76,6 +76,12 @@ const setDefaults = (testDir = 'test-temp') => {
   gulpConfig.set('dist.from', `${srcPath}/**/!(*.test).js`);
   gulpConfig.set('dist.main', `${distPath}/main`);
   gulpConfig.set('dist.to', distPath);
+  // Reset explicitly, for the same reason as readme.fromEsm below: this project's own build-tools.config.json turns
+  // docs on and points them at the website checkout, which would leak into every test that never sets these itself.
+  gulpConfig.set('docs.enabled', false);
+  gulpConfig.set('docs.from', srcPath);
+  gulpConfig.set('docs.to', `${tempDir}docs`);
+  gulpConfig.set('docs.title', '');
   gulpConfig.set('fonts.from', `${srcPath}/fonts/**/*`);
   gulpConfig.set('fonts.to', `${browserPath}/fonts`);
   gulpConfig.set('images.from', `${srcPath}/img/**/*.+(png|jpg|jpeg|gif|svg)`);

package/dist/utilities/convertMjsFilesForDocs.js

@@ -22,6 +22,7 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  * @param {Array<string>} mjsFilePaths - Real `.mjs` files to convert. An empty array is a safe, cheap no-op.
  * @returns {{filePaths: Array<string>, cleanUp: function(): void}} The temp `.js` file paths to pass to
  * jsdoc-to-markdown instead of the real `.mjs` ones, and a function to remove the temp directory afterward.
+ * @private
  */
 const convertMjsFilesForDocs = (mjsFilePaths = []) => {
   if (mjsFilePaths.length === 0) {

package/dist/utilities/dotGet.js

@@ -14,6 +14,7 @@ var _strBefore = require("./strBefore.js");
  * @param {string} [dotNotation=''] - The path to the property
  * @param {string|null} [defaultValue=null] - The default value to return if the property is not found
  * @returns {*} The value of the property
+ * @private
  */
 const dotGet = (arrayObject = {}, dotNotation = '', defaultValue = null) => {
   if (!dotNotation) {

package/dist/utilities/dotNotate.js

@@ -11,12 +11,14 @@ var _isObject = require("./isObject.js");
  * Convert an array of keys into a regex, return a function to test if incoming keys match.
  * @param {Array.<string>} [retainObjects=[]] - An array of keys to retain as objects
  * @returns {Function} The dot-notated array
+ * @private
  */
 const handleRetainObjects = (retainObjects = []) => {
   if (!retainObjects.length) {
     /**
      * Bypass the test function if there are no retainObjects.
      * @returns {false}
+     * @private
      */
     return (currentKey, value, results) => false;
   }
@@ -28,6 +30,7 @@ const handleRetainObjects = (retainObjects = []) => {
    * @param {*} value - The value of the key
    * @param {Object} results - The result object to add to
    * @returns {boolean}
+   * @private
    */
   return (currentKey, value, results) => {
     if (!currentKey.match(retainRegex)) {
@@ -45,6 +48,7 @@ const handleRetainObjects = (retainObjects = []) => {
  * @param {string} [prepend=''] - The path for the property being processed
  * @param {Object<string, *>} [results={}] - The final notated object to return
  * @returns {Object<string, *>} The dot-notated object
+ * @private
  */
 const performDotNotate = (arrayObject, didRetain, prepend = '', results = {}) => {
   for (let key in arrayObject) {
@@ -70,6 +74,7 @@ const performDotNotate = (arrayObject, didRetain, prepend = '', results = {}) =>
  * @param {Object} arrayObject - The array or object to dot-notate
  * @param {Array.<string>} [retainObjects=[]] - An array of keys to retain as objects
  * @returns {Object<string, *>} The dot-notated object
+ * @private
  */
 const dotNotate = (arrayObject, retainObjects = []) => performDotNotate(arrayObject, handleRetainObjects(retainObjects));
 exports.dotNotate = dotNotate;

package/dist/utilities/dotSet.js

@@ -14,6 +14,7 @@ var _strBefore = require("./strBefore.js");
  * @param {string} dotNotation - The path for the property
  * @param {*} value - The default value to return if the property is not found
  * @returns {Object} The modified object
+ * @private
  */
 const dotSet = (arrayObject, dotNotation, value = null) => {
   let key = (0, _strBefore.strBefore)(dotNotation, '.');

package/dist/utilities/esmNamedExportsToCjs.js

@@ -18,6 +18,7 @@ exports.esmNamedExportsToCjs = void 0;
  * @memberOf module:utilities
  * @param {string} source - The raw ESM source text (never executed, just rewritten as text).
  * @returns {string} The rewritten text, safe to write out with a `.js` extension for jsdoc-to-markdown to read.
+ * @private
  */
 const esmNamedExportsToCjs = source => {
   const exportedNames = [];

package/dist/utilities/getBundleConfigs.js

@@ -18,6 +18,7 @@ function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e;
  * specify what's actually different about it.
  * @memberOf module:utilities
  * @returns {Array<{name: string, main: string, ignore: Array, exclude: Array}>}
+ * @private
  */
 const getBundleConfigs = () => {
   const primary = {