js-build-tools 5.2.0 → 5.3.0

package/dist/partials/standardLint.js

@@ -1,40 +1,40 @@
-"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"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-// `standard` (17+) ships ESM-only, 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 (same escape hatch
-// as tsFor.mjs uses for gulp-ts-compile).
-const importStandard = new Function('return import(\'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"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// `standard` (17+) ships ESM-only, 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 (same escape hatch
+// as tsFor.mjs uses for gulp-ts-compile).
+const importStandard = new Function('return import(\'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
@@ -49,48 +49,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,34 +1,34 @@
-"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 _nodeModule = require("node:module");
-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) since it's meant to be consumed by
-// gulpfiles running under a real ESM loader, same as this project's own gulpfile.mjs does. This project also
-// compiles itself to a CommonJS build (dist/*.js, this file's own compiled counterpart) for consumers using
-// require() though, and even a dynamic `import()` gets downleveled by babel's CommonJS transform into a
-// require() call - which can't load a real ES module. Hiding the import() call inside a Function constructor is
-// the standard escape hatch: babel can't see (and so can't rewrite) an import expression that only exists as a
-// runtime-evaluated string, so it survives as a genuine dynamic import, capable of loading gulp-ts-compile from
-// either build.
-const importGulpTsCompile = new Function('return import(\'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 _nodeModule = require("node:module");
+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) since it's meant to be consumed by
+// gulpfiles running under a real ESM loader, same as this project's own gulpfile.mjs does. This project also
+// compiles itself to a CommonJS build (dist/*.js, this file's own compiled counterpart) for consumers using
+// require() though, and even a dynamic `import()` gets downleveled by babel's CommonJS transform into a
+// require() call - which can't load a real ES module. Hiding the import() call inside a Function constructor is
+// the standard escape hatch: babel can't see (and so can't rewrite) an import expression that only exists as a
+// runtime-evaluated string, so it survives as a genuine dynamic import, capable of loading gulp-ts-compile from
+// either build.
+const importGulpTsCompile = new Function('return import(\'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.
@@ -36,23 +36,23 @@ 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()) => {
-  try {
-    return (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json'))('typescript');
-  } catch (error) {
-    if (error.code === 'MODULE_NOT_FOUND' && /Cannot find module 'typescript'/.test(error.message)) {
-      throw new Error(`The typescript task needs the optional peer dependency typescript, which is not installed. ${installHint}`);
-    }
-    throw error;
-  }
-};
-exports.loadTypescript = loadTypescript;
-const streamToPromise = stream => new Promise((resolve, reject) => {
-  stream.on('finish', resolve);
-  stream.on('error', reject);
-});
-
+ */
+const loadTypescript = (projectPath = process.cwd()) => {
+  try {
+    return (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json'))('typescript');
+  } catch (error) {
+    if (error.code === 'MODULE_NOT_FOUND' && /Cannot find module 'typescript'/.test(error.message)) {
+      throw new Error(`The typescript task needs the optional peer dependency typescript, which is not installed. ${installHint}`);
+    }
+    throw error;
+  }
+};
+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
@@ -61,13 +61,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
@@ -80,36 +80,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

@@ -0,0 +1,214 @@
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.writeDocEntries = exports.typeDocsFor = exports.loadTypeDoc = 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");
+require("core-js/modules/esnext.iterator.flat-map.js");
+require("core-js/modules/esnext.iterator.for-each.js");
+require("core-js/modules/esnext.iterator.map.js");
+require("core-js/modules/esnext.iterator.some.js");
+var _nodeFs = _interopRequireDefault(require("node:fs"));
+var _nodeOs = _interopRequireDefault(require("node:os"));
+var _nodePath = _interopRequireDefault(require("node:path"));
+var _nodeModule = require("node:module");
+var _nodeUrl = require("node:url");
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+var _tsFor = require("./tsFor.js");
+var _removeDirectory = require("./removeDirectory.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 }; }
+// TypeDoc ships ESM-only, and this project also compiles itself to a CommonJS build (see tsFor.mjs, which hides its
+// own import of gulp-ts-compile the same way), so the import() is hidden from babel's CommonJS transform.
+const importModule = new Function('specifier', 'return import(specifier)');
+const installHint = 'Install it in your project with: npm install --save-dev typedoc';
+
+/**
+ * Find the TypeDoc of the project being built (an optional peer dependency, only needed when the docs task is
+ * enabled) and load it, so projects which do not document TypeScript never need it installed.
+ * @memberOf module:partials
+ * @param {string} [projectPath=process.cwd()] The folder of the project (which has the package.json) being built.
+ * @returns {Promise<Object>} The TypeDoc module.
+ * @throws {Error} With install instructions when typedoc is not installed.
+ */
+const loadTypeDoc = async (projectPath = process.cwd()) => {
+  let typeDocPath;
+  try {
+    typeDocPath = (0, _nodeModule.createRequire)(_nodePath.default.join(projectPath, 'package.json')).resolve('typedoc');
+  } catch (error) {
+    if (error.code === 'MODULE_NOT_FOUND') {
+      throw new Error(`The docs task needs the optional peer dependency typedoc, which is not installed. ${installHint}`);
+    }
+    throw error;
+  }
+  return importModule((0, _nodeUrl.pathToFileURL)(typeDocPath).href);
+};
+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] : [];
+});
+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('/');
+
+/**
+ * Describe what a source file exports: whether it has a default export, and whether it has any named exports.
+ * @memberOf module:partials
+ * @param {Object} ts - The TypeScript compiler API.
+ * @param {string} filePath
+ * @returns {{hasDefault: boolean, hasNamed: boolean}}
+ */
+const describeExports = (ts, filePath) => {
+  const source = ts.createSourceFile(filePath, _nodeFs.default.readFileSync(filePath, 'utf8'), ts.ScriptTarget.Latest);
+  let hasDefault = false;
+  let hasNamed = false;
+  source.statements.forEach(statement => {
+    if (ts.isExportAssignment(statement)) {
+      hasDefault = hasDefault || !statement.isExportEquals;
+      return;
+    }
+    if (ts.isExportDeclaration(statement)) {
+      const names = statement.exportClause && ts.isNamedExports(statement.exportClause) ? statement.exportClause.elements : null;
+      if (names && names.some(element => element.name.text === 'default')) {
+        hasDefault = true;
+      }
+      if (!names || names.some(element => element.name.text !== 'default')) {
+        hasNamed = true;
+      }
+      return;
+    }
+    const modifiers = ts.canHaveModifiers(statement) ? ts.getModifiers(statement) || [] : [];
+    if (modifiers.some(modifier => modifier.kind === ts.SyntaxKind.ExportKeyword)) {
+      if (modifiers.some(modifier => modifier.kind === ts.SyntaxKind.DefaultKeyword)) {
+        hasDefault = true;
+      } else {
+        hasNamed = true;
+      }
+    }
+  });
+  return {
+    hasDefault,
+    hasNamed
+  };
+};
+
+/**
+ * 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
+ * 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. 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.describeExports = describeExports;
+const writeDocEntries = (ts, srcDir, entryDir) => {
+  const absoluteSrc = _nodePath.default.resolve(srcDir);
+  _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,
+    files: listSources(_nodePath.default.join(absoluteSrc, entry.name))
+  })).filter(folder => folder.files.length);
+  const groups = folders.length ? folders : [{
+    name: 'index',
+    files: listSources(absoluteSrc).filter(file => !/^(index|main)\./.test(_nodePath.default.basename(file)))
+  }];
+  return groups.map(group => {
+    const lines = group.files.filter(file => !/^index\./.test(_nodePath.default.basename(file))).sort().flatMap(file => {
+      const modulePath = toModulePath(file);
+      const {
+        hasDefault,
+        hasNamed
+      } = describeExports(ts, file);
+      const fileName = _nodePath.default.basename(file).replace(/\.[cm]?tsx?$/, '');
+      return [...(hasDefault ? [`export { default as ${toIdentifier(fileName)} } from '${modulePath}'`] : []), ...(hasNamed ? [`export * from '${modulePath}'`] : [])];
+    });
+    const entryPath = _nodePath.default.join(entryDir, `${group.name}.ts`);
+    _nodeFs.default.writeFileSync(entryPath, lines.join('\n') + '\n');
+    return entryPath;
+  });
+};
+exports.writeDocEntries = writeDocEntries;
+const projectName = () => {
+  try {
+    return JSON.parse(_nodeFs.default.readFileSync(_nodePath.default.join(process.cwd(), 'package.json'), 'utf8')).name;
+  } catch (error) {
+    return _nodePath.default.basename(process.cwd());
+  }
+};
+
+/**
+ * Generate the HTML documentation of a TypeScript project with TypeDoc, straight from the TypeScript source, so the
+ * types (and the comments on them) are documented from where they are defined. The modules mirror the folders of the
+ * source, see {@link writeDocEntries}. Configure this with 'docs.from', 'docs.to', 'docs.index', 'docs.title',
+ * 'docs.tsconfig' and 'docs.logLevel'.
+ * @memberOf module:partials
+ * @param {string} [srcPath=gulpConfig.get('docs.from')] - The directory holding the TypeScript source.
+ * @param {string} [outPath=gulpConfig.get('docs.to')] - The directory the documentation is generated into (cleared first).
+ * @param {function(string): Promise<Object>} [loadDocs] - Resolves the TypeDoc module, tests can inject a stand-in.
+ * @returns {Function} A gulp task, it accepts an optional callback and returns a promise.
+ */
+const typeDocsFor = (srcPath = gulpConfig.get('docs.from'), outPath = gulpConfig.get('docs.to'), loadDocs = loadTypeDoc) => {
+  if (gulpConfig.get('docs.enabled') === false) {
+    return () => {};
+  }
+  return done => {
+    const generate = async () => {
+      const ts = (0, _tsFor.loadTypescript)();
+      const {
+        Application
+      } = await loadDocs();
+      const workDir = _nodeFs.default.mkdtempSync(_nodePath.default.join(_nodeOs.default.tmpdir(), 'typedocs-'));
+      try {
+        const entryPoints = writeDocEntries(ts, srcPath, _nodePath.default.join(workDir, 'entries'));
+        // The entry files live outside the project, so the tsconfig which is used for the documentation extends the
+        // one of the project and adds the entries to the files it includes.
+        const projectConfig = gulpConfig.get('docs.tsconfig') || gulpConfig.get('typescript.config');
+        const tsconfig = _nodePath.default.join(workDir, 'tsconfig.json');
+        _nodeFs.default.writeFileSync(tsconfig, JSON.stringify({
+          ...(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'],
+          exclude: [_nodePath.default.resolve(srcPath).split(_nodePath.default.sep).join('/') + '/**/*.test.*']
+        }));
+        const indexFile = gulpConfig.get('docs.index');
+        await (0, _removeDirectory.removeDirectory)(outPath);
+        const app = await Application.bootstrap({
+          entryPoints,
+          tsconfig,
+          name: gulpConfig.get('docs.title') || projectName(),
+          readme: indexFile && _nodeFs.default.existsSync(indexFile) ? indexFile : 'none',
+          logLevel: gulpConfig.get('docs.logLevel') || 'Warn',
+          skipErrorChecking: true
+        });
+        const project = await app.convert();
+        if (!project) {
+          throw new Error('TypeDoc could not read the TypeScript source, see the errors above.');
+        }
+        await app.generateDocs(project, outPath);
+      } finally {
+        await (0, _removeDirectory.removeDirectory)(workDir);
+      }
+    };
+    return typeof done === 'function' ? generate().then(() => done(), done) : generate();
+  };
+};
+exports.typeDocsFor = typeDocsFor;

package/dist/partials.js

@@ -93,6 +93,12 @@ Object.defineProperty(exports, 'tsFor', {
     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')
@@ -108,3 +114,4 @@ 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/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,"minifyFor",{enumerable:!0,get:function(){return _minifyFor.minifyFor}}),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,"runOnChange",{enumerable:!0,get:function(){return _runOnChange.runOnChange}}),Object.defineProperty(exports,"sassFor",{enumerable:!0,get:function(){return _sassFor.sassFor}}),Object.defineProperty(exports,"standardLint",{enumerable:!0,get:function(){return _standardLint.standardLint}}),Object.defineProperty(exports,"tsFor",{enumerable:!0,get:function(){return _tsFor.tsFor}});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"),_minifyFor=require("./partials/minifyFor.js"),_readmeTemplate=require("./partials/readmeTemplate.js"),_removeDirectory=require("./partials/removeDirectory.js"),_runOnChange=require("./partials/runOnChange.js"),_sassFor=require("./partials/sassFor.js"),_standardLint=require("./partials/standardLint.js"),_tsFor=require("./partials/tsFor.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,"minifyFor",{enumerable:!0,get:function(){return _minifyFor.minifyFor}}),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,"runOnChange",{enumerable:!0,get:function(){return _runOnChange.runOnChange}}),Object.defineProperty(exports,"sassFor",{enumerable:!0,get:function(){return _sassFor.sassFor}}),Object.defineProperty(exports,"standardLint",{enumerable:!0,get:function(){return _standardLint.standardLint}}),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"),_minifyFor=require("./partials/minifyFor.js"),_readmeTemplate=require("./partials/readmeTemplate.js"),_removeDirectory=require("./partials/removeDirectory.js"),_runOnChange=require("./partials/runOnChange.js"),_sassFor=require("./partials/sassFor.js"),_standardLint=require("./partials/standardLint.js"),_tsFor=require("./partials/tsFor.js"),_typeDocsFor=require("./partials/typeDocsFor.js");

package/dist/sass.js

@@ -1,10 +1,10 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.sass = void 0
-const _sassFor = require('./partials/sassFor.js')
-// Compile sass into CSS & auto-inject into browsers
-const sass = () => (0, _sassFor.sassFor)()
-exports.sass = sass
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.sass = void 0
+const _sassFor = require('./partials/sassFor.js')
+// Compile sass into CSS & auto-inject into browsers
+const sass = () => (0, _sassFor.sassFor)()
+exports.sass = sass