typedoc - npm Package Compare versions

Comparing version 0.24.7 to 0.24.8

dist/lib/application.d.ts

@@ -80,2 +80,11 @@ import { Converter } from "./converter/index";
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = new Application();
+     * app.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options - Options to set during initialization
      */
@@ -82,0 +91,0 @@ bootstrap(options?: Partial<TypeDocOptions>): void;

dist/lib/application.js

@@ -75,3 +75,3 @@ "use strict";
  */
-let Application = Application_1 = class Application extends component_1.ChildableComponent {
+let Application = exports.Application = Application_1 = class Application extends component_1.ChildableComponent {
     /**
@@ -108,2 +108,11 @@ * Create a new TypeDoc application instance.
      * Initialize TypeDoc without loading plugins.
+     *
+     * @example
+     * Initialize the application with pretty-printing output disabled.
+     * ```ts
+     * const app = new Application();
+     * app.bootstrap({ pretty: false });
+     * ```
+     *
+     * @param options - Options to set during initialization
      */
@@ -443,5 +452,4 @@ bootstrap(options = {}) {
 ], Application.prototype, "entryPoints", void 0);
-Application = Application_1 = __decorate([
+exports.Application = Application = Application_1 = __decorate([
     (0, component_1.Component)({ name: "application", internal: true })
 ], Application);
-exports.Application = Application;

dist/lib/converter/comments/lexer.js

@@ -13,2 +13,2 @@ "use strict";
     TokenSyntaxKind["TypeAnnotation"] = "type";
-})(TokenSyntaxKind = exports.TokenSyntaxKind || (exports.TokenSyntaxKind = {}));
+})(TokenSyntaxKind || (exports.TokenSyntaxKind = TokenSyntaxKind = {}));

dist/lib/converter/converter.js

@@ -31,3 +31,3 @@ "use strict";
  */
