typedoc 0.26.2 → 0.26.4

package/dist/lib/models/FileRegistry.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ValidatingFileRegistry = exports.FileRegistry = void 0;
 const path_1 = require("path");
 const utils_1 = require("../utils");
-const fs_1 = require("fs");
 class FileRegistry {
     constructor() {
         this.nextId = 1;
@@ -50,6 +49,9 @@ class FileRegistry {
         const absolute = this.mediaToPath.get(id);
         if (!absolute)
             return;
+        if (this.names.has(id)) {
+            return this.names.get(id);
+        }
         const file = (0, path_1.basename)(absolute);
         if (!this.nameUsage.has(file)) {
             this.nameUsage.set(file, 1);
@@ -111,7 +113,7 @@ exports.FileRegistry = FileRegistry;
 class ValidatingFileRegistry extends FileRegistry {
     register(sourcePath, relativePath) {
         const absolute = (0, path_1.resolve)((0, path_1.dirname)(sourcePath), relativePath);
-        if (!(0, fs_1.existsSync)(absolute)) {
+        if (!(0, utils_1.isFile)(absolute)) {
             return;
         }
         return this.registerAbsolute(absolute);
@@ -119,8 +121,8 @@ class ValidatingFileRegistry extends FileRegistry {
     fromObject(de, obj) {
         for (const [key, val] of Object.entries(obj.entries)) {
             const absolute = (0, utils_1.normalizePath)((0, path_1.resolve)(de.projectRoot, val));
-            if (!(0, fs_1.existsSync)(absolute)) {
-                de.logger.warn(de.logger.i18n.saved_relative_path_0_resolved_from_1_does_not_exist(val, de.projectRoot));
+            if (!(0, utils_1.isFile)(absolute)) {
+                de.logger.warn(de.logger.i18n.saved_relative_path_0_resolved_from_1_is_not_a_file(val, de.projectRoot));
                 continue;
             }
             de.oldFileIdToNewFileId[+key] = this.registerAbsolute(absolute);

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

@@ -43,6 +43,13 @@ export declare class RendererEvent {
      */
     createPageEvent<Model>(mapping: UrlMapping<Model>): [RenderTemplate<PageEvent<Model>>, PageEvent<Model>];
 }
+export interface PageHeading {
+    link: string;
+    text: string;
+    level?: number;
+    kind?: ReflectionKind;
+    classes?: string;
+}
 /**
  * An event emitted by the {@link Renderer} class before and after the
  * markup of a page is rendered.
@@ -77,13 +84,19 @@ export declare class PageEvent<out Model = unknown> extends Event {
      * Links to content within this page that should be rendered in the page navigation.
      * This is built when rendering the document content.
      */
-    pageHeadings: Array<{
-        link: string;
-        text: string;
-        level?: number;
-        kind?: ReflectionKind;
-        classes?: string;
-    }>;
+    pageHeadings: PageHeading[];
+    /**
+     * Sections of the page, generally set by `@group`s
+     */
+    pageSections: {
+        title: string;
+        headings: PageHeading[];
+    }[];
+    /**
+     * Start a new section of the page. Sections are collapsible within
+     * the "On This Page" sidebar.
+     */
+    startNewSection(title: string): void;
     /**
      * Triggered before a document will be rendered.
      * @event

package/dist/lib/output/events.js

@@ -71,6 +71,17 @@ RendererEvent.END = "endRender";
  * @see {@link Renderer.EVENT_END_PAGE}
  */
 class PageEvent extends Event {
+    /**
+     * Start a new section of the page. Sections are collapsible within
+     * the "On This Page" sidebar.
+     */
+    startNewSection(title) {
+        this.pageHeadings = [];
+        this.pageSections.push({
+            title,
+            headings: this.pageHeadings,
+        });
+    }
     constructor(name, model) {
         super(name);
         /**
@@ -78,6 +89,15 @@ class PageEvent extends Event {
          * This is built when rendering the document content.
          */
         this.pageHeadings = [];
+        /**
+         * Sections of the page, generally set by `@group`s
+         */
+        this.pageSections = [
+            {
+                title: "",
+                headings: this.pageHeadings,
+            },
+        ];
         this.model = model;
     }
 }

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

@@ -1,4 +1,4 @@
-export { PageEvent, RendererEvent, MarkdownEvent, IndexEvent } from "./events";
+export { PageEvent, RendererEvent, MarkdownEvent, IndexEvent, type PageHeading, } from "./events";
 export { UrlMapping } from "./models/UrlMapping";
 export type { RenderTemplate } from "./models/UrlMapping";
 export { Renderer, type RendererEvents } from "./renderer";

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

@@ -228,7 +228,7 @@ class DefaultTheme extends theme_1.Theme {
     }
     render(page, template) {
         const templateOutput = this.defaultLayoutTemplate(page, template);
-        return "<!DOCTYPE html>" + utils_1.JSX.renderElement(templateOutput);
+        return "<!DOCTYPE html>" + utils_1.JSX.renderElement(templateOutput) + "\n";
     }
     /**
      * If implementing a custom theme, it is recommended to override {@link buildNavigation} instead.
@@ -248,29 +248,36 @@ class DefaultTheme extends theme_1.Theme {
         const leaves = this.application.options.getValue("navigationLeaves");
         return getNavigationElements(project) || [];
         function toNavigation(element) {
+            const children = getNavigationElements(element);
             if (element instanceof models_1.ReflectionCategory || element instanceof models_1.ReflectionGroup) {
+                if (!children?.length) {
+                    return;
+                }
                 return {
                     text: element.title,
-                    children: getNavigationElements(element),
+                    children,
                 };
             }
+            if (!element.hasOwnDocument) {
+                return;
+            }
             return {
                 text: (0, lib_1.getDisplayName)(element),
                 path: element.url,
                 kind: element.kind,
                 class: (0, lib_1.classNames)({ deprecated: element.isDeprecated() }, theme.getReflectionClasses(element)),
-                children: getNavigationElements(element),
+                children: children?.length ? children : undefined,
             };
         }
         function getNavigationElements(parent) {
             if (parent instanceof models_1.ReflectionCategory) {
-                return parent.children.map(toNavigation);
+                return (0, utils_1.filterMap)(parent.children, toNavigation);
             }
             if (parent instanceof models_1.ReflectionGroup) {
                 if (shouldShowCategories(parent.owningReflection, opts) && parent.categories) {
-                    return parent.categories.map(toNavigation);
+                    return (0, utils_1.filterMap)(parent.categories, toNavigation);
                 }
-                return parent.children.map(toNavigation);
+                return (0, utils_1.filterMap)(parent.children, toNavigation);
             }
             if (leaves.includes(parent.getFullName())) {
                 return;
@@ -279,23 +286,23 @@ class DefaultTheme extends theme_1.Theme {
                 return;
             }
             if (parent.isDocument()) {
-                return parent.children?.map(toNavigation);
+                return (0, utils_1.filterMap)(parent.children, toNavigation);
             }
             if (!parent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
                 // Tricky: Non-module children don't show up in the navigation pane,
                 //   but any documents added by them should.
-                return parent.documents?.map(toNavigation);
+                return (0, utils_1.filterMap)(parent.documents, toNavigation);
             }
             if (parent.categories && shouldShowCategories(parent, opts)) {
-                return parent.categories.map(toNavigation);
+                return (0, utils_1.filterMap)(parent.categories, toNavigation);
             }
             if (parent.groups && shouldShowGroups(parent, opts)) {
-                return parent.groups.map(toNavigation);
+                return (0, utils_1.filterMap)(parent.groups, toNavigation);
             }
             if (opts.includeFolders && parent.childrenIncludingDocuments?.some((child) => child.name.includes("/"))) {
                 return deriveModuleFolders(parent.childrenIncludingDocuments);
             }
-            return parent.childrenIncludingDocuments?.map(toNavigation);
+            return (0, utils_1.filterMap)(parent.childrenIncludingDocuments, toNavigation);
         }
         function deriveModuleFolders(children) {
             const result = [];
@@ -318,12 +325,14 @@ class DefaultTheme extends theme_1.Theme {
             };
             // Note: This might end up putting a module within another module if we document
             // both foo/index.ts and foo/bar.ts.
-            for (const child of children) {
-                const parts = child.name.split("/");
-                const collection = resolveOrCreateParents(parts);
+            for (const child of children.filter((c) => c.hasOwnDocument)) {
                 const nav = toNavigation(child);
-                nav.text = parts[parts.length - 1];
-                collection.push(nav);
+                if (nav) {
+                    const parts = child.name.split("/");
+                    const collection = resolveOrCreateParents(parts);
+                    nav.text = parts[parts.length - 1];
+                    collection.push(nav);
+                }
             }
             // Now merge single-possible-paths together so we don't have folders in our navigation
             // which contain only another single folder.

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

@@ -5,7 +5,7 @@ import { type NeverIfInternal, type Options } from "../../../utils";
 import type { DefaultTheme } from "./DefaultTheme";
 import { type icons } from "./partials/icon";
 export declare class DefaultThemeRenderContext {
-    private theme;
+    readonly theme: DefaultTheme;
     page: PageEvent<Reflection>;
     private _refIcons;
     options: Options;
@@ -63,7 +63,8 @@ export declare class DefaultThemeRenderContext {
     memberSignatures: (props: DeclarationReflection) => import("../../../utils/jsx.elements").JsxElement;
     memberSources: (props: DeclarationReflection | import("../../../models").SignatureReflection) => import("../../../utils/jsx.elements").JsxElement;
     members: (props: import("../../../models").ContainerReflection) => import("../../../utils/jsx.elements").JsxElement;
-    membersGroup: (group: import("../../../models").ReflectionGroup) => import("../../../utils/jsx.elements").JsxElement;
+    /** @deprecated Since 0.26.3 members does group/category flattening internally */
+    membersGroup?: Function;
     sidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     pageSidebar: (props: PageEvent<Reflection>) => import("../../../utils/jsx.elements").JsxElement;
     sidebarLinks: () => import("../../../utils/jsx.elements").JsxElement | null;

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

@@ -18,7 +18,6 @@ const member_signature_title_1 = require("./partials/member.signature.title");
 const member_signatures_1 = require("./partials/member.signatures");
 const member_sources_1 = require("./partials/member.sources");
 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");
@@ -87,7 +86,6 @@ class DefaultThemeRenderContext {
         this.memberSignatures = bind(member_signatures_1.memberSignatures, this);
         this.memberSources = bind(member_sources_1.memberSources, this);
         this.members = bind(members_1.members, this);
-        this.membersGroup = bind(members_group_1.membersGroup, this);
         this.sidebar = bind(navigation_1.sidebar, this);
         this.pageSidebar = bind(navigation_1.pageSidebar, this);
         this.sidebarLinks = bind(navigation_1.sidebarLinks, this);

package/dist/lib/output/themes/default/partials/member.reference.d.ts

@@ -1,4 +1,4 @@
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
 import { JSX } from "../../../../utils";
 import type { ReferenceReflection } from "../../../../models";
-export declare const memberReference: ({ urlTo, i18n }: DefaultThemeRenderContext, props: ReferenceReflection) => JSX.Element;
+export declare const memberReference: ({ urlTo, i18n, commentSummary, commentTags }: DefaultThemeRenderContext, props: ReferenceReflection) => JSX.Element;

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

@@ -2,23 +2,29 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.memberReference = void 0;
 const utils_1 = require("../../../../utils");
-const memberReference = ({ urlTo, i18n }, props) => {
+const memberReference = ({ urlTo, i18n, commentSummary, commentTags }, props) => {
     const referenced = props.tryGetTargetReflectionDeep();
     if (!referenced) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             i18n.theme_re_exports(),
             " ",
-            props.name));
+            props.name,
+            commentSummary(props),
+            commentTags(props)));
     }
     if (props.name === referenced.name) {
         return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             i18n.theme_re_exports(),
             " ",
-            utils_1.JSX.createElement("a", { href: urlTo(referenced) }, referenced.name)));
+            utils_1.JSX.createElement("a", { href: urlTo(referenced) }, referenced.name),
+            commentSummary(props),
+            commentTags(props)));
     }
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
         i18n.theme_renames_and_re_exports(),
         " ",
-        utils_1.JSX.createElement("a", { href: urlTo(referenced) }, referenced.name)));
+        utils_1.JSX.createElement("a", { href: urlTo(referenced) }, referenced.name),
+        commentSummary(props),
+        commentTags(props)));
 };
 exports.memberReference = memberReference;

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

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

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

