typedoc 0.24.7 → 0.25.0

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

@@ -21,7 +21,7 @@ function sidebarLinks(context) {
     const links = Object.entries(context.options.getValue("sidebarLinks"));
     if (!links.length)
         return null;
-    return (utils_1.JSX.createElement("nav", { id: "tsd-sidebar-links", class: "tsd-navigation" }, links.map(([label, url]) => (utils_1.JSX.createElement("a", { href: url, target: "_blank" }, label)))));
+    return (utils_1.JSX.createElement("nav", { id: "tsd-sidebar-links", class: "tsd-navigation" }, links.map(([label, url]) => (utils_1.JSX.createElement("a", { href: url }, label)))));
 }
 exports.sidebarLinks = sidebarLinks;
 function settings(context) {
@@ -62,46 +62,59 @@ function settings(context) {
                         utils_1.JSX.createElement("option", { value: "dark" }, "Dark")))))));
 }
 exports.settings = settings;
-function getNavigationElements(parent, opts) {
+function shouldShowCategories(reflection, opts) {
+    if (opts.includeCategories) {
+        return !reflection.comment?.hasModifier("@hideCategories");
+    }
+    return reflection.comment?.hasModifier("@showCategories") === true;
+}
+function shouldShowGroups(reflection, opts) {
+    if (opts.includeGroups) {
+        return !reflection.comment?.hasModifier("@hideGroups");
+    }
+    return reflection.comment?.hasModifier("@showGroups") === true;
+}
+const getNavigationElements = function getNavigationElements(parent, opts) {
     if (parent instanceof models_1.ReflectionCategory) {
         return parent.children;
     }
     if (parent instanceof models_1.ReflectionGroup) {
-        if (opts.includeCategories && parent.categories) {
+        if (shouldShowCategories(parent.owningReflection, opts) && parent.categories) {
             return parent.categories;
         }
         return parent.children;
     }
     if (!parent.kindOf(models_1.ReflectionKind.SomeModule | models_1.ReflectionKind.Project)) {
-        return [];
+        return;
     }
-    if (parent.categories && opts.includeCategories) {
+    if (parent.categories && shouldShowCategories(parent, opts)) {
         return parent.categories;
     }
-    if (parent.groups && opts.includeGroups) {
+    if (parent.groups && shouldShowGroups(parent, opts)) {
         return parent.groups;
     }
-    return parent.children || [];
-}
-function navigation(context, props) {
+    return parent.children;
+};
+const navigation = function navigation(context, props) {
     const opts = context.options.getValue("navigation");
     // Create the navigation for the current page
     // Recurse to children if the parent is some kind of module
     return (utils_1.JSX.createElement("nav", { class: "tsd-navigation" },
         createNavElement(props.project),
-        utils_1.JSX.createElement("ul", { class: "tsd-small-nested-navigation" }, getNavigationElements(props.project, opts).map((c) => (utils_1.JSX.createElement("li", null, links(c, [])))))));
+        utils_1.JSX.createElement("ul", { class: "tsd-small-nested-navigation" }, getNavigationElements(props.project, opts)?.map((c) => utils_1.JSX.createElement("li", null, links(c, []))))));
     function links(mod, parents) {
-        const nameClasses = (0, lib_1.classNames)({ deprecated: mod instanceof models_1.Reflection && mod.isDeprecated() }, !(mod instanceof models_1.Reflection) || mod.isProject() ? void 0 : context.getReflectionClasses(mod));
+        const nameClasses = (0, lib_1.classNames)({ deprecated: mod instanceof models_1.Reflection && mod.isDeprecated() }, mod instanceof models_1.DeclarationReflection ? context.getReflectionClasses(mod) : void 0);
         const children = getNavigationElements(mod, opts);
-        if (!children.length) {
+        if (!children || (!opts.fullTree && mod instanceof models_1.Reflection && !inPath(mod))) {
             return createNavElement(mod, nameClasses);
         }
-        return (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-index-accordion": true }, nameClasses), open: mod instanceof models_1.Reflection && inPath(mod), "data-key": mod instanceof models_1.Reflection ? mod.getFullName() : [...parents, mod.title].join("$") },
+        const childParents = mod instanceof models_1.Reflection ? [mod.getFullName()] : [...parents, mod.title];
+        return (utils_1.JSX.createElement("details", { class: (0, lib_1.classNames)({ "tsd-index-accordion": true }, nameClasses), open: mod instanceof models_1.Reflection && inPath(mod), "data-key": childParents.join("$") },
             utils_1.JSX.createElement("summary", { class: "tsd-accordion-summary" },
                 context.icons.chevronDown(),
                 createNavElement(mod)),
             utils_1.JSX.createElement("div", { class: "tsd-accordion-details" },
-                utils_1.JSX.createElement("ul", { class: "tsd-nested-navigation" }, children.map((c) => (utils_1.JSX.createElement("li", null, links(c, mod instanceof models_1.Reflection ? [mod.getFullName()] : [...parents, mod.title]))))))));
+                utils_1.JSX.createElement("ul", { class: "tsd-nested-navigation" }, children.map((c) => (utils_1.JSX.createElement("li", null, links(c, childParents))))))));
     }
     function createNavElement(child, nameClasses) {
         if (child instanceof models_1.Reflection) {
@@ -120,7 +133,7 @@ function navigation(context, props) {
         } while (iter);
         return false;
     }
-}
+};
 exports.navigation = navigation;
 function pageSidebar(context, props) {
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,

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

@@ -25,7 +25,8 @@ const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fra
                         context.type(item.type)))),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "]: "),
                     context.type(props.indexSignature.type)),