-let Converter = Converter_1 = class Converter extends component_1.ChildableComponent {
+let Converter = exports.Converter = Converter_1 = class Converter extends component_1.ChildableComponent {
     get config() {
@@ -347,3 +347,3 @@ return this._config || this._buildCommentParserConfig();
 ], Converter.prototype, "useTsLinkResolution", void 0);
-Converter = Converter_1 = __decorate([
+exports.Converter = Converter = Converter_1 = __decorate([
     (0, component_1.Component)({
@@ -355,3 +355,2 @@ name: "converter",
 ], Converter);
-exports.Converter = Converter;
 function getSymbolForModuleLike(context, node) {
@@ -358,0 +357,0 @@ const symbol = context.checker.getSymbolAtLocation(node) ?? node.symbol;

dist/lib/converter/plugins/CategoryPlugin.js

@@ -21,3 +21,3 @@ "use strict";
  */
-let CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_1.ConverterComponent {
+let CategoryPlugin = exports.CategoryPlugin = CategoryPlugin_1 = class CategoryPlugin extends components_1.ConverterComponent {
     constructor() {
@@ -236,5 +236,4 @@ super(...arguments);
 ], CategoryPlugin.prototype, "boosts", void 0);
-CategoryPlugin = CategoryPlugin_1 = __decorate([
+exports.CategoryPlugin = CategoryPlugin = CategoryPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "category" })
 ], CategoryPlugin);
-exports.CategoryPlugin = CategoryPlugin;

dist/lib/converter/plugins/CommentPlugin.js

@@ -91,3 +91,3 @@ "use strict";
  */
-let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {
+let CommentPlugin = exports.CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {
     get excludeNotDocumentedKinds() {
@@ -293,7 +293,11 @@ this._excludeKinds ?? (this._excludeKinds = this.application.options
         }
-        const comment = reflection.comment;
+        const comment = reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)
+            ? undefined
+            : reflection.comment;
         // Since this reflection has signatures, remove the comment from the parent
         // reflection. This is important so that in type aliases we don't end up with
         // a comment rendered twice.
-        delete reflection.comment;
+        if (!reflection.kindOf(models_1.ReflectionKind.ClassOrInterface)) {
+            delete reflection.comment;
+        }
         for (const signature of signatures) {
@@ -419,6 +423,5 @@ const childComment = (signature.comment || (signature.comment = comment?.clone()));
 ], CommentPlugin.prototype, "excludeNotDocumented", void 0);
-CommentPlugin = __decorate([
+exports.CommentPlugin = CommentPlugin = __decorate([
     (0, components_1.Component)({ name: "comment" })
 ], CommentPlugin);
-exports.CommentPlugin = CommentPlugin;
 function inTypeLiteral(refl) {
@@ -425,0 +428,0 @@ while (refl) {

dist/lib/converter/plugins/GroupPlugin.js

@@ -23,3 +23,3 @@ "use strict";
  */
-let GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.ConverterComponent {
+let GroupPlugin = exports.GroupPlugin = GroupPlugin_1 = class GroupPlugin extends components_1.ConverterComponent {
     constructor() {
@@ -174,5 +174,4 @@ super(...arguments);
 ], GroupPlugin.prototype, "groupOrder", void 0);
-GroupPlugin = GroupPlugin_1 = __decorate([
+exports.GroupPlugin = GroupPlugin = GroupPlugin_1 = __decorate([
     (0, components_1.Component)({ name: "group" })
 ], GroupPlugin);
-exports.GroupPlugin = GroupPlugin;

dist/lib/converter/plugins/ImplementsPlugin.js

@@ -25,3 +25,3 @@ "use strict";
  */
-let ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComponent {
+let ImplementsPlugin = exports.ImplementsPlugin = class ImplementsPlugin extends components_1.ConverterComponent {
     constructor() {
@@ -228,6 +228,5 @@ super(...arguments);
 };
-ImplementsPlugin = __decorate([
+exports.ImplementsPlugin = ImplementsPlugin = __decorate([
     (0, components_1.Component)({ name: "implements" })
 ], ImplementsPlugin);
-exports.ImplementsPlugin = ImplementsPlugin;
 function constructorInheritance(context, reflection, childDecl, constructorDecl) {
@@ -234,0 +233,0 @@ const extendsClause = childDecl.heritageClauses?.find((cl) => cl.token === typescript_1.default.SyntaxKind.ExtendsKeyword);

dist/lib/converter/plugins/InheritDocPlugin.js

@@ -31,3 +31,3 @@ "use strict";
  */
-let InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComponent {
+let InheritDocPlugin = exports.InheritDocPlugin = class InheritDocPlugin extends components_1.ConverterComponent {
     constructor() {
@@ -163,6 +163,5 @@ super(...arguments);
 };
-InheritDocPlugin = __decorate([
+exports.InheritDocPlugin = InheritDocPlugin = __decorate([
     (0, components_1.Component)({ name: "inheritDoc" })
 ], InheritDocPlugin);
-exports.InheritDocPlugin = InheritDocPlugin;
 function copySummaries(source, target) {
@@ -169,0 +168,0 @@ for (const [s, t] of (0, array_1.zip)(source || [], target || [])) {

dist/lib/converter/plugins/LinkResolverPlugin.js

@@ -19,3 +19,3 @@ "use strict";
  */
-let LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
+let LinkResolverPlugin = exports.LinkResolverPlugin = class LinkResolverPlugin extends components_1.ConverterComponent {
     initialize() {
@@ -60,5 +60,4 @@ super.initialize();
 ], LinkResolverPlugin.prototype, "validation", void 0);
-LinkResolverPlugin = __decorate([
+exports.LinkResolverPlugin = LinkResolverPlugin = __decorate([
     (0, components_1.Component)({ name: "link-resolver" })
 ], LinkResolverPlugin);
-exports.LinkResolverPlugin = LinkResolverPlugin;

dist/lib/converter/plugins/PackagePlugin.js

@@ -46,3 +46,3 @@ "use strict";
  */
-let PackagePlugin = class PackagePlugin extends components_1.ConverterComponent {
+let PackagePlugin = exports.PackagePlugin = class PackagePlugin extends components_1.ConverterComponent {
     initialize() {
@@ -145,5 +145,4 @@ this.listenTo(this.owner, {
 ], PackagePlugin.prototype, "includeVersion", void 0);
-PackagePlugin = __decorate([
+exports.PackagePlugin = PackagePlugin = __decorate([
     (0, components_1.Component)({ name: "package" })
 ], PackagePlugin);
-exports.PackagePlugin = PackagePlugin;

dist/lib/converter/plugins/SourcePlugin.js

@@ -26,3 +26,3 @@ "use strict";
  */
-let SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
+let SourcePlugin = exports.SourcePlugin = class SourcePlugin extends components_1.ConverterComponent {
     constructor() {
@@ -167,5 +167,4 @@ super(...arguments);
 ], SourcePlugin.prototype, "basePath", void 0);
-SourcePlugin = __decorate([
+exports.SourcePlugin = SourcePlugin = __decorate([
     (0, components_1.Component)({ name: "source" })
 ], SourcePlugin);
-exports.SourcePlugin = SourcePlugin;

dist/lib/converter/plugins/TypePlugin.js

@@ -18,3 +18,3 @@ "use strict";
  */
-let TypePlugin = class TypePlugin extends components_1.ConverterComponent {
+let TypePlugin = exports.TypePlugin = class TypePlugin extends components_1.ConverterComponent {
     constructor() {
@@ -125,5 +125,4 @@ super(...arguments);
 };
-TypePlugin = __decorate([
+exports.TypePlugin = TypePlugin = __decorate([
     (0, components_1.Component)({ name: "type" })
 ], TypePlugin);
-exports.TypePlugin = TypePlugin;

dist/lib/models/reflections/abstract.js

@@ -37,3 +37,3 @@ "use strict";
     ReflectionFlag[ReflectionFlag["Readonly"] = 4096] = "Readonly";
-})(ReflectionFlag = exports.ReflectionFlag || (exports.ReflectionFlag = {}));
+})(ReflectionFlag || (exports.ReflectionFlag = ReflectionFlag = {}));
 const relevantFlags = [
@@ -174,2 +174,3 @@ ReflectionFlag.Private,
 }
+exports.ReflectionFlags = ReflectionFlags;
 ReflectionFlags.serializedFlags = [
@@ -188,3 +189,2 @@ "isPrivate",
 ];
-exports.ReflectionFlags = ReflectionFlags;
 var TraverseProperty;
@@ -200,3 +200,3 @@ (function (TraverseProperty) {
     TraverseProperty[TraverseProperty["SetSignature"] = 7] = "SetSignature";
-})(TraverseProperty = exports.TraverseProperty || (exports.TraverseProperty = {}));
+})(TraverseProperty || (exports.TraverseProperty = TraverseProperty = {}));
 /**
@@ -203,0 +203,0 @@ * Base class for all reflection classes.

dist/lib/models/reflections/declaration.js

@@ -18,3 +18,3 @@ "use strict";
     ConversionFlags[ConversionFlags["VariableOrPropertySource"] = 1] = "VariableOrPropertySource";
-})(ConversionFlags = exports.ConversionFlags || (exports.ConversionFlags = {}));
+})(ConversionFlags || (exports.ConversionFlags = ConversionFlags = {}));
 /**
@@ -21,0 +21,0 @@ * A reflection that represents a single declaration emitted by the TypeScript compiler.

dist/lib/models/reflections/kind.js

@@ -34,3 +34,3 @@ "use strict";
     ReflectionKind[ReflectionKind["Reference"] = 8388608] = "Reference";
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
+})(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 (function (ReflectionKind) {
@@ -133,5 +133,5 @@ ReflectionKind.All = ReflectionKind.Reference * 2 - 1;
     ReflectionKind.classString = classString;
-})(ReflectionKind = exports.ReflectionKind || (exports.ReflectionKind = {}));
+})(ReflectionKind || (exports.ReflectionKind = ReflectionKind = {}));
 function getKindString(kind) {
     return ReflectionKind[kind].replace(/(.)([A-Z])/g, (_m, a, b) => a + " " + b.toLowerCase());
 }

dist/lib/output/events.d.ts

@@ -104,2 +104,3 @@ import { Event } from "../utils/events";
  * @see {@link MarkdownEvent.PARSE}
+ * @see {@link MarkdownEvent.INCLUDE}
  */
@@ -124,2 +125,7 @@ export declare class MarkdownEvent extends Event {
     static readonly PARSE = "parseMarkdown";
+    /**
+     * Triggered on the renderer when this plugin includes a markdown file through a markdown include tag.
+     * @event
+     */
+    static readonly INCLUDE = "includeMarkdown";
     constructor(name: string, page: PageEvent, originalText: string, parsedText: string);
@@ -126,0 +132,0 @@ }

dist/lib/output/events.js

@@ -57,2 +57,3 @@ "use strict";
 }
+exports.RendererEvent = RendererEvent;
 /**
@@ -68,3 +69,2 @@ * Triggered before the renderer starts rendering a project.
 RendererEvent.END = "endRender";
-exports.RendererEvent = RendererEvent;
 /**
@@ -88,2 +88,3 @@ * An event emitted by the {@link Renderer} class before and after the
 }
+exports.PageEvent = PageEvent;
 /**
@@ -99,3 +100,2 @@ * Triggered before a document will be rendered.
 PageEvent.END = "endPage";
-exports.PageEvent = PageEvent;
 /**
@@ -105,2 +105,3 @@ * An event emitted when markdown is being parsed. Allows other plugins to manipulate the result.
  * @see {@link MarkdownEvent.PARSE}
+ * @see {@link MarkdownEvent.INCLUDE}
  */
@@ -115,2 +116,3 @@ class MarkdownEvent extends events_1.Event {
 }
+exports.MarkdownEvent = MarkdownEvent;
 /**
@@ -121,4 +123,8 @@ * Triggered on the renderer when this plugin parses a markdown string.
 MarkdownEvent.PARSE = "parseMarkdown";
-exports.MarkdownEvent = MarkdownEvent;
 /**
+ * Triggered on the renderer when this plugin includes a markdown file through a markdown include tag.
+ * @event
+ */
+MarkdownEvent.INCLUDE = "includeMarkdown";
+/**
  * An event emitted when the search index is being prepared.
@@ -154,2 +160,3 @@ */
 }
+exports.IndexEvent = IndexEvent;
 /**
@@ -160,2 +167,1 @@ * Triggered on the renderer when the search index is being prepared.
 IndexEvent.PREPARE_INDEX = "prepareIndex";
-exports.IndexEvent = IndexEvent;

dist/lib/output/plugins/AssetsPlugin.js

@@ -22,3 +22,3 @@ "use strict";
  */
-let AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
+let AssetsPlugin = exports.AssetsPlugin = class AssetsPlugin extends components_1.RendererComponent {
     /**
@@ -61,5 +61,4 @@ * Create a new AssetsPlugin instance.
 ], AssetsPlugin.prototype, "customCss", void 0);
-AssetsPlugin = __decorate([
+exports.AssetsPlugin = AssetsPlugin = __decorate([
     (0, components_1.Component)({ name: "assets" })
 ], AssetsPlugin);
-exports.AssetsPlugin = AssetsPlugin;

dist/lib/output/plugins/JavascriptIndexPlugin.js

@@ -45,3 +45,3 @@ "use strict";
  */
-let JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.RendererComponent {
+let JavascriptIndexPlugin = exports.JavascriptIndexPlugin = class JavascriptIndexPlugin extends components_1.RendererComponent {
     /**
@@ -145,5 +145,4 @@ * Create a new JavascriptIndexPlugin instance.
 ], JavascriptIndexPlugin.prototype, "searchComments", void 0);
-JavascriptIndexPlugin = __decorate([
+exports.JavascriptIndexPlugin = JavascriptIndexPlugin = __decorate([
     (0, components_1.Component)({ name: "javascript-index" })
 ], JavascriptIndexPlugin);
-exports.JavascriptIndexPlugin = JavascriptIndexPlugin;

dist/lib/output/renderer.d.ts

@@ -148,2 +148,4 @@ import type { Application } from "../application";
     darkTheme: ShikiTheme;
+    /** @internal */
+    pretty: boolean;
     renderStartTime: number;
@@ -150,0 +152,0 @@ /**

dist/lib/output/renderer.js

@@ -85,3 +85,3 @@ "use strict";
  */
-let Renderer = class Renderer extends component_1.ChildableComponent {
+let Renderer = exports.Renderer = class Renderer extends component_1.ChildableComponent {
     constructor() {
@@ -143,2 +143,3 @@ super(...arguments);
     async render(project, outputDirectory) {
+        (0, jsx_1.setRenderSettings)({ pretty: this.pretty });
         const momento = this.hooks.saveMomento();
@@ -301,8 +302,11 @@ this.renderStartTime = Date.now();
 ], Renderer.prototype, "darkTheme", void 0);
-Renderer = __decorate([
+__decorate([
+    (0, utils_1.BindOption)("pretty")
+], Renderer.prototype, "pretty", void 0);
+exports.Renderer = Renderer = __decorate([
     (0, component_1.Component)({ name: "renderer", internal: true, childClass: components_1.RendererComponent })
 ], Renderer);
-exports.Renderer = Renderer;
 // HACK: THIS HAS TO STAY DOWN HERE
 // if you try to move it up to the top of the file, then you'll run into stuff being used before it has been defined.
 require("./plugins");
+const jsx_1 = require("../utils/jsx");

dist/lib/output/theme.js

@@ -20,3 +20,3 @@ "use strict";
  */
-let Theme = class Theme extends components_1.RendererComponent {
+let Theme = exports.Theme = class Theme extends components_1.RendererComponent {
     /**
@@ -31,5 +31,4 @@ * Create a new BaseTheme instance.
 };
-Theme = __decorate([
+exports.Theme = Theme = __decorate([
     (0, component_1.Component)({ name: "theme", internal: true })
 ], Theme);
-exports.Theme = Theme;

dist/lib/output/themes/default/DefaultTheme.js

@@ -193,4 +193,4 @@ "use strict";
 }
+exports.DefaultTheme = DefaultTheme;
 DefaultTheme.URL_PREFIX = /^(http|ftp)s?:\/\//;
-exports.DefaultTheme = DefaultTheme;
 function hasReadme(readme) {
@@ -197,0 +197,0 @@ return !readme.endsWith("none");

dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts

@@ -28,3 +28,6 @@ import type { PageEvent, RendererHooks } from "../..";
     breadcrumb: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
+    /** @deprecated will be removed in 0.25 */
     comment: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
+    commentSummary: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
+    commentTags: (props: Reflection) => import("../../../utils/jsx.elements").JsxElement | undefined;
     footer: () => import("../../../utils/jsx.elements").JsxElement | undefined;
@@ -31,0 +34,0 @@ header: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;

dist/lib/output/themes/default/DefaultThemeRenderContext.js

@@ -72,3 +72,6 @@ "use strict";
         this.breadcrumb = bind(breadcrumb_1.breadcrumb, this);
+        /** @deprecated will be removed in 0.25 */
         this.comment = bind(comment_1.comment, this);
+        this.commentSummary = bind(comment_1.commentSummary, this);
+        this.commentTags = bind(comment_1.commentTags, this);
         this.footer = bind(footer_1.footer, this);
@@ -75,0 +78,0 @@ this.header = bind(header_1.header, this);

dist/lib/output/themes/default/partials/comment.d.ts

@@ -5,1 +5,3 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 export declare function comment({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
+export declare function commentSummary({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;
+export declare function commentTags({ markdown }: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;

dist/lib/output/themes/default/partials/comment.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.comment = void 0;
+exports.commentTags = exports.commentSummary = exports.comment = void 0;
 const utils_1 = require("../../../../utils");
 const models_1 = require("../../../../models");
 const lib_1 = require("../../lib");
+// Note: Comment modifiers are handled in `renderFlags`
 function comment({ markdown }, props) {
     if (!props.comment?.hasVisibleComponent())
         return;
-    // Note: Comment modifiers are handled in `renderFlags`
     const tags = props.kindOf(models_1.ReflectionKind.SomeSignature)
@@ -21,1 +21,19 @@ ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns")
 exports.comment = comment;
+function commentSummary({ markdown }, props) {
+    if (!props.comment?.summary.some((part) => part.text))
+        return;
+    return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" },
+        utils_1.JSX.createElement(utils_1.Raw, { html: markdown(props.comment.summary) })));
+}
+exports.commentSummary = commentSummary;
+function commentTags({ markdown }, props) {
+    if (!props.comment)
+        return;
+    const tags = props.kindOf(models_1.ReflectionKind.SomeSignature)
+        ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns")
+        : props.comment.blockTags;
+    return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" }, tags.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        utils_1.JSX.createElement("h4", null, (0, lib_1.camelToTitleCase)(item.tag.substring(1))),
+        utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) }))))));
+}
+exports.commentTags = commentTags;

dist/lib/output/themes/default/partials/icon.js

@@ -24,5 +24,5 @@ "use strict";
 }
-const kindIcon = (kind, letterPath, color, circular = false) => (utils_1.JSX.createElement("svg", { class: "tsd-kind-icon", width: "24", height: "24", viewBox: "0 0 24 24" },
-    cachedPart(`${kind}-path`, utils_1.JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" })),
-    cachedPart(`${kind}-text`, letterPath)));
+const kindIcon = (kind, letterPath, color, circular = false) => (utils_1.JSX.createElement("svg", { class: "tsd-kind-icon", viewBox: "0 0 24 24" }, cachedPart(`${kind}`, utils_1.JSX.createElement("g", null,
+    utils_1.JSX.createElement("rect", { fill: "var(--color-icon-background)", stroke: color, "stroke-width": "1.5", x: "1", y: "1", width: "22", height: "22", rx: circular ? "12" : "6" }),
+    letterPath))));
 exports.icons = {
@@ -78,4 +78,3 @@ [models_1.ReflectionKind.Accessor]: () => kindIcon(models_1.ReflectionKind.Accessor, utils_1.JSX.createElement("path", { d: "M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z", fill: "var(--color-text)" }), "#FF4D4D", true),
     [models_1.ReflectionKind.Variable]: () => kindIcon(models_1.ReflectionKind.Variable, utils_1.JSX.createElement("path", { d: "M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z", fill: "var(--color-text)" }), "var(--color-ts-variable)"),
-    chevronDown: () => (utils_1.JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none" },
-        utils_1.JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-text)" }))),
+    chevronDown: () => (utils_1.JSX.createElement("svg", { width: "20", height: "20", viewBox: "0 0 24 24", fill: "none" }, cachedPart("chevronDown", utils_1.JSX.createElement("path", { d: "M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z", fill: "var(--color-text)" })))),
     chevronSmall: () => (utils_1.JSX.createElement("svg", { width: "16", height: "16", viewBox: "0 0 16 16", fill: "none" },
@@ -89,6 +88,6 @@ utils_1.JSX.createElement("path", { d: "M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z", fill: "var(--color-text)" }))),
         utils_1.JSX.createElement("path", { d: "M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z", fill: "var(--color-text)" }))),
-    anchor: () => (utils_1.JSX.createElement("svg", { class: "icon icon-tabler icon-tabler-link", viewBox: "0 0 24 24", "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
-        cachedPart("anchor-a", utils_1.JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" })),
-        cachedPart("anchor-b", utils_1.JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" })),
-        cachedPart("anchor-c", utils_1.JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" })))),
+    anchor: () => (utils_1.JSX.createElement("svg", { viewBox: "0 0 24 24" }, cachedPart("anchor", utils_1.JSX.createElement("g", { "stroke-width": "2", stroke: "currentColor", fill: "none", "stroke-linecap": "round", "stroke-linejoin": "round" },
+        utils_1.JSX.createElement("path", { stroke: "none", d: "M0 0h24v24H0z", fill: "none" }),
+        utils_1.JSX.createElement("path", { d: "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" }),
+        utils_1.JSX.createElement("path", { d: "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" }))))),
 };

dist/lib/output/themes/default/partials/member.declaration.d.ts

@@ -1,4 +0,4 @@
-import { DeclarationReflection } from "../../../../models";
+import type { DeclarationReflection } from "../../../../models";
 import { JSX } from "../../../../utils";
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-export declare const memberDeclaration: (context: DefaultThemeRenderContext, props: DeclarationReflection) => JSX.Element;
+export declare function memberDeclaration(context: DefaultThemeRenderContext, props: DeclarationReflection): JSX.Element;

dist/lib/output/themes/default/partials/member.declaration.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberDeclaration = void 0;
-const models_1 = require("../../../../models");
 const utils_1 = require("../../../../utils");
 const lib_1 = require("../../lib");
-const memberDeclaration = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-    utils_1.JSX.createElement("div", { class: "tsd-signature" },
-        utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) }, (0, lib_1.wbr)(props.name)),
-        (0, lib_1.renderTypeParametersSignature)(context, props.typeParameters),
-        props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
-                !!props.flags.isOptional && "?",
-                ":"),
-            " ",
-            context.type(props.type))),
-        !!props.defaultValue && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
-                " = ",
-                props.defaultValue)))),
-    context.comment(props),
-    (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
-    props.type instanceof models_1.ReflectionType && (utils_1.JSX.createElement("div", { class: "tsd-type-declaration" },
-        utils_1.JSX.createElement("h4", null, "Type declaration"),
-        context.parameter(props.type.declaration))),
-    context.memberSources(props)));
+function memberDeclaration(context, props) {
+    function renderTypeDeclaration(type) {
+        return (utils_1.JSX.createElement("div", { class: "tsd-type-declaration" },
+            utils_1.JSX.createElement("h4", null, "Type declaration"),
+            context.parameter(type.declaration)));
+    }
+    const visitor = { reflection: renderTypeDeclaration };
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+        utils_1.JSX.createElement("div", { class: "tsd-signature" },
+            utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) }, (0, lib_1.wbr)(props.name)),
+            (0, lib_1.renderTypeParametersSignature)(context, props.typeParameters),
+            props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
+                    !!props.flags.isOptional && "?",
+                    ":"),
+                " ",
+                context.type(props.type))),
+            !!props.defaultValue && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
+                    " = ",
+                    props.defaultValue)))),
+        context.commentSummary(props),
+        (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
+        props.type?.visit({
+            reflection: renderTypeDeclaration,
+            array: (arr) => arr.elementType.visit(visitor),
+            intersection: (int) => int.types.map((t) => t.visit(visitor)),
+            union: (union) => union.types.map((t) => t.visit(visitor)),
+            reference: (ref) => ref.typeArguments?.map((t) => t.visit(visitor)),
+            tuple: (ref) => ref.elements.map((t) => t.visit(visitor)),
+        }),
+        context.commentTags(props),
+        context.memberSources(props)));
+}
 exports.memberDeclaration = memberDeclaration;

dist/lib/output/themes/default/partials/member.signature.body.js

@@ -11,3 +11,3 @@ "use strict";
         (0, lib_1.renderFlags)(props.flags, props.comment),
-        context.comment(props),
+        context.commentSummary(props),
         (0, lib_1.hasTypeParameters)(props) && context.typeParameters(props.typeParameters),
@@ -26,3 +26,4 @@ props.parameters && props.parameters.length > 0 && (utils_1.JSX.createElement("div", { class: "tsd-parameters" },
                         item.defaultValue))),
-                context.comment(item),
+                context.commentSummary(item),
+                context.commentTags(item),
                 item.type instanceof models_1.ReflectionType && context.parameter(item.type.declaration))))))),
@@ -35,4 +36,5 @@ props.type && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             props.type instanceof models_1.ReflectionType && context.parameter(props.type.declaration))),
+        context.commentTags(props),
         !hideSources && context.memberSources(props)));
 }
 exports.memberSignatureBody = memberSignatureBody;

dist/lib/output/themes/default/partials/navigation.js

@@ -94,5 +94,5 @@ "use strict";
     function links(mod, parents) {
-        const nameClasses = (0, lib_1.classNames)({ deprecated: mod instanceof models_1.Reflection && mod.isDeprecated() }, !(mod instanceof models_1.Reflection) || mod.isProject() ? void 0 : context.getReflectionClasses(mod));
+        const nameClasses = (0, lib_1.classNames)({ deprecated: mod instanceof models_1.Reflection && mod.isDeprecated() }, mod instanceof models_1.DeclarationReflection ? context.getReflectionClasses(mod) : void 0);
         const children = getNavigationElements(mod, opts);
-        if (!children.length) {
+        if (!children.length || (!opts.fullTree && mod instanceof models_1.Reflection && !inPath(mod))) {
             return createNavElement(mod, nameClasses);
@@ -99,0 +99,0 @@ }

dist/lib/output/themes/default/partials/parameter.js

@@ -28,3 +28,4 @@ "use strict";
                     context.type(props.indexSignature.type)),
-                context.comment(props.indexSignature),
+                context.commentSummary(props.indexSignature),
+                context.commentTags(props.indexSignature),
                 props.indexSignature.type instanceof models_1.ReflectionType &&
@@ -50,3 +51,4 @@ context.parameter(props.indexSignature.type.declaration)))),
                     context.type(item.type)),
-                context.comment(item),
+                context.commentSummary(item),
+                context.commentTags(item),
                 !!item.children && context.parameter(item),
@@ -62,3 +64,4 @@ item.type instanceof models_1.ReflectionType && context.parameter(item.type.declaration)))) : (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                         context.type(item.getSignature.type)),
-                    context.comment(item.getSignature)))),
+                    context.commentSummary(item.getSignature),
+                    context.commentTags(item.getSignature)))),
             item.setSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
