typedoc 0.25.2 → 0.25.4

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

@@ -23,6 +23,7 @@ const members_1 = require("./partials/members");
 const members_group_1 = require("./partials/members.group");
 const navigation_1 = require("./partials/navigation");
 const parameter_1 = require("./partials/parameter");
+const reflectionPreview_1 = require("./partials/reflectionPreview");
 const toolbar_1 = require("./partials/toolbar");
 const type_1 = require("./partials/type");
 const typeAndParent_1 = require("./partials/typeAndParent");
@@ -59,6 +60,15 @@ class DefaultThemeRenderContext {
         this.reflectionTemplate = bind(reflection_1.reflectionTemplate, this);
         this.indexTemplate = bind(templates_1.indexTemplate, this);
         this.defaultLayout = bind(default_1.defaultLayout, this);
+        /**
+         * Rendered just after the description for a reflection.
+         * This can be used to render a shortened type display of a reflection that the
+         * rest of the page expands on.
+         *
+         * Note: Will not be called for variables/type aliases, as they are summarized
+         * by their type declaration, which is already rendered by {@link DefaultThemeRenderContext.memberDeclaration}
+         */
+        this.reflectionPreview = bind(reflectionPreview_1.reflectionPreview, this);
         this.analytics = bind(analytics_1.analytics, this);
         this.breadcrumb = bind(breadcrumb_1.breadcrumb, this);
         this.commentSummary = bind(comment_1.commentSummary, this);

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

@@ -18,9 +18,14 @@ function commentTags({ markdown }, props) {
     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) }))))));
+    return (utils_1.JSX.createElement("div", { class: "tsd-comment tsd-typography" }, tags.map((item) => {
+        const name = item.name
+            ? `${(0, lib_1.camelToTitleCase)(item.tag.substring(1))}: ${item.name}`
+            : (0, lib_1.camelToTitleCase)(item.tag.substring(1));
+        return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+            utils_1.JSX.createElement("h4", null, name),
+            utils_1.JSX.createElement(utils_1.Raw, { html: markdown(item.content) })));
+    })));
 }
 exports.commentTags = commentTags;
 const flagsNotRendered = ["@showCategories", "@showGroups", "@hideCategories", "@hideGroups"];

package/dist/lib/output/themes/default/partials/footer.js

@@ -8,6 +8,6 @@ function footer(context) {
         return (utils_1.JSX.createElement("div", { class: "tsd-generator" },
             utils_1.JSX.createElement("p", null,
                 "Generated using ",
-                utils_1.JSX.createElement("a", { href: "https://typedoc.org/", rel: "noopener", target: "_blank" }, "TypeDoc"))));
+                utils_1.JSX.createElement("a", { href: "https://typedoc.org/", target: "_blank" }, "TypeDoc"))));
 }
 exports.footer = footer;

package/dist/lib/output/themes/default/partials/member.signatures.js

@@ -6,7 +6,8 @@ const anchor_icon_1 = require("./anchor-icon");
 const lib_1 = require("../../lib");
 const memberSignatures = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
     utils_1.JSX.createElement("ul", { class: (0, lib_1.classNames)({ "tsd-signatures": true }, context.getReflectionClasses(props)) }, props.signatures?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("li", { class: "tsd-signature tsd-anchor-link", id: item.anchor },
+        utils_1.JSX.createElement("li", { class: "tsd-signature tsd-anchor-link" },
+            utils_1.JSX.createElement("a", { id: item.anchor, class: "tsd-anchor" }),
             context.memberSignatureTitle(item),
             (0, anchor_icon_1.anchorIcon)(context, item.anchor)),
         utils_1.JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(item))))))));

package/dist/lib/output/themes/default/partials/member.sources.js

@@ -2,6 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberSources = void 0;
 const utils_1 = require("../../../../utils");
+function sourceLink(context, item) {
+    if (!item.url) {
+        return (utils_1.JSX.createElement("li", null,
+            "Defined in ",
+            item.fileName,
+            ":",
+            item.line));
+    }
+    if (context.options.getValue("sourceLinkExternal")) {
+        return (utils_1.JSX.createElement("li", null,
+            "Defined in ",
+            utils_1.JSX.createElement("a", { href: item.url, class: "external", target: "_blank" },
+                item.fileName,
+                ":",
+                item.line)));
+    }
+    return (utils_1.JSX.createElement("li", null,
+        "Defined in ",
+        utils_1.JSX.createElement("a", { href: item.url },
+            item.fileName,
+            ":",
+            item.line)));
+}
 const memberSources = (context, props) => {
     const sources = [];
     if (props.implementationOf) {
@@ -19,17 +42,8 @@ const memberSources = (context, props) => {
             "Overrides ",
             context.typeAndParent(props.overwrites)));
     }