-                context.comment(props.indexSignature),
+                context.commentSummary(props.indexSignature),
+                context.commentTags(props.indexSignature),
                 props.indexSignature.type instanceof models_1.ReflectionType &&
                     context.parameter(props.indexSignature.type.declaration)))),
         props.children?.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, item.signatures ? (utils_1.JSX.createElement("li", { class: "tsd-parameter" },
@@ -39,29 +40,31 @@ const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fra
             context.memberSignatures(item))) : item.type ? (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             utils_1.JSX.createElement("li", { class: "tsd-parameter" },
                 utils_1.JSX.createElement("h5", null,
-                    (0, lib_1.renderFlags)(item.flags, item.comment),
+                    context.reflectionFlags(item),
                     !!item.flags.isRest && utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
                     utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, (0, lib_1.wbr)(item.name)),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" },
                         !!item.flags.isOptional && "?",
                         ": "),
                     context.type(item.type)),
-                context.comment(item),
+                context.commentSummary(item),
+                context.commentTags(item),
                 !!item.children && context.parameter(item),
                 item.type instanceof models_1.ReflectionType && context.parameter(item.type.declaration)))) : (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
             item.getSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 utils_1.JSX.createElement("li", { class: "tsd-parameter" },
                     utils_1.JSX.createElement("h5", null,
-                        (0, lib_1.renderFlags)(item.getSignature.flags, item.getSignature.comment),
+                        context.reflectionFlags(item.getSignature),
                         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "get "),
                         utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, (0, lib_1.wbr)(item.name)),
                         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "(): "),
                         context.type(item.getSignature.type)),
-                    context.comment(item.getSignature)))),
+                    context.commentSummary(item.getSignature),
+                    context.commentTags(item.getSignature)))),
             item.setSignature && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                 utils_1.JSX.createElement("li", { class: "tsd-parameter" },
                     utils_1.JSX.createElement("h5", null,
-                        (0, lib_1.renderFlags)(item.setSignature.flags, item.setSignature.comment),
+                        context.reflectionFlags(item.setSignature),
                         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "set "),
                         utils_1.JSX.createElement("span", { class: (0, lib_1.getKindClass)(item) }, (0, lib_1.wbr)(item.name)),
                         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
@@ -71,5 +74,6 @@ const parameter = (context, props) => (utils_1.JSX.createElement(utils_1.JSX.Fra
                             context.type(item.type)))),
                         utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "): "),
                         context.type(item.setSignature.type)),