@@ -77,3 +80,4 @@ utils_1.JSX.createElement("li", { class: "tsd-parameter" },
                         context.type(item.setSignature.type)),
-                    context.comment(item.setSignature))))))))))));
+                    context.commentSummary(item.setSignature),
+                    context.commentTags(item.setSignature))))))))))));
 exports.parameter = parameter;

dist/lib/output/themes/default/partials/typeParameters.js

@@ -20,4 +20,5 @@ "use strict";
                         context.type(item.default)))),
-                context.comment(item))))))));
+                context.commentSummary(item),
+                context.commentTags(item))))))));
 }
 exports.typeParameters = typeParameters;

dist/lib/output/themes/default/templates/reflection.js

@@ -13,3 +13,5 @@ "use strict";
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        props.model.hasComment() && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-comment" }, context.comment(props.model))),
+        props.model.hasComment() && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-comment" },
+            context.commentSummary(props.model),
+            context.commentTags(props.model))),
         props.model instanceof models_1.DeclarationReflection &&
@@ -42,3 +44,4 @@ props.model.kind === models_1.ReflectionKind.Module &&
                     context.type(props.model.indexSignature.type)),
-                context.comment(props.model.indexSignature),
+                context.commentSummary(props.model.indexSignature),
+                context.commentTags(props.model.indexSignature),
                 props.model.indexSignature?.type instanceof models_1.ReflectionType &&
