typedoc 0.28.14 → 0.28.15

package/dist/lib/cli.js

@@ -75,7 +75,8 @@ async function run(app) {
     }
     const preValidationWarnCount = app.logger.warningCount;
     app.validate(project);
-    const hadValidationWarnings = app.logger.warningCount !== preValidationWarnCount;
+    const hadValidationWarnings = app.logger.warningCount !== preValidationWarnCount ||
+        app.logger.validationWarningCount != 0;
     if (app.logger.hasErrors()) {
         return ExitCodes.ValidationError;
     }

package/dist/lib/converter/comments/index.d.ts

@@ -1,6 +1,6 @@
 import ts from "typescript";
 import { Comment, ReflectionKind } from "../../models/index.js";
-import type { CommentStyle, JsDocCompatibility } from "../../utils/options/declaration.js";
+import type { CommentStyle, JsDocCompatibility, ValidationOptions } from "../../utils/options/declaration.js";
 import type { FileRegistry } from "../../models/FileRegistry.js";
 import { type Logger } from "#utils";
 import type { Context } from "../context.js";
@@ -13,6 +13,7 @@ export interface CommentParserConfig {
     suppressCommentWarningsInDeclarationFiles: boolean;
     useTsLinkResolution: boolean;
     commentStyle: CommentStyle;
+    validationOptions: ValidationOptions;
 }
 export interface CommentContext {
     config: CommentParserConfig;

package/dist/lib/converter/comments/parser.js

@@ -45,12 +45,12 @@ export function parseComment(tokens, file, context) {
     const tok = lexer.done() || lexer.peek();
     const comment = new Comment();
     comment.sourcePath = file.fileName;
-    comment.summary = blockContent(comment, lexer, context.config, i18n, warningImpl, context.files);
+    comment.summary = blockContent(comment, lexer, context.config, warningImpl, validationWarningImpl, context.files);
     while (!lexer.done()) {
-        comment.blockTags.push(blockTag(comment, lexer, context.config, i18n, warningImpl, context.files));
+        comment.blockTags.push(blockTag(comment, lexer, context.config, warningImpl, validationWarningImpl, context.files));
     }
     const tok2 = tok;
-    postProcessComment(comment, i18n, () => `${nicePath(file.fileName)}:${file.getLineAndCharacterOfPosition(tok2.pos).line + 1}`, (message) => context.logger.warn(message));
+    postProcessComment(comment, () => `${nicePath(file.fileName)}:${file.getLineAndCharacterOfPosition(tok2.pos).line + 1}`, (message) => context.logger.warn(message));
     return comment;
     function warningImpl(message, token) {
         if (context.config.suppressCommentWarningsInDeclarationFiles &&
@@ -59,6 +59,13 @@ export function parseComment(tokens, file, context) {
         }
         context.logger.warn(message, token.pos, file);
     }
+    function validationWarningImpl(message, token) {
+        if (context.config.suppressCommentWarningsInDeclarationFiles &&
+            hasDeclarationFileExtension(file.fileName)) {
+            return;
+        }
+        context.logger.validationWarning(message, token.pos, file);
+    }
 }
 /**
  * Intended for parsing markdown documents. This only parses code blocks and
@@ -95,13 +102,22 @@ export function parseCommentString(tokens, config, file, logger, files) {
             case TokenSyntaxKind.Text:
             case TokenSyntaxKind.Tag:
             case TokenSyntaxKind.CloseBrace:
-                textContent(file.fileName, next, i18n, (msg, token) => logger.warn(msg, token.pos, file), content, files, atNewLine, reentry);
+                textContent({
+                    sourcePath: file.fileName,
+                    token: next,
+                    warning: (msg, token) => logger.warn(msg, token.pos, file),
+                    validationWarning: (msg, token) => logger.validationWarning(msg, token.pos, file),
+                    files,
+                    atNewLine,
+                    validationOptions: config.validationOptions,
+                }, 
+                /* out */ content, reentry);
                 break;
             case TokenSyntaxKind.Code:
                 content.push({ kind: "code", text: next.text });
                 break;
             case TokenSyntaxKind.OpenBrace:
-                inlineTag(lexer, content, suppressWarningsConfig, i18n, (message, token) => logger.warn(message, token.pos, file));
+                inlineTag(lexer, content, suppressWarningsConfig, (message, token) => logger.warn(message, token.pos, file));
                 consume = false;
                 break;
             default:
@@ -161,7 +177,7 @@ function makeCodeBlock(text) {
  * Loop over comment, produce lint warnings, and set tag names for tags
  * which have them.
  */
-function postProcessComment(comment, i18n, getPosition, warning) {
+function postProcessComment(comment, getPosition, warning) {
     for (const tag of comment.blockTags) {
         if (HAS_USER_IDENTIFIER.includes(tag.tag) && tag.content.length) {
             const first = tag.content[0];
@@ -211,7 +227,7 @@ function postProcessComment(comment, i18n, getPosition, warning) {
     }
 }
 const aliasedTags = new Map([["@return", "@returns"]]);
-function blockTag(comment, lexer, config, i18n, warning, files) {
+function blockTag(comment, lexer, config, warning, validationWarning, files) {
     const blockTag = lexer.take();
     ok(blockTag.kind === TokenSyntaxKind.Tag, "blockTag called not at the start of a block tag."); // blockContent is broken if this fails.
     if (!config.blockTags.has(blockTag.text)) {
@@ -220,7 +236,7 @@ function blockTag(comment, lexer, config, i18n, warning, files) {
     const tagName = aliasedTags.get(blockTag.text) || blockTag.text;
     let content;
     if (tagName === "@example") {
-        return exampleBlock(comment, lexer, config, i18n, warning, files);
+        return exampleBlock(comment, lexer, config, warning, validationWarning, files);
     }
     let typeAnnotation;
     if (!lexer.done() &&
@@ -234,10 +250,10 @@ function blockTag(comment, lexer, config, i18n, warning, files) {
     }
     if (["@default", "@defaultValue"].includes(tagName) &&
         config.jsDocCompatibility.defaultTag) {
-        content = defaultBlockContent(comment, lexer, config, i18n, warning, files);
+        content = defaultBlockContent(comment, lexer, config, warning, validationWarning, files);
     }
     else {
-        content = blockContent(comment, lexer, config, i18n, warning, files);
+        content = blockContent(comment, lexer, config, warning, validationWarning, files);
     }
     const tag = new CommentTag(tagName, content);
     if (typeAnnotation) {
@@ -249,14 +265,14 @@ function blockTag(comment, lexer, config, i18n, warning, files) {
  * The `@default` tag gets a special case because otherwise we will produce many warnings
  * about unescaped/mismatched/missing braces in legacy JSDoc comments
  */
-function defaultBlockContent(comment, lexer, config, i18n, warning, files) {
+function defaultBlockContent(comment, lexer, config, warning, validationWarning, files) {
     lexer.mark();
     const tempRegistry = new FileRegistry();
-    const content = blockContent(comment, lexer, config, i18n, () => { }, tempRegistry);
+    const content = blockContent(comment, lexer, config, () => { }, () => { }, tempRegistry);
     const end = lexer.done() || lexer.peek();
     lexer.release();
     if (content.some((part) => part.kind === "code" || part.kind === "inline-tag")) {
-        return blockContent(comment, lexer, config, i18n, warning, files);
+        return blockContent(comment, lexer, config, warning, validationWarning, files);
     }
     const tokens = [];
     while ((lexer.done() || lexer.peek()) !== end) {
@@ -279,10 +295,10 @@ function defaultBlockContent(comment, lexer, config, i18n, warning, files) {
  *
  * In TSDoc, we also want to treat the first line of the block as the example name.
  */
-function exampleBlock(comment, lexer, config, i18n, warning, files) {
+function exampleBlock(comment, lexer, config, warning, validationWarning, files) {
     lexer.mark();
     const tempRegistry = new FileRegistry();
-    const content = blockContent(comment, lexer, config, i18n, () => { }, tempRegistry);
+    const content = blockContent(comment, lexer, config, () => { }, () => { }, tempRegistry);
     const end = lexer.done() || lexer.peek();
     lexer.release();
     if (!config.jsDocCompatibility.exampleTag ||
@@ -323,7 +339,7 @@ function exampleBlock(comment, lexer, config, i18n, warning, files) {
                     assertNever(next.kind);
             }
         }
-        const content = blockContent(comment, lexer, config, i18n, warning, files);
+        const content = blockContent(comment, lexer, config, warning, validationWarning, files);
         const tag = new CommentTag("@example", content);
         if (exampleName.trim()) {
             tag.name = exampleName.trim();
@@ -362,7 +378,7 @@ function exampleBlock(comment, lexer, config, i18n, warning, files) {
  * If you change this, also look at parseCommentString as it
  * likely needs similar modifications to ensure parsing is consistent.
  */
-function blockContent(comment, lexer, config, i18n, warning, files) {
+function blockContent(comment, lexer, config, warning, validationWarning, files) {
     const content = [];
     let atNewLine = true;
     const reentry = new TextParserReentryState();
@@ -375,8 +391,16 @@ function blockContent(comment, lexer, config, i18n, warning, files) {
                 content.push({ kind: "text", text: next.text });
                 break;
             case TokenSyntaxKind.Text:
-                textContent(comment.sourcePath, next, i18n, warning, 
-                /*out*/ content, files, atNewLine, reentry);
+                textContent({
+                    sourcePath: comment.sourcePath,
+                    token: next,
+                    files,
+                    atNewLine,
+                    warning,
+                    validationWarning,
+                    validationOptions: config.validationOptions,
+                }, 
+                /*out*/ content, reentry);
                 break;
             case TokenSyntaxKind.Code:
                 content.push({ kind: "code", text: next.text });
@@ -414,7 +438,7 @@ function blockContent(comment, lexer, config, i18n, warning, files) {
                 content.push({ kind: "text", text: next.text });
                 break;
             case TokenSyntaxKind.OpenBrace:
-                inlineTag(lexer, content, config, i18n, warning);
+                inlineTag(lexer, content, config, warning);
                 consume = false;
                 break;
             default:
@@ -451,7 +475,7 @@ function blockContent(comment, lexer, config, i18n, warning, files) {
     }
     return content;
 }
-function inlineTag(lexer, block, config, i18n, warning) {
+function inlineTag(lexer, block, config, warning) {
     const openBrace = lexer.take();
     // Now skip whitespace to grab the tag name.
     // If the first non-whitespace text after the brace isn't a tag,

package/dist/lib/converter/comments/textParser.d.ts

@@ -1,15 +1,18 @@
-/**
- * Parser to handle plain text markdown.
- *
- * Responsible for recognizing relative paths within the text and turning
- * them into references.
- * @module
- */
-import type { TranslationProxy } from "../../internationalization/index.js";
 import type { CommentDisplayPart } from "../../models/index.js";
 import type { FileRegistry } from "../../models/FileRegistry.js";
+import { type ValidationOptions } from "#node-utils";
 import { type Token } from "./lexer.js";
 import type { NormalizedPath, TranslatedString } from "#utils";
+interface TextParserData {
+    sourcePath: NormalizedPath;
+    token: Token;
+    pos: number;
+    warning: (msg: TranslatedString, token: Token) => void;
+    validationWarning: (msg: TranslatedString, token: Token) => void;
+    files: FileRegistry;
+    atNewLine: boolean;
+    validationOptions: ValidationOptions;
+}
 /**
  * This is incredibly unfortunate. The comment lexer owns the responsibility
  * for splitting up text into text/code, this is totally fine for HTML links
@@ -26,4 +29,5 @@ export declare class TextParserReentryState {
  * Look for relative links within a piece of text and add them to the {@link FileRegistry}
  * so that they can be correctly resolved during rendering.
  */
-export declare function textContent(sourcePath: NormalizedPath, token: Token, i18n: TranslationProxy, warning: (msg: TranslatedString, token: Token) => void, outContent: CommentDisplayPart[], files: FileRegistry, atNewLine: boolean, reentry: TextParserReentryState): void;
+export declare function textContent(parserData: Omit<TextParserData, "pos">, outContent: CommentDisplayPart[], reentry: TextParserReentryState): void;
+export {};

package/dist/lib/converter/comments/textParser.js

@@ -1,3 +1,11 @@
+/**
+ * Parser to handle plain text markdown.
+ *
+ * Responsible for recognizing relative paths within the text and turning
+ * them into references.
+ * @module
+ */
+import { i18n } from "#utils";
 import { HtmlAttributeParser, ParserState } from "#node-utils";
 import { TokenSyntaxKind } from "./lexer.js";
 import MarkdownIt from "markdown-it";
@@ -34,42 +42,38 @@ export class TextParserReentryState {
  * Look for relative links within a piece of text and add them to the {@link FileRegistry}
  * so that they can be correctly resolved during rendering.
  */
-export function textContent(sourcePath, token, i18n, warning, outContent, files, atNewLine, reentry) {
+export function textContent(parserData, outContent, reentry) {
     let lastPartEnd = 0;
     let canEndMarkdownLink = true;
     const data = {
-        sourcePath,
-        token,
+        ...parserData,
         pos: 0, // relative to the token
-        warning,
-        files: files,
-        atNewLine,
     };
     function addRef(ref) {
         canEndMarkdownLink = true;
         outContent.push({
             kind: "text",
-            text: token.text.slice(lastPartEnd, ref.pos),
+            text: data.token.text.slice(lastPartEnd, ref.pos),
         });
         const link = {
             kind: "relative-link",
-            text: token.text.slice(ref.pos, ref.end),
+            text: data.token.text.slice(ref.pos, ref.end),
             target: ref.target,
             targetAnchor: ref.targetAnchor,
         };
         outContent.push(link);
         lastPartEnd = ref.end;
         data.pos = ref.end;
-        if (!ref.target) {
-            warning(i18n.relative_path_0_is_not_a_file_and_will_not_be_copied_to_output(token.text.slice(ref.pos, ref.end)), {
+        if (!ref.target && data.validationOptions.invalidPath) {
+            data.validationWarning(i18n.relative_path_0_is_not_a_file_and_will_not_be_copied_to_output(data.token.text.slice(ref.pos, ref.end)), {
                 kind: TokenSyntaxKind.Text,
                 // ref.pos is relative to the token, but this pos is relative to the file.
-                pos: token.pos + ref.pos,
-                text: token.text.slice(ref.pos, ref.end),
+                pos: data.token.pos + ref.pos,
+                text: data.token.text.slice(ref.pos, ref.end),
             });
         }
     }
-    while (data.pos < token.text.length) {
+    while (data.pos < data.token.text.length) {
         if (canEndMarkdownLink) {
             const link = checkMarkdownLink(data, reentry);
             if (link) {
@@ -92,14 +96,14 @@ export function textContent(sourcePath, token, i18n, warning, outContent, files,
             }
             continue;
         }
-        const atNewLine = token.text[data.pos] === "\n";
+        const atNewLine = data.token.text[data.pos] === "\n";
         data.atNewLine = atNewLine;
         if (atNewLine && !reentry.withinLinkDest)
             canEndMarkdownLink = true;
         ++data.pos;
     }
-    if (lastPartEnd !== token.text.length) {
-        outContent.push({ kind: "text", text: token.text.slice(lastPartEnd) });
+    if (lastPartEnd !== data.token.text.length) {
+        outContent.push({ kind: "text", text: data.token.text.slice(lastPartEnd) });
     }
 }
 /**
@@ -245,6 +249,7 @@ function checkTagLink(data) {
     if (token.text.startsWith("<link ", pos)) {
         data.pos += 4;
         return checkAttributes(data, {
+            // cspell:words imagesrcset
             imagesrcset: checkAttributeSrcSet,
         });
     }

package/dist/lib/converter/converter.js

@@ -614,6 +614,7 @@ let Converter = (() => {
                 suppressCommentWarningsInDeclarationFiles: this.application.options.getValue("suppressCommentWarningsInDeclarationFiles"),
                 useTsLinkResolution: this.application.options.getValue("useTsLinkResolution"),
                 commentStyle: this.application.options.getValue("commentStyle"),
+                validationOptions: this.application.options.getValue("validation"),
             };
             // Can't be included in options because the TSDoc parser blows up if we do.
             // TypeDoc supports it as one, so it should always be included here.

package/dist/lib/converter/plugins/CommentPlugin.js

@@ -290,6 +290,8 @@ let CommentPlugin = (() => {
          * @param reflection  The reflection that is currently processed.
          */
         onCreateTypeParameter(_context, reflection) {
+            if (reflection.comment)
+                return;
             const comment = reflection.parent?.comment;
             if (comment) {
                 let tag = comment.getIdentifiedTag(reflection.name, "@typeParam");
@@ -306,6 +308,17 @@ let CommentPlugin = (() => {
                     reflection.comment = new Comment(tag.content);
                     reflection.comment.sourcePath = comment.sourcePath;
                     removeIfPresent(comment.blockTags, tag);
+                    return;
+                }
+            }
+            // #3031 if this is a class constructor, also check for type parameters
+            // that live on the class itself and potentially copy their comment.
+            if (reflection.parent?.kindOf(ReflectionKind.ConstructorSignature) &&
+                reflection.parent.parent?.kindOf(ReflectionKind.Constructor)) {
+                const cls = reflection.parent.parent.parent;
+                const typeParam = cls.typeParameters?.find(param => param.name === reflection.name);
+                if (typeParam?.comment) {
+                    reflection.comment = typeParam.comment.clone();
                 }
             }
         }

package/dist/lib/converter/symbols.js

@@ -377,6 +377,14 @@ function convertClassOrInterface(context, symbol, exportSymbol) {
         reflection.implementedTypes = implementedTypes;
     }
     context.finalizeDeclarationReflection(reflection);
+    // Convert type parameters early so that we get access them when converting the constructors if any
+    if (instanceType.typeParameters) {
+        reflection.typeParameters = instanceType.typeParameters.map((param) => {
+            const declaration = param.symbol.declarations?.[0];
+            assert(declaration && ts.isTypeParameterDeclaration(declaration));
+            return createTypeParamReflection(declaration, reflectionContext);
+        });
+    }
     if (classDeclaration && reflection.kind === ReflectionKind.Class) {
         // Classes can have static props
         const staticType = context.checker.getTypeOfSymbolAtLocation(symbol, classDeclaration);
@@ -404,14 +412,6 @@ function convertClassOrInterface(context, symbol, exportSymbol) {
     }
     // Classes/interfaces usually just have properties...
     convertSymbols(reflectionContext, context.checker.getPropertiesOfType(instanceType));
-    // And type arguments
-    if (instanceType.typeParameters) {
-        reflection.typeParameters = instanceType.typeParameters.map((param) => {
-            const declaration = param.symbol.declarations?.[0];
-            assert(declaration && ts.isTypeParameterDeclaration(declaration));
-            return createTypeParamReflection(declaration, reflectionContext);
-        });
-    }
     // Interfaces might also have call signatures
     // Classes might too, because of declaration merging
     context.checker

package/dist/lib/converter/utils/repository.js

@@ -139,6 +139,9 @@ let GitRepository = (() => {
          * @returns A new instance of {@link GitRepository} or undefined.
          */
         static tryCreateRepository(path, sourceLinkTemplate, gitRevision, gitRemote, logger) {
+            if (gitRevision === "{branch}") {
+                gitRevision = git("-C", path, "branch", "--show-current").stdout.trim();
+            }
             gitRevision ||= git("-C", path, "rev-parse", "HEAD").stdout.trim();
             if (gitRevision == "HEAD")
                 return; // Will only happen in a repo with no commits.

package/dist/lib/models/DeclarationReflection.d.ts

@@ -38,6 +38,13 @@ export declare class DeclarationReflection extends ContainerReflection {
      * A list of all source files that contributed to this reflection.
      */
     sources?: SourceReference[];
+    /**
+     * Precomputed boost for search results, may be less than 1 to de-emphasize this member in search results.
+     * Does NOT include group/category values as they are computed when building the JS index.
+     *
+     * This is exposed purely for plugin use, see #3036 for details.
+     */
+    relevanceBoost?: number;
     /**
      * The escaped name of this declaration assigned by the TS compiler if there is an associated symbol.
      * This is used to retrieve properties for analyzing inherited members.

package/dist/lib/models/DeclarationReflection.js

@@ -19,6 +19,13 @@ export class DeclarationReflection extends ContainerReflection {
      * A list of all source files that contributed to this reflection.
      */
     sources;
+    /**
+     * Precomputed boost for search results, may be less than 1 to de-emphasize this member in search results.
+     * Does NOT include group/category values as they are computed when building the JS index.
+     *
+     * This is exposed purely for plugin use, see #3036 for details.
+     */
+    relevanceBoost;
     /**
      * The escaped name of this declaration assigned by the TS compiler if there is an associated symbol.
      * This is used to retrieve properties for analyzing inherited members.
@@ -217,6 +224,7 @@ export class DeclarationReflection extends ContainerReflection {
             variant: this.variant,
             packageVersion: this.packageVersion,
             sources: serializer.toObjectsOptional(this.sources),
+            relevanceBoost: this.relevanceBoost === 1 ? undefined : this.relevanceBoost,
             typeParameters: serializer.toObjectsOptional(this.typeParameters),
             type: serializer.toObject(this.type),
             signatures: serializer.toObjectsOptional(this.signatures),
@@ -260,6 +268,7 @@ export class DeclarationReflection extends ContainerReflection {
         }
         this.packageVersion = obj.packageVersion;
         this.sources = de.reviveMany(obj.sources, (src) => new SourceReference(src.fileName, src.line, src.character));
+        this.relevanceBoost = obj.relevanceBoost;
         this.typeParameters = de.reviveMany(obj.typeParameters, (tp) => de.constructReflection(tp));
         this.type = de.revive(obj.type, (t) => de.constructType(t));
         this.signatures = de.reviveMany(obj.signatures, (r) => de.constructReflection(r));

package/dist/lib/output/events.d.ts

@@ -1,6 +1,7 @@
 import type { ProjectReflection } from "../models/ProjectReflection.js";
 import { type DeclarationReflection, type DocumentReflection, Reflection, type ReflectionKind } from "../models/index.js";
 import type { PageDefinition, PageKind, RouterTarget } from "./router.js";
+import { type Icons } from "./themes/default/partials/icon.js";
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
  * ending of the entire rendering process.
@@ -39,6 +40,7 @@ export interface PageHeading {
     level?: number;
     kind?: ReflectionKind;
     classes?: string;
+    icon?: keyof Icons & (string | number);
 }
 /**
  * An event emitted by the {@link Renderer} class before and after the

package/dist/lib/output/events.js

@@ -1,4 +1,5 @@
 import { Reflection, } from "../models/index.js";
+import {} from "./themes/default/partials/icon.js";
 /**
  * An event emitted by the {@link Renderer} class at the very beginning and
  * ending of the entire rendering process.

package/dist/lib/output/plugins/JavascriptIndexPlugin.js

@@ -174,7 +174,7 @@ let JavascriptIndexPlugin = (() => {
             }
         }
         getBoost(refl) {
-            let boost = 1;
+            let boost = refl.relevanceBoost ?? 1;
             for (const group of GroupPlugin.getGroups(refl, this.groupReferencesByType)) {
                 boost *= this.searchGroupBoosts[group] ?? 1;
                 this.unusedGroupBoosts.delete(group);

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

@@ -9,6 +9,7 @@ export function member(context, props) {
         text: getDisplayName(props),
         kind: props.kind,
         classes: context.getReflectionClasses(props),
+        icon: context.theme.getReflectionIcon(props),
     });
     // With the default url derivation, we'll never hit this case as documents are always placed into their
     // own pages. Handle it here in case someone creates a custom url scheme which embeds guides within the page.

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

@@ -35,6 +35,7 @@ export function moduleMemberSummary(context, member) {
         text: getDisplayName(member),
         kind: member instanceof ReferenceReflection ? member.getTargetReflectionDeep().kind : member.kind,
         classes: context.getReflectionClasses(member),
+        icon: context.theme.getReflectionIcon(member),
     });
     let name;
     if (member instanceof ReferenceReflection) {

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

@@ -109,7 +109,7 @@ function buildSectionNavigation(context, headings) {
             levels.push([]);
         }
         levels[levels.length - 1].push(JSX.createElement("a", { href: heading.link, class: classNames({}, heading.classes) },
-            heading.kind && context.icons[heading.kind](),
+            heading.icon && context.icons[heading.icon](),
             JSX.createElement("span", null, wbr(heading.text))));
     }
     while (levels.length > 1) {

package/dist/lib/serialization/schema.d.ts

@@ -97,7 +97,7 @@ export interface ParameterReflection extends Omit<Reflection, "variant">, S<M.Pa
     variant: "param";
 }
 /** @category Reflections */
-export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "type" | "signatures" | "indexSignatures" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters" | "readme"> {
+export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignatures" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters" | "readme"> {
 }
 /** @category Reflections */
 export interface TypeParameterReflection extends Omit<Reflection, "variant">, S<M.TypeParameterReflection, "variant" | "type" | "default" | "varianceModifier"> {

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

@@ -242,6 +242,10 @@ export type ValidationOptions = {
      * If set, TypeDoc will produce warnings about \{\@link\} tags which will produce broken links.
      */
     invalidLink: boolean;
+    /**
+     * If set, TypeDoc will produce warnings about relative paths within the documentation which could not be resolved.
+     */
+    invalidPath: boolean;
     /**
      * If set, TypeDoc will produce warnings about \{\@link\} tags which do not link directly to their target.
      */

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

@@ -864,6 +864,7 @@ export function addTypeDocOptions(options) {
         defaults: {
             notExported: true,
             invalidLink: true,
+            invalidPath: true,
             rewrittenLink: true,
             notDocumented: false,
             unusedMergeModuleWith: true,

package/dist/lib/utils/options/tsdoc-defaults.d.ts

@@ -1,5 +1,5 @@
-export declare const tsdocBlockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam"];
-export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam", "@author", "@callback", "@category", "@categoryDescription", "@default", "@document", "@extends", "@augments", "@yields", "@group", "@groupDescription", "@import", "@inheritDoc", "@jsx", "@license", "@module", "@mergeModuleWith", "@prop", "@property", "@return", "@satisfies", "@since", "@sortStrategy", "@template", "@this", "@type", "@typedef", "@summary", "@preventInline", "@inlineType", "@preventExpand", "@expandType"];
+export declare const tsdocBlockTags: readonly ["@defaultValue", "@deprecated", "@example", "@jsx", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam"];
+export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@example", "@jsx", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam", "@author", "@callback", "@category", "@categoryDescription", "@default", "@document", "@extends", "@augments", "@yields", "@group", "@groupDescription", "@import", "@inheritDoc", "@license", "@module", "@mergeModuleWith", "@prop", "@property", "@return", "@satisfies", "@since", "@sortStrategy", "@template", "@this", "@type", "@typedef", "@summary", "@preventInline", "@inlineType", "@preventExpand", "@expandType"];
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain", "@include", "@includeCode"];
 export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];

package/dist/lib/utils/options/tsdoc-defaults.js

@@ -3,6 +3,7 @@ export const tsdocBlockTags = [
     "@defaultValue",
     "@deprecated",
     "@example",
+    "@jsx",
     "@param",
     "@privateRemarks",
     "@remarks",
@@ -26,7 +27,6 @@ export const blockTags = [
     "@groupDescription",
     "@import",
     "@inheritDoc",
-    "@jsx",
     "@license",
     "@module",
     "@mergeModuleWith",

package/dist/lib/utils-common/logger.d.ts

@@ -26,6 +26,10 @@ export declare class Logger {
      * How many warning messages have been logged?
      */
     warningCount: number;
+    /**
+     * How many validation warning messages have been logged?
+     */
+    validationWarningCount: number;
     /**
      * The minimum logging level to print.
      */
@@ -57,10 +61,17 @@ export declare class Logger {
     /**
      * Log the given warning.
      *
-     * @param text  The warning that should be logged.
+     * @param text The warning that should be logged.
      */
     warn(text: IfInternal<TranslatedString, string>, node?: MinimalNode): void;
     warn(text: IfInternal<TranslatedString, string>, pos: number, file: MinimalSourceFile): void;
+    /**
+     * Log the given warning and records that a validation warning has occurred.
+     *
+     * @param text The warning that should be logged.
+     */
+    validationWarning(text: IfInternal<TranslatedString, string>, node?: MinimalNode): void;
+    validationWarning(text: IfInternal<TranslatedString, string>, pos: number, file: MinimalSourceFile): void;
     /**
      * Log the given error.
      *

package/dist/lib/utils-common/logger.js

@@ -30,6 +30,10 @@ export class Logger {
      * How many warning messages have been logged?
      */
     warningCount = 0;
+    /**
+     * How many validation warning messages have been logged?
+     */
+    validationWarningCount = 0;
     /**
      * The minimum logging level to print.
      */
@@ -57,6 +61,7 @@ export class Logger {
      */
     resetWarnings() {
         this.warningCount = 0;
+        this.validationWarningCount = 0;
     }
     /**
      * Log the given verbose message.
@@ -74,6 +79,10 @@ export class Logger {
         const text2 = this.addContext(text, LogLevel.Warn, ...args);
         this.log(text2, LogLevel.Warn);
     }
+    validationWarning(...args) {
+        this.validationWarningCount += 1;
+        this.warn(...args);
+    }
     error(text, ...args) {
         const text2 = this.addContext(text, LogLevel.Error, ...args);
         this.log(text2, LogLevel.Error);

package/dist/lib/validation/documentation.js

@@ -81,11 +81,11 @@ export function validateDocumentation(project, logger, requiredToBeDocumented, i
                 intentionalUsage.add(intentionalIndex);
                 continue;
             }
-            logger.warn(i18n.reflection_0_kind_1_defined_in_2_does_not_have_any_documentation(ref.getFriendlyFullName(), ReflectionKind[ref.kind], `${symbolId.packageName}/${symbolId.packagePath}`));
+            logger.validationWarning(i18n.reflection_0_kind_1_defined_in_2_does_not_have_any_documentation(ref.getFriendlyFullName(), ReflectionKind[ref.kind], `${symbolId.packageName}/${symbolId.packagePath}`));
         }
     }
     const unusedIntentional = intentionallyNotDocumented.filter((_, i) => !intentionalUsage.has(i));
     if (unusedIntentional.length) {
-        logger.warn(i18n.invalid_intentionally_not_documented_names_0(unusedIntentional.join("\n\t")));
+        logger.validationWarning(i18n.invalid_intentionally_not_documented_names_0(unusedIntentional.join("\n\t")));
     }
 }

package/dist/lib/validation/exports.js

@@ -55,11 +55,11 @@ export function validateExports(project, logger, intentionallyNotExported) {
             !warned.has(uniqueId) &&
             !project.symbolIdHasBeenRemoved(type.symbolId)) {
             warned.add(uniqueId);
-            logger.warn(i18n.type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs(type.qualifiedName, `${type.symbolId.packageName}/${type.symbolId.packagePath}`, owner.getFriendlyFullName()));
+            logger.validationWarning(i18n.type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs(type.qualifiedName, `${type.symbolId.packageName}/${type.symbolId.packagePath}`, owner.getFriendlyFullName()));
         }
     }
     const unusedIntentional = intentional.getUnused();
     if (unusedIntentional.length) {
-        logger.warn(i18n.invalid_intentionally_not_exported_symbols_0(unusedIntentional.join("\n\t")));
+        logger.validationWarning(i18n.invalid_intentionally_not_exported_symbols_0(unusedIntentional.join("\n\t")));
     }
 }

package/dist/lib/validation/links.js

@@ -34,10 +34,10 @@ function checkReflection(reflection, logger) {
             // If a link starts with it, and doesn't include a module source indicator "!"
             // then the user probably is trying to link to a package containing "@" with an absolute link.
             if (linkText.startsWith("@") && !linkText.includes("!")) {
-                logger.warn(i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(linkText, reflection.getFriendlyFullName(), linkText.replace(/[.#~]/, "!")));
+                logger.validationWarning(i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(linkText, reflection.getFriendlyFullName(), linkText.replace(/[.#~]/, "!")));
             }
             else {
-                logger.warn(i18n.failed_to_resolve_link_to_0_in_readme_for_1(linkText, reflection.getFriendlyFullName()));
+                logger.validationWarning(i18n.failed_to_resolve_link_to_0_in_readme_for_1(linkText, reflection.getFriendlyFullName()));
             }
         }
     }
@@ -45,10 +45,10 @@ function checkReflection(reflection, logger) {
         for (const broken of getBrokenPartLinks(reflection.content)) {
             const linkText = broken.text.trim();
             if (linkText.startsWith("@") && !linkText.includes("!")) {
-                logger.warn(i18n.failed_to_resolve_link_to_0_in_document_1_may_have_meant_2(linkText, reflection.getFriendlyFullName(), linkText.replace(/[.#~]/, "!")));
+                logger.validationWarning(i18n.failed_to_resolve_link_to_0_in_document_1_may_have_meant_2(linkText, reflection.getFriendlyFullName(), linkText.replace(/[.#~]/, "!")));
             }
             else {
-                logger.warn(i18n.failed_to_resolve_link_to_0_in_document_1(linkText, reflection.getFriendlyFullName()));
+                logger.validationWarning(i18n.failed_to_resolve_link_to_0_in_document_1(linkText, reflection.getFriendlyFullName()));
             }
         }
     }
@@ -67,12 +67,12 @@ function checkReflection(reflection, logger) {
 function reportBrokenCommentLink(broken, reflection, logger) {
     const linkText = broken.text.trim();
     if (broken.target instanceof ReflectionSymbolId) {
-        logger.warn(i18n.comment_for_0_links_to_1_not_included_in_docs_use_external_link_2(reflection.getFriendlyFullName(), linkText, `{ "${broken.target.packageName}": { "${broken.target.qualifiedName}": "#" }}`));
+        logger.validationWarning(i18n.comment_for_0_links_to_1_not_included_in_docs_use_external_link_2(reflection.getFriendlyFullName(), linkText, `{ "${broken.target.packageName}": { "${broken.target.qualifiedName}": "#" }}`));
     }
     else if (linkText.startsWith("@") && !linkText.includes("!")) {
-        logger.warn(i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(linkText, reflection.getFriendlyFullName(), linkText.replace(/[.#~]/, "!")));
+        logger.validationWarning(i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(linkText, reflection.getFriendlyFullName(), linkText.replace(/[.#~]/, "!")));
     }
     else {
-        logger.warn(i18n.failed_to_resolve_link_to_0_in_comment_for_1(linkText, reflection.getFriendlyFullName()));
+        logger.validationWarning(i18n.failed_to_resolve_link_to_0_in_comment_for_1(linkText, reflection.getFriendlyFullName()));
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.28.14",
+  "version": "0.28.15",
   "homepage": "https://typedoc.org",
   "type": "module",
   "exports": {
@@ -31,7 +31,7 @@
     "pnpm": ">= 10"
   },
   "dependencies": {
-    "@gerrit0/mini-shiki": "^3.12.0",
+    "@gerrit0/mini-shiki": "^3.17.0",
     "lunr": "^2.3.9",
     "markdown-it": "^14.1.0",
     "minimatch": "^9.0.5",
@@ -41,22 +41,22 @@
     "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x"
   },
   "devDependencies": {
-    "@eslint/js": "^9.34.0",
+    "@eslint/js": "^9.39.1",
     "@types/lunr": "^2.3.7",
     "@types/markdown-it": "^14.1.2",
     "@types/mocha": "^10.0.10",
     "@types/node": "18",
     "@typestrong/fs-fixture-builder": "github:TypeStrong/fs-fixture-builder#34113409e3a171e68ce5e2b55461ef5c35591cfe",
     "c8": "^10.1.3",
-    "dprint": "^0.50.1",
-    "esbuild": "^0.25.9",
-    "eslint": "^9.34.0",
-    "mocha": "^11.7.1",
-    "puppeteer": "^24.17.1",
-    "semver": "^7.7.2",
-    "tsx": "^4.20.5",
-    "typescript": "5.9.2",
-    "typescript-eslint": "^8.41.0"
+    "dprint": "^0.50.2",
+    "esbuild": "^0.27.0",
+    "eslint": "^9.39.1",
+    "mocha": "^11.7.5",
+    "puppeteer": "^24.31.0",
+    "semver": "^7.7.3",
+    "tsx": "^4.20.6",
+    "typescript": "5.9.3",
+    "typescript-eslint": "^8.48.0"
   },
   "files": [
     "/bin",

package/static/style.css

@@ -1595,9 +1595,9 @@
         .container-main {
             grid-template-columns:
                 minmax(0, 1fr) minmax(0, 2.5fr) minmax(
-                0,
-                20rem
-            );
+                    0,
+                    20rem
+                );
             grid-template-areas: "sidebar content toc";
         }
 

package/tsdoc.json

@@ -231,10 +231,6 @@
             "tagName": "@hideconstructor",
             "syntaxKind": "modifier"
         },
-        {
-            "tagName": "@jsx",
-            "syntaxKind": "block"
-        },
         {
             "tagName": "@summary",
             "syntaxKind": "block"