-    if (props.sources) {
-        sources.push(utils_1.JSX.createElement("ul", null, props.sources.map((item) => item.url ? (utils_1.JSX.createElement("li", null,
-            "Defined in ",
-            utils_1.JSX.createElement("a", { href: item.url },
-                item.fileName,
-                ":",
-                item.line))) : (utils_1.JSX.createElement("li", null,
-            "Defined in ",
-            item.fileName,
-            ":",
-            item.line)))));
+    if (props.sources?.length) {
+        sources.push(utils_1.JSX.createElement("ul", null, props.sources.map((item) => sourceLink(context, item))));
     }
     if (sources.length === 0) {
         return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);

package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts

@@ -0,0 +1,4 @@
+import { type Reflection } from "../../../../models";
+import { JSX } from "../../../../utils";
+import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
+export declare function reflectionPreview(context: DefaultThemeRenderContext, props: Reflection): JSX.Element | undefined;

package/dist/lib/output/themes/default/partials/reflectionPreview.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reflectionPreview = void 0;
+const models_1 = require("../../../../models");
+const utils_1 = require("../../../../utils");
+const lib_1 = require("../../lib");
+function reflectionPreview(context, props) {
+    if (!(props instanceof models_1.DeclarationReflection))
+        return;
+    // Each property of the interface will have a member rendered later on the page describing it, so generate
+    // a type-like object with links to each member.
+    if (props.kindOf(models_1.ReflectionKind.Interface)) {
+        return (utils_1.JSX.createElement("div", { class: "tsd-signature" },
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "interface "),
+            utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(props) },
+                props.name,
+                " "),
+            context.type(new models_1.ReflectionType(props), { topLevelLinks: true })));
+    }
+}
+exports.reflectionPreview = reflectionPreview;

package/dist/lib/output/themes/default/partials/type.d.ts

@@ -2,4 +2,6 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { Type } from "../../../../models";
 import { JSX } from "../../../../utils";
 export declare function validateStateIsClean(page: string): void;
-export declare function type(context: DefaultThemeRenderContext, type: Type | undefined): JSX.Element;
+export declare function type(context: DefaultThemeRenderContext, type: Type | undefined, options?: {
+    topLevelLinks: boolean;
+}): JSX.Element;

package/dist/lib/output/themes/default/partials/type.js

@@ -74,7 +74,7 @@ const typeRenderers = {
         indentationDepth++;
         const parts = [
             renderType(context, type.checkType, models_1.TypeContext.conditionalCheck),
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " extends "),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " extends "),
             renderType(context, type.extendsType, models_1.TypeContext.conditionalExtends),
             utils_1.JSX.createElement("br", null),
             includeIndentation(),
@@ -107,11 +107,11 @@ const typeRenderers = {
     },
     inferred(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "infer "),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "infer "),
             " ",
             utils_1.JSX.createElement("span", { class: "tsd-kind-type-parameter" }, type.name),
             type.constraint && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " extends "),
+                utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " extends "),
                 renderType(context, type.constraint, models_1.TypeContext.inferredConstraint)))));
     },
     intersection(context, type) {
@@ -128,15 +128,17 @@ const typeRenderers = {
         const parts = [utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "{"), utils_1.JSX.createElement("br", null), includeIndentation()];
         switch (type.readonlyModifier) {
             case "+":
-                parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "readonly "));
+                parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly "));
                 break;
             case "-":
-                parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "-readonly "));
+                parts.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "-"),
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly ")));
                 break;
         }
-        parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "["), utils_1.JSX.createElement("span", { class: "tsd-kind-type-parameter" }, type.parameter), utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " in "), renderType(context, type.parameterType, models_1.TypeContext.mappedParameter));
+        parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "["), utils_1.JSX.createElement("span", { class: "tsd-kind-type-parameter" }, type.parameter), utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " in "), renderType(context, type.parameterType, models_1.TypeContext.mappedParameter));
         if (type.nameType) {
-            parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " as "), renderType(context, type.nameType, models_1.TypeContext.mappedName));
+            parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " as "), renderType(context, type.nameType, models_1.TypeContext.mappedName));
         }
         parts.push(utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "]"));
         switch (type.optionalModifier) {
@@ -170,15 +172,15 @@ const typeRenderers = {
     },
     predicate(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            !!type.asserts && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "asserts "),
+            !!type.asserts && utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "asserts "),
             utils_1.JSX.createElement("span", { class: "tsd-kind-parameter" }, type.name),
             !!type.targetType && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, " is "),