@@ -2,17 +2,47 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.members = members;
 const utils_1 = require("../../../../utils");
-const models_1 = require("../../../../models");
-const lib_1 = require("../../lib");
+function getMemberSections(parent) {
+    if (parent.categories?.length) {
+        return (0, utils_1.filterMap)(parent.categories, (cat) => {
+            if (!cat.allChildrenHaveOwnDocument()) {
+                return {
+                    title: cat.title,
+                    children: cat.children.filter((child) => !child.hasOwnDocument),
+                };
+            }
+        });
+    }
+    if (parent.groups?.length) {
+        return parent.groups.flatMap((group) => {
+            if (group.categories?.length) {
+                return (0, utils_1.filterMap)(group.categories, (cat) => {
+                    if (!cat.allChildrenHaveOwnDocument()) {
+                        return {
+                            title: `${group.title} - ${cat.title}`,
+                            children: cat.children.filter((child) => !child.hasOwnDocument),
+                        };
+                    }
+                });
+            }
+            return {
+                title: group.title,
+                children: group.children.filter((child) => !child.hasOwnDocument),
+            };
+        });
+    }
+    return [];
+}
 function members(context, props) {
-    if (props.categories && props.categories.length) {
-        return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, props.categories.map((item) => !item.allChildrenHaveOwnDocument() && (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-panel-group": true, "tsd-member-group": true, "tsd-accordion": true }, props instanceof models_1.DeclarationReflection ? context.getReflectionClasses(props) : "") },
-            utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + item.title },
+    const sections = getMemberSections(props).filter((sect) => sect.children.length);
+    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, sections.map(({ title, children }) => {
+        context.page.startNewSection(title);
+        return (utils_1.JSX.createElement("details", { class: "tsd-panel-group tsd-member-group tsd-accordion", open: true },
+            utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": "section-" + title },
                 utils_1.JSX.createElement("h2", null,
                     context.icons.chevronDown(),
                     " ",
-                    item.title)),
-            utils_1.JSX.createElement("section", null, item.children.map((item) => !item.hasOwnDocument && context.member(item))))))));
-    }
-    return utils_1.JSX.createElement(utils_1.JSX.Fragment, null, props.groups?.map((item) => !item.allChildrenHaveOwnDocument() && context.membersGroup(item)));
+                    title)),
+            utils_1.JSX.createElement("section", null, children.map((item) => context.member(item)))));
+    })));
 }

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

