typedoc 0.28.10 → 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/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/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/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.10",
+  "version": "0.28.11",
   "homepage": "https://typedoc.org",
   "type": "module",
   "exports": {