+                utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, " is "),
                 renderType(context, type.targetType, models_1.TypeContext.predicateTarget)))));
     },
     query(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "typeof "),
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "typeof "),
             renderType(context, type.queryType, models_1.TypeContext.queryTypeTarget)));
     },
     reference(context, type) {
@@ -211,30 +213,31 @@ const typeRenderers = {
         }
         return name;
     },
-    reflection(context, type) {
+    reflection(context, type, { topLevelLinks }) {
         const members = [];
         const children = type.declaration.children || [];
         indentationDepth++;
+        const renderName = (named) => topLevelLinks ? (utils_1.JSX.createElement("a", { class: (0, lib_1.getKindClass)(named), href: context.urlTo(named) }, named.name)) : (utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(named) }, named.name));
         for (const item of children) {
             if (item.getSignature && item.setSignature) {
                 members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                    utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, item.name),
+                    renderName(item),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, ": "),
                     renderType(context, item.getSignature.type, models_1.TypeContext.none)));
                 continue;
             }
             if (item.getSignature) {
                 members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                    utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "get "),
-                    utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item.getSignature) }, item.name),
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "get "),
+                    renderName(item.getSignature),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "(): "),
                     renderType(context, item.getSignature.type, models_1.TypeContext.none)));
                 continue;
             }
             if (item.setSignature) {
                 members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                    utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "set "),
-                    utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item.setSignature) }, item.name),
+                    utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" }, "set "),
+                    renderName(item.setSignature),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
                     item.setSignature.parameters?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                         item.name,
@@ -246,17 +249,17 @@ const typeRenderers = {
             if (item.signatures) {
                 for (const sig of item.signatures) {
                     members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                        utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(sig) }, item.name),
+                        renderName(sig),
                         item.flags.isOptional && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "?"),
                         context.memberSignatureTitle(sig, {
                             hideName: true,
-                            arrowStyle: true,
+                            arrowStyle: false,
                         })));
                 }
                 continue;
             }
             members.push(utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-                utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, item.name),
+                renderName(item),
                 utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, item.flags.isOptional ? "?: " : ": "),
                 renderType(context, item.type, models_1.TypeContext.none)));
         }
@@ -331,7 +334,7 @@ const typeRenderers = {
     },
     typeOperator(context, type) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-            utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
+            utils_1.JSX.createElement("span", { class: "tsd-signature-keyword" },
                 type.operator,
                 " "),
             renderType(context, type.target, models_1.TypeContext.typeOperatorTarget)));
@@ -343,12 +346,12 @@ const typeRenderers = {
         return utils_1.JSX.createElement(utils_1.JSX.Fragment, null, type.name);
     },
 };