-                    context.comment(item.setSignature))))))))))));
+                    context.commentSummary(item.setSignature),
+                    context.commentTags(item.setSignature))))))))))));
 exports.parameter = parameter;

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

@@ -17,6 +17,7 @@ function typeParameters(context, typeParameters) {
                     !!item.default && (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
                         " = ",
                         context.type(item.default)))),
-                context.comment(item))))))));
+                context.commentSummary(item),
+                context.commentTags(item))))))));
 }
 exports.typeParameters = typeParameters;

package/dist/lib/output/themes/default/templates/reflection.js

@@ -10,7 +10,9 @@ function reflectionTemplate(context, props) {
         return context.memberDeclaration(props.model);
     }
     return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        props.model.hasComment() && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-comment" }, context.comment(props.model))),
+        props.model.hasComment() && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-comment" },
+            context.commentSummary(props.model),
+            context.commentTags(props.model))),
         props.model instanceof models_1.DeclarationReflection &&
             props.model.kind === models_1.ReflectionKind.Module &&
             props.model.readme?.length && (utils_1.JSX.createElement("section", { class: "tsd-panel tsd-typography" },
@@ -38,7 +40,8 @@ function reflectionTemplate(context, props) {
                         context.type(item.type)))),
                     utils_1.JSX.createElement("span", { class: "tsd-signature-symbol" }, "]: "),
                     context.type(props.model.indexSignature.type)),
-                context.comment(props.model.indexSignature),
+                context.commentSummary(props.model.indexSignature),
+                context.commentTags(props.model.indexSignature),
                 props.model.indexSignature?.type instanceof models_1.ReflectionType &&
                     context.parameter(props.model.indexSignature.type.declaration))),
             !props.model.signatures && context.memberSources(props.model))),

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

@@ -1,5 +1,5 @@
 import type { DefaultThemeRenderContext } from "..";
-import { Comment, Reflection, ReflectionFlags, TypeParameterReflection } from "../../models";
+import { Reflection, TypeParameterReflection } from "../../models";
 import { JSX } from "../../utils";
 export declare function stringify(data: unknown): string;
 export declare function getDisplayName(refl: Reflection): string;
@@ -15,7 +15,6 @@ export declare function getKindClass(refl: Reflection): string;
  */
 export declare function wbr(str: string): (string | JSX.Element)[];
 export declare function join<T>(joiner: JSX.Children, list: readonly T[], cb: (x: T) => JSX.Children): JSX.Element;
