typedoc 0.28.13 → 0.28.15

package/dist/lib/internationalization/locales/de.d.cts

@@ -150,7 +150,6 @@ declare const _default: {
     help_excludeNotDocumentedKinds: string;
     help_excludeInternal: string;
     help_excludeCategories: string;
-    help_excludePrivate: string;
     help_excludeProtected: string;
     help_excludeReferences: string;
     help_externalSymbolLinkMappings: string;

package/dist/lib/internationalization/locales/en.cjs

@@ -168,7 +168,8 @@ module.exports = {
     help_excludeNotDocumentedKinds: "Specify the type of reflections that can be removed by excludeNotDocumented",
     help_excludeInternal: "Prevent symbols that are marked with @internal from being documented",
     help_excludeCategories: "Exclude symbols within this category from the documentation",
-    help_excludePrivate: "Ignore private variables and methods, defaults to true.",
+    help_excludePrivate: "Ignore members marked with the private keyword and #private class fields, defaults to true.",
+    help_excludePrivateClassFields: "Ignore #private class fields, defaults to true.",
     help_excludeProtected: "Ignore protected variables and methods",
     help_excludeReferences: "If a symbol is exported multiple times, ignore all but the first export",
     help_externalSymbolLinkMappings: "Define custom links for symbols not included in the documentation",
@@ -200,6 +201,7 @@ module.exports = {
     help_excludeTags: "Remove the listed block/modifier tags from doc comments",
     help_notRenderedTags: "Tags which will be preserved in doc comments, but not rendered when creating output",
     help_cascadedModifierTags: "Modifier tags which should be copied to all children of the parent reflection",
+    help_preservedTypeAnnotationTags: "Block tags whose type annotations should be preserved in the output.",
     help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page",
     help_basePath: "Specifies a path which links may be resolved relative to.",
     help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages",

package/dist/lib/internationalization/locales/en.d.cts

@@ -155,7 +155,8 @@ declare const _default: {
     readonly help_excludeNotDocumentedKinds: "Specify the type of reflections that can be removed by excludeNotDocumented";
     readonly help_excludeInternal: "Prevent symbols that are marked with @internal from being documented";
     readonly help_excludeCategories: "Exclude symbols within this category from the documentation";
-    readonly help_excludePrivate: "Ignore private variables and methods, defaults to true.";
+    readonly help_excludePrivate: "Ignore members marked with the private keyword and #private class fields, defaults to true.";
+    readonly help_excludePrivateClassFields: "Ignore #private class fields, defaults to true.";
     readonly help_excludeProtected: "Ignore protected variables and methods";
     readonly help_excludeReferences: "If a symbol is exported multiple times, ignore all but the first export";
     readonly help_externalSymbolLinkMappings: "Define custom links for symbols not included in the documentation";
@@ -187,6 +188,7 @@ declare const _default: {
     readonly help_excludeTags: "Remove the listed block/modifier tags from doc comments";
     readonly help_notRenderedTags: "Tags which will be preserved in doc comments, but not rendered when creating output";
     readonly help_cascadedModifierTags: "Modifier tags which should be copied to all children of the parent reflection";
+    readonly help_preservedTypeAnnotationTags: "Block tags whose type annotations should be preserved in the output.";
     readonly help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page";
     readonly help_basePath: "Specifies a path which links may be resolved relative to.";
     readonly help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages";

package/dist/lib/internationalization/locales/ja.cjs

@@ -129,7 +129,6 @@ module.exports = localeUtils.buildIncompleteTranslation({
     help_excludeNotDocumentedKinds: "excludeNotDocumented によって削除できる反射の種類を指定します",
     help_excludeInternal: "@internal でマークされたシンボルがドキュメント化されないようにする",
     help_excludeCategories: "このカテゴリ内のシンボルをドキュメントから除外する",
-    help_excludePrivate: "プライベート変数とメソッドを無視します。デフォルトは true です。",
     help_excludeProtected: "保護された変数とメソッドを無視する",
     help_excludeReferences: "シンボルが複数回エクスポートされた場合、最初のエクスポート以外はすべて無視されます。",
     help_externalSymbolLinkMappings: "ドキュメントに含まれていないシンボルのカスタムリンクを定義する",

package/dist/lib/internationalization/locales/ja.d.cts

@@ -119,7 +119,6 @@ declare const _default: {
     help_excludeNotDocumentedKinds: string;
     help_excludeInternal: string;
     help_excludeCategories: string;
-    help_excludePrivate: string;
     help_excludeProtected: string;
     help_excludeReferences: string;
     help_externalSymbolLinkMappings: string;

package/dist/lib/internationalization/locales/ko.cjs

@@ -47,7 +47,6 @@ module.exports = localeUtils.buildIncompleteTranslation({
     help_excludeNotDocumentedKinds: "excludeNotDocumented로 제거될 리플렉션 유형을 지정합니다",
     help_excludeInternal: "@internal로 표시된 심볼이 문서화되지 않도록 방지합니다",
     help_excludeCategories: "문서에서 제외할 카테고리 내의 심볼을 제외합니다",
-    help_excludePrivate: "비공개 변수와 메서드를 무시합니다. 기본값은 true입니다.",
     help_excludeProtected: "보호된 변수와 메서드를 무시합니다",
     help_excludeReferences: "심볼이 여러 번 내보내진 경우 첫 번째 내보내기를 제외하고 모두 무시합니다",
     help_externalSymbolLinkMappings: "문서에 포함되지 않은 심볼에 대한 사용자 정의 링크를 정의합니다",

package/dist/lib/internationalization/locales/ko.d.cts

@@ -39,7 +39,6 @@ declare const _default: {
     help_excludeNotDocumentedKinds: string;
     help_excludeInternal: string;
     help_excludeCategories: string;
-    help_excludePrivate: string;
     help_excludeProtected: string;
     help_excludeReferences: string;
     help_externalSymbolLinkMappings: string;

package/dist/lib/internationalization/locales/zh.cjs

@@ -167,7 +167,6 @@ module.exports = localeUtils.buildIncompleteTranslation({
     help_excludeNotDocumentedKinds: "指定可以通过 excludeNotDocumented 删除的反射类型",
     help_excludeInternal: "防止标有 @internal 的符号被记录",
     help_excludeCategories: "从文档中排除此类别中的符号",
-    help_excludePrivate: "忽略私有变量和方法，默认为 true。",
     help_excludeProtected: "忽略受保护的变量和方法",
     help_excludeReferences: "如果一个符号被导出多次，则忽略除第一次导出之外的所有导出",
     help_externalSymbolLinkMappings: "为文档中未包含的符号定义自定义链接",

package/dist/lib/internationalization/locales/zh.d.cts

@@ -152,7 +152,6 @@ declare const _default: {
     help_excludeNotDocumentedKinds: string;
     help_excludeInternal: string;
     help_excludeCategories: string;
-    help_excludePrivate: string;
     help_excludeProtected: string;
     help_excludeReferences: string;
     help_externalSymbolLinkMappings: string;

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

@@ -85,6 +85,11 @@ export declare class CommentTag {
      * If this tag is one of those, it will be parsed out and included here.
      */
     name?: string;
+    /**
+     * Optional type annotation associated with this tag. TypeDoc will remove type annotations unless explicitly
+     * requested by the user with the `preservedTypeAnnotationTags` option.
+     */
+    typeAnnotation?: string;
     /**
      * The actual body text of this tag.
      */

package/dist/lib/models/Comment.js

@@ -50,6 +50,11 @@ export class CommentTag {
      * If this tag is one of those, it will be parsed out and included here.
      */
     name;
+    /**
+     * Optional type annotation associated with this tag. TypeDoc will remove type annotations unless explicitly
+     * requested by the user with the `preservedTypeAnnotationTags` option.
+     */
+    typeAnnotation;
     /**
      * The actual body text of this tag.
      */
@@ -83,6 +88,9 @@ export class CommentTag {
         if (this.name) {
             tag.name = this.name;
         }
+        if (this.typeAnnotation) {
+            tag.typeAnnotation = this.typeAnnotation;
+        }
         return tag;
     }
     toObject() {
@@ -90,11 +98,13 @@ export class CommentTag {
             tag: this.tag,
             name: this.name,
             content: Comment.serializeDisplayParts(this.content),
+            typeAnnotation: this.typeAnnotation,
         };
     }
     fromObject(de, obj) {
         // tag already set by Comment.fromObject
         this.name = obj.name;
+        this.typeAnnotation = obj.typeAnnotation;
         this.content = Comment.deserializeDisplayParts(de, obj.content);
     }
 }

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/MarkedPlugin.js

@@ -387,10 +387,17 @@ let MarkedPlugin = (() => {
 })();
 export { MarkedPlugin };
 function getTokenTextContent(token) {
+    // If there are children, we want their text content, not the full text content
     if (token.children) {
         return token.children.map(getTokenTextContent).join("");
     }
-    return token.content;
+    // If this is a simple text fragment, use its content
+    if (token.type === "text") {
+        return token.content;
+    }
+    // Otherwise this is some type of metadata token (e.g. header_open)
+    // or a HTML tag token. Don't include it in the text content.
+    return "";
 }
 const kindNames = ["note", "tip", "important", "warning", "caution"];
 const iconNames = ["alertNote", "alertTip", "alertImportant", "alertWarning", "alertCaution"];

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

@@ -1,4 +1,4 @@
-import type { TypeDocOptionMap } from "../../../utils/index.js";
+import type { TypeDocOptionMap } from "#node-utils";
 /**
  * Responsible for getting a unique anchor for elements within a page.
  */

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

@@ -6,15 +6,23 @@ export class Slugger {
     options;
     seen = new Map();
     serialize(value) {
-        // Notes:
-        // There are quite a few trade-offs here.
+        // There are quite a few trade-offs here. We used to remove HTML tags here,
+        // but TypeDoc now removes the HTML tags before passing text into the slug
+        // method, which allows us to skip doing that here. This improves the slugger
+        // generation for headers which look like the following:
+        // (html allowed in markdown)
+        // # test <t>
+        // (html disallowed in markdown)
+        // # test <t>
+        // both of the above should slug to test-t
         return (value
             .trim()
-            // remove html tags
-            .replace(/<[!/a-z].*?>/gi, "")
             // remove unwanted chars
             .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g, "")
-            .replace(/\s/g, "-"));
+            // change whitespace to dash
+            .replace(/\s/g, "-")
+            // combine adjacent dashes
+            .replace(/--+/, "-"));
     }
     constructor(options) {
         this.options = options;

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

@@ -58,6 +58,7 @@ export function commentTags(context, props) {
                 JSX.createElement("h4", { class: "tsd-anchor-link", id: anchor },
                     name,
                     anchorIcon(context, anchor)),
+                item.typeAnnotation && JSX.createElement("span", { class: "tsd-type-annotation" }, item.typeAnnotation),
                 JSX.createElement(JSX.Raw, { html: context.markdown(item.content) }))));
     });
     return (JSX.createElement(JSX.Fragment, null,

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"> {
@@ -226,7 +226,7 @@ export interface Comment extends Partial<S<M.Comment, "blockTags" | "label">> {
     modifierTags?: TagString[];
 }
 /** @category Comments */
-export interface CommentTag extends S<M.CommentTag, "tag" | "name"> {
+export interface CommentTag extends S<M.CommentTag, "tag" | "name" | "typeAnnotation"> {
     content: CommentDisplayPart[];
 }
 /**

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

@@ -93,6 +93,7 @@ export interface TypeDocOptionMap {
     excludeNotDocumented: boolean;
     excludeNotDocumentedKinds: ReflectionKind.KindString[];
     excludeInternal: boolean;
+    excludePrivateClassFields: boolean;
     excludePrivate: boolean;
     excludeProtected: boolean;
     excludeReferences: boolean;
@@ -200,6 +201,7 @@ export interface TypeDocOptionMap {
     notRenderedTags: TagString[];
     externalSymbolLinkMappings: ManuallyValidatedOption<Record<string, Record<string, string>>>;
     cascadedModifierTags: TagString[];
+    preservedTypeAnnotationTags: TagString[];
     categorizeByGroup: boolean;
     groupReferencesByType: boolean;
     defaultCategory: string;
@@ -240,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/defaults.d.ts

@@ -11,6 +11,7 @@ export declare const blockTags: readonly TagString[];
 export declare const inlineTags: readonly TagString[];
 export declare const modifierTags: readonly TagString[];
 export declare const cascadedModifierTags: readonly TagString[];
+export declare const preservedTypeAnnotationTags: readonly TagString[];
 export declare const notRenderedTags: readonly TagString[];
 export declare const highlightLanguages: readonly BundledLanguage[];
 export declare const ignoredHighlightLanguages: readonly string[];

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

@@ -37,6 +37,7 @@ export const cascadedModifierTags = [
     "@beta",
     "@experimental",
 ];
+export const preservedTypeAnnotationTags = [];
 export const notRenderedTags = [
     "@showCategories",
     "@showGroups",

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

@@ -167,6 +167,12 @@ export function addTypeDocOptions(options) {
         type: ParameterType.Boolean,
         defaultValue: true,
     });
+    options.addDeclaration({
+        name: "excludePrivateClassFields",
+        help: () => i18n.help_excludePrivateClassFields(),
+        type: ParameterType.Boolean,
+        defaultValue: true,
+    });
     options.addDeclaration({
         name: "excludeProtected",
         help: () => i18n.help_excludeProtected(),
@@ -700,6 +706,13 @@ export function addTypeDocOptions(options) {
         defaultValue: OptionDefaults.cascadedModifierTags,
         validate: makeTagArrayValidator("cascadedModifierTags"),
     });
+    options.addDeclaration({
+        name: "preservedTypeAnnotationTags",
+        help: () => i18n.help_preservedTypeAnnotationTags(),
+        type: ParameterType.Array,
+        defaultValue: OptionDefaults.preservedTypeAnnotationTags,
+        validate: makeTagArrayValidator("preservedTypeAnnotationTags"),
+    });
     // MARK: Organization Options
     options.addDeclaration({
         name: "categorizeByGroup",
@@ -851,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", "@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",
@@ -37,6 +37,7 @@ export const blockTags = [
     "@since",
     "@sortStrategy",
     "@template", // Alias for @typeParam
+    "@this",
     "@type",
     "@typedef",
     "@summary",

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

@@ -6,6 +6,8 @@ export function assertNever(x) {
 }
 export function assert(x, message = "Assertion failed") {
     if (!x) {
+        // eslint-disable-next-line no-debugger
+        debugger;
         throw new Error(message);
     }
 }

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()));
     }
 }