typedoc 0.28.9 → 0.28.11

package/dist/lib/application.js

@@ -409,7 +409,7 @@ let Application = (() => {
             if (!supportedVersionMajorMinor.some((version) => version == ts.versionMajorMinor)) {
                 this.logger.warn(i18n.unsupported_ts_version_0(supportedVersionMajorMinor.join(", ")));
             }
-            if (Object.keys(this.options.getCompilerOptions()).length === 0) {
+            if (Object.keys(this.options.getCompilerOptions(this.logger)).length === 0) {
                 this.logger.warn(i18n.no_compiler_options_set());
             }
             // Doing this is considerably more complicated, we'd need to manage an array of programs, not convert until all programs
@@ -429,7 +429,7 @@ let Application = (() => {
             // We don't want to do it the first time to preserve initial debug status messages. They'll be lost
             // after the user saves a file, but better than nothing...
             let firstStatusReport = true;
-            const host = ts.createWatchCompilerHost(tsconfigFile, this.options.fixCompilerOptions({}), ts.sys, ts.createEmitAndSemanticDiagnosticsBuilderProgram, (d) => diagnostic(this.logger, d), (status, newLine, _options, errorCount) => {
+            const host = ts.createWatchCompilerHost(tsconfigFile, this.options.fixCompilerOptions({}, this.logger), ts.sys, ts.createEmitAndSemanticDiagnosticsBuilderProgram, (d) => diagnostic(this.logger, d), (status, newLine, _options, errorCount) => {
                 if (!firstStatusReport &&
                     errorCount === void 0 &&
                     !this.options.getValue("preserveWatchOutput") &&

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

@@ -263,9 +263,7 @@ function findJsDocForComment(node, ranges) {
             .map((doc) => ts.findAncestor(doc, ts.isJSDoc));
         if (ts.isSourceFile(node)) {
             if (node.statements.length) {
-                jsDocs.push(...ts
-                    .getJSDocCommentsAndTags(node.statements[0])
-                    .map((doc) => ts.findAncestor(doc, ts.isJSDoc)));
+                jsDocs.push(...node.statements[0].getChildren().filter(ts.isJSDoc));
             }
         }
         return jsDocs.find((doc) => doc.pos === ranges[0].pos);
@@ -405,6 +403,19 @@ function declarationToCommentNodes(node, checker) {
             inheritedFromParentDeclaration: true,
         });
     }
+    // #2999 automatically pick up comments from the value symbol for shorthand assignments
+    if (ts.isShorthandPropertyAssignment(node)) {
+        const sourceSymbol = checker.getShorthandAssignmentValueSymbol(node);
+        if (sourceSymbol?.valueDeclaration) {
+            const commentNode = declarationToCommentNodeIgnoringParents(sourceSymbol.valueDeclaration);
+            if (commentNode) {
+                result.push({
+                    node: commentNode,
+                    inheritedFromParentDeclaration: true,
+                });
+            }
+        }
+    }
     // With overloaded functions/methods, TypeScript will use the comment on the first signature
     // declaration
     if ((ts.isFunctionDeclaration(node) || ts.isMethodDeclaration(node)) &&

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

@@ -195,7 +195,13 @@ function checkReference(data) {
         while (/[ \t]/.test(token.text[lookahead])) {
             ++lookahead;
         }
-        if (token.text[lookahead] === "[") {
+        // #2991, we check that this reference also doesn't look like a footnote reference
+        // as it is unlikely that someone uses that syntax without intending for footnote behavior.
+        // This introduces a problem if someone has an [^ref] and doesn't intend for that to
+        // be interpreted as a footnote, but as a reference, but we can't have it both ways,
+        // and having people rename their reference to not be confused with a footnote isn't a
+        // horrible workaround.
+        if (token.text[lookahead] === "[" && token.text[lookahead + 1] !== "^") {
             while (lookahead < token.text.length &&
                 /[^\n\]]/.test(token.text[lookahead])) {
                 ++lookahead;

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

@@ -5,7 +5,7 @@ import { Context } from "./context.js";
 import { AbstractComponent } from "../utils/component.js";
 import { type GlobString, MinimalSourceFile } from "#utils";
 import type { DocumentationEntryPoint } from "../utils/entry-point.js";
-import type { CommentParserConfig } from "./comments/index.js";
+import { type CommentParserConfig } from "./comments/index.js";
 import type { CommentStyle, ValidationOptions } from "../utils/options/declaration.js";
 import { type ExternalResolveResult, type ExternalSymbolResolver } from "./comments/linkResolver.js";
 import { type DeclarationReference } from "#utils";

package/dist/lib/converter/converter.js

@@ -43,6 +43,7 @@ import { ConverterEvents } from "./converter-events.js";
 import { convertSymbol } from "./symbols.js";
 import { MinimatchSet, nicePath, normalizePath } from "../utils/paths.js";
 import { hasAllFlags, hasAnyFlag, i18n, MinimalSourceFile, NormalizedPathUtils, partition, unique, } from "#utils";
+import { clearCommentCache } from "./comments/index.js";
 import { parseCommentString } from "./comments/parser.js";
 import { lexCommentString } from "./comments/rawLexer.js";
 import { resolveLinks, resolvePartLinks, } from "./comments/linkResolver.js";
@@ -320,6 +321,9 @@ let Converter = (() => {
             delete this._config;
             delete this.excludeCache;
             delete this.externalPatternCache;
+            // Also clear the comment cache so if we convert this ts.Program again
+            // later we will re-parse comments.
+            clearCommentCache();
             return project;
         }
         /** @internal */

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

@@ -144,6 +144,7 @@ module.exports = {
     invalid_tsdoc_json_0: `The file {0} is not a valid tsdoc.json file`,
     options_file_0_does_not_exist: `The options file {0} does not exist`,
     failed_read_options_file_0: `Failed to parse {0}, ensure it exists and exports an object`,
+    failed_to_apply_compilerOptions_overrides_0: "Failed to apply compilerOptions overrides: {0}",
     // plugins
     invalid_plugin_0_missing_load_function: `Invalid structure in plugin {0}, no load function found`,
     plugin_0_could_not_be_loaded: `The plugin {0} could not be loaded`,
@@ -360,7 +361,7 @@ module.exports = {
     // Page headings/labels
     theme_implements: "Implements",
     theme_indexable: "Indexable",
-    theme_type_declaration: "Type declaration",
+    theme_type_declaration: "Type Declaration",
     theme_index: "Index",
     theme_hierarchy: "Hierarchy",
     theme_hierarchy_summary: "Hierarchy Summary",

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

@@ -133,6 +133,7 @@ declare const _default: {
     readonly invalid_tsdoc_json_0: "The file {0} is not a valid tsdoc.json file";
     readonly options_file_0_does_not_exist: "The options file {0} does not exist";
     readonly failed_read_options_file_0: "Failed to parse {0}, ensure it exists and exports an object";
+    readonly failed_to_apply_compilerOptions_overrides_0: "Failed to apply compilerOptions overrides: {0}";
     readonly invalid_plugin_0_missing_load_function: "Invalid structure in plugin {0}, no load function found";
     readonly plugin_0_could_not_be_loaded: "The plugin {0} could not be loaded";
     readonly help_options: "Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory";
@@ -336,7 +337,7 @@ declare const _default: {
     readonly flag_inherited: "Inherited";
     readonly theme_implements: "Implements";
     readonly theme_indexable: "Indexable";
-    readonly theme_type_declaration: "Type declaration";
+    readonly theme_type_declaration: "Type Declaration";
     readonly theme_index: "Index";
     readonly theme_hierarchy: "Hierarchy";
     readonly theme_hierarchy_summary: "Hierarchy Summary";

package/dist/lib/models/ProjectReflection.js

@@ -1,3 +1,37 @@
+var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
+    function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
+    var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
+    var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
+    var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
+    var _, done = false;
+    for (var i = decorators.length - 1; i >= 0; i--) {
+        var context = {};
+        for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
+        for (var p in contextIn.access) context.access[p] = contextIn.access[p];
+        context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
+        var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
+        if (kind === "accessor") {
+            if (result === void 0) continue;
+            if (result === null || typeof result !== "object") throw new TypeError("Object expected");
+            if (_ = accept(result.get)) descriptor.get = _;
+            if (_ = accept(result.set)) descriptor.set = _;
+            if (_ = accept(result.init)) initializers.unshift(_);
+        }
+        else if (_ = accept(result)) {
+            if (kind === "field") initializers.unshift(_);
+            else descriptor[key] = _;
+        }
+    }
+    if (target) Object.defineProperty(target, contextIn.name, descriptor);
+    done = true;
+};
+var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
+    var useValue = arguments.length > 2;
+    for (var i = 0; i < initializers.length; i++) {
+        value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
+    }
+    return useValue ? value : void 0;
+};
 import { TraverseProperty } from "./Reflection.js";
 import { ContainerReflection } from "./ContainerReflection.js";
 import { ReferenceReflection } from "./ReferenceReflection.js";
@@ -5,7 +39,7 @@ import { IntrinsicType, makeRecursiveVisitor } from "./types.js";
 import { ReflectionKind } from "./kind.js";
 import { Comment } from "./Comment.js";
 import { ReflectionSymbolId } from "./ReflectionSymbolId.js";
-import { assertNever, DefaultMap, i18n, removeIfPresent, StableKeyMap } from "#utils";
+import { assertNever, DefaultMap, i18n, NonEnumerable, removeIfPresent, StableKeyMap, } from "#utils";
 // Keep this in sync with JSONOutput.SCHEMA_VERSION
 export const JSON_SCHEMA_VERSION = "2.0";
 /**
@@ -15,331 +49,369 @@ export const JSON_SCHEMA_VERSION = "2.0";
  * and source files of the processed project through this reflection.
  * @category Reflections
  */
-export class ProjectReflection extends ContainerReflection {
-    variant = "project";
-    // Used to resolve references.
-    symbolToReflectionIdMap = new StableKeyMap();
-    reflectionIdToSymbolIdMap = new Map();
-    removedSymbolIds = new StableKeyMap();
-    // Maps a reflection ID to all references eventually referring to it.
-    referenceGraph;
-    // Maps a reflection ID to all reflections with it as their parent.
-    reflectionChildren = new DefaultMap(() => []);
-    /**
-     * A list of all reflections within the project. DO NOT MUTATE THIS OBJECT.
-     * All mutation should be done via {@link registerReflection} and {@link removeReflection}
-     * to ensure that links to reflections remain valid.
-     *
-     * This may be replaced with a `Map<number, Reflection>` someday.
-     */
-    reflections = {};
-    /**
-     * The name of the package that this reflection documents according to package.json.
-     */
-    packageName;
-    /**
-     * The version of the package that this reflection documents according to package.json.
-     */
-    packageVersion;
-    /**
-     * The contents of the readme.md file of the project when found.
-     */
-    readme;
-    /**
-     * Object which describes where to find content for relative links.
-     */
-    files;
-    constructor(name, registry) {
-        super(name, ReflectionKind.Project);
-        this.reflections[this.id] = this;
-        this.files = registry;
-    }
-    /**
-     * Return whether this reflection is the root / project reflection.
-     */
-    isProject() {
-        return true;
-    }
-    /**
-     * Return a list of all reflections in this project of a certain kind.
-     *
-     * @param kind  The desired kind of reflection.
-     * @returns     An array containing all reflections with the desired kind.
-     */
-    getReflectionsByKind(kind) {
-        return Object.values(this.reflections).filter((reflection) => reflection.kindOf(kind));
-    }
-    /**
-     * Registers the given reflection so that it can be quickly looked up by helper methods.
-     * Should be called for *every* reflection added to the project.
-     *
-     * Note: During conversion, `Context.registerReflection` should be used instead so
-     * that symbols can be saved for later use.
-     */
-    registerReflection(reflection, id, filePath) {
-        this.referenceGraph = undefined;
-        if (reflection.parent) {
-            this.reflectionChildren
-                .get(reflection.parent.id)
-                .push(reflection.id);
+let ProjectReflection = (() => {
+    let _classSuper = ContainerReflection;
+    let _symbolToReflectionIdMap_decorators;
+    let _symbolToReflectionIdMap_initializers = [];
+    let _symbolToReflectionIdMap_extraInitializers = [];
+    let _reflectionIdToSymbolIdMap_decorators;
+    let _reflectionIdToSymbolIdMap_initializers = [];
+    let _reflectionIdToSymbolIdMap_extraInitializers = [];
+    let _removedSymbolIds_decorators;
+    let _removedSymbolIds_initializers = [];
+    let _removedSymbolIds_extraInitializers = [];
+    let _referenceGraph_decorators;
+    let _referenceGraph_initializers = [];
+    let _referenceGraph_extraInitializers = [];
+    let _reflectionChildren_decorators;
+    let _reflectionChildren_initializers = [];
+    let _reflectionChildren_extraInitializers = [];
+    let _reflections_decorators;
+    let _reflections_initializers = [];
+    let _reflections_extraInitializers = [];
+    return class ProjectReflection extends _classSuper {
+        static {
+            const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
+            _symbolToReflectionIdMap_decorators = [NonEnumerable];
+            _reflectionIdToSymbolIdMap_decorators = [NonEnumerable];
+            _removedSymbolIds_decorators = [NonEnumerable];
+            _referenceGraph_decorators = [NonEnumerable];
+            _reflectionChildren_decorators = [NonEnumerable];
+            _reflections_decorators = [NonEnumerable];
+            __esDecorate(null, null, _symbolToReflectionIdMap_decorators, { kind: "field", name: "symbolToReflectionIdMap", static: false, private: false, access: { has: obj => "symbolToReflectionIdMap" in obj, get: obj => obj.symbolToReflectionIdMap, set: (obj, value) => { obj.symbolToReflectionIdMap = value; } }, metadata: _metadata }, _symbolToReflectionIdMap_initializers, _symbolToReflectionIdMap_extraInitializers);
+            __esDecorate(null, null, _reflectionIdToSymbolIdMap_decorators, { kind: "field", name: "reflectionIdToSymbolIdMap", static: false, private: false, access: { has: obj => "reflectionIdToSymbolIdMap" in obj, get: obj => obj.reflectionIdToSymbolIdMap, set: (obj, value) => { obj.reflectionIdToSymbolIdMap = value; } }, metadata: _metadata }, _reflectionIdToSymbolIdMap_initializers, _reflectionIdToSymbolIdMap_extraInitializers);
+            __esDecorate(null, null, _removedSymbolIds_decorators, { kind: "field", name: "removedSymbolIds", static: false, private: false, access: { has: obj => "removedSymbolIds" in obj, get: obj => obj.removedSymbolIds, set: (obj, value) => { obj.removedSymbolIds = value; } }, metadata: _metadata }, _removedSymbolIds_initializers, _removedSymbolIds_extraInitializers);
+            __esDecorate(null, null, _referenceGraph_decorators, { kind: "field", name: "referenceGraph", static: false, private: false, access: { has: obj => "referenceGraph" in obj, get: obj => obj.referenceGraph, set: (obj, value) => { obj.referenceGraph = value; } }, metadata: _metadata }, _referenceGraph_initializers, _referenceGraph_extraInitializers);
+            __esDecorate(null, null, _reflectionChildren_decorators, { kind: "field", name: "reflectionChildren", static: false, private: false, access: { has: obj => "reflectionChildren" in obj, get: obj => obj.reflectionChildren, set: (obj, value) => { obj.reflectionChildren = value; } }, metadata: _metadata }, _reflectionChildren_initializers, _reflectionChildren_extraInitializers);
+            __esDecorate(null, null, _reflections_decorators, { kind: "field", name: "reflections", static: false, private: false, access: { has: obj => "reflections" in obj, get: obj => obj.reflections, set: (obj, value) => { obj.reflections = value; } }, metadata: _metadata }, _reflections_initializers, _reflections_extraInitializers);
+            if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
-        this.reflections[reflection.id] = reflection;
-        if (id) {
-            this.registerSymbolId(reflection, id);
+        variant = "project";
+        // Used to resolve references.
+        symbolToReflectionIdMap = __runInitializers(this, _symbolToReflectionIdMap_initializers, new StableKeyMap());
+        reflectionIdToSymbolIdMap = (__runInitializers(this, _symbolToReflectionIdMap_extraInitializers), __runInitializers(this, _reflectionIdToSymbolIdMap_initializers, new Map()));
+        removedSymbolIds = (__runInitializers(this, _reflectionIdToSymbolIdMap_extraInitializers), __runInitializers(this, _removedSymbolIds_initializers, new StableKeyMap()));
+        // Maps a reflection ID to all references eventually referring to it.
+        referenceGraph = (__runInitializers(this, _removedSymbolIds_extraInitializers), __runInitializers(this, _referenceGraph_initializers, void 0));
+        // Maps a reflection ID to all reflections with it as their parent.
+        reflectionChildren = (__runInitializers(this, _referenceGraph_extraInitializers), __runInitializers(this, _reflectionChildren_initializers, new DefaultMap(() => [])));
+        /**
+         * A list of all reflections within the project. DO NOT MUTATE THIS OBJECT.
+         * All mutation should be done via {@link registerReflection} and {@link removeReflection}
+         * to ensure that links to reflections remain valid.
+         *
+         * This may be replaced with a `Map<number, Reflection>` someday.
+         */
+        reflections = (__runInitializers(this, _reflectionChildren_extraInitializers), __runInitializers(this, _reflections_initializers, {}));
+        /**
+         * The name of the package that this reflection documents according to package.json.
+         */
+        packageName = __runInitializers(this, _reflections_extraInitializers);
+        /**
+         * The version of the package that this reflection documents according to package.json.
+         */
+        packageVersion;
+        /**
+         * The contents of the readme.md file of the project when found.
+         */
+        readme;
+        /**
+         * Object which describes where to find content for relative links.
+         */
+        files;
+        constructor(name, registry) {
+            super(name, ReflectionKind.Project);
+            this.reflections[this.id] = this;
+            this.files = registry;
         }
-        if (filePath) {
-            this.files.registerReflection(filePath, reflection);
+        /**
+         * Return whether this reflection is the root / project reflection.
+         */
+        isProject() {
+            return true;
         }
-    }
-    /**
-     * Removes references to reflections contained within the provided type.
-     * Plugins which overwrite types on reflections should pass the type to this
-     * method before overwriting the property.
-     * @since 0.26.6
-     */
-    removeTypeReflections(type) {
-        type?.visit(makeRecursiveVisitor({
-            reflection: (type) => {
-                this.removeReflection(type.declaration);
-            },
-        }));
-    }
-    /**
-     * Removes a reflection from the documentation. Can be used by plugins to filter reflections
-     * out of the generated documentation. Has no effect if the reflection is not present in the
-     * project.
-     */
-    removeReflection(reflection) {
-        // Remove the reflection...
-        this._removeReflection(reflection);
-        // And now try to remove references to it in the parent reflection.
-        // This might not find anything if someone called removeReflection on a member of a union
-        // but I think that could only be caused by a plugin doing something weird, not by a regular
-        // user... so this is probably good enough for now. Reflections that live on types are
-        // kind of half-real anyways.
-        const parent = reflection.parent;
-        parent?.traverse((child, property) => {
-            if (child !== reflection) {
-                return true; // Continue iteration
+        /**
+         * Return a list of all reflections in this project of a certain kind.
+         *
+         * @param kind  The desired kind of reflection.
+         * @returns     An array containing all reflections with the desired kind.
+         */
+        getReflectionsByKind(kind) {
+            return Object.values(this.reflections).filter((reflection) => reflection.kindOf(kind));
+        }
+        /**
+         * Registers the given reflection so that it can be quickly looked up by helper methods.
+         * Should be called for *every* reflection added to the project.
+         *
+         * Note: During conversion, `Context.registerReflection` should be used instead so
+         * that symbols can be saved for later use.
+         */
+        registerReflection(reflection, id, filePath) {
+            this.referenceGraph = undefined;
+            if (reflection.parent) {
+                this.reflectionChildren
+                    .get(reflection.parent.id)
+                    .push(reflection.id);
             }
-            switch (property) {
-                case TraverseProperty.Children:
-                case TraverseProperty.Documents:
-                    parent.removeChild(reflection);
-                    break;
-                case TraverseProperty.GetSignature:
-                    delete parent.getSignature;
-                    break;
-                case TraverseProperty.IndexSignature:
-                    removeIfPresent(parent.indexSignatures, reflection);
-                    if (!parent.indexSignatures?.length) {
-                        delete parent.indexSignatures;
-                    }
-                    break;
-                case TraverseProperty.Parameters:
-                    removeIfPresent(reflection.parent.parameters, reflection);
-                    if (!reflection.parent.parameters
-                        ?.length) {
-                        delete reflection.parent
-                            .parameters;
-                    }
-                    break;
-                case TraverseProperty.SetSignature:
-                    delete parent.setSignature;
-                    break;
-                case TraverseProperty.Signatures:
-                    removeIfPresent(parent.signatures, reflection);
-                    if (!parent.signatures?.length) {
-                        delete parent.signatures;
-                    }
-                    break;
-                case TraverseProperty.TypeLiteral:
-                    parent.type = new IntrinsicType("Object");
-                    break;
-                case TraverseProperty.TypeParameter:
-                    removeIfPresent(parent.typeParameters, reflection);
-                    if (!parent.typeParameters?.length) {
-                        delete parent.typeParameters;
-                    }
-                    break;
-                default:
-                    assertNever(property);
+            this.reflections[reflection.id] = reflection;
+            if (id) {
+                this.registerSymbolId(reflection, id);
             }
-            return false; // Stop iteration
-        });
-    }
-    /** @internal */
-    mergeReflections(source, target) {
-        // First, tell the children about their new parent
-        delete this.referenceGraph;
-        const oldChildrenIds = this.reflectionChildren.getNoInsert(source.id) || [];
-        const newChildren = this.reflectionChildren.get(target.id);
-        for (const childId of oldChildrenIds) {
-            const childRefl = this.getReflectionById(childId);
-            // To avoid conflicting with some plugins which do this surgery somewhat incorrectly
-            // (typedoc-plugin-merge-modules and likely others I'm not aware of) only move children
-            // which are still children
-            if (childRefl?.parent === source) {
-                childRefl.parent = target;
-                newChildren.push(childId);
-                target.addChild(childRefl);
+            if (filePath) {
+                this.files.registerReflection(filePath, reflection);
             }
         }
-        // Then remove the now-empty parent
-        this.reflectionChildren.delete(source.id);
-        this.removeReflection(source);
-        // And remove any outdated collections of children on the new parent.
-        // So long as this is used before REVIVE(-100) or EVENT_BEGIN_RESOLVE(-100)
-        // this will make the appropriate plugin rebuild the lists.
-        delete target.groups;
-        delete target.categories;
-    }
-    /**
-     * Remove a reflection without updating the parent reflection to remove references to the removed reflection.
-     */
-    _removeReflection(reflection) {
-        this.files.removeReflection(reflection);
-        // Remove references pointing to this reflection
-        const graph = this.getReferenceGraph();
-        for (const id of graph.get(reflection.id) ?? []) {
-            const ref = this.getReflectionById(id);
-            if (ref) {
-                this.removeReflection(ref);
-            }
+        /**
+         * Removes references to reflections contained within the provided type.
+         * Plugins which overwrite types on reflections should pass the type to this
+         * method before overwriting the property.
+         * @since 0.26.6
+         */
+        removeTypeReflections(type) {
+            type?.visit(makeRecursiveVisitor({
+                reflection: (type) => {
+                    this.removeReflection(type.declaration);
+                },
+            }));
+        }
+        /**
+         * Removes a reflection from the documentation. Can be used by plugins to filter reflections
+         * out of the generated documentation. Has no effect if the reflection is not present in the
+         * project.
+         */
+        removeReflection(reflection) {
+            // Remove the reflection...
+            this._removeReflection(reflection);
+            // And now try to remove references to it in the parent reflection.
+            // This might not find anything if someone called removeReflection on a member of a union
+            // but I think that could only be caused by a plugin doing something weird, not by a regular
+            // user... so this is probably good enough for now. Reflections that live on types are
+            // kind of half-real anyways.
+            const parent = reflection.parent;
+            parent?.traverse((child, property) => {
+                if (child !== reflection) {
+                    return true; // Continue iteration
+                }
+                switch (property) {
+                    case TraverseProperty.Children:
+                    case TraverseProperty.Documents:
+                        parent.removeChild(reflection);
+                        break;
+                    case TraverseProperty.GetSignature:
+                        delete parent.getSignature;
+                        break;
+                    case TraverseProperty.IndexSignature:
+                        removeIfPresent(parent.indexSignatures, reflection);
+                        if (!parent.indexSignatures?.length) {
+                            delete parent.indexSignatures;
+                        }
+                        break;
+                    case TraverseProperty.Parameters:
+                        removeIfPresent(reflection.parent.parameters, reflection);
+                        if (!reflection.parent.parameters
+                            ?.length) {
+                            delete reflection.parent
+                                .parameters;
+                        }
+                        break;
+                    case TraverseProperty.SetSignature:
+                        delete parent.setSignature;
+                        break;
+                    case TraverseProperty.Signatures:
+                        removeIfPresent(parent.signatures, reflection);
+                        if (!parent.signatures?.length) {
+                            delete parent.signatures;
+                        }
+                        break;
+                    case TraverseProperty.TypeLiteral:
+                        parent.type = new IntrinsicType("Object");
+                        break;
+                    case TraverseProperty.TypeParameter:
+                        removeIfPresent(parent.typeParameters, reflection);
+                        if (!parent.typeParameters?.length) {
+                            delete parent.typeParameters;
+                        }
+                        break;
+                    default:
+                        assertNever(property);
+                }
+                return false; // Stop iteration
+            });
         }
-        graph.delete(reflection.id);
-        // Remove children of this reflection
-        for (const childId of this.reflectionChildren.getNoInsert(reflection.id) || []) {
-            const child = this.getReflectionById(childId);
-            // Only remove if the child's parent is still actually this reflection.
-            // This might not be the case if a plugin has moved this reflection to another parent.
-            // (typedoc-plugin-merge-modules)
-            if (child?.parent === reflection) {
-                this._removeReflection(child);
+        /** @internal */
+        mergeReflections(source, target) {
+            // First, tell the children about their new parent
+            delete this.referenceGraph;
+            const oldChildrenIds = this.reflectionChildren.getNoInsert(source.id) || [];
+            const newChildren = this.reflectionChildren.get(target.id);
+            for (const childId of oldChildrenIds) {
+                const childRefl = this.getReflectionById(childId);
+                // To avoid conflicting with some plugins which do this surgery somewhat incorrectly
+                // (typedoc-plugin-merge-modules and likely others I'm not aware of) only move children
+                // which are still children
+                if (childRefl?.parent === source) {
+                    childRefl.parent = target;
+                    newChildren.push(childId);
+                    target.addChild(childRefl);
+                }
             }
+            // Then remove the now-empty parent
+            this.reflectionChildren.delete(source.id);
+            this.removeReflection(source);
+            // And remove any outdated collections of children on the new parent.
+            // So long as this is used before REVIVE(-100) or EVENT_BEGIN_RESOLVE(-100)
+            // this will make the appropriate plugin rebuild the lists.
+            delete target.groups;
+            delete target.categories;
         }
-        this.reflectionChildren.delete(reflection.id);
-        // Remove references from the TS symbol to this reflection.
-        const symbolId = this.reflectionIdToSymbolIdMap.get(reflection.id);
-        if (symbolId) {
-            const saved = this.symbolToReflectionIdMap.get(symbolId);
-            if (saved === reflection.id) {
-                this.symbolToReflectionIdMap.delete(symbolId);
-                this.removedSymbolIds.set(symbolId, true);
+        /**
+         * Remove a reflection without updating the parent reflection to remove references to the removed reflection.
+         */
+        _removeReflection(reflection) {
+            this.files.removeReflection(reflection);
+            // Remove references pointing to this reflection
+            const graph = this.getReferenceGraph();
+            for (const id of graph.get(reflection.id) ?? []) {
+                const ref = this.getReflectionById(id);
+                if (ref) {
+                    this.removeReflection(ref);
+                }
             }
-            else if (typeof saved === "object") {
-                removeIfPresent(saved, reflection.id);
-                if (saved.length === 0) {
+            graph.delete(reflection.id);
+            // Remove children of this reflection
+            for (const childId of this.reflectionChildren.getNoInsert(reflection.id) || []) {
+                const child = this.getReflectionById(childId);
+                // Only remove if the child's parent is still actually this reflection.
+                // This might not be the case if a plugin has moved this reflection to another parent.
+                // (typedoc-plugin-merge-modules)
+                if (child?.parent === reflection) {
+                    this._removeReflection(child);
+                }
+            }
+            this.reflectionChildren.delete(reflection.id);
+            // Remove references from the TS symbol to this reflection.
+            const symbolId = this.reflectionIdToSymbolIdMap.get(reflection.id);
+            if (symbolId) {
+                const saved = this.symbolToReflectionIdMap.get(symbolId);
+                if (saved === reflection.id) {
+                    this.symbolToReflectionIdMap.delete(symbolId);
                     this.removedSymbolIds.set(symbolId, true);
                 }
+                else if (typeof saved === "object") {
+                    removeIfPresent(saved, reflection.id);
+                    if (saved.length === 0) {
+                        this.removedSymbolIds.set(symbolId, true);
+                    }
+                }
             }
+            this.reflectionIdToSymbolIdMap.delete(reflection.id);
+            delete this.reflections[reflection.id];
         }
-        this.reflectionIdToSymbolIdMap.delete(reflection.id);
-        delete this.reflections[reflection.id];
-    }
-    /**
-     * Gets the reflection registered for the given reflection ID, or undefined if it is not present
-     * in the project.
-     */
-    getReflectionById(id) {
-        return this.reflections[id];
-    }
-    /**
-     * Gets the reflection associated with the given symbol id, if it exists.
-     * If there are multiple reflections associated with this symbol, gets the first one.
-     * @internal
-     */
-    getReflectionFromSymbolId(symbolId) {
-        return this.getReflectionsFromSymbolId(symbolId)[0];
-    }
-    /** @internal */
-    getReflectionsFromSymbolId(symbolId) {
-        const id = this.symbolToReflectionIdMap.get(symbolId);
-        if (typeof id === "number") {
-            return [this.getReflectionById(id)];
+        /**
+         * Gets the reflection registered for the given reflection ID, or undefined if it is not present
+         * in the project.
+         */
+        getReflectionById(id) {
+            return this.reflections[id];
         }
-        else if (typeof id === "object") {
-            return id.map((id) => this.getReflectionById(id));
+        /**
+         * Gets the reflection associated with the given symbol id, if it exists.
+         * If there are multiple reflections associated with this symbol, gets the first one.
+         * @internal
+         */
+        getReflectionFromSymbolId(symbolId) {
+            return this.getReflectionsFromSymbolId(symbolId)[0];
         }
-        return [];
-    }
-    /** @internal */
-    getSymbolIdFromReflection(reflection) {
-        return this.reflectionIdToSymbolIdMap.get(reflection.id);
-    }
-    /** @internal */
-    registerSymbolId(reflection, id) {
-        this.removedSymbolIds.delete(id);
-        this.reflectionIdToSymbolIdMap.set(reflection.id, id);
-        const previous = this.symbolToReflectionIdMap.get(id);
-        if (previous) {
-            if (typeof previous === "number") {
-                this.symbolToReflectionIdMap.set(id, [previous, reflection.id]);
+        /** @internal */
+        getReflectionsFromSymbolId(symbolId) {
+            const id = this.symbolToReflectionIdMap.get(symbolId);
+            if (typeof id === "number") {
+                return [this.getReflectionById(id)];
+            }
+            else if (typeof id === "object") {
+                return id.map((id) => this.getReflectionById(id));
+            }
+            return [];
+        }
+        /** @internal */
+        getSymbolIdFromReflection(reflection) {
+            return this.reflectionIdToSymbolIdMap.get(reflection.id);
+        }
+        /** @internal */
+        registerSymbolId(reflection, id) {
+            this.removedSymbolIds.delete(id);
+            this.reflectionIdToSymbolIdMap.set(reflection.id, id);
+            const previous = this.symbolToReflectionIdMap.get(id);
+            if (previous) {
+                if (typeof previous === "number") {
+                    this.symbolToReflectionIdMap.set(id, [previous, reflection.id]);
+                }
+                else {
+                    previous.push(reflection.id);
+                }
             }
             else {
-                previous.push(reflection.id);
+                this.symbolToReflectionIdMap.set(id, reflection.id);
             }
         }
-        else {
-            this.symbolToReflectionIdMap.set(id, reflection.id);
+        symbolIdHasBeenRemoved(id) {
+            return this.removedSymbolIds.has(id);
         }
-    }
-    symbolIdHasBeenRemoved(id) {
-        return this.removedSymbolIds.has(id);
-    }
-    getReferenceGraph() {
-        if (!this.referenceGraph) {
-            this.referenceGraph = new Map();
-            for (const id in this.reflections) {
-                const ref = this.reflections[id];
-                if (ref instanceof ReferenceReflection) {
-                    const target = ref.tryGetTargetReflection();
-                    if (target) {
-                        const refs = this.referenceGraph.get(target.id) ?? [];
-                        refs.push(ref.id);
-                        this.referenceGraph.set(target.id, refs);
+        getReferenceGraph() {
+            if (!this.referenceGraph) {
+                this.referenceGraph = new Map();
+                for (const id in this.reflections) {
+                    const ref = this.reflections[id];
+                    if (ref instanceof ReferenceReflection) {
+                        const target = ref.tryGetTargetReflection();
+                        if (target) {
+                            const refs = this.referenceGraph.get(target.id) ?? [];
+                            refs.push(ref.id);
+                            this.referenceGraph.set(target.id, refs);
+                        }
                     }
                 }
             }
+            return this.referenceGraph;
         }
-        return this.referenceGraph;
-    }
-    toObject(serializer) {
-        const symbolIdMap = {};
-        this.reflectionIdToSymbolIdMap.forEach((sid, id) => {
-            symbolIdMap[id] = sid.toObject();
-        });
-        return {
-            schemaVersion: JSON_SCHEMA_VERSION,
-            ...super.toObject(serializer),
-            variant: this.variant,
-            packageName: this.packageName,
-            packageVersion: this.packageVersion,
-            readme: Comment.serializeDisplayParts(this.readme),
-            symbolIdMap,
-            files: serializer.toObject(this.files),
-        };
-    }
-    fromObject(de, obj) {
-        super.fromObject(de, obj);
-        // If updating this, also check the block in DeclarationReflection.fromObject.
-        this.packageName = obj.packageName;
-        this.packageVersion = obj.packageVersion;
-        if (obj.readme) {
-            this.readme = Comment.deserializeDisplayParts(de, obj.readme);
+        toObject(serializer) {
+            const symbolIdMap = {};
+            this.reflectionIdToSymbolIdMap.forEach((sid, id) => {
+                symbolIdMap[id] = sid.toObject();
+            });
+            return {
+                schemaVersion: JSON_SCHEMA_VERSION,
+                ...super.toObject(serializer),
+                variant: this.variant,
+                packageName: this.packageName,
+                packageVersion: this.packageVersion,
+                readme: Comment.serializeDisplayParts(this.readme),
+                symbolIdMap,
+                files: serializer.toObject(this.files),
+            };
         }
-        this.files.fromObject(de, obj.files || {});
-        de.defer(() => {
-            // Unnecessary conditional in release
-            for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {
-                const refl = this.getReflectionById(de.oldIdToNewId[+id] ?? -1);
-                if (refl) {
-                    this.registerSymbolId(refl, new ReflectionSymbolId(sid));
-                }
-                else {
-                    de.logger.warn(i18n.serialized_project_referenced_0_not_part_of_project(id.toString()));
-                }
+        fromObject(de, obj) {
+            super.fromObject(de, obj);
+            // If updating this, also check the block in DeclarationReflection.fromObject.
+            this.packageName = obj.packageName;
+            this.packageVersion = obj.packageVersion;
+            if (obj.readme) {
+                this.readme = Comment.deserializeDisplayParts(de, obj.readme);
             }
-        });
-    }
-}
+            this.files.fromObject(de, obj.files || {});
+            de.defer(() => {
+                // Unnecessary conditional in release
+                for (const [id, sid] of Object.entries(obj.symbolIdMap || {})) {
+                    const refl = this.getReflectionById(de.oldIdToNewId[+id] ?? -1);
+                    if (refl) {
+                        this.registerSymbolId(refl, new ReflectionSymbolId(sid));
+                    }
+                    else {
+                        de.logger.warn(i18n.serialized_project_referenced_0_not_part_of_project(id.toString()));
+                    }
+                }
+            });
+        }
+    };
+})();
+export { ProjectReflection };

package/dist/lib/output/formatter.js

@@ -566,6 +566,7 @@ export class FormattedCodeBuilder {
         const id = this.newId();
         return group(id, [
             name,
+            sig.parent.flags.isOptional ? simpleElement(JSX.createElement("span", { class: "tsd-signature-symbol" }, "?")) : emptyNode,
             this.typeParameters(sig),
             ...this.parameters(sig, id),
             nodes(options.arrowStyle ? space() : emptyNode, simpleElement(JSX.createElement("span", { class: "tsd-signature-symbol" }, options.arrowStyle ? "=>" : ":")), space(), this.type(sig.type, TypeContext.none)),

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

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

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

@@ -1,30 +1,32 @@
 import { JSX } from "#utils";
 import { FormattedCodeBuilder, FormattedCodeGenerator, Wrap } from "../../../formatter.js";
 import { hasTypeParameters } from "../../lib.js";
+function shouldRenderDefaultValue(props) {
+    const defaultValue = props.defaultValue;
+    if (defaultValue === undefined) {
+        return false;
+    }
+    /** Fix for #2717. If type is the same as value the default value is omitted */
+    if (props.type && props.type.type === "literal") {
+        const reflectionTypeString = props.type.toString();
+        if (reflectionTypeString === defaultValue.toString()) {
+            return false;
+        }
+    }
+    return true;
+}
 export function memberDeclaration(context, props) {
     const builder = new FormattedCodeBuilder(context.router, context.model);
     const content = [];
     builder.member(content, props, { topLevelLinks: false });
     const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
     generator.node({ type: "nodes", content }, Wrap.Detect);
-    /** Fix for #2717. If type is the same as value the default value is omitted */
-    function shouldRenderDefaultValue() {
-        if (props.type && props.type.type === "literal") {
-            const reflectionTypeString = props.type.toString();
-            const defaultValue = props.defaultValue;
-            if (defaultValue === undefined || reflectionTypeString === defaultValue.toString()) {
-                return false;
-            }
-        }
-        return true;
-    }
     return (JSX.createElement(JSX.Fragment, null,
         JSX.createElement("div", { class: "tsd-signature" },
             generator.toElement(),
-            !!props.defaultValue && shouldRenderDefaultValue() && (JSX.createElement(JSX.Fragment, null,
-                JSX.createElement("span", { class: "tsd-signature-symbol" },
-                    " = ",
-                    props.defaultValue)))),
+            shouldRenderDefaultValue(props) && (JSX.createElement("span", { class: "tsd-signature-symbol" },
+                " = ",
+                props.defaultValue))),
         context.commentSummary(props),
         hasTypeParameters(props) && context.typeParameters(props.typeParameters),
         props.type && context.typeDeclaration(props, props.type),

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

@@ -29,7 +29,7 @@ export function moduleReflection(context, mod) {
         })));
 }
 export function moduleMemberSummary(context, member) {
-    const id = context.slugger.slug(member.name);
+    const id = member.isReference() ? context.getAnchor(member) : context.slugger.slug(member.name);
     context.page.pageHeadings.push({
         link: `#${id}`,
         text: getDisplayName(member),

package/dist/lib/utils/entry-point.js

@@ -214,7 +214,7 @@ function getEntryPointsForPaths(logger, inputFiles, options, programs = getEntry
     return entryPoints;
 }
 export function getExpandedEntryPointsForPaths(logger, inputFiles, options, programs = getEntryPrograms(inputFiles, logger, options)) {
-    const compilerOptions = options.getCompilerOptions();
+    const compilerOptions = options.getCompilerOptions(logger);
     const supportedFileRegex = compilerOptions.allowJs || compilerOptions.checkJs
         ? /\.([cm][tj]s|[tj]sx?)$/
         : /\.([cm]ts|tsx?)$/;
@@ -252,14 +252,14 @@ function getEntryPrograms(inputFiles, logger, options) {
     const rootProgram = noTsConfigFound
         ? ts.createProgram({
             rootNames: inputFiles,
-            options: options.getCompilerOptions(),
+            options: options.getCompilerOptions(logger),
         })
         : ts.createProgram({
             rootNames: options.getFileNames(),
-            options: options.getCompilerOptions(),
+            options: options.getCompilerOptions(logger),
             projectReferences: options.getProjectReferences(),
         });
-    addInferredDeclarationMapPaths(options.getCompilerOptions(), options.getFileNames());
+    addInferredDeclarationMapPaths(options.getCompilerOptions(logger), options.getFileNames());
     const programs = [rootProgram];
     // This might be a solution style tsconfig, in which case we need to add a program for each
     // reference so that the converter can look through each of these.
@@ -270,7 +270,7 @@ function getEntryPrograms(inputFiles, logger, options) {
             if (!ref)
                 continue; // This indicates bad configuration... will be reported later.
             programs.push(ts.createProgram({
-                options: options.fixCompilerOptions(ref.commandLine.options),
+                options: options.fixCompilerOptions(ref.commandLine.options, logger),
                 rootNames: ref.commandLine.fileNames,
                 projectReferences: ref.commandLine.projectReferences,
             }));

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

@@ -1,4 +1,4 @@
-import type ts from "typescript";
+import ts from "typescript";
 import type { Application } from "../../../index.js";
 import { type DeclarationOption, type KeyToDeclaration, type TypeDocOptionMap, type TypeDocOptions, type TypeDocOptionValues } from "./declaration.js";
 import { type Logger, type NeverIfInternal } from "#utils";
@@ -156,9 +156,9 @@ export declare class Options {
     /**
      * Gets the set compiler options.
      */
-    getCompilerOptions(): ts.CompilerOptions;
+    getCompilerOptions(logger: Logger): ts.CompilerOptions;
     /** @internal */
-    fixCompilerOptions(options: Readonly<ts.CompilerOptions>): ts.CompilerOptions;
+    fixCompilerOptions(options: Readonly<ts.CompilerOptions>, logger: Logger): ts.CompilerOptions;
     /**
      * Gets the file names discovered through reading a tsconfig file.
      */

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

@@ -1,3 +1,4 @@
+import ts from "typescript";
 import { resolve } from "path";
 import { ParameterType } from "./declaration.js";
 import { normalizePath } from "../paths.js";
@@ -185,15 +186,25 @@ export class Options {
     /**
      * Gets the set compiler options.
      */
-    getCompilerOptions() {
-        return this.fixCompilerOptions(this._compilerOptions);
+    getCompilerOptions(logger) {
+        return this.fixCompilerOptions(this._compilerOptions, logger);
     }
     /** @internal */
-    fixCompilerOptions(options) {
+    fixCompilerOptions(options, logger) {
         const overrides = this.getValue("compilerOptions");
         const result = { ...options };
         if (overrides) {
-            Object.assign(result, overrides);
+            const tsOptions = ts.convertCompilerOptionsFromJson(overrides, ".", "typedoc-overrides.json");
+            if (tsOptions.errors.length) {
+                for (const error of tsOptions.errors) {
+                    logger.error(i18n.failed_to_apply_compilerOptions_overrides_0(ts.flattenDiagnosticMessageText(error.messageText, "\n")));
+                }
+            }
+            else {
+                for (const key in overrides) {
+                    result[key] = tsOptions.options[key];
+                }
+            }
         }
         if (this.getValue("emit") !== "both") {
             result.noEmit = true;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "typedoc",
   "description": "Create api documentation for TypeScript projects.",
-  "version": "0.28.9",
+  "version": "0.28.11",
   "homepage": "https://typedoc.org",
   "type": "module",
   "exports": {