-export declare function renderFlags(flags: ReflectionFlags, comment: Comment | undefined): JSX.Element;
 export declare function classNames(names: Record<string, boolean | null | undefined>, extraCss?: string): string | undefined;
 export declare function hasTypeParameters(reflection: Reflection): reflection is Reflection & {
     typeParameters: TypeParameterReflection[];

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderName = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.renderFlags = exports.join = exports.wbr = exports.getKindClass = exports.toStyleClass = exports.getDisplayName = exports.stringify = void 0;
+exports.renderName = exports.camelToTitleCase = exports.renderTypeParametersSignature = exports.hasTypeParameters = exports.classNames = exports.join = exports.wbr = exports.getKindClass = exports.toStyleClass = exports.getDisplayName = exports.stringify = void 0;
 const models_1 = require("../../models");
 const utils_1 = require("../../utils");
 function stringify(data) {
@@ -62,16 +62,6 @@ function join(joiner, list, cb) {
     return utils_1.JSX.createElement(utils_1.JSX.Fragment, null, result);
 }
 exports.join = join;
-function renderFlags(flags, comment) {
-    const allFlags = [...flags];
-    if (comment) {
-        allFlags.push(...Array.from(comment.modifierTags, (tag) => tag.replace(/@([a-z])/, (x) => x[1].toUpperCase())));
-    }
-    return (utils_1.JSX.createElement(utils_1.JSX.Fragment, null, allFlags.map((item) => (utils_1.JSX.createElement(utils_1.JSX.Fragment, null,
-        utils_1.JSX.createElement("code", { class: "tsd-tag ts-flag" + item }, item),
-        " ")))));
-}
-exports.renderFlags = renderFlags;
 function classNames(names, extraCss) {
     const css = Object.keys(names)
         .filter((key) => names[key])

package/dist/lib/serialization/schema.d.ts

@@ -57,9 +57,11 @@ export interface ReflectionGroup extends S<M.ReflectionGroup, "title" | "categor
 export interface ReflectionCategory extends S<M.ReflectionCategory, "title"> {
     children?: M.ReflectionCategory["children"][number]["id"][];
 }
+/** @category Reflections */
 export type SomeReflection = {
     [K in keyof M.ReflectionVariant]: ModelToObject<M.ReflectionVariant[K]>;
 }[keyof M.ReflectionVariant];
+/** @category Reflections */
 export interface ReferenceReflection extends Omit<DeclarationReflection, "variant">, S<M.ReferenceReflection, "variant"> {
     /**
      * -1 if the reference refers to a symbol that does not exist in the documentation.
@@ -67,25 +69,34 @@ export interface ReferenceReflection extends Omit<DeclarationReflection, "varian
      */
     target: number;
 }
+/** @category Reflections */
 export interface SignatureReflection extends Omit<Reflection, "variant">, S<M.SignatureReflection, "variant" | "sources" | "parameters" | "type" | "overwrites" | "inheritedFrom" | "implementationOf"> {
     typeParameter?: ModelToObject<M.SignatureReflection["typeParameters"]>;
 }
+/** @category Reflections */
 export interface ParameterReflection extends Omit<Reflection, "variant">, S<M.ParameterReflection, "variant" | "type" | "defaultValue"> {
     variant: "param";
 }
+/** @category Reflections */
 export interface DeclarationReflection extends Omit<ContainerReflection, "variant">, S<M.DeclarationReflection, "variant" | "packageVersion" | "sources" | "relevanceBoost" | "type" | "signatures" | "indexSignature" | "defaultValue" | "overwrites" | "inheritedFrom" | "implementationOf" | "extendedTypes" | "extendedBy" | "implementedTypes" | "implementedBy" | "getSignature" | "setSignature" | "typeParameters"> {
 }
+/** @category Reflections */
 export interface TypeParameterReflection extends Omit<Reflection, "variant">, S<M.TypeParameterReflection, "variant" | "type" | "default" | "varianceModifier"> {
 }
+/** @category Reflections */
 export interface ProjectReflection extends Omit<ContainerReflection, "variant">, S<M.ProjectReflection, "variant" | "packageName" | "packageVersion" | "readme"> {
     symbolIdMap: Record<number, ReflectionSymbolId>;
 }
+/** @category Reflections */
 export interface ContainerReflection extends Reflection, S<M.ContainerReflection, "children" | "groups" | "categories"> {
 }
+/** @category Reflections */
 export interface Reflection extends S<M.Reflection, "id" | "variant" | "name" | "kind" | "comment"> {
     flags: ReflectionFlags;
 }
+/** @category Types */
 export type SomeType = ModelToObject<M.SomeType>;
+/** @category Types */
 export type TypeKindMap = {
     array: ArrayType;
     conditional: ConditionalType;
@@ -108,51 +119,72 @@ export type TypeKindMap = {
     union: UnionType;
     unknown: UnknownType;
 };
+/** @category Types */
 export interface ArrayType extends Type, S<M.ArrayType, "type" | "elementType"> {
 }
+/** @category Types */
 export interface ConditionalType extends Type, S<M.ConditionalType, "type" | "checkType" | "extendsType" | "trueType" | "falseType"> {
 }
+/** @category Types */
 export interface IndexedAccessType extends Type, S<M.IndexedAccessType, "type" | "indexType" | "objectType"> {
 }
+/** @category Types */
 export interface InferredType extends Type, S<M.InferredType, "type" | "name" | "constraint"> {
 }
+/** @category Types */
 export interface IntersectionType extends Type, S<M.IntersectionType, "type" | "types"> {
 }
+/** @category Types */
 export interface IntrinsicType extends Type, S<M.IntrinsicType, "type" | "name"> {
 }
+/** @category Types */
 export interface OptionalType extends Type, S<M.OptionalType, "type" | "elementType"> {
 }
+/** @category Types */
 export interface PredicateType extends Type, S<M.PredicateType, "type" | "name" | "asserts" | "targetType"> {
 }
+/** @category Types */
 export interface QueryType extends Type, S<M.QueryType, "type" | "queryType"> {
 }
+/** @category Types */
 export interface ReferenceType extends Type, S<M.ReferenceType, "type" | "name" | "typeArguments" | "package" | "externalUrl"> {
     target: number | ReflectionSymbolId;
     qualifiedName?: string;
     refersToTypeParameter?: boolean;
 }
+/** @category Types */
 export interface ReflectionType extends Type, S<M.ReflectionType, "type" | "declaration"> {
 }
+/** @category Types */
 export interface RestType extends Type, S<M.RestType, "type" | "elementType"> {
 }
+/** @category Types */
 export interface LiteralType extends Type, S<M.LiteralType, "type" | "value"> {
 }
+/** @category Types */
 export interface TupleType extends Type, S<M.TupleType, "type"> {
     elements?: ModelToObject<M.TupleType["elements"]>;
 }
+/** @category Types */
 export interface NamedTupleMemberType extends Type, S<M.NamedTupleMember, "type" | "name" | "isOptional" | "element"> {
 }
+/** @category Types */
 export interface TemplateLiteralType extends Type, S<M.TemplateLiteralType, "type" | "head"> {
     tail: [SomeType, string][];
 }
+/** @category Types */
 export interface MappedType extends Type, S<M.MappedType, "type" | "parameter" | "parameterType" | "templateType" | "readonlyModifier" | "optionalModifier" | "nameType"> {
 }
+/** @category Types */
 export interface TypeOperatorType extends Type, S<M.TypeOperatorType, "type" | "operator" | "target"> {
 }
+/** @category Types */
 export interface UnionType extends Type, S<M.UnionType, "type" | "types"> {
 }
+/** @category Types */
 export interface UnknownType extends Type, S<M.UnknownType, "type" | "name"> {
 }
+/** @category Types */
 export interface Type {
 }
 type BoolKeys<T> = {
@@ -160,13 +192,16 @@ type BoolKeys<T> = {
 }[keyof T];
 export interface ReflectionFlags extends Partial<S<M.ReflectionFlags, BoolKeys<M.ReflectionFlags>>> {
 }
+/** @category Comments */
 export interface Comment extends Partial<S<M.Comment, "blockTags" | "label">> {
     summary: CommentDisplayPart[];
-    modifierTags?: string[];
+    modifierTags?: `@${string}`[];
 }
+/** @category Comments */
 export interface CommentTag extends S<M.CommentTag, "tag" | "name"> {
     content: CommentDisplayPart[];
 }
+/** @category Comments */
 export type CommentDisplayPart = {
     kind: "text";
     text: string;
@@ -177,6 +212,7 @@ export type CommentDisplayPart = {
 /**
  * If `target` is a number, it is a reflection ID. If a string, it is a URL.
  * `target` will only be set for `@link`, `@linkcode`, and `@linkplain` tags.
+ * @category Comments
  */
 export interface InlineTagDisplayPart {
     kind: "inline-tag";

package/dist/lib/serialization/serializer.js

@@ -41,6 +41,7 @@ class Serializer extends utils_1.EventDispatcher {
         return project;
     }
 }
+exports.Serializer = Serializer;
 /**
  * Triggered when the {@link Serializer} begins transforming a project.
  * @event EVENT_BEGIN
@@ -51,4 +52,3 @@ Serializer.EVENT_BEGIN = "begin";
  * @event EVENT_END
  */
 Serializer.EVENT_END = "end";
-exports.Serializer = Serializer;

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

@@ -43,7 +43,7 @@ export declare abstract class AbstractComponent<O extends ComponentHost> extends
      */
     private _componentOwner;
     /**
-     * The name of this component as set by the @Component decorator.
+     * The name of this component as set by the `@Component` decorator.
      */
     componentName: string;
     /**

package/dist/lib/utils/component.js

@@ -49,9 +49,9 @@ class ComponentEvent extends events_1.Event {
         this.component = component;
     }
 }
+exports.ComponentEvent = ComponentEvent;
 ComponentEvent.ADDED = "componentAdded";
 ComponentEvent.REMOVED = "componentRemoved";
-exports.ComponentEvent = ComponentEvent;
 /**
  * Component base class.  Has an owner (unless it's the application root component),
  * can dispatch events to its children, and has access to the root Application component.

package/dist/lib/utils/entry-point.d.ts

@@ -21,12 +21,6 @@ export declare const EntryPointStrategy: {
      * use the merge option to produce final output.
      */
     readonly Packages: "packages";
-    /**
-     * Will be removed in 0.25, this was called packages mode in 0.24.
-     * Alternative resolution mode useful for monorepos. With this mode, TypeDoc will look for a package.json
-     * and tsconfig.json under each provided entry point. The `main` field of each package will be documented.
-     */
-    readonly LegacyPackages: "legacy-packages";
     /**
      * Merges multiple previously generated output from TypeDoc's --json output together into a single project.
      */

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

@@ -30,7 +30,6 @@ exports.getExpandedEntryPointsForPaths = exports.getPackageDirectories = exports
 const path_1 = require("path");
 const typescript_1 = __importDefault(require("typescript"));
 const FS = __importStar(require("fs"));
-const Path = __importStar(require("path"));
 const package_manifest_1 = require("./package-manifest");
 const paths_1 = require("./paths");
 const fs_1 = require("./fs");
@@ -55,12 +54,6 @@ exports.EntryPointStrategy = {
      * use the merge option to produce final output.
      */
     Packages: "packages",
-    /**
-     * Will be removed in 0.25, this was called packages mode in 0.24.
-     * Alternative resolution mode useful for monorepos. With this mode, TypeDoc will look for a package.json
-     * and tsconfig.json under each provided entry point. The `main` field of each package will be documented.
-     */
-    LegacyPackages: "legacy-packages",
     /**
      * Merges multiple previously generated output from TypeDoc's --json output together into a single project.
      */
@@ -86,9 +79,6 @@ function getEntryPoints(logger, options) {
         case exports.EntryPointStrategy.Expand:
             result = getExpandedEntryPointsForPaths(logger, expandGlobs(entryPoints, logger), options);
             break;
-        case exports.EntryPointStrategy.LegacyPackages:
-            result = getEntryPointsForLegacyPackages(logger, entryPoints, options);
-            break;
         case exports.EntryPointStrategy.Merge:
         case exports.EntryPointStrategy.Packages:
             // Doesn't really have entry points in the traditional way of how TypeDoc has dealt with them.
@@ -268,92 +258,3 @@ function expandInputFiles(logger, entryPoints, options) {
     });
     return files;
 }
-/**
- * Expand the provided packages configuration paths, determining the entry points
- * and creating the ts.Programs for any which are found.
- * @param logger
- * @param packageGlobPaths
- * @returns The information about the discovered programs, undefined if an error occurs.
- */
-function getEntryPointsForLegacyPackages(logger, packageGlobPaths, options) {
-    const results = [];
-    for (const packagePath of getPackageDirectories(logger, options, packageGlobPaths)) {
-        const packageJsonPath = (0, path_1.resolve)(packagePath, "package.json");
-        const packageJson = (0, package_manifest_1.loadPackageManifest)(logger, packageJsonPath);
-        const includeVersion = options.getValue("includeVersion");
-        const typedocPackageConfig = packageJson
-            ? (0, package_manifest_1.extractTypedocConfigFromPackageManifest)(logger, packageJsonPath)
-            : undefined;
-        if (packageJson === undefined) {
-            logger.error(`Could not load package manifest ${packageJsonPath}`);
-            return;
-        }
-        const packageEntryPoint = (0, package_manifest_1.getTsEntryPointForPackage)(logger, packageJsonPath, packageJson);
-        if (packageEntryPoint === undefined) {
-            logger.error(`Could not determine TS entry point for package ${packageJsonPath}`);
-            return;
-        }
-        if (packageEntryPoint === package_manifest_1.ignorePackage) {
-            continue;
-        }
-        const tsconfigFile = typescript_1.default.findConfigFile(packageEntryPoint, typescript_1.default.sys.fileExists, typedocPackageConfig?.tsconfig);
-        if (tsconfigFile === undefined) {
-            logger.error(`Could not determine tsconfig.json for source file ${packageEntryPoint} (it must be on an ancestor path)`);
-            return;
-        }
-        // Consider deduplicating this with similar code in src/lib/utils/options/readers/tsconfig.ts
-        let fatalError = false;
-        const parsedCommandLine = typescript_1.default.getParsedCommandLineOfConfigFile(tsconfigFile, {}, {
-            ...typescript_1.default.sys,
-            onUnRecoverableConfigFileDiagnostic: (error) => {
-                logger.diagnostic(error);
-                fatalError = true;
-            },
-        });
-        if (!parsedCommandLine) {
-            return;
-        }
-        logger.diagnostics(parsedCommandLine.errors);
-        if (fatalError) {
-            return;
-        }
-        const program = typescript_1.default.createProgram({
-            rootNames: parsedCommandLine.fileNames,
-            options: options.fixCompilerOptions(parsedCommandLine.options),
-            projectReferences: parsedCommandLine.projectReferences,
-        });
-        const sourceFile = program.getSourceFile(packageEntryPoint);
-        if (sourceFile === undefined) {
-            logger.error(`Entry point "${packageEntryPoint}" does not appear to be built by/included in the tsconfig found at "${tsconfigFile}"`);
-            return;
-        }
-        const packageName = packageJson["name"];
-        results.push({
-            displayName: typedocPackageConfig?.displayName ?? packageName,
-            version: includeVersion
-                ? packageJson["version"]?.replace(/^v/, "")
-                : void 0,
-            readmeFile: discoverReadmeFile(logger, Path.join(packageJsonPath, ".."), typedocPackageConfig?.readmeFile),
-            program,
-            sourceFile,
-        });
-    }
-    return results;
-}
-function discoverReadmeFile(logger, packageDir, userReadme) {
-    if (userReadme?.endsWith("none")) {
-        return;
-    }
-    if (userReadme) {
-        if (!FS.existsSync(Path.join(packageDir, userReadme))) {
-            logger.warn(`Failed to find ${userReadme} in ${(0, paths_1.nicePath)(packageDir)}`);
-            return;
-        }
-        return Path.resolve(Path.join(packageDir, userReadme));
-    }
-    for (const file of FS.readdirSync(packageDir)) {
-        if (file.toLowerCase() === "readme.md") {
-            return Path.resolve(Path.join(packageDir, file));
-        }
-    }
-}

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

@@ -41,4 +41,7 @@ export declare namespace JSX {
  * @param children
  */
 export declare function createElement(tag: typeof Fragment | string | JsxComponent<any>, props: object | null, ...children: JsxChildren[]): JsxElement;
-export declare function renderElement(element: JsxElement | null | undefined): string;
+export declare function setRenderSettings(options: {
+    pretty: boolean;
+}): void;
+export declare const renderElement: (element: JsxElement | null | undefined) => string;