@@ -45,0 +48,0 @@ context.parameter(props.model.indexSignature.type.declaration))),

dist/lib/output/themes/MarkedPlugin.js

@@ -45,3 +45,3 @@ "use strict";
  */
-let MarkedPlugin = class MarkedPlugin extends components_1.ContextAwareRendererComponent {
+let MarkedPlugin = exports.MarkedPlugin = class MarkedPlugin extends components_1.ContextAwareRendererComponent {
     constructor() {
@@ -100,3 +100,5 @@ super(...arguments);
                     const contents = (0, utils_1.readFile)(path);
-                    return contents;
+                    const event = new events_1.MarkdownEvent(events_1.MarkdownEvent.INCLUDE, page, contents, contents);
+                    this.owner.trigger(event);
+                    return event.parsedText;
                 }
@@ -204,6 +206,5 @@ else {
 ], MarkedPlugin.prototype, "darkTheme", void 0);
-MarkedPlugin = __decorate([
+exports.MarkedPlugin = MarkedPlugin = __decorate([
     (0, components_1.Component)({ name: "marked" })
 ], MarkedPlugin);
-exports.MarkedPlugin = MarkedPlugin;
 // Basically a copy/paste of Marked's code, with the addition of the button
@@ -210,0 +211,0 @@ // https://github.com/markedjs/marked/blob/v4.3.0/src/Renderer.js#L15-L39

dist/lib/serialization/serializer.js

@@ -44,2 +44,3 @@ "use strict";
 }
+exports.Serializer = Serializer;
 /**
@@ -55,2 +56,1 @@ * Triggered when the {@link Serializer} begins transforming a project.
 Serializer.EVENT_END = "end";
-exports.Serializer = Serializer;

dist/lib/utils/component.d.ts

@@ -46,3 +46,3 @@ import type { Application } from "../application";
     /**
-     * The name of this component as set by the @Component decorator.
+     * The name of this component as set by the `@Component` decorator.
      */
@@ -49,0 +49,0 @@ componentName: string;

dist/lib/utils/component.js

@@ -52,5 +52,5 @@ "use strict";
 }
+exports.ComponentEvent = ComponentEvent;
 ComponentEvent.ADDED = "componentAdded";
 ComponentEvent.REMOVED = "componentRemoved";
-exports.ComponentEvent = ComponentEvent;
 /**
@@ -57,0 +57,0 @@ * Component base class.  Has an owner (unless it's the application root component),

dist/lib/utils/jsx.d.ts

@@ -44,2 +44,5 @@ /**
 export declare function createElement(tag: typeof Fragment | string | JsxComponent<any>, props: object | null, ...children: JsxChildren[]): JsxElement;
+export declare function setRenderSettings(options: {
+    pretty: boolean;
+}): void;
 export declare function renderElement(element: JsxElement | null | undefined): string;

dist/lib/utils/jsx.js

@@ -17,3 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderElement = exports.createElement = exports.Raw = exports.Fragment = void 0;
+exports.renderElement = exports.setRenderSettings = exports.createElement = exports.Raw = exports.Fragment = void 0;
 const html_1 = require("./html");
@@ -75,2 +75,7 @@ const jsx_elements_1 = require("./jsx.elements");
 exports.createElement = createElement;
+let renderPretty = true;
+function setRenderSettings(options) {
+    renderPretty = options.pretty;
+}
+exports.setRenderSettings = setRenderSettings;
 function renderElement(element) {
@@ -89,3 +94,3 @@ if (!element) {
     if (tag !== jsx_elements_1.JsxFragment) {
-        if (blockElements.has(tag)) {
+        if (blockElements.has(tag) && renderPretty) {
             html.push("\n");
@@ -92,0 +97,0 @@ }

dist/lib/utils/loggers.js

@@ -22,3 +22,3 @@ "use strict";
     LogLevel[LogLevel["None"] = 4] = "None";
-})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));
+})(LogLevel || (exports.LogLevel = LogLevel = {}));
 const Colors = {
@@ -25,0 +25,0 @@ red: "\u001b[91m",

dist/lib/utils/options/declaration.d.ts

@@ -106,2 +106,3 @@ import type { Theme as ShikiTheme } from "shiki";
         includeGroups: boolean;
+        fullTree: boolean;
     };
@@ -108,0 +109,0 @@ visibilityFilters: ManuallyValidatedOption<{

dist/lib/utils/options/declaration.js

@@ -25,3 +25,3 @@ "use strict";
     ParameterHint[ParameterHint["Directory"] = 1] = "Directory";
-})(ParameterHint = exports.ParameterHint || (exports.ParameterHint = {}));
+})(ParameterHint || (exports.ParameterHint = ParameterHint = {}));
 var ParameterType;
@@ -59,3 +59,3 @@ (function (ParameterType) {
     ParameterType[ParameterType["Flags"] = 11] = "Flags";
-})(ParameterType = exports.ParameterType || (exports.ParameterType = {}));
+})(ParameterType || (exports.ParameterType = ParameterType = {}));
 const converters = {
@@ -62,0 +62,0 @@ [ParameterType.String](value, option) {

dist/lib/utils/options/sources/typedoc.js

@@ -417,2 +417,3 @@ "use strict";
             includeGroups: false,
+            fullTree: false,
         },
@@ -419,0 +420,0 @@ });

package.json

 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.24.7",
+  "version": "0.24.8",
   "homepage": "https://typedoc.org",
@@ -33,3 +33,3 @@ "exports": {
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x"
   },
@@ -51,3 +51,3 @@ "devDependencies": {
     "ts-node": "^10.9.1",
-    "typescript": "5.0.4"
+    "typescript": "5.1.3"
   },
@@ -54,0 +54,0 @@ "files": [

No alert changes

Improved metrics

Total package byte prevSize

1219336

increased by0.4%

Lines of code

29333

increased by0.29%

No dependency changes