typedoc 0.28.12 → 0.28.13

package/dist/lib/application.d.ts

@@ -67,6 +67,10 @@ export declare class Application extends AbstractComponent<Application, Applicat
      */
     internationalization: Internationalization;
     options: Options;
+    /**
+     * Due for deprecation in 0.29, use the reference to this on {@link ProjectReflection},
+     * this was the wrong place for this member to live.
+     */
     files: FileRegistry;
     /** @internal */
     accessor lang: string;

package/dist/lib/application.js

@@ -158,6 +158,10 @@ let Application = (() => {
          */
         internationalization = new Internationalization();
         options = new Options();
+        /**
+         * Due for deprecation in 0.29, use the reference to this on {@link ProjectReflection},
+         * this was the wrong place for this member to live.
+         */
         files = new ValidatingFileRegistry();
         #lang_accessor_storage = __runInitializers(this, _lang_initializers, void 0);
         /** @internal */
@@ -260,6 +264,9 @@ let Application = (() => {
             else {
                 this.logger.level = this.options.getValue("logLevel");
             }
+            if (this.files instanceof ValidatingFileRegistry) {
+                this.files.basePath = this.options.getValue("basePath");
+            }
             for (const [lang, locales] of Object.entries(this.options.getValue("locales"))) {
                 this.internationalization.addTranslations(lang, locales);
             }
@@ -630,7 +637,7 @@ let Application = (() => {
             for (const { dir, options } of projectsToConvert) {
                 this.logger.info(i18n.converting_project_at_0(nicePath(dir)));
                 this.options = options;
-                this.files = new ValidatingFileRegistry();
+                this.files = new ValidatingFileRegistry(options.getValue("basePath"));
                 let project = await this.convert();
                 if (project) {
                     this.validate(project);

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

@@ -206,6 +206,9 @@ function postProcessComment(comment, i18n, getPosition, warning) {
     if ((inlineInheritDoc.length || inheritDoc.length) && remarks.length) {
         warning(i18n.content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0(getPosition()));
     }
+    if ((inlineInheritDoc.length || inheritDoc.length) && returns.length) {
+        warning(i18n.content_in_returns_block_overwritten_by_inheritdoc_in_comment_at_0(getPosition()));
+    }
 }
 const aliasedTags = new Map([["@return", "@returns"]]);
 function blockTag(comment, lexer, config, i18n, warning, files) {

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

@@ -4,7 +4,7 @@ import { DeclarationReflection, ReflectionFlag, ReflectionKind, SignatureReflect
 import { ReferenceType, ReflectionType } from "../../models/types.js";
 import { filterMap, zip } from "#utils";
 import { ConverterComponent } from "../components.js";
-import { getHumanName } from "../../utils/index.js";
+import { findPackageForPath, getHumanName } from "../../utils/index.js";
 import { ConverterEvents } from "../converter-events.js";
 /**
  * A plugin that detects interface implementations of functions and
@@ -95,22 +95,23 @@ export class ImplementsPlugin extends ConverterComponent {
         // serialization/deserialization, might point to an unexpected location. (See the mixin
         // converter tests, I suspect this might actually be an indication of something else slightly
         // broken there, but don't want to spend more time with this right now.)
-        // #2982, even more unfortunately, we only want to keep the link if it is pointing to a reflection
-        // which will receive a link during rendering.
-        const isValidRef = (ref) => ref.reflection && !ref.reflection.parent?.kindOf(ReflectionKind.TypeLiteral);
+        // #2982/#3007, even more unfortunately, we only want to keep the link if it is pointing
+        // to a reflection which will receive a link during rendering, we pick this based on it being
+        // the type of member we expect to point to.
+        const isValidRef = (ref) => !!ref.reflection?.parent?.kindOf(ReflectionKind.ClassOrInterface | ReflectionKind.Method | ReflectionKind.Constructor);
         for (const child of reflection.children || []) {
             if (child.inheritedFrom && !isValidRef(child.inheritedFrom)) {
-                child.inheritedFrom = ReferenceType.createBrokenReference(child.inheritedFrom.name, project);
+                child.inheritedFrom = ReferenceType.createBrokenReference(child.inheritedFrom.name, project, child.inheritedFrom.package);
             }
             if (child.overwrites && !isValidRef(child.overwrites)) {
-                child.overwrites = ReferenceType.createBrokenReference(child.overwrites.name, project);
+                child.overwrites = ReferenceType.createBrokenReference(child.overwrites.name, project, child.overwrites.package);
             }
             for (const childSig of child.getAllSignatures()) {
                 if (childSig.inheritedFrom && !isValidRef(childSig.inheritedFrom)) {
-                    childSig.inheritedFrom = ReferenceType.createBrokenReference(childSig.inheritedFrom.name, project);
+                    childSig.inheritedFrom = ReferenceType.createBrokenReference(childSig.inheritedFrom.name, project, childSig.inheritedFrom.package);
                 }
                 if (childSig.overwrites && !isValidRef(childSig.overwrites)) {
-                    childSig.overwrites = ReferenceType.createBrokenReference(childSig.overwrites.name, project);
+                    childSig.overwrites = ReferenceType.createBrokenReference(childSig.overwrites.name, project, childSig.overwrites.package);
                 }
             }
         }
@@ -325,15 +326,27 @@ export class ImplementsPlugin extends ConverterComponent {
         }
     }
 }
+function getConstructorPackagePath(context, clause) {
+    const symbol = context.getSymbolAtLocation(clause.expression);
+    if (!symbol)
+        return undefined;
+    const resolvedSymbol = context.resolveAliasedSymbol(symbol);
+    const symbolPath = resolvedSymbol?.declarations?.[0]?.getSourceFile().fileName;
+    if (!symbolPath)
+        return undefined;
+    return findPackageForPath(symbolPath)?.[0];
+}
 function constructorInheritance(context, reflection, childDecl, constructorDecl) {
     const extendsClause = childDecl.heritageClauses?.find((cl) => cl.token === ts.SyntaxKind.ExtendsKeyword);
     if (!extendsClause)
         return;
-    const name = `${extendsClause.types[0].getText()}.constructor`;
+    const extendsType = extendsClause.types[0];
+    const refPackage = getConstructorPackagePath(context, extendsType);
+    const name = `${extendsType.getText()}.constructor`;
     const key = constructorDecl ? "overwrites" : "inheritedFrom";
-    reflection[key] ??= ReferenceType.createBrokenReference(name, context.project);
+    reflection[key] ??= ReferenceType.createBrokenReference(name, context.project, refPackage);
     for (const sig of reflection.signatures ?? []) {
-        sig[key] ??= ReferenceType.createBrokenReference(name, context.project);
+        sig[key] ??= ReferenceType.createBrokenReference(name, context.project, refPackage);
     }
 }
 function findProperty(reflection, parent) {
@@ -356,7 +369,7 @@ function createLink(context, reflection, clause, expr, symbol, isInherit) {
     const rootSymbols = context.checker.getRootSymbols(symbol);
     const ref = rootSymbols.length && rootSymbols[0] != symbol
         ? context.createSymbolReference(rootSymbols[0], context, name)
-        : ReferenceType.createBrokenReference(name, context.project);
+        : ReferenceType.createBrokenReference(name, context.project, undefined);
     link(reflection);
     link(reflection.getSignature);
     link(reflection.setSignature);

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

@@ -149,6 +149,8 @@ let InheritDocPlugin = (() => {
                 return;
             }
             target.comment.removeTags("@inheritDoc");
+            target.comment.removeTags("@remarks");
+            target.comment.removeTags("@returns");
             target.comment.summary = Comment.cloneDisplayParts(source.comment.summary);
             const remarks = source.comment.getTag("@remarks");
             if (remarks) {

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

@@ -1,6 +1,5 @@
 import { ConverterComponent } from "../components.js";
 import type { Converter } from "../converter.js";
-import { type NormalizedPath } from "#utils";
 /**
  * A handler that attaches source file information to reflections.
  */
@@ -10,7 +9,7 @@ export declare class SourcePlugin extends ConverterComponent {
     accessor gitRemote: string;
     accessor disableGit: boolean;
     accessor sourceLinkTemplate: string;
-    accessor basePath: NormalizedPath;
+    get displayBasePath(): import("#utils").NormalizedPath;
     /**
      * All file names to find the base path from.
      */

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

@@ -62,9 +62,6 @@ let SourcePlugin = (() => {
     let _sourceLinkTemplate_decorators;
     let _sourceLinkTemplate_initializers = [];
     let _sourceLinkTemplate_extraInitializers = [];
-    let _basePath_decorators;
-    let _basePath_initializers = [];
-    let _basePath_extraInitializers = [];
     return class SourcePlugin extends _classSuper {
         static {
             const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
@@ -73,13 +70,11 @@ let SourcePlugin = (() => {
             _gitRemote_decorators = [Option("gitRemote")];
             _disableGit_decorators = [Option("disableGit")];
             _sourceLinkTemplate_decorators = [Option("sourceLinkTemplate")];
-            _basePath_decorators = [Option("basePath")];
             __esDecorate(this, null, _disableSources_decorators, { kind: "accessor", name: "disableSources", static: false, private: false, access: { has: obj => "disableSources" in obj, get: obj => obj.disableSources, set: (obj, value) => { obj.disableSources = value; } }, metadata: _metadata }, _disableSources_initializers, _disableSources_extraInitializers);
             __esDecorate(this, null, _gitRevision_decorators, { kind: "accessor", name: "gitRevision", static: false, private: false, access: { has: obj => "gitRevision" in obj, get: obj => obj.gitRevision, set: (obj, value) => { obj.gitRevision = value; } }, metadata: _metadata }, _gitRevision_initializers, _gitRevision_extraInitializers);
             __esDecorate(this, null, _gitRemote_decorators, { kind: "accessor", name: "gitRemote", static: false, private: false, access: { has: obj => "gitRemote" in obj, get: obj => obj.gitRemote, set: (obj, value) => { obj.gitRemote = value; } }, metadata: _metadata }, _gitRemote_initializers, _gitRemote_extraInitializers);
             __esDecorate(this, null, _disableGit_decorators, { kind: "accessor", name: "disableGit", static: false, private: false, access: { has: obj => "disableGit" in obj, get: obj => obj.disableGit, set: (obj, value) => { obj.disableGit = value; } }, metadata: _metadata }, _disableGit_initializers, _disableGit_extraInitializers);
             __esDecorate(this, null, _sourceLinkTemplate_decorators, { kind: "accessor", name: "sourceLinkTemplate", static: false, private: false, access: { has: obj => "sourceLinkTemplate" in obj, get: obj => obj.sourceLinkTemplate, set: (obj, value) => { obj.sourceLinkTemplate = value; } }, metadata: _metadata }, _sourceLinkTemplate_initializers, _sourceLinkTemplate_extraInitializers);
-            __esDecorate(this, null, _basePath_decorators, { kind: "accessor", name: "basePath", static: false, private: false, access: { has: obj => "basePath" in obj, get: obj => obj.basePath, set: (obj, value) => { obj.basePath = value; } }, metadata: _metadata }, _basePath_initializers, _basePath_extraInitializers);
             if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
         }
         #disableSources_accessor_storage = __runInitializers(this, _disableSources_initializers, void 0);
@@ -97,13 +92,13 @@ let SourcePlugin = (() => {
         #sourceLinkTemplate_accessor_storage = (__runInitializers(this, _disableGit_extraInitializers), __runInitializers(this, _sourceLinkTemplate_initializers, void 0));
         get sourceLinkTemplate() { return this.#sourceLinkTemplate_accessor_storage; }
         set sourceLinkTemplate(value) { this.#sourceLinkTemplate_accessor_storage = value; }
-        #basePath_accessor_storage = (__runInitializers(this, _sourceLinkTemplate_extraInitializers), __runInitializers(this, _basePath_initializers, void 0));
-        get basePath() { return this.#basePath_accessor_storage; }
-        set basePath(value) { this.#basePath_accessor_storage = value; }
+        get displayBasePath() {
+            return this.application.options.getValue("displayBasePath") || this.application.options.getValue("basePath");
+        }
         /**
          * All file names to find the base path from.
          */
-        fileNames = (__runInitializers(this, _basePath_extraInitializers), new Set());
+        fileNames = (__runInitializers(this, _sourceLinkTemplate_extraInitializers), new Set());
         repositories;
         constructor(owner) {
             super(owner);
@@ -170,7 +165,7 @@ let SourcePlugin = (() => {
                 !this.gitRevision) {
                 this.application.logger.warn(i18n.disable_git_set_and_git_revision_used());
             }
-            const basePath = this.basePath || getCommonDirectory([...this.fileNames]);
+            const basePath = this.displayBasePath || getCommonDirectory([...this.fileNames]);
             this.repositories ||= new RepositoryManager(basePath, this.gitRevision, this.gitRemote, this.sourceLinkTemplate, this.disableGit, this.application.logger);
             for (const id in context.project.reflections) {
                 const refl = context.project.reflections[id];

package/dist/lib/converter/types.js

@@ -410,7 +410,7 @@ const queryConverter = {
         if (!querySymbol) {
             // This can happen if someone uses `typeof` on some property
             // on a variable typed as `any` with a name that doesn't exist.
-            return new QueryType(ReferenceType.createBrokenReference(node.exprName.getText(), context.project));
+            return new QueryType(ReferenceType.createBrokenReference(node.exprName.getText(), context.project, undefined));
         }
         const ref = context.createSymbolReference(context.resolveAliasedSymbol(querySymbol), context, node.exprName.getText());
         ref.preferValues = true;
@@ -454,7 +454,7 @@ const referenceConverter = {
         if (!symbol) {
             // This happens when we get a reference to a type parameter
             // created within a mapped type, `K` in: `{ [K in T]: string }`
-            const ref = ReferenceType.createBrokenReference(context.checker.typeToString(type), context.project);
+            const ref = ReferenceType.createBrokenReference(context.checker.typeToString(type), context.project, undefined);
             ref.refersToTypeParameter = true;
             return ref;
         }

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

@@ -45,6 +45,7 @@ module.exports = {
     at_most_one_inheritdoc_tag_expected_in_comment_at_0: "At most one @inheritDoc tag is expected in a comment, ignoring all but the first in comment at {0}",
     content_in_summary_overwritten_by_inheritdoc_in_comment_at_0: "Content in the summary section will be overwritten by the @inheritDoc tag in comment at {0}",
     content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0: "Content in the @remarks block will be overwritten by the @inheritDoc tag in comment at {0}",
+    content_in_returns_block_overwritten_by_inheritdoc_in_comment_at_0: "Content in the @returns block will be overwritten by the @inheritDoc tag in comment at {0}",
     example_tag_literal_name: "The first line of an example tag will be taken literally as the example name, and should only contain text",
     inheritdoc_tag_properly_capitalized: "The @inheritDoc tag should be properly capitalized",
     treating_unrecognized_tag_0_as_modifier: `Treating unrecognized tag {0} as a modifier tag`,
@@ -195,11 +196,12 @@ module.exports = {
     help_gitRevision: "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set",
     help_gitRemote: "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set",
     help_disableGit: "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath",
-    help_basePath: "Specifies the base path to be used when displaying file paths",
+    help_displayBasePath: "Specifies the base path to be used when displaying file paths. If not specified, basePath is used.",
     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_basePath: "Specifies a path which links may be resolved relative to.",
     help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages",
     help_favicon: "Path to favicon to include as the site icon",
     help_sourceLinkExternal: "Specifies that source links should be treated as external links to be opened in a new tab",

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

@@ -41,6 +41,7 @@ declare const _default: {
     readonly at_most_one_inheritdoc_tag_expected_in_comment_at_0: "At most one @inheritDoc tag is expected in a comment, ignoring all but the first in comment at {0}";
     readonly content_in_summary_overwritten_by_inheritdoc_in_comment_at_0: "Content in the summary section will be overwritten by the @inheritDoc tag in comment at {0}";
     readonly content_in_remarks_block_overwritten_by_inheritdoc_in_comment_at_0: "Content in the @remarks block will be overwritten by the @inheritDoc tag in comment at {0}";
+    readonly content_in_returns_block_overwritten_by_inheritdoc_in_comment_at_0: "Content in the @returns block will be overwritten by the @inheritDoc tag in comment at {0}";
     readonly example_tag_literal_name: "The first line of an example tag will be taken literally as the example name, and should only contain text";
     readonly inheritdoc_tag_properly_capitalized: "The @inheritDoc tag should be properly capitalized";
     readonly treating_unrecognized_tag_0_as_modifier: "Treating unrecognized tag {0} as a modifier tag";
@@ -182,11 +183,12 @@ declare const _default: {
     readonly help_gitRevision: "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set";
     readonly help_gitRemote: "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set";
     readonly help_disableGit: "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath";
-    readonly help_basePath: "Specifies the base path to be used when displaying file paths";
+    readonly help_displayBasePath: "Specifies the base path to be used when displaying file paths. If not specified, basePath is used.";
     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_basePath: "Specifies a path which links may be resolved relative to.";
     readonly help_cname: "Set the CNAME file text, it's useful for custom domains on GitHub Pages";
     readonly help_favicon: "Path to favicon to include as the site icon";
     readonly help_sourceLinkExternal: "Specifies that source links should be treated as external links to be opened in a new tab";

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

@@ -393,7 +393,7 @@ export declare class ReferenceType extends Type {
      * later during conversion.
      * @internal
      */
-    static createBrokenReference(name: string, project: ProjectReflection): ReferenceType;
+    static createBrokenReference(name: string, project: ProjectReflection, packageName: string | undefined): ReferenceType;
     protected getTypeString(): string;
     needsParenthesis(): boolean;
     toObject(serializer: Serializer): JSONOutput.ReferenceType;

package/dist/lib/models/types.js

@@ -833,8 +833,10 @@ let ReferenceType = (() => {
          * later during conversion.
          * @internal
          */
-        static createBrokenReference(name, project) {
-            return new ReferenceType(name, -1, project, name);
+        static createBrokenReference(name, project, packageName) {
+            const ref = new ReferenceType(name, -1, project, name);
+            ref.package = packageName;
+            return ref;
         }
         getTypeString() {
             const name = this.reflection ? this.reflection.name : this.name;

package/dist/lib/output/themes/default/partials/typeAndParent.d.ts

@@ -1,4 +1,4 @@
 import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
-import { type Type } from "../../../../models/index.js";
+import { type Type } from "#models";
 import { JSX } from "#utils";
 export declare const typeAndParent: (context: DefaultThemeRenderContext, props: Type) => JSX.Element;

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

@@ -1,4 +1,4 @@
-import { ArrayType, ReferenceType, SignatureReflection } from "../../../../models/index.js";
+import { ArrayType, ReferenceType, SignatureReflection } from "#models";
 import { JSX } from "#utils";
 export const typeAndParent = (context, props) => {
     if (props instanceof ArrayType) {
@@ -6,13 +6,23 @@ export const typeAndParent = (context, props) => {
             context.typeAndParent(props.elementType),
             "[]"));
     }
-    if (props instanceof ReferenceType && props.reflection) {
-        const refl = props.reflection instanceof SignatureReflection ? props.reflection.parent : props.reflection;
-        const parent = refl.parent;
-        return (JSX.createElement(JSX.Fragment, null,
-            JSX.createElement("a", { href: context.urlTo(parent) }, parent.name),
-            ".",
-            JSX.createElement("a", { href: context.urlTo(refl) }, refl.name)));
+    if (props instanceof ReferenceType) {
+        if (props.reflection) {
+            const refl = props.reflection instanceof SignatureReflection ? props.reflection.parent : props.reflection;
+            const parent = refl.parent;
+            return (JSX.createElement(JSX.Fragment, null,
+                JSX.createElement("a", { href: context.urlTo(parent) }, parent.name),
+                ".",
+                JSX.createElement("a", { href: context.urlTo(refl) }, refl.name)));
+        }
+        else if (props.externalUrl) {
+            if (props.externalUrl === "#") {
+                return JSX.createElement(JSX.Fragment, null, props.toString());
+            }
+            else {
+                return JSX.createElement("a", { href: props.externalUrl, class: "external", target: "_blank" }, props.name);
+            }
+        }
     }
     return JSX.createElement(JSX.Fragment, null, props.toString());
 };

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

@@ -2,6 +2,8 @@ import { type FileId, FileRegistry } from "../models/FileRegistry.js";
 import type { Deserializer, JSONOutput } from "#serialization";
 import { type NormalizedPath } from "#utils";
 export declare class ValidatingFileRegistry extends FileRegistry {
+    basePath: NormalizedPath;
+    constructor(basePath?: NormalizedPath);
     register(sourcePath: NormalizedPath, relativePath: NormalizedPath): {
         target: FileId;
         anchor: string | undefined;

package/dist/lib/utils/ValidatingFileRegistry.js

@@ -2,14 +2,29 @@ import { FileRegistry } from "../models/FileRegistry.js";
 import { i18n, NormalizedPathUtils } from "#utils";
 import { existsSync } from "fs";
 export class ValidatingFileRegistry extends FileRegistry {
+    basePath;
+    constructor(basePath = "") {
+        super();
+        this.basePath = basePath;
+    }
     register(sourcePath, relativePath) {
-        const absolute = NormalizedPathUtils.resolve(NormalizedPathUtils.dirname(sourcePath), relativePath);
-        const absoluteWithoutAnchor = absolute.replace(/#.*/, "");
+        let absolute = NormalizedPathUtils.resolve(NormalizedPathUtils.dirname(sourcePath), relativePath);
+        let absoluteWithoutAnchor = absolute.replace(/#.*/, "");
         // Note: We allow paths to directories to be registered here, but the AssetsPlugin will not
         // copy them to the output path. This is so that we can link to directories and associate them
         // with reflections in packages mode.
         if (!existsSync(absoluteWithoutAnchor)) {
-            return;
+            // If the relative path didn't exist normally, also check the path relative to the assetBasePath option
+            if (this.basePath != "") {
+                absolute = NormalizedPathUtils.resolve(this.basePath, relativePath);
+                absoluteWithoutAnchor = absolute.replace(/#.*/, "");
+                if (!existsSync(absoluteWithoutAnchor)) {
+                    return;
+                }
+            }
+            else {
+                return;
+            }
         }
         return this.registerAbsolute(absolute);
     }

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

@@ -124,7 +124,7 @@ export function getDocumentEntryPoints(logger, options) {
     // that have at some point or another been used for markdown: https://superuser.com/a/285878
     const supportedFileRegex = /\.(md|markdown)$/;
     const expanded = expandInputFiles(logger, docPaths, options, supportedFileRegex);
-    const baseDir = options.getValue("basePath") || getCommonDirectory(expanded);
+    const baseDir = options.getValue("displayBasePath") || options.getValue("basePath") || getCommonDirectory(expanded);
     return expanded.map((path) => {
         return {
             displayName: relative(baseDir, path).replace(/\.[^.]+$/, ""),
@@ -184,7 +184,8 @@ function getModuleName(fileName, baseDir) {
  * This is in contrast with the package-oriented `getEntryPointsForPackages`
  */
 function getEntryPointsForPaths(logger, inputFiles, options, programs = getEntryPrograms(inputFiles, logger, options)) {
-    const baseDir = options.getValue("basePath") || getCommonDirectory(inputFiles);
+    const baseDir = options.getValue("displayBasePath") || options.getValue("basePath") ||
+        getCommonDirectory(inputFiles);
     const entryPoints = [];
     let expandSuggestion = true;
     entryLoop: for (const fileOrDir of inputFiles.map(normalizePath)) {

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

@@ -108,6 +108,7 @@ export interface TypeDocOptionMap {
     gitRevision: string;
     gitRemote: string;
     readme: string;
+    basePath: NormalizedPath;
     outputs: ManuallyValidatedOption<Array<OutputSpecification>>;
     out: NormalizedPath;
     html: NormalizedPath;
@@ -145,7 +146,7 @@ export interface TypeDocOptionMap {
      * strictly typed here.
      */
     markdownItLoader: ManuallyValidatedOption<(parser: any) => void>;
-    basePath: NormalizedPath;
+    displayBasePath: NormalizedPath;
     cname: string;
     favicon: NormalizedPath;
     githubPages: boolean;

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

@@ -16,9 +16,7 @@ function makeTagArrayValidator(name) {
 }
 // For convenience, added in the same order as they are documented on the website.
 export function addTypeDocOptions(options) {
-    ///////////////////////////
-    // Configuration Options //
-    ///////////////////////////
+    // MARK: Configuration Options
     options.addDeclaration({
         type: ParameterType.Path,
         name: "options",
@@ -84,9 +82,7 @@ export function addTypeDocOptions(options) {
             }
         },
     });
-    ///////////////////////////
-    ////// Input Options //////
-    ///////////////////////////
+    // MARK: Input Options
     options.addDeclaration({
         name: "entryPoints",
         help: () => i18n.help_entryPoints(),
@@ -202,9 +198,17 @@ export function addTypeDocOptions(options) {
             }
         },
     });
-    ///////////////////////////
-    ///// Output Options //////
-    ///////////////////////////
+    options.addDeclaration({
+        name: "readme",
+        help: () => i18n.help_readme(),
+        type: ParameterType.Path,
+    });
+    options.addDeclaration({
+        name: "basePath",
+        help: () => i18n.help_basePath(),
+        type: ParameterType.Path,
+    });
+    // MARK: Output Options
     options.addDeclaration({
         name: "outputs",
         help: () => i18n.help_out(),
@@ -396,13 +400,8 @@ export function addTypeDocOptions(options) {
         type: ParameterType.Boolean,
     });
     options.addDeclaration({
-        name: "basePath",
-        help: () => i18n.help_basePath(),
-        type: ParameterType.Path,
-    });
-    options.addDeclaration({
-        name: "readme",
-        help: () => i18n.help_readme(),
+        name: "displayBasePath",
+        help: () => i18n.help_displayBasePath(),
         type: ParameterType.Path,
     });
     options.addDeclaration({
@@ -622,9 +621,7 @@ export function addTypeDocOptions(options) {
         help: () => i18n.help_useFirstParagraphOfCommentAsSummary(),
         type: ParameterType.Boolean,
     });
-    ///////////////////////////
-    ///// Comment Options /////
-    ///////////////////////////
+    // MARK: Comment Options
     options.addDeclaration({
         name: "jsDocCompatibility",
         help: () => i18n.help_jsDocCompatibility(),
@@ -703,9 +700,7 @@ export function addTypeDocOptions(options) {
         defaultValue: OptionDefaults.cascadedModifierTags,
         validate: makeTagArrayValidator("cascadedModifierTags"),
     });
-    ///////////////////////////
-    // Organization Options ///
-    ///////////////////////////
+    // MARK: Organization Options
     options.addDeclaration({
         name: "categorizeByGroup",
         help: () => i18n.help_categorizeByGroup(),
@@ -764,9 +759,7 @@ export function addTypeDocOptions(options) {
             }
         },
     });
-    ///////////////////////////
-    ///// General Options /////
-    ///////////////////////////
+    // MARK: General Options
     options.addDeclaration({
         name: "watch",
         help: () => i18n.help_watch(),

package/package.json

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