typedoc 0.28.0-beta.0 → 0.28.0-beta.1

package/dist/index.d.ts

@@ -36,7 +36,7 @@ export { type CommentParserConfig, Context, Converter, type ConverterEvents, typ
 export * from "./lib/models/index.js";
 /** @primaryExport */
 export * as Configuration from "./lib/utils/options/index.js";
-export { BaseRouter, CategoryRouter, DefaultTheme, DefaultThemeRenderContext, GroupRouter, IndexEvent, KindDirRouter, KindRouter, MarkdownEvent, PageEvent, PageKind, Renderer, RendererEvent, Slugger, StructureDirRouter, StructureRouter, Theme, UrlMapping, } from "./lib/output/index.js";
+export { BaseRouter, CategoryRouter, DefaultTheme, DefaultThemeRenderContext, GroupRouter, IndexEvent, KindDirRouter, KindRouter, MarkdownEvent, PageEvent, PageKind, Renderer, RendererEvent, Slugger, StructureDirRouter, StructureRouter, Theme, } from "./lib/output/index.js";
 export type { Icons, NavigationElement, PageDefinition, PageHeading, RendererEvents, RendererHooks, RenderTemplate, Router, } from "./lib/output/index.js";
 export { Outputs } from "./lib/output/output.js";
 export { ArgumentsReader, CommentStyle, EntryPointStrategy, normalizePath, Option, OptionDefaults, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, ValidatingFileRegistry, } from "./lib/utils/index.js";

package/dist/index.js

@@ -36,7 +36,7 @@ export { Context, Converter, } from "./lib/converter/index.js";
 export * from "./lib/models/index.js";
 /** @primaryExport */
 export * as Configuration from "./lib/utils/options/index.js";
-export { BaseRouter, CategoryRouter, DefaultTheme, DefaultThemeRenderContext, GroupRouter, IndexEvent, KindDirRouter, KindRouter, MarkdownEvent, PageEvent, PageKind, Renderer, RendererEvent, Slugger, StructureDirRouter, StructureRouter, Theme, UrlMapping, } from "./lib/output/index.js";
+export { BaseRouter, CategoryRouter, DefaultTheme, DefaultThemeRenderContext, GroupRouter, IndexEvent, KindDirRouter, KindRouter, MarkdownEvent, PageEvent, PageKind, Renderer, RendererEvent, Slugger, StructureDirRouter, StructureRouter, Theme, } from "./lib/output/index.js";
 export { Outputs } from "./lib/output/output.js";
 export { ArgumentsReader, CommentStyle, EntryPointStrategy, normalizePath, Option, OptionDefaults, Options, PackageJsonReader, ParameterHint, ParameterType, TSConfigReader, TypeDocReader, ValidatingFileRegistry, } from "./lib/utils/index.js";
 export { ConsoleLogger, EventDispatcher, EventHooks, i18n, JSX, Logger, LogLevel, MinimalSourceFile, translateTagName, } from "#utils";

package/dist/lib/application.d.ts

@@ -4,7 +4,7 @@ import { Renderer } from "./output/renderer.js";
 import { type ProjectReflection } from "./models/index.js";
 import { AbstractComponent, type OptionsReader } from "./utils/index.js";
 import { Options } from "./utils/index.js";
-import type { TypeDocOptions } from "./utils/options/declaration.js";
+import { type TypeDocOptions } from "./utils/options/declaration.js";
 import { type GlobString, Logger } from "#utils";
 import { type DocumentationEntryPoint, EntryPointStrategy } from "./utils/entry-point.js";
 import { FileRegistry } from "./models/FileRegistry.js";

package/dist/lib/application.js

@@ -40,6 +40,7 @@ import { Renderer } from "./output/renderer.js";
 import { ReflectionSymbolId } from "./models/index.js";
 import { AbstractComponent, FancyConsoleLogger, loadPlugins, PackageJsonReader, TSConfigReader, TypeDocReader, writeFile, } from "./utils/index.js";
 import { Option, Options } from "./utils/index.js";
+import { rootPackageOptions } from "./utils/options/declaration.js";
 import { i18n, Logger, LogLevel, unique } from "#utils";
 import { ok } from "assert";
 import { EntryPointStrategy, getEntryPoints, getPackageDirectories, getWatchEntryPoints, inferEntryPoints, } from "./utils/entry-point.js";
@@ -593,6 +594,11 @@ let Application = (() => {
             const origFiles = this.files;
             const origOptions = this.options;
             const projects = [];
+            for (const opt of Object.keys(this.options.getValue("packageOptions"))) {
+                if (rootPackageOptions.includes(opt)) {
+                    this.logger.warn(i18n.package_option_0_should_be_specified_at_root(opt));
+                }
+            }
             const projectsToConvert = [];
             // Generate a json file for each package
             for (const dir of packageDirs) {

package/dist/lib/converter/context.js

@@ -234,8 +234,7 @@ export class Context {
         return getSignatureComment(declaration, this.converter.config, this.logger, this.checker, this.project.files);
     }
     withScope(scope) {
-        // TODO: This will be important for #2862
-        // assert(scope.parent === this.scope, "Incorrect context used for withScope");
+        assert(scope.parent === this.scope || scope === this.scope, "Incorrect context used for withScope");
         const context = new Context(this.converter, this.programs, this.project, scope);
         context.convertingTypeNode = this.convertingTypeNode;
         context.setActiveProgram(this._program);

package/dist/lib/converter/factories/index-signature.js

@@ -24,6 +24,7 @@ export function convertIndexSignatures(context, type) {
         }
         // Otherwise create a new one
         const index = new SignatureReflection("__index", ReflectionKind.IndexSignature, context.scope);
+        const ic = context.withScope(index);
         if (indexInfo.isReadonly) {
             index.setFlag(ReflectionFlag.Readonly);
         }
@@ -36,8 +37,8 @@ export function convertIndexSignatures(context, type) {
         index.parameters = [
             new ParameterReflection(indexInfo.declaration?.parameters[0].name.getText() ?? "key", ReflectionKind.Parameter, index),
         ];
-        index.parameters[0].type = context.converter.convertType(context.withScope(index.parameters[0]), indexInfo.keyType);
-        index.type = context.converter.convertType(context.withScope(index), indexInfo.type);
+        index.parameters[0].type = context.converter.convertType(ic.withScope(index.parameters[0]), indexInfo.keyType);
+        index.type = context.converter.convertType(ic, indexInfo.type);
         context.registerReflection(index, indexInfo.declaration?.symbol);
         context.scope.indexSignatures ||= [];
         context.scope.indexSignatures.push(index);

package/dist/lib/converter/jsdoc.js

@@ -53,12 +53,13 @@ function convertJsDocSignature(context, node) {
         return new IntrinsicType("Function");
     }
     const reflection = new DeclarationReflection("__type", ReflectionKind.TypeLiteral, context.scope);
+    const rc = context.withScope(reflection);
     context.registerReflection(reflection, symbol);
     context.converter.trigger(ConverterEvents.CREATE_DECLARATION, context, reflection);
     const signature = new SignatureReflection("__type", ReflectionKind.CallSignature, reflection);
     context.project.registerSymbolId(signature, createSymbolId(symbol, node));
     context.registerReflection(signature, void 0);
-    const signatureCtx = context.withScope(signature);
+    const signatureCtx = rc.withScope(signature);
     reflection.signatures = [signature];
     signature.type = context.converter.convertType(signatureCtx, node.type?.typeExpression?.type);
     signature.parameters = convertParameterNodes(signatureCtx, signature, node.parameters);

package/dist/lib/converter/plugins/PackagePlugin.js

@@ -37,7 +37,8 @@ import { ConverterComponent } from "../components.js";
 import { ApplicationEvents } from "../../application-events.js";
 import { ConverterEvents } from "../converter-events.js";
 import { i18n, MinimalSourceFile } from "#utils";
-import { discoverInParentDir, discoverPackageJson, getCommonDirectory, nicePath, normalizePath, Option, readFile, } from "#node-utils";
+import { discoverPackageJson, getCommonDirectory, nicePath, normalizePath, Option, readFile, } from "#node-utils";
+import { existsSync } from "fs";
 /**
  * A handler that tries to find the package.json and readme.md files of the
  * current project.
@@ -117,8 +118,9 @@ let PackagePlugin = (() => {
             this.packageJson = undefined;
             const dirName = this.application.options.packageDir ??
                 Path.resolve(getCommonDirectory(this.entryPoints.map(g => `${g}/`)));
-            this.application.logger.verbose(`Begin readme.md/package.json search at ${nicePath(dirName)}`);
-            this.packageJson = discoverPackageJson(dirName)?.content;
+            this.application.logger.verbose(`Begin package.json search at ${nicePath(dirName)}`);
+            const packageJson = discoverPackageJson(dirName);
+            this.packageJson = packageJson?.content;
             // Path will be resolved already. This is kind of ugly, but...
             if (this.readme.endsWith("none")) {
                 return; // No readme, we're done
@@ -134,12 +136,20 @@ let PackagePlugin = (() => {
                     this.application.logger.error(i18n.provided_readme_at_0_could_not_be_read(nicePath(this.readme)));
                 }
             }
-            else {
+            else if (packageJson) {
                 // No readme provided, automatically find the readme
-                const result = discoverInParentDir("readme.md", dirName, (content) => content);
-                if (result) {
-                    this.readmeFile = normalizePath(result.file);
-                    this.readmeContents = result.content;
+                const possibleReadmePaths = [
+                    "README.md",
+                    "readme.md",
+                    "Readme.md",
+                ].map(name => Path.join(Path.dirname(packageJson.file), name));
+                const readmePath = possibleReadmePaths.find(path => {
+                    this.application.watchFile(path);
+                    return existsSync(path);
+                });
+                if (readmePath) {
+                    this.readmeFile = normalizePath(readmePath);
+                    this.readmeContents = readFile(readmePath);
                     this.application.watchFile(this.readmeFile);
                 }
             }

package/dist/lib/converter/symbols.js

@@ -164,6 +164,9 @@ function convertNamespace(context, symbol, exportSymbol) {
             return;
         }
     }
+    if (symbol.declarations?.some(ts.isFunctionDeclaration)) {
+        exportFlags |= ts.SymbolFlags.PropertyOrAccessor;
+    }
     // #2364, @namespace on a variable might be merged with a namespace containing types.
     const existingReflection = context.getReflectionFromSymbol(exportSymbol || symbol);
     let reflection;
@@ -551,7 +554,10 @@ function convertVariable(context, symbol, exportSymbol) {
     }
     if (type.getCallSignatures().length &&
         !type.getConstructSignatures().length) {
-        return convertVariableAsFunction(context, symbol, exportSymbol);
+        if (comment?.hasModifier("@function") ||
+            (declaration && shouldAutomaticallyConvertAsFunction(declaration))) {
+            return convertVariableAsFunction(context, symbol, exportSymbol);
+        }
     }
     const reflection = context.createDeclarationReflection(context.scope.kindOf(ReflectionKind.VariableContainer)
         ? ReflectionKind.Variable
@@ -625,6 +631,7 @@ function convertVariableAsFunction(context, symbol, exportSymbol) {
     for (const signature of type.getCallSignatures()) {
         createSignature(reflectionContext, ReflectionKind.CallSignature, signature, symbol);
     }
+    reflection.comment?.removeModifier("@function");
     // #2824 If there is only one signature, and there isn't a comment
     // on the signature already, treat the comment on the variable
     // as if it belongs to the signature instead.
@@ -648,7 +655,8 @@ function convertFunctionProperties(context, symbol, type) {
     const nsFlags = ts.SymbolFlags.ValueModule | ts.SymbolFlags.NamespaceModule;
     if (type.getProperties().length &&
         (hasAllFlags(symbol.flags, nsFlags) ||
-            !hasAnyFlag(symbol.flags, nsFlags))) {
+            !hasAnyFlag(symbol.flags, nsFlags)) &&
+        !symbol.declarations?.some(ts.isModuleDeclaration)) {
         convertSymbols(context, type.getProperties());
         return ts.SymbolFlags.NamespaceModule;
     }
@@ -768,3 +776,38 @@ function setModifiers(symbol, declaration, reflection) {
 function setSymbolModifiers(symbol, reflection) {
     reflection.setFlag(ReflectionFlag.Optional, hasAllFlags(symbol.flags, ts.SymbolFlags.Optional));
 }
+function shouldAutomaticallyConvertAsFunction(node) {
+    // const fn = () => {}
+    if (ts.isVariableDeclaration(node)) {
+        if (node.type || !node.initializer)
+            return false;
+        return isFunctionLikeInitializer(node.initializer);
+    }
+    // { fn: () => {} }
+    if (ts.isPropertyAssignment(node)) {
+        return isFunctionLikeInitializer(node.initializer);
+    }
+    // exports.fn = () => {}
+    // exports.fn ||= () => {}
+    // exports.fn ??= () => {}
+    if (ts.isPropertyAccessExpression(node)) {
+        if (ts.isBinaryExpression(node.parent) &&
+            [ts.SyntaxKind.EqualsToken, ts.SyntaxKind.BarBarEqualsToken, ts.SyntaxKind.QuestionQuestionEqualsToken]
+                .includes(node.parent.operatorToken.kind)) {
+            return isFunctionLikeInitializer(node.parent.right);
+        }
+    }
+    return false;
+}
+function isFunctionLikeInitializer(node) {
+    if (ts.isFunctionExpression(node) || ts.isArrowFunction(node)) {
+        return true;
+    }
+    if (ts.isSatisfiesExpression(node)) {
+        return isFunctionLikeInitializer(node.expression);
+    }
+    if (ts.isAsExpression(node)) {
+        return isFunctionLikeInitializer(node.expression);
+    }
+    return false;
+}

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

@@ -16,6 +16,7 @@ module.exports = {
     no_entry_points_for_packages: "No entry points provided to packages mode, documentation cannot be generated",
     failed_to_find_packages: "Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json",
     nested_packages_unsupported_0: "Project at {0} has entryPointStrategy set to packages, but nested packages are not supported",
+    package_option_0_should_be_specified_at_root: "The packageOptions option sets option {0}, which only has an affect at the root level",
     previous_error_occurred_when_reading_options_for_0: "The previous error occurred when reading options for the package at {0}",
     converting_project_at_0: "Converting project at {0}",
     failed_to_convert_packages: "Failed to convert one or more packages, result will not be merged together",
@@ -193,6 +194,7 @@ module.exports = {
     help_basePath: "Specifies the base path to be used when displaying file paths",
     help_excludeTags: "Remove the listed block/modifier tags from doc comments",
     help_notRenderedTags: "Tags which will be preserved in doc comments, but not rendered when creating output",
+    help_cascadedModifierTags: "Modifier tags which should be copied to all children of the parent reflection",
     help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page",
     help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages",
     help_favicon: "Path to favicon to include as the site icon",

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

@@ -13,6 +13,7 @@ declare const _default: {
     readonly no_entry_points_for_packages: "No entry points provided to packages mode, documentation cannot be generated";
     readonly failed_to_find_packages: "Failed to find any packages, ensure you have provided at least one directory as an entry point containing package.json";
     readonly nested_packages_unsupported_0: "Project at {0} has entryPointStrategy set to packages, but nested packages are not supported";
+    readonly package_option_0_should_be_specified_at_root: "The packageOptions option sets option {0}, which only has an affect at the root level";
     readonly previous_error_occurred_when_reading_options_for_0: "The previous error occurred when reading options for the package at {0}";
     readonly converting_project_at_0: "Converting project at {0}";
     readonly failed_to_convert_packages: "Failed to convert one or more packages, result will not be merged together";
@@ -180,6 +181,7 @@ declare const _default: {
     readonly help_basePath: "Specifies the base path to be used when displaying file paths";
     readonly help_excludeTags: "Remove the listed block/modifier tags from doc comments";
     readonly help_notRenderedTags: "Tags which will be preserved in doc comments, but not rendered when creating output";
+    readonly help_cascadedModifierTags: "Modifier tags which should be copied to all children of the parent reflection";
     readonly help_readme: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page";
     readonly help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages";
     readonly help_favicon: "Path to favicon to include as the site icon";

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

@@ -63,7 +63,8 @@ module.exports = localeUtils.buildIncompleteTranslation({
     failed_to_resolve_link_to_0_in_document_1_may_have_meant_2: "无法解析文档 {1} 中指向 “{0}” 的链接。您可能想要 “{2}”",
     type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs: "{0} 在 {1} 中定义，被 {2} 引用，但未包含在文档中",
     reflection_0_kind_1_defined_in_2_does_not_have_any_documentation: "{0} ({1})，在 {2} 中定义，没有任何文档",
-    invalid_intentionally_not_exported_symbols_0: "以下符号被标记为有意不导出，但未在文档中引用，或已被导出：\n{0}",
+    invalid_intentionally_not_documented_names_0: "以下的限定反射名称被设定为刻意无文档说明，但它们要么未在文档中被引用，要么已有文档说明：\n\t{0}",
+    invalid_intentionally_not_exported_symbols_0: "以下符号被设定为刻意非导出，但它们要么未在文档中被引用，要么已为导出符号：\n{0}",
     reflection_0_has_unused_mergeModuleWith_tag: "{0} 中存在无法解析的 @mergeModuleWith 标签",
     reflection_0_links_to_1_with_text_2_but_resolved_to_3: "“{0}”中的链接“{2}”指向“{1}”，目标虽然存在但并没有直接的链接，因此将改为链接至“{3}”。",
     // conversion plugins
@@ -194,6 +195,7 @@ module.exports = localeUtils.buildIncompleteTranslation({
     help_basePath: "指定显示文件路径时使用的基本路径",
     help_excludeTags: "从文档注释中删除列出的块级/修饰符标签",
     help_notRenderedTags: "保留在文档注释中但在创建输出时不渲染的标签",
+    help_cascadedModifierTags: "需要从父反射复制至所有子反射的修饰符标签",
     help_readme: "应显示在索引页上的自述文件路径。传递“none”以禁用索引页并在全局页上启动文档",
     help_cname: "设置 CNAME 文件文本，这对于 GitHub Pages 上的自定义域很有用",
     help_favicon: "作为站点图标包含的 favicon 的路径",
@@ -222,6 +224,7 @@ module.exports = localeUtils.buildIncompleteTranslation({
     help_searchGroupBoosts: "配置搜索以增强所选种类（例如“类别”）的相关性",
     help_useFirstParagraphOfCommentAsSummary: "如果设置，且没有指定 @summary 标签，TypeDoc 会使用注释的第一行作为在模块/命名空间一览里的概述",
     help_jsDocCompatibility: "设置注释解析的兼容性选项，以增加与 JSDoc 注释的相似度",
+    help_suppressCommentWarningsInDeclarationFiles: "阻止 .d.ts 文件的注释中因为存在未指定的标签而弹出的警告。",
     help_commentStyle: "确定 TypeDoc 如何搜索注释",
     help_useTsLinkResolution: "使用 TypeScript 的链接解析来确定 @link 标签指向的位置。这仅适用于 JSDoc 样式注释",
     help_preserveLinkText: "如果设置，不带链接文本的 @link 标签将使用文本内容作为链接。如果未设置，将使用目标反射名称",
@@ -246,8 +249,10 @@ module.exports = localeUtils.buildIncompleteTranslation({
     help_logLevel: "指定应使用什么级别的日志记录",
     help_treatWarningsAsErrors: "如果设置，所有警告都将被视为错误",
     help_treatValidationWarningsAsErrors: "如果设置，验证期间发出的警告将被视为错误。此选项不能用于禁用验证警告的 treatWarningsAsErrors",
-    help_intentionallyNotExported: "不应产生“引用但未记录”警告的类型列表",
-    help_requiredToBeDocumented: "必须记录的反射类型列表",
+    help_intentionallyNotExported: "不会因为“引用但并未导出”而产生警告的符号列表",
+    help_requiredToBeDocumented: "需要有文档说明的反射类型列表",
+    help_packagesRequiringDocumentation: "需要有文档说明的包的列表",
+    help_intentionallyNotDocumented: "不会因为无文档说明而产生警告的完整反射名称列表",
     help_validation: "指定 TypeDoc 应对生成的文档执行哪些验证步骤",
     // ==================================================================
     // Option validation

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

@@ -56,7 +56,8 @@ declare const _default: {
     failed_to_resolve_link_to_0_in_document_1_may_have_meant_2: "无法解析文档 {1} 中指向 “{0}” 的链接。您可能想要 “{2}”";
     type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs: "{0} 在 {1} 中定义，被 {2} 引用，但未包含在文档中";
     reflection_0_kind_1_defined_in_2_does_not_have_any_documentation: "{0} ({1})，在 {2} 中定义，没有任何文档";
-    invalid_intentionally_not_exported_symbols_0: "以下符号被标记为有意不导出，但未在文档中引用，或已被导出：\n{0}";
+    invalid_intentionally_not_documented_names_0: "以下的限定反射名称被设定为刻意无文档说明，但它们要么未在文档中被引用，要么已有文档说明：\n\t{0}";
+    invalid_intentionally_not_exported_symbols_0: "以下符号被设定为刻意非导出，但它们要么未在文档中被引用，要么已为导出符号：\n{0}";
     reflection_0_has_unused_mergeModuleWith_tag: "{0} 中存在无法解析的 @mergeModuleWith 标签";
     reflection_0_links_to_1_with_text_2_but_resolved_to_3: "“{0}”中的链接“{2}”指向“{1}”，目标虽然存在但并没有直接的链接，因此将改为链接至“{3}”。";
     not_all_search_category_boosts_used_0: "文档中并未使用 searchCategoryBoosts 中指定的所有类别。未使用的类别包括：\n{0}";
@@ -179,6 +180,7 @@ declare const _default: {
     help_basePath: string;
     help_excludeTags: string;
     help_notRenderedTags: string;
+    help_cascadedModifierTags: string;
     help_readme: string;
     help_cname: string;
     help_favicon: string;
@@ -207,6 +209,7 @@ declare const _default: {
     help_searchGroupBoosts: string;
     help_useFirstParagraphOfCommentAsSummary: string;
     help_jsDocCompatibility: string;
+    help_suppressCommentWarningsInDeclarationFiles: string;
     help_commentStyle: string;
     help_useTsLinkResolution: string;
     help_preserveLinkText: string;
@@ -233,6 +236,8 @@ declare const _default: {
     help_treatValidationWarningsAsErrors: string;
     help_intentionallyNotExported: string;
     help_requiredToBeDocumented: string;
+    help_packagesRequiringDocumentation: string;
+    help_intentionallyNotDocumented: string;
     help_validation: string;
     unknown_option_0_you_may_have_meant_1: "未知选项“{0}” 你可能指的是：\n{1}";
     option_0_must_be_between_1_and_2: "{0} 必须介于 {1} 和 {2} 之间";

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

@@ -1,10 +1,8 @@
 export { IndexEvent, MarkdownEvent, PageEvent, type PageHeading, RendererEvent } from "./events.js";
-export { UrlMapping } from "./models/UrlMapping.js";
-export type { RenderTemplate } from "./models/UrlMapping.js";
 export { Renderer, type RendererEvents } from "./renderer.js";
 export type { RendererHooks } from "./renderer.js";
 export { Theme } from "./theme.js";
-export { DefaultTheme, type NavigationElement } from "./themes/default/DefaultTheme.js";
+export { DefaultTheme, type NavigationElement, type RenderTemplate } from "./themes/default/DefaultTheme.js";
 export { DefaultThemeRenderContext } from "./themes/default/DefaultThemeRenderContext.js";
 export type { Icons } from "./themes/default/partials/icon.js";
 export { Slugger } from "./themes/default/Slugger.js";

package/dist/lib/output/index.js

@@ -1,5 +1,4 @@
 export { IndexEvent, MarkdownEvent, PageEvent, RendererEvent } from "./events.js";
-export { UrlMapping } from "./models/UrlMapping.js";
 export { Renderer } from "./renderer.js";
 export { Theme } from "./theme.js";
 export { DefaultTheme } from "./themes/default/DefaultTheme.js";

package/dist/lib/output/router.js

@@ -135,6 +135,9 @@ let BaseRouter = (() => {
             return Array.from(this.fullUrls.keys());
         }
         getAnchor(refl) {
+            if (!this.anchors.has(refl)) {
+                this.application.logger.verbose(`${refl.getFullName()} does not have an anchor but one was requested, this is a bug in the theme`);
+            }
             return this.anchors.get(refl);
         }
         hasOwnDocument(refl) {
@@ -161,6 +164,9 @@ let BaseRouter = (() => {
                 }
             }
             if (equal && !to.isProject()) {
+                if (fromUrl === toUrl) {
+                    return "";
+                }
                 return `#${this.getAnchor(to)}`;
             }
             return "../".repeat(slashes) + toUrl.substring(start);

package/dist/lib/output/themes/MarkedPlugin.js

@@ -175,7 +175,7 @@ let MarkedPlugin = (() => {
                                         // If we don't have a URL the user probably linked to some deeply nested property
                                         // which doesn't get an assigned URL. We'll walk upwards until we find a reflection
                                         // which has a URL and link to that instead.
-                                        if (!url) {
+                                        if (typeof url === "undefined") {
                                             // Walk upwards to find something we can link to.
                                             let target = part.target.parent;
                                             while (!context.router.hasUrl(target)) {

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

@@ -1,7 +1,6 @@
 import { Theme } from "../../theme.js";
 import type { Renderer } from "../../renderer.js";
 import { type ContainerReflection, type DocumentReflection, type ProjectReflection, type Reflection, ReflectionKind } from "../../../models/index.js";
-import { type RenderTemplate } from "../../models/UrlMapping.js";
 import type { PageEvent } from "../../events.js";
 import type { MarkedPlugin } from "../../plugins/index.js";
 import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext.js";
@@ -15,6 +14,11 @@ export interface NavigationElement {
     class?: string;
     children?: NavigationElement[];
 }
+/**
+ * @param data the reflection to render
+ * @returns either a string to be written to the file, or an element to be serialized and then written.
+ */
+export type RenderTemplate<T> = (data: T) => JSX.Element | string;
 export declare class DefaultTheme extends Theme {
     usedFileNames: Set<string>;
     /** @internal */

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

@@ -1,6 +1,5 @@
 import { Theme } from "../../theme.js";
 import { ReferenceReflection, ReflectionCategory, ReflectionGroup, ReflectionKind, } from "../../../models/index.js";
-import {} from "../../models/UrlMapping.js";
 import { DefaultThemeRenderContext } from "./DefaultThemeRenderContext.js";
 import { getIcons } from "./partials/icon.js";
 import { filterMap, JSX } from "#utils";

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

@@ -35,7 +35,7 @@ export declare class DefaultThemeRenderContext {
     reflectionTemplate: (props: PageEvent<import("../../../models/ContainerReflection.js").ContainerReflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
     indexTemplate: (props: PageEvent<import("../../../models/ProjectReflection.js").ProjectReflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
     hierarchyTemplate: (props: PageEvent<import("../../../models/ProjectReflection.js").ProjectReflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
-    defaultLayout: (template: import("../../index.js").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
+    defaultLayout: (template: import("./DefaultTheme.js").RenderTemplate<PageEvent<Reflection>>, props: PageEvent<Reflection>) => import("../../../utils-common/jsx.elements.js").JsxElement;
     /**
      * Rendered just after the description for a reflection.
      * This can be used to render a shortened type display of a reflection that the

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

@@ -69,20 +69,10 @@ export class DefaultThemeRenderContext {
         return result;
     };
     getAnchor = (reflection) => {
-        const anchor = this.router.getAnchor(reflection);
-        if (!anchor) {
-            // This will go to debug level before release
-            this.theme.application.logger.warn(`${reflection.getFullName()} does not have an anchor but one was requested when generating page for ${this.model.getFullName()}, this is a bug`);
-        }
-        return anchor;
+        return this.router.getAnchor(reflection);
     };
     urlTo = (reflection) => {
-        if (this.router.hasUrl(reflection)) {
-            return this.router.relativeUrl(this.page.model, reflection);
-        }
-        // This will go to debug level before release
-        this.theme.application.logger.warn(`${reflection.getFullName()} does not have a URL but was linked to when generating page for ${this.model.getFullName()}, this is a bug`);
-        return undefined;
+        return this.router.relativeUrl(this.page.model, reflection);
     };
     markdown = (md) => {
         return this.theme.markedPlugin.parseMarkdown(md || "", this.page, this);

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

@@ -7,11 +7,17 @@ export function typeParameters(context, typeParameters) {
             JSX.createElement("ul", { class: "tsd-type-parameter-list" }, typeParameters.map((item) => (JSX.createElement("li", null,
                 JSX.createElement("span", null,
                     anchorLinkIfPresent(context, item),
-                    item.flags.isConst && JSX.createElement("span", { class: "tsd-signature-keyword" }, "const"),
-                    item.varianceModifier && (JSX.createElement("span", { class: "tsd-signature-keyword" }, item.varianceModifier)),
+                    item.flags.isConst && (JSX.createElement(JSX.Fragment, null,
+                        JSX.createElement("span", { class: "tsd-signature-keyword" }, "const"),
+                        " ")),
+                    item.varianceModifier && (JSX.createElement(JSX.Fragment, null,
+                        JSX.createElement("span", { class: "tsd-signature-keyword" }, item.varianceModifier),
+                        " ")),
                     JSX.createElement("span", { class: "tsd-kind-type-parameter" }, item.name),
                     !!item.type && (JSX.createElement(JSX.Fragment, null,
+                        " ",
                         JSX.createElement("span", { class: "tsd-signature-keyword" }, "extends"),
+                        " ",
                         context.type(item.type))),
                     !!item.default && (JSX.createElement(JSX.Fragment, null,
                         " = ",

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

@@ -49,10 +49,6 @@ export declare function glob(pattern: GlobString, root: NormalizedPath, options?
 }): NormalizedPath[];
 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;
-} | undefined;
 export declare function discoverInParentDirExactMatch<T extends {}>(name: string, dir: string, read: (content: string) => T | undefined, usedFile?: (path: string) => void): {
     file: string;
     content: T;

package/dist/lib/utils/fs.js

@@ -221,27 +221,6 @@ export function hasTsExtension(path) {
 export function hasDeclarationFileExtension(path) {
     return /\.d\.[cm]?ts$/.test(path);
 }
-export function discoverInParentDir(name, dir, read) {
-    if (!isDir(dir))
-        return;
-    const reachedTopDirectory = (dirName) => dirName === resolve(join(dirName, ".."));
-    while (!reachedTopDirectory(dir)) {
-        for (const file of fs.readdirSync(dir)) {
-            if (file.toLowerCase() !== name.toLowerCase())
-                continue;
-            try {
-                const content = read(readFile(join(dir, file)));
-                if (content != null) {
-                    return { file: join(dir, file), content };
-                }
-            }
-            catch {
-                // Ignore, file didn't pass validation
-            }
-        }
-        dir = resolve(join(dir, ".."));
-    }
-}
 export function discoverInParentDirExactMatch(name, dir, read, usedFile) {
     if (!isDir(dir))
         return;

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

@@ -28,6 +28,11 @@ export type OutputSpecification = {
     path: string;
     options?: Partial<TypeDocOptions>;
 };
+/**
+ * List of option names which, with `entryPointStrategy` set to `packages`
+ * should only be set at the root level.
+ */
+export declare const rootPackageOptions: readonly ["plugin", "packageOptions", "outputs", "out", "html", "json", "pretty", "theme", "router", "lightHighlightTheme", "darkHighlightTheme", "highlightLanguages", "ignoredHighlightLanguages", "typePrintWidth", "customCss", "customJs", "customFooterHtml", "customFooterHtmlDisableWrapper", "markdownItOptions", "markdownItLoader", "cname", "favicon", "sourceLinkExternal", "markdownLinkExternal", "lang", "locales", "githubPages", "cacheBust", "hideGenerator", "searchInComments", "searchInDocuments", "cleanOutputDir", "titleLink", "navigationLinks", "sidebarLinks", "navigation", "headings", "sluggerConfiguration", "navigationLeaves", "visibilityFilters", "searchCategoryBoosts", "searchGroupBoosts", "hostedBaseUrl", "useHostedBaseUrlForAbsoluteLinks", "useFirstParagraphOfCommentAsSummary", "includeHierarchySummary", "notRenderedTags", "treatWarningsAsErrors", "treatValidationWarningsAsErrors", "watch", "preserveWatchOutput", "help", "version", "showConfig", "logLevel"];
 /**
  * An interface describing all TypeDoc specific options. Generated from a
  * map which contains more information about each option for better types when
@@ -46,6 +51,13 @@ export type TypeDocOptions = {
 export type TypeDocOptionValues = {
     [K in keyof TypeDocOptionMap]: unknown extends TypeDocOptionMap[K] ? unknown : TypeDocOptionMap[K] extends ManuallyValidatedOption<infer ManuallyValidated> ? ManuallyValidated : TypeDocOptionMap[K] extends string | string[] | GlobString[] | number | boolean | Record<string, boolean> ? TypeDocOptionMap[K] : TypeDocOptionMap[K][keyof TypeDocOptionMap[K]];
 };
+/**
+ * Describes TypeDoc options suitable for setting within the `packageOptions` setting.
+ *
+ * This is a subset of all options specified in {@link TypeDocOptions}.
+ */
+export interface TypeDocPackageOptions extends Omit<TypeDocOptions, typeof rootPackageOptions[number]> {
+}
 /**
  * Describes all TypeDoc options. Used internally to provide better types when fetching options.
  * External consumers should likely use {@link TypeDocOptions} instead.
@@ -68,7 +80,7 @@ export interface TypeDocOptionMap {
     plugin: NormalizedPathOrModule[];
     lang: string;
     locales: ManuallyValidatedOption<Record<string, Record<string, string>>>;
-    packageOptions: ManuallyValidatedOption<TypeDocOptions>;
+    packageOptions: ManuallyValidatedOption<Partial<TypeDocPackageOptions>>;
     entryPoints: GlobString[];
     entryPointStrategy: typeof EntryPointStrategy;
     alwaysCreateEntryPointModule: boolean;

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

@@ -17,6 +17,74 @@ export const CommentStyle = {
     Line: "line",
     All: "all",
 };
+/**
+ * List of option names which, with `entryPointStrategy` set to `packages`
+ * should only be set at the root level.
+ */
+export const rootPackageOptions = [
+    // Configuration Options
+    "plugin",
+    // Input Options
+    "packageOptions",
+    // Output Options
+    "outputs",
+    "out",
+    "html",
+    "json",
+    "pretty",
+    "theme",
+    "router",
+    "lightHighlightTheme",
+    "darkHighlightTheme",
+    "highlightLanguages",
+    "ignoredHighlightLanguages",
+    "typePrintWidth",
+    "customCss",
+    "customJs",
+    "customFooterHtml",
+    "customFooterHtmlDisableWrapper",
+    "markdownItOptions",
+    "markdownItLoader",
+    "cname",
+    "favicon",
+    "sourceLinkExternal",
+    "markdownLinkExternal",
+    "lang",
+    "locales",
+    "githubPages",
+    "cacheBust",
+    "hideGenerator",
+    "searchInComments",
+    "searchInDocuments",
+    "cleanOutputDir",
+    "titleLink",
+    "navigationLinks",
+    "sidebarLinks",
+    "navigation",
+    "headings",
+    "sluggerConfiguration",
+    "navigationLeaves",
+    "visibilityFilters",
+    "searchCategoryBoosts",
+    "searchGroupBoosts",
+    "hostedBaseUrl",
+    "useHostedBaseUrlForAbsoluteLinks",
+    "useFirstParagraphOfCommentAsSummary",
+    "includeHierarchySummary",
+    // Comment Options
+    "notRenderedTags",
+    // Organization Options
+    // Validation Options
+    "treatWarningsAsErrors",
+    "treatValidationWarningsAsErrors",
+    // Other Options
+    "watch",
+    "preserveWatchOutput",
+    "help",
+    "version",
+    "showConfig",
+    "logLevel",
+];
 export var ParameterHint;
 (function (ParameterHint) {
     ParameterHint[ParameterHint["File"] = 0] = "File";