typedoc 0.26.4 → 0.26.6

package/dist/lib/serialization/serializer.js

@@ -32,11 +32,14 @@ class Serializer extends utils_1.EventDispatcher {
      */
     projectToObject(value, projectRoot) {
         this.projectRoot = projectRoot;
+        this.project = value;
         const eventBegin = new events_1.SerializeEvent(value);
         this.trigger(Serializer.EVENT_BEGIN, eventBegin);
         const project = this.toObject(value);
         const eventEnd = new events_1.SerializeEvent(value, project);
         this.trigger(Serializer.EVENT_END, eventEnd);
+        this.project = undefined;
+        this.projectRoot = undefined;
         return project;
     }
 }

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

@@ -1,7 +1,7 @@
 export declare const emptyArray: readonly [];
 /**
  * Inserts an item into an array sorted by priority. If two items have the same priority,
- * the item will be inserted later will be placed earlier in the array.
+ * the item will be inserted later will be placed later in the array.
  * @param arr modified by inserting item.
  * @param item
  */

package/dist/lib/utils/array.js

@@ -15,12 +15,12 @@ exports.filter = filter;
 exports.emptyArray = [];
 /**
  * Inserts an item into an array sorted by priority. If two items have the same priority,
- * the item will be inserted later will be placed earlier in the array.
+ * the item will be inserted later will be placed later in the array.
  * @param arr modified by inserting item.
  * @param item
  */
 function insertPrioritySorted(arr, item) {
-    const index = binaryFindPartition(arr, (v) => v.priority <= item.priority);
+    const index = binaryFindPartition(arr, (v) => v.priority < item.priority);
     arr.splice(index === -1 ? arr.length : index, 0, item);
     return arr;
 }

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

@@ -8,7 +8,7 @@ export interface ComponentHost {
 }
 export interface Component<E extends Record<keyof E, unknown[]> = {}> extends AbstractComponent<ComponentHost, E> {
 }
