typedoc-toolbox 0.0.1

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 - Present  Hervé Perchec
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# typedoc-toolbox
+
+[![author](https://img.shields.io/static/v1?label=\&message=Author:\&color=black)](http://herve-perchec.com/)
+[![herve-perchec](http://herve-perchec.com/badge.svg)](http://herve-perchec.com/)
+[![release](https://img.shields.io/gitlab/v/release/hperchec/typedoc-toolbox?include_prereleases\&logo=gitlab\&sort=semver)](https://gitlab.com/hperchec/typedoc-toolbox/-/releases)
+[![pipeline-status](https://gitlab.com/hperchec/typedoc-toolbox/badges/v0.0.1/pipeline.svg)](https://gitlab.com/hperchec/typedoc-toolbox/commits/v0.0.1)
+![coverage](https://gitlab.com/hperchec/typedoc-toolbox/badges/v0.0.1/coverage.svg)
+[![package](https://img.shields.io/npm/v/typedoc-toolbox?logo=npm)](https://www.npmjs.com/package/typedoc-toolbox)
+[![downloads](https://img.shields.io/npm/dw/typedoc-toolbox?logo=npm)](https://www.npmjs.com/package/typedoc-toolbox)
+[![issues](https://img.shields.io/gitlab/issues/open/hperchec/typedoc-toolbox?gitlab_url=https%3A%2F%2Fgitlab.com)](https://gitlab.com/hperchec/typedoc-toolbox/issues)
+[![license](https://img.shields.io/gitlab/license/hperchec/typedoc-toolbox?gitlab_url=https%3A%2F%2Fgitlab.com)](https://gitlab.com/hperchec/typedoc-toolbox/-/blob/dd0823badca2649c726e982b074fb76665fbb1d6/LICENSE)
+
+## Table of contents
+
+* [🍵 Introduction](#-introduction)
+* [🚀 Get started](#-get-started)
+* [🛠️ Usage](#️-usage)
+* [🤝 Contribute](#-contribute)
+* [👑 Author](#-author)
+* [⚖️ License](#️-license)
+* [📰 Changelog](#-changelog)
+
+## 🍵 Introduction
+
+This library is a collection of useful tools for [TypeDoc](https://typedoc.org/index.html).
+
+## 🚀 Get started
+
+This package is published on [NPM](https://www.npmjs.com/package/typedoc-toolbox).
+
+```sh
+npm install typedoc-toolbox
+```
+
+## 🛠️ Usage
+
+> 💡 Please check the [API documentation](https://gitlab.com/hperchec/typedoc-toolbox/-/blob/dd0823badca2649c726e982b074fb76665fbb1d6/docs/api/gen/README.md).
+
+## 🤝 Contribute
+
+You would like to contribute to this project? You are welcome!
+
+First, please check:
+
+* the [contribution guide](https://gitlab.com/hperchec/typedoc-toolbox/-/blob/dd0823badca2649c726e982b074fb76665fbb1d6/CONTRIBUTING.md)
+* the [code of conduct](https://gitlab.com/hperchec/typedoc-toolbox/-/blob/dd0823badca2649c726e982b074fb76665fbb1d6/CODE_OF_CONDUCT.md)
+
+## 👑 Author
+
+Made with ❤ by [Hervé Perchec](https://gitlab.com/herveperchec)
+
+## ⚖️ License
+
+[MIT](https://gitlab.com/hperchec/typedoc-toolbox/-/blob/dd0823badca2649c726e982b074fb76665fbb1d6/LICENSE)
+
+## 📰 Changelog
+
+See all changes to this project in the [CHANGELOG.md](https://gitlab.com/hperchec/typedoc-toolbox/-/blob/dd0823badca2649c726e982b074fb76665fbb1d6/CHANGELOG.md) file.
+
+***
+
+<!-- markdownlint-disable-next-line line-length -->
+
+*README.md - this file was auto generated with [juisy](https://www.npmjs.com/package/juisy) README templater. Don't edit it.*

package/dist/index.cjs

@@ -0,0 +1,225 @@
+/*!
+ * typedoc-toolbox v0.0.1
+ * MIT License
+ * Copyright © 2025-Present Hervé Perchec (https://gitlab.com/herveperchec)
+ */
+
+'use strict';
+
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+
+const os = require('node:os');
+const fs = require('node:fs/promises');
+const node_fs = require('node:fs');
+const path = require('node:path');
+const juisy = require('juisy');
+const dayjs = require('dayjs');
+const td = require('typedoc');
+
+function _interopNamespaceDefault(e) {
+  const n = Object.create(null, { [Symbol.toStringTag]: { value: 'Module' } });
+  if (e) {
+    for (const k in e) {
+      if (k !== 'default') {
+        const d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: () => e[k]
+        });
+      }
+    }
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+const td__namespace = /*#__PURE__*/_interopNamespaceDefault(td);
+
+class TDOptionError extends Error {
+}
+class TDCompileError extends Error {
+}
+class TDValidationError extends Error {
+}
+class TDOutputError extends Error {
+}
+const dryRunsTempRootDir = path.join(os.tmpdir(), "typedoc-toolbox-dry-runs");
+async function createApp(options = {}, readers = []) {
+  return await td__namespace.Application.bootstrapWithPlugins({
+    // By default, only errors are logged
+    logLevel: 3,
+    // No entry points
+    entryPoints: [],
+    // Prevent cleaning output directory
+    cleanOutputDir: false,
+    ...options
+  }, [
+    // new td.TypeDocReader(),
+    // new td.PackageJsonReader(),
+    // new td.TSConfigReader()
+    ...readers
+  ]);
+}
+function getRawConfig(app) {
+  return app.options.getRawValues();
+}
+async function run(app, options) {
+  options = options ?? { dry: false };
+  if (options.dry) {
+    app.logger.info("Dry run started");
+  }
+  const optionsSnapshot = app.options.snapshot();
+  let context;
+  const start = Date.now();
+  const throwRunError = (error) => {
+    logRunSummary(app.logger);
+    throw error;
+  };
+  if (app.logger.hasErrors()) {
+    throwRunError(new TDOptionError("TypeDoc option error"));
+  }
+  if (app.options.getValue("treatWarningsAsErrors") && app.logger.hasWarnings()) {
+    throwRunError(new TDOptionError("TypeDoc option error"));
+  }
+  const getConverterContext = (ctx) => {
+    context = ctx;
+  };
+  app.converter.on(td__namespace.Converter.EVENT_END, getConverterContext);
+  if (!await app.convert() || app.logger.hasErrors()) {
+    throwRunError(new TDCompileError("Compilation error"));
+  }
+  if (app.options.getValue("treatWarningsAsErrors") && app.logger.hasWarnings()) {
+    throwRunError(new TDCompileError("Compilation error"));
+  }
+  app.converter.off(td__namespace.Converter.EVENT_END, getConverterContext);
+  const project = context.project;
+  const preValidationWarnCount = app.logger.warningCount;
+  app.validate(project);
+  const hadValidationWarnings = app.logger.warningCount !== preValidationWarnCount || app.logger.validationWarningCount != 0;
+  if (app.logger.hasErrors()) {
+    throwRunError(new TDValidationError("Validation error"));
+  }
+  if (hadValidationWarnings && (app.options.getValue("treatWarningsAsErrors") || app.options.getValue("treatValidationWarningsAsErrors"))) {
+    throwRunError(new TDValidationError("Validation error"));
+  }
+  if (app.options.getValue("emit") !== "none") {
+    if (options.dry) {
+      await dryOutput(app, project);
+    } else {
+      await app.generateOutputs(project);
+    }
+    if (app.logger.hasErrors()) {
+      throwRunError(new TDOutputError("Output error"));
+    }
+    if (app.options.getValue("treatWarningsAsErrors") && app.logger.hasWarnings()) {
+      throwRunError(new TDOutputError("Output error"));
+    }
+  }
+  app.options.restore(optionsSnapshot);
+  app.logger.verbose(`Full run took ${Date.now() - start}ms`);
+  return {
+    application: app,
+    context
+  };
+}
+async function dryOutput(app, project) {
+  const optionsSnapshot = app.options.snapshot();
+  app.options.setValue("cleanOutputDir", false);
+  if (!node_fs.existsSync(dryRunsTempRootDir)) {
+    await fs.mkdir(dryRunsTempRootDir);
+  }
+  const tempDirPath = path.join(dryRunsTempRootDir, dayjs().format("YYYYMMDDHHmmssSSS"));
+  await fs.mkdir(tempDirPath);
+  try {
+    app.logger.info(`Temporary folder "${tempDirPath}" succesfully created`);
+    const originalGetOutputSpecs = app.outputs.getOutputSpecs.bind(app.outputs);
+    app.outputs.getOutputSpecs = function() {
+      return originalGetOutputSpecs().map((outputSpec, index) => {
+        const extension = path.extname(outputSpec.path);
+        outputSpec.path = juisy.utils.path.toPosix(path.join(tempDirPath, `${outputSpec.name}_${index}${extension}`));
+        return outputSpec;
+      });
+    };
+    await app.generateOutputs(project);
+    app.logger.info(`Temporary folder "${tempDirPath}" succesfully deleted`);
+    app.outputs.getOutputSpecs = originalGetOutputSpecs;
+    app.options.restore(optionsSnapshot);
+  } finally {
+    await fs.rm(tempDirPath, { recursive: true, force: true });
+  }
+}
+function logRunSummary(logger) {
+  const { errorCount, warningCount } = logger;
+  if (errorCount) {
+    logger.error(
+      td__namespace.i18n.found_0_errors_and_1_warnings(
+        errorCount.toString(),
+        warningCount.toString()
+      )
+    );
+  } else if (warningCount) {
+    logger.warn(
+      td__namespace.i18n.found_0_errors_and_1_warnings(
+        errorCount.toString(),
+        warningCount.toString()
+      )
+    );
+  }
+}
+async function createReflectionUrlResolver(app) {
+  const outputSpecs = app.outputs.getOutputSpecs();
+  if (outputSpecs.length > 1) {
+    throw new Error(`Unable to create reflection URL resolver with multiple outputs [ ${outputSpecs.map((o) => `"${o.name}"`).join(", ")} ]. Please provide only one theme.`);
+  } else if (outputSpecs[0].name === "json") {
+    throw new Error(`Unable to create reflection URL resolver with JSON output.`);
+  }
+  const reflectionsCache = {};
+  const optionsSnapshot = app.options.snapshot();
+  app.options.setValue("emit", "docs");
+  let router;
+  let getFullUrl;
+  app.renderer.on(td__namespace.RendererEvent.BEGIN, () => {
+    router = app.renderer.router;
+    getFullUrl = router.getFullUrl.bind(router);
+  });
+  const { context } = await run(app, { dry: true });
+  app.options.restore(optionsSnapshot);
+  return function resolver(identifier) {
+    if (!reflectionsCache[identifier]) {
+      const tempRefl = new td__namespace.DeclarationReflection("__TEMP__", td__namespace.ReflectionKind.All, context.project);
+      tempRefl.comment = new td__namespace.Comment([
+        { kind: "inline-tag", tag: "@link", text: identifier }
+      ]);
+      app.converter.resolveLinks(tempRefl);
+      const resolvedTag = tempRefl.comment.summary[0];
+      const targetReflection = resolvedTag.target;
+      reflectionsCache[resolvedTag.text] = {
+        reflection: targetReflection,
+        url: targetReflection ? getFullUrl(targetReflection) : void 0
+      };
+    }
+    return reflectionsCache[identifier].url;
+  };
+}
+function getReflectionTag(tag, reflection) {
+  const comment = reflection.comment;
+  if (!comment) return;
+  return comment.getTag(tag);
+}
+function getReflectionTags(tag, reflection) {
+  const comment = reflection.comment;
+  if (!comment) return [];
+  return comment.getTags(tag);
+}
+
+exports.TDCompileError = TDCompileError;
+exports.TDOptionError = TDOptionError;
+exports.TDOutputError = TDOutputError;
+exports.TDValidationError = TDValidationError;
+exports.createApp = createApp;
+exports.createReflectionUrlResolver = createReflectionUrlResolver;
+exports.dryRunsTempRootDir = dryRunsTempRootDir;
+exports.getRawConfig = getRawConfig;
+exports.getReflectionTag = getReflectionTag;
+exports.getReflectionTags = getReflectionTags;
+exports.run = run;

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+/**
+ * @module
+ * @importTarget .
+ */
+import * as td from 'typedoc';
+/**
+ * All TypeDoc error types
+ */
+export type TDError = TDOptionError | TDCompileError | TDValidationError | TDOutputError;
+/**
+ * TypeDoc option error
+ */
+export declare class TDOptionError extends Error {
+}
+/**
+ * TypeDoc compilation error
+ */
+export declare class TDCompileError extends Error {
+}
+/**
+ * TypeDoc validation error
+ */
+export declare class TDValidationError extends Error {
+}
+/**
+ * TypeDoc output error
+ */
+export declare class TDOutputError extends Error {
+}
+/**
+ * {@link createApp} function options
+ */
+export interface CreateAppOptions extends Omit<td.Configuration.TypeDocOptions, 'help' | 'version' | 'watch' | 'plugin'> {
+    plugin?: Array<string | ((app: td.Application) => Promise<void> | void)>;
+}
+/**
+ * {@link run} function options
+ */
+export interface RunOptions {
+    /**
+     * Dry run (no emit). Default: `false`
+     */
+    dry: boolean;
+}
+/**
+ * Type of function returned by {@link createReflectionUrlResolver}.
+ * @param identifier - The reflection identifier in a `@link` style
+ * @returns The resolved URL or undefined
+ */
+export type ReflectionUrlResolver = (identifier: string) => string | undefined;
+/**
+ * The path of temporary folder for dry runs
+ */
+export declare const dryRunsTempRootDir: string;
+/**
+ * Create and boot a new TypeDoc application
+ *
+ * Default options:
+ * - **logLevel**: `3`
+ * - **entryPoints**: `[]`
+ * - **cleanOutputDir**: `false`
+ *
+ * @param options - The base options
+ * @param readers - The option readers
+ * @returns The created application
+ *
+ * @example
+ * import * as td from 'typedoc'
+ *
+ * const app = await createApp()
+ * // With options
+ * const app = await createApp({
+ *   // See CreateAppOptions
+ * })
+ * // With default readers
+ * const app = await createApp({}, [
+ *   new td.TypeDocReader(),
+ *   new td.PackageJsonReader(),
+ *   new td.TSConfigReader()
+ * ])
+ */
+export declare function createApp(options?: CreateAppOptions, readers?: td.Configuration.OptionsReader[]): Promise<td.Application>;
+/**
+ * Get all of the TypeDoc option values defined in the app option container.
+ * @param app - The TypeDoc Application instance
+ */
+export declare function getRawConfig(app: td.Application): Readonly<Partial<td.Configuration.TypeDocOptionValues>>;
+/**
+ * Run a TypeDoc process like the CLI does.
+ *
+ * This code is widely inspired from
+ * [TypeDoc library sources](https://github.com/TypeStrong/typedoc/blob/v0.28.16/src/lib/cli.ts)
+ *
+ * Thanks to [Gerrit Birkeland](https://github.com/Gerrit0), the author of TypeDoc.
+ *
+ * @param app - The TypeDoc Application instance
+ *
+ * @example
+ * const result = await run(app)
+ * // Dry run
+ * const result = await run(app, { dry: true })
+ */
+export declare function run(app: td.Application, options?: RunOptions): Promise<{
+    application: td.Application;
+    context: td.Context;
+}>;
+/**
+ * Create a reflection URL resolver from the given TypeDoc application instance.
+ * @returns The resolver function
+ * @example
+ * // With the default "html" output
+ * const resolver = await createReflectionUrlResolver(app)
+ * // For a "bar" constant in the "foo" module
+ * resolver('foo!bar') // => 'variables/foo.bar.html'
+ * // For a "bar" method of the "Foo" class in the "foo" module
+ * resolver('foo!Foo#bar') // => 'classes/foo.Foo.html#bar'
+ */
+export declare function createReflectionUrlResolver(app: td.Application): Promise<ReflectionUrlResolver>;
+/**
+ * Get the tag in reflection comment
+ * @param tag - The tag to find
+ * @param reflection - The reflection object
+ * @returns The found comment tag or undefined
+ */
+export declare function getReflectionTag(tag: td.TagString, reflection: td.Reflection): td.CommentTag | undefined;
+/**
+ * Get the tags in reflection comment
+ * @param tag - The tag to find
+ * @param reflection - The reflection object
+ * @returns The found comment tags or empty array
+ */
+export declare function getReflectionTags(tag: td.TagString, reflection: td.Reflection): td.CommentTag[];

package/dist/index.js

@@ -0,0 +1,192 @@
+/*!
+ * typedoc-toolbox v0.0.1
+ * MIT License
+ * Copyright © 2025-Present Hervé Perchec (https://gitlab.com/herveperchec)
+ */
+
+import os from 'node:os';
+import fs from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import path from 'node:path';
+import { utils } from 'juisy';
+import dayjs from 'dayjs';
+import * as td from 'typedoc';
+
+class TDOptionError extends Error {
+}
+class TDCompileError extends Error {
+}
+class TDValidationError extends Error {
+}
+class TDOutputError extends Error {
+}
+const dryRunsTempRootDir = path.join(os.tmpdir(), "typedoc-toolbox-dry-runs");
+async function createApp(options = {}, readers = []) {
+  return await td.Application.bootstrapWithPlugins({
+    // By default, only errors are logged
+    logLevel: 3,
+    // No entry points
+    entryPoints: [],
+    // Prevent cleaning output directory
+    cleanOutputDir: false,
+    ...options
+  }, [
+    // new td.TypeDocReader(),
+    // new td.PackageJsonReader(),
+    // new td.TSConfigReader()
+    ...readers
+  ]);
+}
+function getRawConfig(app) {
+  return app.options.getRawValues();
+}
+async function run(app, options) {
+  options = options ?? { dry: false };
+  if (options.dry) {
+    app.logger.info("Dry run started");
+  }
+  const optionsSnapshot = app.options.snapshot();
+  let context;
+  const start = Date.now();
+  const throwRunError = (error) => {
+    logRunSummary(app.logger);
+    throw error;
+  };
+  if (app.logger.hasErrors()) {
+    throwRunError(new TDOptionError("TypeDoc option error"));
+  }
+  if (app.options.getValue("treatWarningsAsErrors") && app.logger.hasWarnings()) {
+    throwRunError(new TDOptionError("TypeDoc option error"));
+  }
+  const getConverterContext = (ctx) => {
+    context = ctx;
+  };
+  app.converter.on(td.Converter.EVENT_END, getConverterContext);
+  if (!await app.convert() || app.logger.hasErrors()) {
+    throwRunError(new TDCompileError("Compilation error"));
+  }
+  if (app.options.getValue("treatWarningsAsErrors") && app.logger.hasWarnings()) {
+    throwRunError(new TDCompileError("Compilation error"));
+  }
+  app.converter.off(td.Converter.EVENT_END, getConverterContext);
+  const project = context.project;
+  const preValidationWarnCount = app.logger.warningCount;
+  app.validate(project);
+  const hadValidationWarnings = app.logger.warningCount !== preValidationWarnCount || app.logger.validationWarningCount != 0;
+  if (app.logger.hasErrors()) {
+    throwRunError(new TDValidationError("Validation error"));
+  }
+  if (hadValidationWarnings && (app.options.getValue("treatWarningsAsErrors") || app.options.getValue("treatValidationWarningsAsErrors"))) {
+    throwRunError(new TDValidationError("Validation error"));
+  }
+  if (app.options.getValue("emit") !== "none") {
+    if (options.dry) {
+      await dryOutput(app, project);
+    } else {
+      await app.generateOutputs(project);
+    }
+    if (app.logger.hasErrors()) {
+      throwRunError(new TDOutputError("Output error"));
+    }
+    if (app.options.getValue("treatWarningsAsErrors") && app.logger.hasWarnings()) {
+      throwRunError(new TDOutputError("Output error"));
+    }
+  }
+  app.options.restore(optionsSnapshot);
+  app.logger.verbose(`Full run took ${Date.now() - start}ms`);
+  return {
+    application: app,
+    context
+  };
+}
+async function dryOutput(app, project) {
+  const optionsSnapshot = app.options.snapshot();
+  app.options.setValue("cleanOutputDir", false);
+  if (!existsSync(dryRunsTempRootDir)) {
+    await fs.mkdir(dryRunsTempRootDir);
+  }
+  const tempDirPath = path.join(dryRunsTempRootDir, dayjs().format("YYYYMMDDHHmmssSSS"));
+  await fs.mkdir(tempDirPath);
+  try {
+    app.logger.info(`Temporary folder "${tempDirPath}" succesfully created`);
+    const originalGetOutputSpecs = app.outputs.getOutputSpecs.bind(app.outputs);
+    app.outputs.getOutputSpecs = function() {
+      return originalGetOutputSpecs().map((outputSpec, index) => {
+        const extension = path.extname(outputSpec.path);
+        outputSpec.path = utils.path.toPosix(path.join(tempDirPath, `${outputSpec.name}_${index}${extension}`));
+        return outputSpec;
+      });
+    };
+    await app.generateOutputs(project);
+    app.logger.info(`Temporary folder "${tempDirPath}" succesfully deleted`);
+    app.outputs.getOutputSpecs = originalGetOutputSpecs;
+    app.options.restore(optionsSnapshot);
+  } finally {
+    await fs.rm(tempDirPath, { recursive: true, force: true });
+  }
+}
+function logRunSummary(logger) {
+  const { errorCount, warningCount } = logger;
+  if (errorCount) {
+    logger.error(
+      td.i18n.found_0_errors_and_1_warnings(
+        errorCount.toString(),
+        warningCount.toString()
+      )
+    );
+  } else if (warningCount) {
+    logger.warn(
+      td.i18n.found_0_errors_and_1_warnings(
+        errorCount.toString(),
+        warningCount.toString()
+      )
+    );
+  }
+}
+async function createReflectionUrlResolver(app) {
+  const outputSpecs = app.outputs.getOutputSpecs();
+  if (outputSpecs.length > 1) {
+    throw new Error(`Unable to create reflection URL resolver with multiple outputs [ ${outputSpecs.map((o) => `"${o.name}"`).join(", ")} ]. Please provide only one theme.`);
+  } else if (outputSpecs[0].name === "json") {
+    throw new Error(`Unable to create reflection URL resolver with JSON output.`);
+  }
+  const reflectionsCache = {};
+  const optionsSnapshot = app.options.snapshot();
+  app.options.setValue("emit", "docs");
+  let router;
+  let getFullUrl;
+  app.renderer.on(td.RendererEvent.BEGIN, () => {
+    router = app.renderer.router;
+    getFullUrl = router.getFullUrl.bind(router);
+  });
+  const { context } = await run(app, { dry: true });
+  app.options.restore(optionsSnapshot);
+  return function resolver(identifier) {
+    if (!reflectionsCache[identifier]) {
+      const tempRefl = new td.DeclarationReflection("__TEMP__", td.ReflectionKind.All, context.project);
+      tempRefl.comment = new td.Comment([
+        { kind: "inline-tag", tag: "@link", text: identifier }
+      ]);
+      app.converter.resolveLinks(tempRefl);
+      const resolvedTag = tempRefl.comment.summary[0];
+      const targetReflection = resolvedTag.target;
+      reflectionsCache[resolvedTag.text] = {
+        reflection: targetReflection,
+        url: targetReflection ? getFullUrl(targetReflection) : void 0
+      };
+    }
+    return reflectionsCache[identifier].url;
+  };
+}
+function getReflectionTag(tag, reflection) {
+  const comment = reflection.comment;
+  if (!comment) return;
+  return comment.getTag(tag);
+}
+function getReflectionTags(tag, reflection) {
+  const comment = reflection.comment;
+  if (!comment) return [];
+  return comment.getTags(tag);
+}
+
+export { TDCompileError, TDOptionError, TDOutputError, TDValidationError, createApp, createReflectionUrlResolver, dryRunsTempRootDir, getRawConfig, getReflectionTag, getReflectionTags, run };

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "typedoc-toolbox",
+  "version": "0.0.1",
+  "description": "A collection of useful tools for TypeDoc library",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "docs:readme": "node ./bin/cli docs generate:readme",
+    "docs:api": "node ./bin/cli docs generate:api -c ./docs/config/api/typedoc.config.js",
+    "docs:cli": "npm run -s docs:cli:private && npm run -s docs:cli:public",
+    "docs:cli:private": "node ./bin/cli docs generate:cli -c ./docs/config/cli/private/config.js",
+    "docs:cli:public": "node ./bin/cli docs generate:cli -c ./docs/config/cli/public/config.js",
+    "docs": "npm run -s docs:api && npm run -s docs:readme && npm run -s docs:cli",
+    "lint": "node ./bin/cli lint",
+    "lint:fix": "npm run -s lint -- --fix",
+    "lint:markdown": "node ./bin/cli lint:markdown",
+    "lint:markdown:fix": "npm run -s lint:markdown -- --fix",
+    "release": "node ./bin/cli release",
+    "changelog": "node ./bin/cli changelog",
+    "git-hooks:reset": "node ./bin/cli git-hooks reset",
+    "git-hooks:sync": "node ./bin/cli git-hooks sync",
+    "test": "node ./bin/cli test run",
+    "test:watch": "node ./bin/cli test",
+    "test:ui": "npm run -s test:watch -- --ui --coverage.enabled=true",
+    "test:coverage": "npm run -s test -- --coverage.enabled=true"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/hperchec/typedoc-toolbox.git"
+  },
+  "author": {
+    "name": "Hervé Perchec",
+    "url": "https://gitlab.com/herveperchec"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://gitlab.com/hperchec/typedoc-toolbox/issues"
+  },
+  "homepage": "https://gitlab.com/hperchec/typedoc-toolbox",
+  "keywords": [
+    "typedoc",
+    "typedoc-plugin",
+    "tool",
+    "tools",
+    "toolbox",
+    "api",
+    "documentation"
+  ],
+  "dependencies": {
+    "dayjs": "^1.11.19",
+    "juisy": "^2.2.0",
+    "typedoc": "^0.28.16"
+  },
+  "devDependencies": {
+    "@release-it/conventional-changelog": "^9.0.4",
+    "@vitest/coverage-v8": "^3",
+    "@vitest/ui": "^3",
+    "eslint-plugin-jsdoc": "^50.8.0",
+    "eslint-plugin-tsdoc": "^0.5.0",
+    "remark-insert-headings": "^0.0.0",
+    "remark-toc": "^9.0.0",
+    "simple-git-hooks": "^2.13.1",
+    "typedoc-plugin-default-groups": "^1.0.2",
+    "typedoc-plugin-dt-links": "^2.0.39",
+    "typedoc-plugin-import-target": "^1.3.2",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-mdn-links": "^5.1.1",
+    "typedoc-plugin-remark": "^2.0.1",
+    "typescript-eslint": "^8.39.1",
+    "vite-plugin-checker": "^0.11.0",
+    "vite-plugin-dts": "^4.5.4",
+    "vitest": "^3"
+  },
+  "peerDependencies": {
+    "typedoc": "^0.28.16"
+  }
+}