@@ -86,7 +86,7 @@ function pageSidebar(context, props) {
         context.settings(),
         context.pageNavigation(props)));
 }
-function pageNavigation(context, props) {
+function buildSectionNavigation(context, headings) {
     const levels = [[]];
     function finalizeLevel(finishedHandlingHeadings) {
         const level = levels.pop();
@@ -97,8 +97,12 @@ function pageNavigation(context, props) {
         const built = (utils_1.JSX.createElement("ul", null, level.map((l) => (utils_1.JSX.createElement("li", null, l)))));
         levels[levels.length - 1].push(built);
     }
-    for (const heading of props.pageHeadings) {
-        const inferredLevel = heading.level ? heading.level + 1 : 1;
+    for (const heading of headings) {
+        const inferredLevel = heading.level
+            ? heading.level + 2 // regular heading
+            : heading.kind
+                ? 2 // reflection
+                : 1; // group/category
         while (inferredLevel < levels.length) {
             finalizeLevel(false);
         }
@@ -113,15 +117,31 @@ function pageNavigation(context, props) {
     while (levels.length > 1) {
         finalizeLevel(true);
     }
-    if (!levels[0].length) {
-        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
-    }
     levels.unshift([]);
     finalizeLevel(true);
+    return levels[0];
+}
+function pageNavigation(context, props) {
+    if (!props.pageSections.some((sect) => sect.headings.length)) {
+        return utils_1.JSX.createElement(utils_1.JSX.Fragment, null);
+    }
+    const sections = [];
+    for (const section of props.pageSections) {
+        if (section.title) {
+            sections.push(utils_1.JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation-section" },
+                utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary", "data-key": `tsd-otp-${section.title}` },
+                    context.icons.chevronDown(),
+                    section.title),
+                utils_1.JSX.createElement("div", null, buildSectionNavigation(context, section.headings))));
+        }
+        else {
+            sections.push(buildSectionNavigation(context, section.headings));
+        }
+    }
     return (utils_1.JSX.createElement("details", { open: true, class: "tsd-accordion tsd-page-navigation" },
         utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
             utils_1.JSX.createElement("h3", null,
                 context.icons.chevronDown(),
                 context.i18n.theme_on_this_page())),
-        utils_1.JSX.createElement("div", { class: "tsd-accordion-details" }, levels[0])));
+        utils_1.JSX.createElement("div", { class: "tsd-accordion-details" }, sections)));
 }

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