-export interface ComponentClass<T extends Component, O extends ComponentHost = ComponentHost> extends Function {
+export interface ComponentClass<T extends Component, O extends ComponentHost = ComponentHost> {
     new (owner: O): T;
 }
 /**

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

@@ -2,8 +2,8 @@ export declare function getEnumFlags<T extends number>(flags: T): T[];
 export declare function removeFlag<T extends number>(flag: T, remove: T & {}): T;
 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 {}> = {
+export declare function debugFlags(Enum: object, flags: number): string[];
+export declare function getEnumKeys(Enum: object): string[];
+export type EnumKeys<E extends object> = {
     [K in keyof E]: number extends E[K] ? K : never;
 }[keyof E] & {};

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

@@ -43,6 +43,7 @@ export declare function glob(pattern: string, root: string, options?: {
     followSymlinks?: boolean;
 }): string[];
 export declare function hasTsExtension(path: string): boolean;
+export declare function hasDeclarationFileExtension(path: string): boolean;
 export declare function discoverInParentDir<T extends {}>(name: string, dir: string, read: (content: string) => T | undefined): {
     file: string;
     content: T;

package/dist/lib/utils/fs.js

@@ -34,6 +34,7 @@ exports.copy = copy;
 exports.copySync = copySync;
 exports.glob = glob;
 exports.hasTsExtension = hasTsExtension;
+exports.hasDeclarationFileExtension = hasDeclarationFileExtension;
 exports.discoverInParentDir = discoverInParentDir;
 exports.discoverInParentDirExactMatch = discoverInParentDirExactMatch;
 exports.discoverPackageJson = discoverPackageJson;
@@ -277,6 +278,9 @@ function glob(pattern, root, options = {}) {
 function hasTsExtension(path) {
     return /\.[cm]?ts$|\.tsx$/.test(path);
 }
+function hasDeclarationFileExtension(path) {
+    return /\.d\.[cm]?ts$/.test(path);
+}
 function discoverInParentDir(name, dir, read) {
     if (!isDir(dir))
         return;

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

@@ -8,7 +8,7 @@ export type { IfInternal, NeverIfInternal, Chars } from "./general";
 export { assertNever } from "./general";
 export { ConsoleLogger, Logger, LogLevel } from "./loggers";
 export { DefaultMap } from "./map";
-export { ArgumentsReader, Option, CommentStyle, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, } from "./options";
+export { ArgumentsReader, Option, CommentStyle, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, OptionDefaults, } from "./options";
 export type { ArrayDeclarationOption, BooleanDeclarationOption, DeclarationOption, DeclarationOptionBase, DeclarationOptionToOptionType, KeyToDeclaration, MapDeclarationOption, MixedDeclarationOption, NumberDeclarationOption, FlagsDeclarationOption, ObjectDeclarationOption, OptionsReader, StringDeclarationOption, TypeDocOptionMap, TypeDocOptions, ValidationOptions, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, JsDocCompatibility, } from "./options";
 export { loadPlugins } from "./plugins";
 export { getSortFunction } from "./sort";

package/dist/lib/utils/index.js

@@ -26,7 +26,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.normalizePath = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
+exports.MinimalSourceFile = exports.Validation = exports.renderElement = exports.Raw = exports.Fragment = exports.JSX = exports.EventHooks = exports.getSortFunction = exports.loadPlugins = exports.OptionDefaults = exports.TypeDocReader = exports.TSConfigReader = exports.ParameterType = exports.ParameterHint = exports.PackageJsonReader = exports.Options = exports.CommentStyle = exports.Option = exports.ArgumentsReader = exports.DefaultMap = exports.LogLevel = exports.Logger = exports.ConsoleLogger = exports.assertNever = exports.normalizePath = exports.discoverPackageJson = exports.discoverInParentDir = exports.writeFileSync = exports.writeFile = exports.readFile = exports.getCommonDirectory = exports.copySync = exports.copy = exports.isFile = exports.EventDispatcher = exports.Component = exports.ChildableComponent = exports.AbstractComponent = exports.unique = exports.removeIfPresent = exports.removeIf = exports.partition = exports.insertPrioritySorted = exports.filterMap = void 0;
 var array_1 = require("./array");
 Object.defineProperty(exports, "filterMap", { enumerable: true, get: function () { return array_1.filterMap; } });
 Object.defineProperty(exports, "insertPrioritySorted", { enumerable: true, get: function () { return array_1.insertPrioritySorted; } });
@@ -71,6 +71,7 @@ Object.defineProperty(exports, "ParameterHint", { enumerable: true, get: functio
 Object.defineProperty(exports, "ParameterType", { enumerable: true, get: function () { return options_1.ParameterType; } });
 Object.defineProperty(exports, "TSConfigReader", { enumerable: true, get: function () { return options_1.TSConfigReader; } });
 Object.defineProperty(exports, "TypeDocReader", { enumerable: true, get: function () { return options_1.TypeDocReader; } });
+Object.defineProperty(exports, "OptionDefaults", { enumerable: true, get: function () { return options_1.OptionDefaults; } });
 var plugins_1 = require("./plugins");
 Object.defineProperty(exports, "loadPlugins", { enumerable: true, get: function () { return plugins_1.loadPlugins; } });
 var sort_1 = require("./sort");

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

@@ -141,6 +141,7 @@ export interface TypeDocOptionMap {
         includeCategories: boolean;
         includeGroups: boolean;
         includeFolders: boolean;
+        compactFolders: boolean;
     };
     visibilityFilters: ManuallyValidatedOption<{
         protected?: boolean;

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

@@ -0,0 +1,23 @@
+import type { BundledLanguage } from "shiki" with { "resolution-mode": "import" };
+import type { EnumKeys } from "../enum";
+import type { ReflectionKind } from "../../models/index";
+/**
+ * Default values for TypeDoc options. This object should not be modified.
+ *
+ * @privateRemarks
+ * These are declared here, rather than within the option declaration, so that
+ * they can be exposed as a part of the public API. The unfortunate type declaration
+ * is to control the type which appears in the generated documentation.
+ */
+export declare const OptionDefaults: {
+    excludeNotDocumentedKinds: readonly EnumKeys<typeof ReflectionKind>[];
+    excludeTags: readonly `@${string}`[];
+    blockTags: readonly `@${string}`[];
+    inlineTags: readonly `@${string}`[];
+    modifierTags: readonly `@${string}`[];
+    cascadedModifierTags: readonly `@${string}`[];
+    highlightLanguages: readonly BundledLanguage[];
+    sort: readonly string[];
+    kindSortOrder: readonly EnumKeys<typeof ReflectionKind>[];
+    requiredToBeDocumented: readonly EnumKeys<typeof ReflectionKind>[];
+};

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

@@ -0,0 +1,120 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionDefaults = void 0;
+const TagDefaults = __importStar(require("./tsdoc-defaults"));
+/**
+ * Default values for TypeDoc options. This object should not be modified.
+ *
+ * @privateRemarks
+ * These are declared here, rather than within the option declaration, so that
+ * they can be exposed as a part of the public API. The unfortunate type declaration
+ * is to control the type which appears in the generated documentation.
+ */
+exports.OptionDefaults = {
+    excludeNotDocumentedKinds: [
+        "Module",
+        "Namespace",
+        "Enum",
+        // Not including enum member here by default
+        "Variable",
+        "Function",
+        "Class",
+        "Interface",
+        "Constructor",
+        "Property",
+        "Method",
+        "CallSignature",
+        "IndexSignature",
+        "ConstructorSignature",
+        "Accessor",
+        "GetSignature",
+        "SetSignature",
+        "TypeAlias",
+        "Reference",
+    ],
+    excludeTags: [
+        "@override",
+        "@virtual",
+        "@privateRemarks",
+        "@satisfies",
+        "@overload",
+    ],
+    blockTags: TagDefaults.blockTags,
+    inlineTags: TagDefaults.inlineTags,
+    modifierTags: TagDefaults.modifierTags,
+    cascadedModifierTags: ["@alpha", "@beta", "@experimental"],
+    highlightLanguages: [
+        "bash",
+        "console",
+        "css",
+        "html",
+        "javascript",
+        "json",
+        "jsonc",
+        "json5",
+        "tsx",
+        "typescript",
+    ],
+    sort: ["kind", "instance-first", "alphabetical"],
+    kindSortOrder: [
+        "Document",
+        "Reference",
+        "Project",
+        "Module",
+        "Namespace",
+        "Enum",
+        "EnumMember",
+        "Class",
+        "Interface",
+        "TypeAlias",
+        "Constructor",
+        "Property",
+        "Variable",
+        "Function",
+        "Accessor",
+        "Method",
+        "Parameter",
+        "TypeParameter",
+        "TypeLiteral",
+        "CallSignature",
+        "ConstructorSignature",
+        "IndexSignature",
+        "GetSignature",
+        "SetSignature",
+    ],
+    requiredToBeDocumented: [
+        "Enum",
+        "EnumMember",
+        "Variable",
+        "Function",
+        "Class",
+        "Interface",
+        "Property",
+        "Method",
+        "Accessor",
+        "TypeAlias",
+    ],
+};

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

@@ -3,3 +3,4 @@ export type { OptionsReader } from "./options";
 export { ArgumentsReader, PackageJsonReader, TypeDocReader, TSConfigReader, } from "./readers";
 export { CommentStyle, EmitStrategy, ParameterType, ParameterHint, } from "./declaration";
 export type { TypeDocOptions, TypeDocOptionMap, ValidationOptions, KeyToDeclaration, DeclarationOption, DeclarationOptionBase, StringDeclarationOption, NumberDeclarationOption, BooleanDeclarationOption, ArrayDeclarationOption, MixedDeclarationOption, ObjectDeclarationOption, MapDeclarationOption, FlagsDeclarationOption, DeclarationOptionToOptionType, TypeDocOptionValues, ParameterTypeToOptionTypeMap, ManuallyValidatedOption, JsDocCompatibility, } from "./declaration";
+export { OptionDefaults } from "./defaults";

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParameterHint = exports.ParameterType = exports.EmitStrategy = exports.CommentStyle = exports.TSConfigReader = exports.TypeDocReader = exports.PackageJsonReader = exports.ArgumentsReader = exports.Option = exports.Options = void 0;
+exports.OptionDefaults = exports.ParameterHint = exports.ParameterType = exports.EmitStrategy = exports.CommentStyle = exports.TSConfigReader = exports.TypeDocReader = exports.PackageJsonReader = exports.ArgumentsReader = exports.Option = exports.Options = void 0;
 var options_1 = require("./options");
 Object.defineProperty(exports, "Options", { enumerable: true, get: function () { return options_1.Options; } });
 Object.defineProperty(exports, "Option", { enumerable: true, get: function () { return options_1.Option; } });
@@ -14,3 +14,5 @@ Object.defineProperty(exports, "CommentStyle", { enumerable: true, get: function
 Object.defineProperty(exports, "EmitStrategy", { enumerable: true, get: function () { return declaration_1.EmitStrategy; } });
 Object.defineProperty(exports, "ParameterType", { enumerable: true, get: function () { return declaration_1.ParameterType; } });
 Object.defineProperty(exports, "ParameterHint", { enumerable: true, get: function () { return declaration_1.ParameterHint; } });
+var defaults_1 = require("./defaults");
+Object.defineProperty(exports, "OptionDefaults", { enumerable: true, get: function () { return defaults_1.OptionDefaults; } });

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

@@ -91,6 +91,7 @@ class TypeDocReader {
         else {
             try {
                 try {
+                    // eslint-disable-next-line @typescript-eslint/no-require-imports
                     fileContent = await require(file);
                 }
                 catch (error) {

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

@@ -30,10 +30,10 @@ const sort_1 = require("../../sort");
 const entry_point_1 = require("../../entry-point");
 const kind_1 = require("../../../models/reflections/kind");
 const Validation = __importStar(require("../../validation"));
-const tsdoc_defaults_1 = require("../tsdoc-defaults");
 const enum_1 = require("../../enum");
 const highlighter_1 = require("../../highlighter");
 const set_1 = require("../../set");
+const defaults_1 = require("../defaults");
 // For convenience, added in the same order as they are documented on the website.
 function addTypeDocOptions(options) {
     ///////////////////////////
@@ -172,27 +172,7 @@ function addTypeDocOptions(options) {
                 throw new Error(i18n.exclude_not_documented_specified_0_valid_values_are_1(Array.from(invalid).join(", "), Array.from(valid).join(", ")));
             }
         },
-        defaultValue: [
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Module],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Namespace],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Enum],
-            // Not including enum member here by default
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Variable],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Function],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Class],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Interface],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Constructor],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Property],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Method],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.CallSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.IndexSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.ConstructorSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Accessor],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.GetSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.SetSignature],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.TypeAlias],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Reference],
-        ],
+        defaultValue: defaults_1.OptionDefaults.excludeNotDocumentedKinds,
     });
     options.addDeclaration({
         name: "excludeInternal",
@@ -305,18 +285,7 @@ function addTypeDocOptions(options) {
         name: "highlightLanguages",
         help: (i18n) => i18n.help_highlightLanguages(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: [
-            "bash",
-            "console",
-            "css",
-            "html",
-            "javascript",
-            "json",
-            "jsonc",
-            "json5",
-            "tsx",
-            "typescript",
-        ],
+        defaultValue: defaults_1.OptionDefaults.highlightLanguages,
         validate(value, i18n) {
             const invalid = (0, set_1.setDifference)(value, (0, highlighter_1.getSupportedLanguagesWithoutAliases)());
             if (invalid.size) {
@@ -403,13 +372,7 @@ function addTypeDocOptions(options) {
         name: "excludeTags",
         help: (i18n) => i18n.help_excludeTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: [
-            "@override",
-            "@virtual",
-            "@privateRemarks",
-            "@satisfies",
-            "@overload",
-        ],
+        defaultValue: defaults_1.OptionDefaults.excludeTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("excludeTags"));
@@ -538,6 +501,7 @@ function addTypeDocOptions(options) {
             includeCategories: false,
             includeGroups: false,
             includeFolders: true,
+            compactFolders: true,
         },
     });
     options.addDeclaration({
@@ -638,7 +602,7 @@ function addTypeDocOptions(options) {
         name: "blockTags",
         help: (i18n) => i18n.help_blockTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: tsdoc_defaults_1.blockTags,
+        defaultValue: defaults_1.OptionDefaults.blockTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("blockTags"));
@@ -649,7 +613,7 @@ function addTypeDocOptions(options) {
         name: "inlineTags",
         help: (i18n) => i18n.help_inlineTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: tsdoc_defaults_1.inlineTags,
+        defaultValue: defaults_1.OptionDefaults.inlineTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("inlineTags"));
@@ -660,7 +624,7 @@ function addTypeDocOptions(options) {
         name: "modifierTags",
         help: (i18n) => i18n.help_modifierTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: tsdoc_defaults_1.modifierTags,
+        defaultValue: defaults_1.OptionDefaults.modifierTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("modifierTags"));
@@ -671,7 +635,7 @@ function addTypeDocOptions(options) {
         name: "cascadedModifierTags",
         help: (i18n) => i18n.help_modifierTags(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: ["@alpha", "@beta", "@experimental"],
+        defaultValue: defaults_1.OptionDefaults.cascadedModifierTags,
         validate(value, i18n) {
             if (!Validation.validate([Array, Validation.isTagString], value)) {
                 throw new Error(i18n.option_0_values_must_be_array_of_tags("cascadedModifierTags"));
@@ -707,7 +671,7 @@ function addTypeDocOptions(options) {
         name: "sort",
         help: (i18n) => i18n.help_sort(),
         type: declaration_1.ParameterType.Array,
-        defaultValue: ["kind", "instance-first", "alphabetical"],
+        defaultValue: defaults_1.OptionDefaults.sort,
         validate(value, i18n) {
             const invalid = new Set(value);
             for (const v of sort_1.SORT_STRATEGIES) {
@@ -730,13 +694,9 @@ function addTypeDocOptions(options) {
         type: declaration_1.ParameterType.Array,
         defaultValue: [],
         validate(value, i18n) {
-            const invalid = new Set(value);
-            const valid = (0, enum_1.getEnumKeys)(kind_1.ReflectionKind);
-            for (const v of valid) {
-                invalid.delete(v);
-            }
+            const invalid = (0, set_1.setDifference)(value, (0, enum_1.getEnumKeys)(kind_1.ReflectionKind));
             if (invalid.size !== 0) {
-                throw new Error(i18n.option_0_specified_1_but_only_2_is_valid(`kindSortOrder`, Array.from(invalid).join(", "), valid.join(", ")));
+                throw new Error(i18n.option_0_specified_1_but_only_2_is_valid(`kindSortOrder`, Array.from(invalid).join(", "), (0, enum_1.getEnumKeys)(kind_1.ReflectionKind).join(", ")));
             }
         },
     });
@@ -814,18 +774,7 @@ function addTypeDocOptions(options) {
                 }
             }
         },
-        defaultValue: [
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Enum],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.EnumMember],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Variable],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Function],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Class],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Interface],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Property],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Method],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.Accessor],
-            kind_1.ReflectionKind[kind_1.ReflectionKind.TypeAlias],
-        ],
+        defaultValue: defaults_1.OptionDefaults.requiredToBeDocumented,
     });
     options.addDeclaration({
         name: "validation",

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", "@since", "@template", "@type", "@typedef"];
+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", "@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

@@ -22,6 +22,9 @@ exports.blockTags = [
     "@categoryDescription",
     "@default",
     "@document",
+    "@extends",
+    "@augments", //Alias for @extends
+    "@yields",
     "@group",
     "@groupDescription",
     "@import",

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

@@ -1,3 +1,3 @@
-export declare function bench<T extends Function>(fn: T, name?: string): T;
-export declare function Bench<T extends Function>(value: T, context: ClassMethodDecoratorContext): (this: any, ...args: any) => any;
+export declare function bench<T extends (..._: any) => any>(fn: T, name?: string): T;
+export declare function Bench<T extends (..._: any) => any>(value: T, context: ClassMethodDecoratorContext): T;
 export declare function measure<T>(cb: () => T): T;

package/dist/lib/utils/plugins.js

@@ -10,6 +10,7 @@ async function loadPlugins(app, plugins) {
         try {
             let instance;
             try {
+                // eslint-disable-next-line @typescript-eslint/no-require-imports
                 instance = require(plugin);
             }
             catch (error) {

package/dist/lib/utils/sort.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SORT_STRATEGIES = void 0;
 exports.getSortFunction = getSortFunction;
 const kind_1 = require("../models/reflections/kind");
+const defaults_1 = require("./options/defaults");
 exports.SORT_STRATEGIES = [
     "source-order",
     "alphabetical",
@@ -23,32 +24,6 @@ exports.SORT_STRATEGIES = [
     "documents-first",
     "documents-last",
 ];
-const defaultKindSortOrder = [
-    kind_1.ReflectionKind.Document,
-    kind_1.ReflectionKind.Reference,
-    kind_1.ReflectionKind.Project,
-    kind_1.ReflectionKind.Module,
-    kind_1.ReflectionKind.Namespace,
-    kind_1.ReflectionKind.Enum,
-    kind_1.ReflectionKind.EnumMember,
-    kind_1.ReflectionKind.Class,
-    kind_1.ReflectionKind.Interface,
-    kind_1.ReflectionKind.TypeAlias,
-    kind_1.ReflectionKind.Constructor,
-    kind_1.ReflectionKind.Property,
-    kind_1.ReflectionKind.Variable,
-    kind_1.ReflectionKind.Function,
-    kind_1.ReflectionKind.Accessor,
-    kind_1.ReflectionKind.Method,
-    kind_1.ReflectionKind.Parameter,
-    kind_1.ReflectionKind.TypeParameter,
-    kind_1.ReflectionKind.TypeLiteral,
-    kind_1.ReflectionKind.CallSignature,
-    kind_1.ReflectionKind.ConstructorSignature,
-    kind_1.ReflectionKind.IndexSignature,
-    kind_1.ReflectionKind.GetSignature,
-    kind_1.ReflectionKind.SetSignature,
-];
 // Return true if a < b
 const sorts = {
     "source-order"(a, b) {
@@ -152,9 +127,9 @@ function getSortFunction(opts) {
     const kindSortOrder = opts
         .getValue("kindSortOrder")
         .map((k) => kind_1.ReflectionKind[k]);
-    for (const kind of defaultKindSortOrder) {
-        if (!kindSortOrder.includes(kind)) {
-            kindSortOrder.push(kind);
+    for (const kind of defaults_1.OptionDefaults.kindSortOrder) {
+        if (!kindSortOrder.includes(kind_1.ReflectionKind[kind])) {
+            kindSortOrder.push(kind_1.ReflectionKind[kind]);
         }
     }
     const strategies = opts.getValue("sort");

package/dist/lib/validation/documentation.js

@@ -71,7 +71,11 @@ function validateDocumentation(project, logger, requiredToBeDocumented) {
             }
         }
         const symbolId = project.getSymbolIdFromReflection(ref);
-        if (!ref.hasComment() && symbolId) {
+        // #2644, signatures may be documented by their parent reflection.
+        const hasComment = ref.hasComment() ||
+            (ref.kindOf(models_1.ReflectionKind.SomeSignature) &&
+                ref.parent?.hasComment());
+        if (!hasComment && symbolId) {
             if (symbolId.fileName.includes("node_modules")) {
                 continue;
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.26.4",
+  "version": "0.26.6",
   "homepage": "https://typedoc.org",
   "exports": {
     ".": "./dist/index.js",
@@ -47,7 +47,7 @@
     "puppeteer": "^22.12.1",
     "ts-node": "^10.9.2",
     "typescript": "5.5.2",
-    "typescript-eslint": "^7.14.1"
+    "typescript-eslint": "^8.0.1"
   },
   "files": [
     "/bin",