-function renderType(context, type, where) {
+function renderType(context, type, where, options = { topLevelLinks: false }) {
     if (!type) {
         return utils_1.JSX.createElement("span", { class: "tsd-signature-type" }, "any");
     }
     const renderFn = typeRenderers[type.type];
-    const rendered = renderFn(context, type);
+    const rendered = renderFn(context, type, options);
     if (type.needsParenthesis(where)) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
@@ -357,7 +360,7 @@ function renderType(context, type, where) {
     }
     return rendered;
 }
-function type(context, type) {
-    return renderType(context, type, models_1.TypeContext.none);
+function type(context, type, options = { topLevelLinks: false }) {
+    return renderType(context, type, models_1.TypeContext.none, options);
 }
 exports.type = type;

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

@@ -5,7 +5,7 @@ const lib_1 = require("../../lib");
 const models_1 = require("../../../../models");
 const utils_1 = require("../../../../utils");
 function reflectionTemplate(context, props) {
-    if ([models_1.ReflectionKind.TypeAlias, models_1.ReflectionKind.Variable].includes(props.model.kind) &&
+    if (props.model.kindOf(models_1.ReflectionKind.TypeAlias | models_1.ReflectionKind.Variable) &&
         props.model instanceof models_1.DeclarationReflection) {
         return context.memberDeclaration(props.model);
     }
@@ -17,6 +17,7 @@ function reflectionTemplate(context, props) {
             props.model.kind === models_1.ReflectionKind.Module &&
             props.model.readme?.length && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
             utils_1.JSX.createElement(utils_1.Raw, { html: context.markdown(props.model.readme) }))),
+        context.reflectionPreview(props.model),
         (0, lib_1.hasTypeParameters)(props.model) && utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             " ",
             context.typeParameters(props.model.typeParameters),

package/dist/lib/utils/general.d.ts

@@ -38,6 +38,7 @@ export type Chars<T extends string> = T extends `${infer C}${infer R}` ? C | Cha
  * Utility to help type checking ensure that there is no uncovered case.
  */
 export declare function assertNever(x: never): never;
+export declare function NonEnumerable(_cls: unknown, context: ClassFieldDecoratorContext): void;
 export declare function hasBeenLoadedMultipleTimes(): boolean;
 export declare function getLoadedPaths(): string[];
 export {};

package/dist/lib/utils/general.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLoadedPaths = exports.hasBeenLoadedMultipleTimes = exports.assertNever = void 0;
+exports.getLoadedPaths = exports.hasBeenLoadedMultipleTimes = exports.NonEnumerable = exports.assertNever = void 0;
 const path_1 = require("path");
 const Util = __importStar(require("util"));
 /**
@@ -33,6 +33,16 @@ function assertNever(x) {
     throw new Error(`Expected handling to cover all possible cases, but it didn't cover: ${Util.inspect(x)}`);
 }
 exports.assertNever = assertNever;
+function NonEnumerable(_cls, context) {
+    context.addInitializer(function () {
+        Object.defineProperty(this, context.name, {
+            enumerable: false,
+            configurable: true,
+            writable: true,
+        });
+    });
+}
+exports.NonEnumerable = NonEnumerable;
 /**
  * This is a hack to make it possible to detect and warn about installation setups
  * which result in TypeDoc being installed multiple times. If TypeDoc has been loaded

package/dist/lib/utils/jsx.js

@@ -89,7 +89,7 @@ const renderElement = function renderElement(element) {
     }
     let html = "";
     if (tag !== jsx_elements_1.JsxFragment) {
-        if (blockElements.has(tag) && renderPretty) {
+        if (blockElements.has(tag) && renderPretty && html) {
             html += "\n";
         }
         html += "<";
@@ -106,8 +106,9 @@ const renderElement = function renderElement(element) {
             else {
                 html += " ";
                 html += key;
-                html += "=";
-                html += JSON.stringify(val);
+                html += '="';
+                html += (typeof val === "string" ? val : JSON.stringify(val)).replaceAll('"', "&quot;");
+                html += '"';
             }
         }
     }

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

@@ -76,6 +76,7 @@ export interface TypeDocOptionMap {
     includeVersion: boolean;
     disableSources: boolean;
     sourceLinkTemplate: string;
+    sourceLinkExternal: boolean;
     disableGit: boolean;
     gitRevision: string;
     gitRemote: string;

package/dist/lib/utils/options/declaration.js

@@ -4,8 +4,8 @@ exports.getDefaultValue = exports.convert = exports.ParameterType = exports.Para
 const path_1 = require("path");
 /** @enum */
 exports.EmitStrategy = {
-    both: "both",
-    docs: "docs",
+    both: "both", // Emit both documentation and JS
+    docs: "docs", // Emit documentation, but not JS (default)
     none: "none", // Emit nothing, just convert and run validation
 };
 /**

package/dist/lib/utils/options/options.js

@@ -46,6 +46,7 @@ class Options {
         options.packageDir = packageDir;
         options._readers = this._readers.filter((reader) => reader.supportsPackages);
         options._declarations = new Map(this._declarations);
+        options.reset();
         return options;
     }
     /**
@@ -85,7 +86,7 @@ class Options {
         if (name != null) {
             const declaration = this.getDeclaration(name);
             if (!declaration) {
-                throw new Error("Cannot reset an option which has not been declared.");
+                throw new Error(`Cannot reset an option (${name}) which has not been declared.`);
             }
             this._values[declaration.name] = (0, declaration_2.getDefaultValue)(declaration);
             this._setOptions.delete(declaration.name);
@@ -137,7 +138,7 @@ class Options {
     }
     isSet(name) {
         if (!this._declarations.has(name)) {
-            throw new Error("Tried to check if an undefined option was set");
+            throw new Error(`Tried to check if an undefined option (${name}) was set`);
         }
         return this._setOptions.has(name);
     }
@@ -157,7 +158,7 @@ class Options {
     }
     setValue(name, value, configPath) {
         if (this.isFrozen()) {
-            throw new Error("Tried to modify an option value after options have been frozen.");
+            throw new Error(`Tried to modify an option (${name}) value after options have been frozen.`);
         }
         const declaration = this.getDeclaration(name);
         if (!declaration) {
@@ -212,7 +213,7 @@ class Options {
      */
     setCompilerOptions(fileNames, options, projectReferences) {
         if (this.isFrozen()) {
-            throw new Error("Tried to modify an option value after options have been sealed.");
+            throw new Error("Tried to modify compiler options after options have been frozen.");
         }
         // We do this here instead of in the tsconfig reader so that API consumers which
         // supply a program to `Converter.convert` instead of letting TypeDoc create one
@@ -264,7 +265,7 @@ function Option(name) {
                 return value;
             },
             set(_value) {
-                throw new Error("Options may not be set via the Option decorator");
+                throw new Error(`Options may not be set via the Option decorator when setting ${name}`);
             },
         };
     };

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

@@ -292,6 +292,24 @@ function addTypeDocOptions(options) {
         help: "Disable setting the source of a reflection when documenting it.",
         type: declaration_1.ParameterType.Boolean,
     });
+    options.addDeclaration({
+        name: "sourceLinkTemplate",
+        help: "Specify a link template to be used when generating source urls. If not set, will be automatically created using the git remote. Supports {path}, {line}, {gitRevision} placeholders.",
+    });
+    options.addDeclaration({
+        name: "gitRevision",
+        help: "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set.",
+    });
+    options.addDeclaration({
+        name: "gitRemote",
+        help: "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set.",
+        defaultValue: "origin",
+    });
+    options.addDeclaration({
+        name: "disableGit",
+        help: "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath",
+        type: declaration_1.ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "basePath",
         help: "Specifies the base path to be used when displaying file paths.",
@@ -329,23 +347,10 @@ function addTypeDocOptions(options) {
         help: "Set the CNAME file text, it's useful for custom domains on GitHub Pages.",
     });
     options.addDeclaration({
-        name: "sourceLinkTemplate",
-        help: "Specify a link template to be used when generating source urls. If not set, will be automatically created using the git remote. Supports {path}, {line}, {gitRevision} placeholders.",
-    });
-    options.addDeclaration({
-        name: "disableGit",
-        help: "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath",
+        name: "sourceLinkExternal",
+        help: "Specifies that source links should be treated as external links to be opened in a new tab.",
         type: declaration_1.ParameterType.Boolean,
     });
-    options.addDeclaration({
-        name: "gitRevision",
-        help: "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set.",
-    });
-    options.addDeclaration({
-        name: "gitRemote",
-        help: "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set.",
-        defaultValue: "origin",
-    });
     options.addDeclaration({
         name: "githubPages",
         help: "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`.",

package/dist/lib/utils/sort.d.ts

@@ -4,6 +4,6 @@
  */
 import type { DeclarationReflection } from "../models/reflections/declaration";
 import type { Options } from "./options";
-export declare const SORT_STRATEGIES: readonly ["source-order", "alphabetical", "enum-value-ascending", "enum-value-descending", "enum-member-source-order", "static-first", "instance-first", "visibility", "required-first", "kind"];
+export declare const SORT_STRATEGIES: readonly ["source-order", "alphabetical", "enum-value-ascending", "enum-value-descending", "enum-member-source-order", "static-first", "instance-first", "visibility", "required-first", "kind", "external-last"];
 export type SortStrategy = (typeof SORT_STRATEGIES)[number];
 export declare function getSortFunction(opts: Options): (reflections: DeclarationReflection[]) => void;

package/dist/lib/utils/sort.js

@@ -18,6 +18,7 @@ exports.SORT_STRATEGIES = [
     "visibility",
     "required-first",
     "kind",
+    "external-last",
 ];
 const defaultKindSortOrder = [
     kind_1.ReflectionKind.Reference,
@@ -120,6 +121,9 @@ const sorts = {
     kind(a, b, { kindSortOrder }) {
         return kindSortOrder.indexOf(a.kind) < kindSortOrder.indexOf(b.kind);
     },
+    "external-last"(a, b) {
+        return !a.flags.isExternal && b.flags.isExternal;
+    },
 };
 function getSortFunction(opts) {
     const kindSortOrder = opts

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.25.2",
+  "version": "0.25.4",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -30,7 +30,7 @@
     "shiki": "^0.14.1"
   },
   "peerDependencies": {
-    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x"
+    "typescript": "4.6.x || 4.7.x || 4.8.x || 4.9.x || 5.0.x || 5.1.x || 5.2.x || 5.3.x"
   },
   "devDependencies": {
     "@types/lunr": "^2.3.5",
@@ -47,7 +47,7 @@
     "prettier": "3.0.3",
     "puppeteer": "^13.5.2",
     "ts-node": "^10.9.1",
-    "typescript": "5.2.2"
+    "typescript": "5.3.2"
   },
   "files": [
     "/bin",
@@ -64,7 +64,9 @@
     "test": "mocha --config .config/mocha.fast.json",
     "test:cov": "c8 mocha --config .config/mocha.fast.json",
     "doc:c": "node bin/typedoc --tsconfig src/test/converter/tsconfig.json",
-    "doc:c2": "node --inspect-brk bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
+    "doc:c2": "node bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
+    "doc:c2d": "node --inspect-brk bin/typedoc --tsconfig src/test/converter2/tsconfig.json",
+    "example": "cd example && node ../bin/typedoc",
     "test:full": "c8 mocha --config .config/mocha.full.json",
     "test:visual": "ts-node ./src/test/capture-screenshots.ts && ./scripts/compare_screenshots.sh",
     "test:visual:accept": "node scripts/accept_visual_regression.js",

package/static/style.css

@@ -11,6 +11,7 @@
     --light-color-text-aside: #6e6e6e;
     --light-color-link: #1f70c2;
 
+    --light-color-ts-keyword: #056bd6;
     --light-color-ts-project: #b111c9;
     --light-color-ts-module: var(--light-color-ts-project);
     --light-color-ts-namespace: var(--light-color-ts-project);
@@ -50,6 +51,7 @@
     --dark-color-text-aside: #dddddd;
     --dark-color-link: #00aff4;
 
+    --dark-color-ts-keyword: #3399ff;
     --dark-color-ts-project: #e358ff;
     --dark-color-ts-module: var(--dark-color-ts-project);
     --dark-color-ts-namespace: var(--dark-color-ts-project);
@@ -91,6 +93,7 @@
         --color-text-aside: var(--light-color-text-aside);
         --color-link: var(--light-color-link);
 
+        --color-ts-keyword: var(--light-color-ts-keyword);
         --color-ts-module: var(--light-color-ts-module);
         --color-ts-namespace: var(--light-color-ts-namespace);
         --color-ts-enum: var(--light-color-ts-enum);
@@ -132,6 +135,7 @@
         --color-text-aside: var(--dark-color-text-aside);
         --color-link: var(--dark-color-link);
 
+        --color-ts-keyword: var(--dark-color-ts-keyword);
         --color-ts-module: var(--dark-color-ts-module);
         --color-ts-namespace: var(--dark-color-ts-namespace);
         --color-ts-enum: var(--dark-color-ts-enum);
@@ -180,6 +184,7 @@ body {
     --color-text-aside: var(--light-color-text-aside);
     --color-link: var(--light-color-link);
 
+    --color-ts-keyword: var(--light-color-ts-keyword);
     --color-ts-module: var(--light-color-ts-module);
     --color-ts-namespace: var(--light-color-ts-namespace);
     --color-ts-enum: var(--light-color-ts-enum);
@@ -219,6 +224,7 @@ body {
     --color-text-aside: var(--dark-color-text-aside);
     --color-link: var(--dark-color-link);
 
+    --color-ts-keyword: var(--dark-color-ts-keyword);
     --color-ts-module: var(--dark-color-ts-module);
     --color-ts-namespace: var(--dark-color-ts-namespace);
     --color-ts-enum: var(--dark-color-ts-enum);
@@ -984,6 +990,11 @@ a.tsd-index-link {
     overflow-x: auto;
 }
 
+.tsd-signature-keyword {
+    color: var(--color-ts-keyword);
+    font-weight: normal;
+}
+
 .tsd-signature-symbol {
     color: var(--color-text-aside);
     font-weight: normal;