@@ -48,6 +48,6 @@ export declare function partition<T>(iter: Iterable<T>, predicate: (item: T) =>
 export declare function zip<T extends Iterable<any>[]>(...args: T): Iterable<{
     [K in keyof T]: T[K] extends Iterable<infer U> ? U : T[K];
 }>;
-export declare function filterMap<T, U>(iter: Iterable<T>, fn: (item: T) => U | undefined): U[];
+export declare function filterMap<T, U>(iter: Iterable<T> | undefined, fn: (item: T) => U | undefined): U[];
 export declare function firstDefined<T, U>(array: readonly T[] | undefined, callback: (element: T, index: number) => U | undefined): U | undefined;
 export declare function filter<T>(array: readonly T[] | undefined, predicate: (value: T, index: number, array: readonly T[]) => boolean): readonly T[];

package/dist/lib/utils/array.js

@@ -119,7 +119,7 @@ function* zip(...args) {
 }
 function filterMap(iter, fn) {
     const result = [];
-    for (const item of iter) {
+    for (const item of iter || []) {
         const newItem = fn(item);
         if (newItem !== void 0) {
             result.push(newItem);

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

@@ -4,6 +4,6 @@ export declare function hasAllFlags(flags: number, check: number): boolean;
 export declare function hasAnyFlag(flags: number, check: number): boolean;
 export declare function debugFlags(Enum: {}, flags: number): string[];
 export declare function getEnumKeys(Enum: {}): string[];
-export type EnumKeys<E extends {}> = keyof {
-    [K in keyof E as number extends E[K] ? K : never]: 1;
-};
+export type EnumKeys<E extends {}> = {
+    [K in keyof E]: number extends E[K] ? K : never;
+}[keyof E] & {};

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

@@ -1,7 +1,7 @@
 import type { LineAndCharacter, SourceFileLike } from "typescript";
 export declare class MinimalSourceFile implements SourceFileLike {
-    readonly text: string;
     readonly fileName: string;
+    readonly text: string;
     constructor(text: string, fileName: string);
     getLineAndCharacterOfPosition(pos: number): LineAndCharacter;
 }

package/dist/lib/utils/minimalSourceFile.js

@@ -8,8 +8,16 @@ const array_1 = require("./array");
 const lineStarts = new WeakMap();
 class MinimalSourceFile {
     constructor(text, fileName) {
-        this.text = text;
         this.fileName = fileName;
+        // This is unfortunate, but the yaml library we use relies on the source
+        // text using LF line endings https://github.com/eemeli/yaml/issues/127.
+        // If we don't do this, in a simple document which includes a single key
+        // like:
+        // ---<CR><LF>
+        // title: Windows line endings<CR><LF>
+        // ---<CR><LF>
+        // we'll end up with a parsed title of "Windows line endings\r"
+        this.text = text.replaceAll("\r\n", "\n");
         lineStarts.set(this, [0]);
     }
     getLineAndCharacterOfPosition(pos) {

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

@@ -73,7 +73,7 @@ export interface TypeDocOptionMap {
     externalPattern: string[];
     excludeExternals: boolean;
     excludeNotDocumented: boolean;
-    excludeNotDocumentedKinds: Array<keyof typeof ReflectionKind>;
+    excludeNotDocumentedKinds: ReflectionKind.KindString[];
     excludeInternal: boolean;
     excludePrivate: boolean;
     excludeProtected: boolean;

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", "@group", "@groupDescription", "@import", "@inheritDoc", "@jsx", "@license", "@module", "@prop", "@property", "@return", "@satisfies", "@template", "@type", "@typedef"];
+export declare const blockTags: readonly ["@defaultValue", "@deprecated", "@example", "@param", "@privateRemarks", "@remarks", "@returns", "@see", "@throws", "@typeParam", "@author", "@callback", "@category", "@categoryDescription", "@default", "@document", "@group", "@groupDescription", "@import", "@inheritDoc", "@jsx", "@license", "@module", "@prop", "@property", "@return", "@satisfies", "@since", "@template", "@type", "@typedef"];
 export declare const tsdocInlineTags: readonly ["@link", "@inheritDoc", "@label"];
 export declare const inlineTags: readonly ["@link", "@inheritDoc", "@label", "@linkcode", "@linkplain"];
 export declare const tsdocModifierTags: readonly ["@alpha", "@beta", "@eventProperty", "@experimental", "@internal", "@override", "@packageDocumentation", "@public", "@readonly", "@sealed", "@virtual"];

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

@@ -33,8 +33,9 @@ exports.blockTags = [
     "@property",
     "@return",
     "@satisfies",
+    "@since",
     "@template", // Alias for @typeParam
-    "@type", // Because TypeScript is important!
+    "@type",
     "@typedef",
 ];
 exports.tsdocInlineTags = ["@link", "@inheritDoc", "@label"];

package/dist/lib/validation/links.js

@@ -9,7 +9,7 @@ function getBrokenPartLinks(parts) {
         if (part.kind === "inline-tag" &&
             linkTags.includes(part.tag) &&
             !part.target) {
-            links.push(part.text);
+            links.push(part.text.trim());
         }
     }
     return links;
@@ -25,42 +25,60 @@ function getBrokenLinks(comment) {
 }
 function validateLinks(project, logger) {
     for (const id in project.reflections) {
-        const reflection = project.reflections[id];
-        if (reflection.isProject() || reflection.isDeclaration()) {
-            for (const broken of getBrokenPartLinks(reflection.readme || [])) {
-                // #2360, "@" is a future reserved character in TSDoc component paths
-                // 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 (broken.startsWith("@") && !broken.includes("!")) {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
-                }
-                else {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1(broken, reflection.getFriendlyFullName()));
-                }
+        checkReflection(project.reflections[id], logger);
+    }
+    if (!(project.id in project.reflections)) {
+        checkReflection(project, logger);
+    }
+}
+function checkReflection(reflection, logger) {
+    if (reflection.isProject() || reflection.isDeclaration()) {
+        for (const broken of getBrokenPartLinks(reflection.readme || [])) {
+            // #2360, "@" is a future reserved character in TSDoc component paths
+            // 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 (broken.startsWith("@") && !broken.includes("!")) {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+            }
+            else {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1(broken, reflection.getFriendlyFullName()));
             }
         }
-        for (const broken of getBrokenLinks(reflection.comment)) {
+    }
+    if (reflection.isDocument()) {
+        for (const broken of getBrokenPartLinks(reflection.content)) {
             // #2360, "@" is a future reserved character in TSDoc component paths
             // 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 (broken.startsWith("@") && !broken.includes("!")) {
-                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_document_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
             }
             else {
-                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_document_1(broken, reflection.getFriendlyFullName()));
             }
         }
-        if (reflection.isDeclaration() &&
-            reflection.kindOf(models_1.ReflectionKind.TypeAlias) &&
-            reflection.type?.type === "union" &&
-            reflection.type.elementSummaries) {
-            for (const broken of reflection.type.elementSummaries.flatMap(getBrokenPartLinks)) {
-                if (broken.startsWith("@") && !broken.includes("!")) {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
-                }
-                else {
-                    logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
-                }
+    }
+    for (const broken of getBrokenLinks(reflection.comment)) {
+        // #2360, "@" is a future reserved character in TSDoc component paths
+        // 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 (broken.startsWith("@") && !broken.includes("!")) {
+            logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+        }
+        else {
+            logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
+        }
+    }
+    if (reflection.isDeclaration() &&
+        reflection.kindOf(models_1.ReflectionKind.TypeAlias) &&
+        reflection.type?.type === "union" &&
+        reflection.type.elementSummaries) {
+        for (const broken of reflection.type.elementSummaries.flatMap(getBrokenPartLinks)) {
+            if (broken.startsWith("@") && !broken.includes("!")) {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(broken, reflection.getFriendlyFullName(), broken.replace(/[.#~]/, "!")));
+            }
+            else {
+                logger.warn(logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(broken, reflection.getFriendlyFullName()));
             }
         }
     }