-**TSDoc Reference:** [@packageDocumentation](https://tsdoc.org/pages/tags/packageDocumentation/) +**TSDoc Reference:** [@packageDocumentation](https://tsdoc.org/pages/tags/packagedocumentation/) The `@packageDocumentation` tag is used to mark a comment as referring to a file rather than the declaration following it. The TypeDoc specific [`@module`](module.md) tag can be used for the same purpose when semantically clearer. diff --git a/site/tags/param.md b/site/tags/param.md index 1a074f162..d98216e9b 100644 --- a/site/tags/param.md +++ b/site/tags/param.md @@ -2,7 +2,7 @@ title: "@param" --- -# @param +# @param and @this **Tag Kind:** [Block](../tags.md#block-tags)
**TSDoc Reference:** [@param](https://tsdoc.org/pages/tags/param/) @@ -54,6 +54,21 @@ export function configure({ value }: { value: string }) {} export function configure(options: { value: string }) {} ``` +## `this` Parameters + +Functions which use `this` in JavaScript files may use TypeScript's `@this` tag to define the type of their `this` +parameter. TypeDoc will check for `@this` tags and use their content in the description of the `this` parameter. + +```js +/** + * @this {Request} parameter description for `this` + * @param {Response} response parameter description for `response` + */ +export function hello(response) { + response.write(`Hello ${this.query.name || "world!"}`); +} +``` + ## TSDoc Compatibility The TSDoc standard requires that the `@param` tag _not_ include types and that diff --git a/site/tags/primaryExport.md b/site/tags/primaryExport.md index ab3533632..c1a5b13f4 100644 --- a/site/tags/primaryExport.md +++ b/site/tags/primaryExport.md @@ -1,8 +1,8 @@ --- -title: "@primaryModifier" +title: "@primaryExport" --- -# @primaryModifier +# @primaryExport **Tag Kind:** [Modifier](../tags.md#modifier-tags) diff --git a/site/tags/sortStrategy.md b/site/tags/sortStrategy.md new file mode 100644 index 000000000..c795c08e0 --- /dev/null +++ b/site/tags/sortStrategy.md @@ -0,0 +1,34 @@ +--- +title: "@sortStrategy" +--- + +# @sortStrategy + +**Tag Kind:** [Block](../tags.md#block-tags)
+ +This tag can be used to override the [sort](../options/organization.md#sort) locally +for a module, namespace, class, or interface. The override will be applied to direct +children of the declaration it appears on. If the declaration has a child which contains +children (e.g. a nested namespace) the grandchildren will _not_ be sorted according +to the `@sortStrategy` tag. + +## Example + +This class makes the most sense if the documentation is reviewed in the source order +rather than being sorted alphabetically. + +```ts +/** + * @sortStrategy source-order + */ +export class Class { + commonMethod(): void; + commonMethod2(): void; + lessCommonMethod(): void; + uncommonMethod(): void; +} +``` + +## See Also + +- The [`--sort`](../options/organization.md#sort) option diff --git a/site/typedoc.config.jsonc b/site/typedoc.config.jsonc index 48f0b91ae..ab9eca333 100644 --- a/site/typedoc.config.jsonc +++ b/site/typedoc.config.jsonc @@ -1,6 +1,7 @@ { "$schema": "https://typedoc.org/schema.json", "logLevel": "Verbose", + "treatWarningsAsErrors": true, "entryPointStrategy": "merge", "entryPoints": [], diff --git a/src/index.ts b/src/index.ts index 88fb52d87..aefdf11bc 100644 --- a/src/index.ts +++ b/src/index.ts @@ -139,7 +139,9 @@ export { MinimalSourceFile, type NormalizedPath, type NormalizedPathOrModule, + type NormalizedPathOrModuleOrFunction, type SymbolReference, + type TagString, type TranslatedString, translateTagName, } from "#utils"; diff --git a/src/lib/application.ts b/src/lib/application.ts index 779b3310a..75b5cd214 100644 --- a/src/lib/application.ts +++ b/src/lib/application.ts @@ -43,7 +43,6 @@ import { Outputs } from "./output/output.js"; import { validateMergeModuleWith } from "./validation/unusedMergeModuleWith.js"; import { diagnostic, diagnostics } from "./utils/loggers.js"; import { ValidatingFileRegistry } from "./utils/ValidatingFileRegistry.js"; -import { addInferredDeclarationMapPaths } from "./converter/factories/symbol-id.js"; import { Internationalization } from "./internationalization/internationalization.js"; const packageInfo = JSON.parse( @@ -149,6 +148,10 @@ export class Application extends AbstractComponent< 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: FileRegistry = new ValidatingFileRegistry(); /** @internal */ @@ -274,6 +277,10 @@ export class Application extends AbstractComponent< 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"), @@ -497,7 +504,7 @@ export class Application extends AbstractComponent< ); } - if (Object.keys(this.options.getCompilerOptions()).length === 0) { + if (Object.keys(this.options.getCompilerOptions(this.logger)).length === 0) { this.logger.warn(i18n.no_compiler_options_set()); } @@ -526,7 +533,7 @@ export class Application extends AbstractComponent< const host = ts.createWatchCompilerHost( tsconfigFile, - this.options.fixCompilerOptions({}), + this.options.fixCompilerOptions({}, this.logger), ts.sys, ts.createEmitAndSemanticDiagnosticsBuilderProgram, (d) => diagnostic(this.logger, d), @@ -822,18 +829,13 @@ export class Application extends AbstractComponent< continue; } - addInferredDeclarationMapPaths( - opts.getCompilerOptions(), - opts.getFileNames(), - ); - projectsToConvert.push({ dir, options: opts }); } 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); diff --git a/src/lib/cli.ts b/src/lib/cli.ts index d45f4b006..75c3abf7e 100644 --- a/src/lib/cli.ts +++ b/src/lib/cli.ts @@ -26,7 +26,7 @@ async function main() { new td.TypeDocReader(), new td.PackageJsonReader(), new td.TSConfigReader(), - new td.ArgumentsReader(300), + new td.ArgumentsReader(300).ignoreErrors(), ]); const exitCode = await run(app); diff --git a/src/lib/converter/comments/blockLexer.ts b/src/lib/converter/comments/blockLexer.ts index 7bd0bb5af..dae38840f 100644 --- a/src/lib/converter/comments/blockLexer.ts +++ b/src/lib/converter/comments/blockLexer.ts @@ -1,12 +1,15 @@ import ts from "typescript"; import { type Token, TokenSyntaxKind } from "./lexer.js"; import { resolveAliasedSymbol } from "../utils/symbols.js"; -import { createSymbolId } from "../factories/symbol-id.js"; +import type { Context } from "../context.js"; export function* lexBlockComment( file: string, pos = 0, end = file.length, + createSymbolId: Context["createSymbolId"] = () => { + throw new Error("unreachable"); + }, jsDoc: ts.JSDoc | undefined = undefined, checker: ts.TypeChecker | undefined = undefined, ): Generator
+
+
+ );
+ });
+
return (
<>
{beforeTags}
- + {name} + {anchorIcon(context, anchor)} +
+ {item.typeAnnotation && {item.typeAnnotation}} +
+ {tagsContents}
+
+ )}
{afterTags}
);
diff --git a/src/lib/output/themes/default/partials/icon.tsx b/src/lib/output/themes/default/partials/icon.tsx
index 27a415cbe..91ce4875d 100644
--- a/src/lib/output/themes/default/partials/icon.tsx
+++ b/src/lib/output/themes/default/partials/icon.tsx
@@ -61,6 +61,7 @@ export interface Icons extends Record
- {context.icons.chevronSmall()}
+ {context.icons.chevronDown()}
{i18n.theme_index()}
diff --git a/src/lib/output/themes/default/partials/member.declaration.tsx b/src/lib/output/themes/default/partials/member.declaration.tsx
index 4086ebcb8..510caa883 100644
--- a/src/lib/output/themes/default/partials/member.declaration.tsx
+++ b/src/lib/output/themes/default/partials/member.declaration.tsx
@@ -1,9 +1,28 @@
-import type { DeclarationReflection } from "../../../../models/index.js";
+import type { DeclarationReflection } from "#models";
import { JSX } from "#utils";
import { FormattedCodeBuilder, FormattedCodeGenerator, type FormatterNode, Wrap } from "../../../formatter.js";
import { hasTypeParameters } from "../../lib.js";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
+function shouldRenderDefaultValue(props: DeclarationReflection) {
+ const defaultValue = props.defaultValue;
+
+ if (defaultValue === undefined) {
+ return false;
+ }
+
+ /** Fix for #2717. If type is the same as value the default value is omitted */
+ if (props.type && props.type.type === "literal") {
+ const reflectionTypeString = props.type.toString();
+
+ if (reflectionTypeString === defaultValue) {
+ return false;
+ }
+ }
+
+ return true;
+}
+
export function memberDeclaration(context: DefaultThemeRenderContext, props: DeclarationReflection) {
const builder = new FormattedCodeBuilder(context.router, context.model);
const content: FormatterNode[] = [];
@@ -11,31 +30,15 @@ export function memberDeclaration(context: DefaultThemeRenderContext, props: Dec
const generator = new FormattedCodeGenerator(context.options.getValue("typePrintWidth"));
generator.node({ type: "nodes", content }, Wrap.Detect);
- /** Fix for #2717. If type is the same as value the default value is omitted */
- function shouldRenderDefaultValue() {
- if (props.type && props.type.type === "literal") {
- const reflectionTypeString = props.type.toString();
-
- const defaultValue = props.defaultValue;
-
- if (defaultValue === undefined || reflectionTypeString === defaultValue.toString()) {
- return false;
- }
- }
- return true;
- }
-
return (
<>
{generator.toElement()}
- {!!props.defaultValue && shouldRenderDefaultValue() && (
- <>
-
- {" = "}
- {props.defaultValue}
-
-
+ {shouldRenderDefaultValue(props) && (
+
+ {" = "}
+ {props.defaultValue}
+
)}
diff --git a/src/lib/output/themes/default/partials/member.signature.body.tsx b/src/lib/output/themes/default/partials/member.signature.body.tsx
index f22486924..627721300 100644
--- a/src/lib/output/themes/default/partials/member.signature.body.tsx
+++ b/src/lib/output/themes/default/partials/member.signature.body.tsx
@@ -25,7 +25,7 @@ export function memberSignatureBody(
{context.reflectionFlags(item)}
- {!!item.flags.isRest && ...}
+ {item.flags.isRest && ...}
{item.name}
{": "}
{context.type(item.type)}
diff --git a/src/lib/output/themes/default/partials/moduleReflection.tsx b/src/lib/output/themes/default/partials/moduleReflection.tsx
index 9c0af4d77..89a4dd4d9 100644
--- a/src/lib/output/themes/default/partials/moduleReflection.tsx
+++ b/src/lib/output/themes/default/partials/moduleReflection.tsx
@@ -16,14 +16,14 @@ export function moduleReflection(context: DefaultThemeRenderContext, mod: Declar
return (
<>
- {mod.hasComment() && (
+ {mod.hasComment(context.options.getValue("notRenderedTags")) && (
{context.commentSummary(mod)}
{context.commentTags(mod)}
)}
- {mod.isDeclaration() && mod.kind === ReflectionKind.Module && mod.readme?.length && (
+ {mod.isDeclaration() && mod.kind === ReflectionKind.Module && !!mod.readme?.length && (
@@ -75,7 +75,7 @@ export function moduleMemberSummary(
context: DefaultThemeRenderContext,
member: DeclarationReflection | DocumentReflection,
) {
- const id = context.slugger.slug(member.name);
+ const id = member.isReference() ? context.getAnchor(member)! : context.slugger.slug(member.name);
context.page.pageHeadings.push({
link: `#${id}`,
text: getDisplayName(member),
diff --git a/src/lib/output/themes/default/partials/navigation.tsx b/src/lib/output/themes/default/partials/navigation.tsx
index d53bf60ad..39e9efa93 100644
--- a/src/lib/output/themes/default/partials/navigation.tsx
+++ b/src/lib/output/themes/default/partials/navigation.tsx
@@ -1,5 +1,5 @@
import { type Reflection, ReflectionFlag, ReflectionFlags } from "../../../../models/index.js";
-import { i18n, JSX, translateTagName } from "#utils";
+import { i18n, JSX, type TagString, translateTagName } from "#utils";
import type { PageEvent, PageHeading } from "../../../events.js";
import { classNames, getDisplayName, wbr } from "../../lib.js";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
@@ -65,7 +65,7 @@ export function settings(context: DefaultThemeRenderContext) {
buildFilterItem(
context,
filterName,
- translateTagName(key as `@${string}`),
+ translateTagName(key as TagString),
defaultFilters[key],
),
);
@@ -97,7 +97,7 @@ export function settings(context: DefaultThemeRenderContext) {
- {visibilityOptions.length && (
+ {!!visibilityOptions.length && (
{i18n.theme_member_visibility()}
> = {
array(type) {
- return renderingTypeDetailsIsUseful(container, type.elementType);
+ return renderingTypeDetailsIsUseful(container, type.elementType, notRenderedTags);
},
intersection(type) {
- return type.types.some(t => renderingTypeDetailsIsUseful(container, t));
+ return type.types.some(t => renderingTypeDetailsIsUseful(container, t, notRenderedTags));
},
union(type) {
- return !!type.elementSummaries || type.types.some(t => renderingTypeDetailsIsUseful(container, t));
+ return !!type.elementSummaries ||
+ type.types.some(t => renderingTypeDetailsIsUseful(container, t, notRenderedTags));
},
reflection(type) {
- return renderingChildIsUseful(type.declaration);
+ return renderingChildIsUseful(type.declaration, notRenderedTags);
},
reference(type) {
return shouldExpandReference(container, type);
@@ -44,7 +49,7 @@ export function typeDeclaration(
"typeDeclaration(reflectionOwningType, type) called incorrectly",
);
- if (renderingTypeDetailsIsUseful(reflectionOwningType, type)) {
+ if (renderingTypeDetailsIsUseful(reflectionOwningType, type, context.options.getValue("notRenderedTags"))) {
return (
);
}
diff --git a/src/lib/output/themes/default/templates/reflection.tsx b/src/lib/output/themes/default/templates/reflection.tsx
index 6c949995d..2fd4735a3 100644
--- a/src/lib/output/themes/default/templates/reflection.tsx
+++ b/src/lib/output/themes/default/templates/reflection.tsx
@@ -27,7 +27,7 @@ export function reflectionTemplate(context: DefaultThemeRenderContext, props: Pa
return (
<>
- {props.model.hasComment() && (
+ {props.model.hasComment(context.options.getValue("notRenderedTags")) && (
{context.commentSummary(props.model)}
{context.commentTags(props.model)}
diff --git a/src/lib/output/themes/lib.tsx b/src/lib/output/themes/lib.tsx
index 7a930a9bf..f9aa0938d 100644
--- a/src/lib/output/themes/lib.tsx
+++ b/src/lib/output/themes/lib.tsx
@@ -49,18 +49,14 @@ export function getKindClass(refl: Reflection): string {
* @return The original string containing ```` tags where possible.
*/
export function wbr(str: string): (string | JSX.Element)[] {
- // TODO surely there is a better way to do this, but I'm tired.
- const ret: (string | JSX.Element)[] = [];
- const re = /[\s\S]*?(?:[^_-][_-](?=[^_-])|[^A-Z](?=[A-Z][^A-Z]))/g;
- let match: RegExpExecArray | null;
- let i = 0;
- while ((match = re.exec(str))) {
- ret.push(match[0], (joiner: JSX.Children, list: readonly T[], cb: (x: T) => JSX.Children) {
diff --git a/src/lib/serialization/deserializer.ts b/src/lib/serialization/deserializer.ts
index 4bb458f06..141c3a29d 100644
--- a/src/lib/serialization/deserializer.ts
+++ b/src/lib/serialization/deserializer.ts
@@ -3,6 +3,7 @@ import {
ConditionalType,
DeclarationReflection,
DocumentReflection,
+ type FileId,
type FileRegistry,
IndexedAccessType,
InferredType,
@@ -19,6 +20,7 @@ import {
ReferenceReflection,
ReferenceType,
Reflection,
+ type ReflectionId,
ReflectionKind,
ReflectionType,
type ReflectionVariant,
@@ -132,7 +134,7 @@ export class Deserializer {
return new IntrinsicType(obj.name);
},
literal(obj) {
- if (obj.value && typeof obj.value === "object") {
+ if (typeof obj.value === "object" && obj.value != null) {
return new LiteralType(
BigInt(
`${obj.value.negative ? "-" : ""}${obj.value.value}`,
@@ -166,7 +168,7 @@ export class Deserializer {
},
reference(obj) {
// Correct reference will be restored in fromObject
- return ReferenceType.createResolvedReference(obj.name, -2, null);
+ return ReferenceType.createResolvedReference(obj.name, -2 as ReflectionId, null);
},
reflection(obj, de) {
return new ReflectionType(
@@ -213,8 +215,8 @@ export class Deserializer {
*/
projectRoot!: NormalizedPath;
- oldIdToNewId: Record = {};
- oldFileIdToNewFileId: Record = {};
+ oldIdToNewId: Record = {};
+ oldFileIdToNewFileId: Record = {};
project: ProjectReflection | undefined;
constructor(public logger: Logger) {}
@@ -350,15 +352,15 @@ export class Deserializer {
return project;
}
- revive>(
+ revive>(
source: NonNullable,
creator: (obj: T) => U,
): U;
- revive>(
+ revive>(
source: T | undefined,
creator: (obj: T) => U,
): U | undefined;
- revive>(
+ revive>(
source: T | undefined,
creator: (obj: T) => U,
): U | undefined {
diff --git a/src/lib/serialization/schema.ts b/src/lib/serialization/schema.ts
index 8c1861770..f1fe07a74 100644
--- a/src/lib/serialization/schema.ts
+++ b/src/lib/serialization/schema.ts
@@ -30,8 +30,9 @@
*/
import type * as M from "#models";
-import type { IfInternal, NormalizedPath } from "#utils";
+import type { IfInternal, NormalizedPath, TagString } from "#utils";
+// Keep this in sync with JSON_SCHEMA_VERSION in ProjectReflection.ts
export const SCHEMA_VERSION = "2.0";
/**
@@ -57,6 +58,7 @@ type _ModelToObject =
T extends M.CommentDisplayPart ? CommentDisplayPart :
T extends M.SourceReference ? SourceReference :
T extends M.FileRegistry ? FileRegistry :
+ T extends M.ReflectionSymbolId ? ReflectionSymbolId :
never;
type Primitive = string | number | undefined | null | boolean;
@@ -76,6 +78,9 @@ type S = {
-readonly [K2 in K]: ToSerialized;
};
+export type ReflectionId = M.ReflectionId;
+export type FileId = M.FileId;
+
export interface ReflectionSymbolId {
packageName: string;
packagePath: NormalizedPath;
@@ -125,7 +130,7 @@ export interface ReferenceReflection
* -1 if the reference refers to a symbol that does not exist in the documentation.
* Otherwise, the reflection ID.
*/
- target: number;
+ target: ReflectionId;
}
/** @category Reflections */
@@ -202,7 +207,7 @@ export interface ProjectReflection extends
*/
schemaVersion: string;
symbolIdMap:
- | Record
+ | Record
| IfInternal;
files: FileRegistry;
}
@@ -215,7 +220,7 @@ export interface ContainerReflection extends
"children" | "documents" | "groups" | "categories"
>
{
- childrenIncludingDocuments?: number[];
+ childrenIncludingDocuments?: ReflectionId[];
}
/** @category Reflections */
@@ -293,7 +298,7 @@ export interface ReferenceType extends
"type" | "name" | "typeArguments" | "package" | "externalUrl"
>
{
- target: number | ReflectionSymbolId;
+ target: ReflectionId | ReflectionSymbolId;
qualifiedName?: string;
refersToTypeParameter?: boolean;
preferValues?: boolean;
@@ -360,11 +365,11 @@ export interface ReflectionFlags extends Partial> {
summary: CommentDisplayPart[];
- modifierTags?: `@${string}`[];
+ modifierTags?: TagString[];
}
/** @category Comments */
-export interface CommentTag extends S {
+export interface CommentTag extends S {
content: CommentDisplayPart[];
}
@@ -385,9 +390,9 @@ export type CommentDisplayPart =
*/
export interface InlineTagDisplayPart {
kind: "inline-tag";
- tag: `@${string}`;
+ tag: TagString;
text: string;
- target?: string | number | ReflectionSymbolId;
+ target?: string | ReflectionId | ReflectionSymbolId;
tsLinkText?: string;
}
@@ -405,7 +410,7 @@ export interface RelativeLinkDisplayPart {
/**
* File ID, if present
*/
- target?: number;
+ target?: FileId;
/**
* Anchor within the target file, if present
*/
@@ -416,7 +421,7 @@ export interface SourceReference extends S;
+ entries: Record;
/** File ID to reflection ID */
- reflections: Record;
+ reflections: Record;
}
diff --git a/src/lib/types/ts-internal/index.d.ts b/src/lib/types/ts-internal/index.d.ts
index 9f10898d2..f9be4f771 100644
--- a/src/lib/types/ts-internal/index.d.ts
+++ b/src/lib/types/ts-internal/index.d.ts
@@ -23,22 +23,8 @@ declare module "typescript" {
// https://github.com/microsoft/TypeScript/blob/v5.0.2/src/compiler/utilities.ts#L7432
export function getCheckFlags(symbol: ts.Symbol): CheckFlags;
- // https://github.com/microsoft/TypeScript/blob/v5.0.2/src/compiler/utilities.ts#L4171
- export function getJSDocCommentsAndTags(
- hostNode: Node,
- noCache?: boolean,
- ): readonly (JSDoc | JSDocTag)[];
-
- export function getInterfaceBaseTypeNodes(
- node: InterfaceDeclaration,
- ): NodeArray | undefined;
-
export function getAllSuperTypeNodes(node: ts.Node): readonly ts.TypeNode[];
- export interface Signature {
- thisParameter?: ts.Symbol;
- }
-
// https://github.com/microsoft/TypeScript/blob/e213b2af3430bdc9cf5fbc76a8634d832e7aaaaa/src/compiler/types.ts#L5298-L5299
export interface UnionType {
/* @internal */
diff --git a/src/lib/utils-common/array.ts b/src/lib/utils-common/array.ts
index 82e85bea9..7f30b8cbc 100644
--- a/src/lib/utils-common/array.ts
+++ b/src/lib/utils-common/array.ts
@@ -3,6 +3,7 @@ export const emptyArray: readonly [] = [];
/**
* Inserts an item into an array sorted by priority. If two items have the same priority,
* the item will be inserted later will be placed later in the array.
+ * Higher priority is placed earlier in the array.
* @param arr modified by inserting item.
* @param item
*/
@@ -148,13 +149,9 @@ export function filterMap(
}
export function firstDefined(
- array: readonly T[] | undefined,
+ array: readonly T[],
callback: (element: T, index: number) => U | undefined,
): U | undefined {
- if (array === undefined) {
- return undefined;
- }
-
for (let i = 0; i < array.length; i++) {
const result = callback(array[i], i);
if (result !== undefined) {
@@ -175,17 +172,6 @@ export function aggregate(arr: T[], fn: (item: T) => number) {
return arr.reduce((sum, it) => sum + fn(it), 0);
}
-export function aggregateWithJoiner(
- arr: T[],
- fn: (item: T) => number,
- joiner: string,
-) {
- return (
- arr.reduce((sum, it) => sum + fn(it), 0) +
- (arr.length - 1) * joiner.length
- );
-}
-
export function joinArray(
arr: readonly T[] | undefined,
joiner: string,
diff --git a/src/lib/utils-common/events.ts b/src/lib/utils-common/events.ts
index 697d97d21..def5a16b9 100644
--- a/src/lib/utils-common/events.ts
+++ b/src/lib/utils-common/events.ts
@@ -22,6 +22,7 @@ export class EventDispatcher> {
* @param event the event to listen to.
* @param listener function to be called when an this event is emitted.
* @param priority optional priority to insert this hook with.
+ * Higher priority is placed earlier in the listener array.
*/
on(
event: K,
diff --git a/src/lib/utils-common/general.ts b/src/lib/utils-common/general.ts
index 1fcab7f2c..73f06bcad 100644
--- a/src/lib/utils-common/general.ts
+++ b/src/lib/utils-common/general.ts
@@ -45,6 +45,8 @@ export function assertNever(x: never): never {
export function assert(x: unknown, message = "Assertion failed"): asserts x {
if (!x) {
+ // eslint-disable-next-line no-debugger
+ debugger;
throw new Error(message);
}
}
diff --git a/src/lib/utils-common/i18n.ts b/src/lib/utils-common/i18n.ts
index 3ee361204..22129a2dc 100644
--- a/src/lib/utils-common/i18n.ts
+++ b/src/lib/utils-common/i18n.ts
@@ -1,6 +1,7 @@
// Type only import to non-bundled file
// eslint-disable-next-line no-restricted-imports
import type { TranslationProxy } from "../internationalization/internationalization.js";
+import type { TagString } from "./validation.js";
let translations: Record = {};
@@ -36,7 +37,7 @@ export const i18n = new Proxy({}, {
},
}) as TranslationProxy;
-export function translateTagName(tag: `@${string}`): TranslatedString {
+export function translateTagName(tag: TagString): TranslatedString {
const tagName = tag.substring(1);
if (Object.prototype.hasOwnProperty.call(translations, `tag_${tagName}`)) {
return translations[`tag_${tagName}`] as TranslatedString;
diff --git a/src/lib/utils-common/index.ts b/src/lib/utils-common/index.ts
index ceb743edf..be18a0756 100644
--- a/src/lib/utils-common/index.ts
+++ b/src/lib/utils-common/index.ts
@@ -8,7 +8,6 @@ export * from "./events.js";
export * from "./general.js";
export * from "./hooks.js";
export * from "./i18n.js";
-export * from "./index.js";
export * as JSX from "./jsx.js";
export * from "./logger.js";
export * from "./map.js";
@@ -17,3 +16,4 @@ export * from "./path.js";
export * from "./set.js";
export * from "./string.js";
export * as Validation from "./validation.js";
+export type { TagString } from "./validation.js";
diff --git a/src/lib/utils-common/jsx.elements.ts b/src/lib/utils-common/jsx.elements.ts
index d7c2fe489..c6d23dfaa 100644
--- a/src/lib/utils-common/jsx.elements.ts
+++ b/src/lib/utils-common/jsx.elements.ts
@@ -144,6 +144,8 @@ export type JsxChildren =
| JsxElement
| string
| number
+ | boolean
+ | bigint
| null
| undefined
| JsxChildren[];
diff --git a/src/lib/utils-common/jsx.ts b/src/lib/utils-common/jsx.ts
index ef93e6c82..e6fd9a5a8 100644
--- a/src/lib/utils-common/jsx.ts
+++ b/src/lib/utils-common/jsx.ts
@@ -98,7 +98,7 @@ export function setRenderSettings(options: { pretty: boolean }) {
}
export function renderElement(element: JsxElement | null | undefined): string {
- if (!element || typeof element === "boolean") {
+ if (!element) {
return "";
}
@@ -161,11 +161,11 @@ export function renderElement(element: JsxElement | null | undefined): string {
function renderChildren(children: JsxChildren[]) {
for (const child of children) {
- if (!child) continue;
+ if (typeof child === "boolean") continue;
if (Array.isArray(child)) {
renderChildren(child);
- } else if (typeof child === "string" || typeof child === "number") {
+ } else if (typeof child === "string" || typeof child === "number" || typeof child === "bigint") {
html += escapeHtml(child.toString());
} else {
html += renderElement(child);
@@ -180,7 +180,7 @@ export function renderElement(element: JsxElement | null | undefined): string {
* @internal
*/
export function renderElementToText(element: JsxElement | null | undefined) {
- if (!element || typeof element === "boolean") {
+ if (!element) {
return "";
}
@@ -205,11 +205,12 @@ export function renderElementToText(element: JsxElement | null | undefined) {
function renderChildren(children: JsxChildren[]) {
for (const child of children) {
- if (!child) continue;
+ if (typeof child === "boolean") continue;
if (Array.isArray(child)) {
renderChildren(child);
- } else if (typeof child === "string" || typeof child === "number") {
+ } else if (typeof child === "string" || typeof child === "number" || typeof child === "bigint") {
+ // Turn non-breaking spaces into regular spaces
html += child.toString().replaceAll("\u00A0", " ");
} else {
html += renderElementToText(child);
diff --git a/src/lib/utils-common/map.ts b/src/lib/utils-common/map.ts
index a893cdceb..034e1de18 100644
--- a/src/lib/utils-common/map.ts
+++ b/src/lib/utils-common/map.ts
@@ -49,7 +49,7 @@ export class StableKeyMap {
}
forEach(
- callbackfn: (value: V, key: K, map: Map) => void,
+ callbackfn: (value: V, key: K, map: StableKeyMap) => void,
thisArg?: any,
): void {
for (const [k, v] of this.entries()) {
diff --git a/src/lib/utils-common/path.ts b/src/lib/utils-common/path.ts
index 507846a51..feec89110 100644
--- a/src/lib/utils-common/path.ts
+++ b/src/lib/utils-common/path.ts
@@ -1,5 +1,9 @@
import { assert } from "./general.js";
+// Type only import is permitted
+// eslint-disable-next-line no-restricted-imports
+import type { Application } from "../application.js";
+
/**
* Represents a normalized path with path separators being `/`
* On Windows, drives are represented like `C:/Users` for consistency
@@ -15,6 +19,12 @@ export type NormalizedPath = "" | "/" | string & { readonly __normPath: unique s
*/
export type NormalizedPathOrModule = NormalizedPath | string & { readonly __normPathOrModule: unique symbol };
+/**
+ * Represents either a {@link NormalizedPath} or a Node module name
+ * (e.g. `typedoc-plugin-mdn-links` or `@gerrit0/typedoc-plugin`)
+ */
+export type NormalizedPathOrModuleOrFunction = NormalizedPathOrModule | ((app: Application) => Promise | void);
+
/**
* Represents a glob path configured by a user.
*/
diff --git a/src/lib/utils-common/validation.ts b/src/lib/utils-common/validation.ts
index 8febb48d6..f6c01aa33 100644
--- a/src/lib/utils-common/validation.ts
+++ b/src/lib/utils-common/validation.ts
@@ -119,6 +119,8 @@ export function optional(x: T): Optional {
return { [opt]: x };
}
-export function isTagString(x: unknown): x is `@${string}` {
- return typeof x === "string" && /^@[a-zA-Z][a-zA-Z0-9]*$/.test(x);
+export type TagString = `@${string}`;
+
+export function isTagString(x: unknown): x is TagString {
+ return typeof x === "string" && /^@[a-z][a-z0-9-]*$/i.test(x);
}
diff --git a/src/lib/utils/ValidatingFileRegistry.ts b/src/lib/utils/ValidatingFileRegistry.ts
index f16afad64..0e26dc72a 100644
--- a/src/lib/utils/ValidatingFileRegistry.ts
+++ b/src/lib/utils/ValidatingFileRegistry.ts
@@ -1,17 +1,36 @@
-import { FileRegistry } from "../models/FileRegistry.js";
-import { isFile } from "./fs.js";
+import { type FileId, FileRegistry } from "../models/FileRegistry.js";
import type { Deserializer, JSONOutput } from "#serialization";
import { i18n, type NormalizedPath, NormalizedPathUtils } from "#utils";
+import { existsSync } from "fs";
export class ValidatingFileRegistry extends FileRegistry {
+ basePath: NormalizedPath;
+
+ constructor(basePath: NormalizedPath = "") {
+ super();
+ this.basePath = basePath;
+ }
+
override register(
sourcePath: NormalizedPath,
relativePath: NormalizedPath,
- ): { target: number; anchor: string | undefined } | undefined {
- const absolute = NormalizedPathUtils.resolve(NormalizedPathUtils.dirname(sourcePath), relativePath);
- const absoluteWithoutAnchor = absolute.replace(/#.*/, "");
- if (!isFile(absoluteWithoutAnchor)) {
- return;
+ ): { target: FileId; anchor: string | undefined } | undefined {
+ 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)) {
+ // 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);
}
@@ -19,9 +38,9 @@ export class ValidatingFileRegistry extends FileRegistry {
override fromObject(de: Deserializer, obj: JSONOutput.FileRegistry) {
for (const [key, val] of Object.entries(obj.entries)) {
const absolute = NormalizedPathUtils.resolve(de.projectRoot, val);
- if (!isFile(absolute)) {
+ if (!existsSync(absolute)) {
de.logger.warn(
- i18n.saved_relative_path_0_resolved_from_1_is_not_a_file(
+ i18n.saved_relative_path_0_resolved_from_1_does_not_exist(
val,
de.projectRoot,
),
@@ -29,7 +48,7 @@ export class ValidatingFileRegistry extends FileRegistry {
continue;
}
- de.oldFileIdToNewFileId[+key] = this.registerAbsolute(absolute).target;
+ de.oldFileIdToNewFileId[+key as FileId] = this.registerAbsolute(absolute).target;
}
de.defer((project) => {
@@ -39,7 +58,7 @@ export class ValidatingFileRegistry extends FileRegistry {
);
if (refl) {
this.mediaToReflection.set(
- de.oldFileIdToNewFileId[+media]!,
+ de.oldFileIdToNewFileId[+media as FileId]!,
refl.id,
);
} else {
diff --git a/src/lib/utils/declaration-maps.ts b/src/lib/utils/declaration-maps.ts
new file mode 100644
index 000000000..a6183d6f7
--- /dev/null
+++ b/src/lib/utils/declaration-maps.ts
@@ -0,0 +1,71 @@
+import type ts from "typescript";
+import { existsSync } from "fs";
+import { readFile } from "./fs.js";
+import { Validation } from "#utils";
+import { join, relative, resolve } from "path";
+import { getCommonDirectory, normalizePath } from "./paths.js";
+
+const declarationMapCache = new Map();
+
+export function resolveDeclarationMaps(file: string): string {
+ if (!/\.d\.[cm]?ts$/.test(file)) return file;
+ if (declarationMapCache.has(file)) return declarationMapCache.get(file)!;
+
+ const mapFile = file + ".map";
+ if (!existsSync(mapFile)) return file;
+
+ let sourceMap: unknown;
+ try {
+ sourceMap = JSON.parse(readFile(mapFile)) as unknown;
+ } catch {
+ return file;
+ }
+
+ if (
+ Validation.validate(
+ {
+ file: String,
+ sourceRoot: Validation.optional(String),
+ sources: [Array, String],
+ },
+ sourceMap,
+ )
+ ) {
+ // There's a pretty large assumption in here that we only have
+ // 1 source file per js file. This is a pretty standard typescript approach,
+ // but people might do interesting things with transpilation that could break this.
+ let source = sourceMap.sources[0];
+
+ // If we have a sourceRoot, trim any leading slash from the source, and join them
+ // Similar to how it's done at https://github.com/mozilla/source-map/blob/58819f09018d56ef84dc41ba9c93f554e0645169/lib/util.js#L412
+ if (sourceMap.sourceRoot !== undefined) {
+ source = source.replace(/^\//, "");
+ source = join(sourceMap.sourceRoot, source);
+ }
+
+ const result = resolve(mapFile, "..", source);
+ declarationMapCache.set(file, result);
+ return result;
+ }
+
+ return file;
+}
+
+// See also: inferEntryPoints in entry-point.ts
+export function addInferredDeclarationMapPaths(
+ opts: ts.CompilerOptions,
+ files: readonly string[],
+) {
+ const rootDir = opts.rootDir || getCommonDirectory(files);
+ const declDir = opts.declarationDir || opts.outDir || rootDir;
+
+ for (const file of files) {
+ const mapFile = normalizePath(
+ resolve(declDir, relative(rootDir, file)).replace(
+ /\.([cm]?[tj]s)x?$/,
+ ".d.$1",
+ ),
+ );
+ declarationMapCache.set(mapFile, file);
+ }
+}
diff --git a/src/lib/utils/entry-point.ts b/src/lib/utils/entry-point.ts
index badb348fe..35f90d8b0 100644
--- a/src/lib/utils/entry-point.ts
+++ b/src/lib/utils/entry-point.ts
@@ -6,6 +6,7 @@ import { deriveRootDir, getCommonDirectory, MinimatchSet, nicePath, normalizePat
import type { Options } from "./options/index.js";
import { discoverPackageJson, glob, inferPackageEntryPointPaths, isDir } from "./fs.js";
import { assertNever, type GlobString, i18n, type Logger, type NormalizedPath } from "#utils";
+import { addInferredDeclarationMapPaths, resolveDeclarationMaps } from "./declaration-maps.js";
/**
* Defines how entry points are interpreted.
@@ -65,7 +66,7 @@ export function inferEntryPoints(logger: Logger, options: Options, programs?: ts
options,
);
- // See also: addInferredDeclarationMapPaths in ReflectionSymbolId
+ // See also: addInferredDeclarationMapPaths in symbol-id factory
const jsToTsSource = new Map();
for (const program of programs) {
const opts = program.getCompilerOptions();
@@ -86,7 +87,7 @@ export function inferEntryPoints(logger: Logger, options: Options, programs?: ts
for (const [name, path] of pathEntries) {
// Strip leading ./ from the display name
const displayName = name.replace(/^\.\/?/, "");
- const targetPath = jsToTsSource.get(path) || path;
+ const targetPath = jsToTsSource.get(path) || resolveDeclarationMaps(path) || path;
const program = programs.find((p) => p.getSourceFile(targetPath));
if (program) {
@@ -107,6 +108,10 @@ export function inferEntryPoints(logger: Logger, options: Options, programs?: ts
return [];
}
+ logger.verbose(
+ `Inferred entry points to be:\n\t${entryPoints.map(e => nicePath(e.sourceFile.fileName)).join("\n\t")}`,
+ );
+
return entryPoints;
}
@@ -191,7 +196,7 @@ export function getDocumentEntryPoints(
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(/\.[^.]+$/, ""),
@@ -288,7 +293,8 @@ function getEntryPointsForPaths(
options: Options,
programs = getEntryPrograms(inputFiles, logger, options),
): DocumentationEntryPoint[] {
- const baseDir = options.getValue("basePath") || getCommonDirectory(inputFiles);
+ const baseDir = options.getValue("displayBasePath") || options.getValue("basePath") ||
+ getCommonDirectory(inputFiles);
const entryPoints: DocumentationEntryPoint[] = [];
let expandSuggestion = true;
@@ -339,7 +345,7 @@ export function getExpandedEntryPointsForPaths(
options: Options,
programs = getEntryPrograms(inputFiles, logger, options),
): DocumentationEntryPoint[] {
- const compilerOptions = options.getCompilerOptions();
+ const compilerOptions = options.getCompilerOptions(logger);
const supportedFileRegex = compilerOptions.allowJs || compilerOptions.checkJs
? /\.([cm][tj]s|[tj]sx?)$/
: /\.([cm]ts|tsx?)$/;
@@ -372,9 +378,6 @@ function expandGlobs(globs: GlobString[], exclude: GlobString[], logger: Logger)
logger.warn(
i18n.glob_0_did_not_match_any_files(entry),
);
- if (entry.includes("\\") && !entry.includes("/")) {
- logger.info(i18n.glob_should_use_posix_slash());
- }
} else if (filtered.length === 0) {
logger.warn(
i18n.entry_point_0_did_not_match_any_files_after_exclude(
@@ -408,14 +411,19 @@ function getEntryPrograms(
const rootProgram = noTsConfigFound
? ts.createProgram({
rootNames: inputFiles,
- options: options.getCompilerOptions(),
+ options: options.getCompilerOptions(logger),
})
: ts.createProgram({
rootNames: options.getFileNames(),
- options: options.getCompilerOptions(),
+ options: options.getCompilerOptions(logger),
projectReferences: options.getProjectReferences(),
});
+ addInferredDeclarationMapPaths(
+ options.getCompilerOptions(logger),
+ options.getFileNames(),
+ );
+
const programs = [rootProgram];
// This might be a solution style tsconfig, in which case we need to add a program for each
// reference so that the converter can look through each of these.
@@ -431,11 +439,17 @@ function getEntryPrograms(
ts.createProgram({
options: options.fixCompilerOptions(
ref.commandLine.options,
+ logger,
),
rootNames: ref.commandLine.fileNames,
projectReferences: ref.commandLine.projectReferences,
}),
);
+
+ addInferredDeclarationMapPaths(
+ ref.commandLine.options,
+ ref.commandLine.fileNames,
+ );
}
}
diff --git a/src/lib/utils/highlighter.tsx b/src/lib/utils/highlighter.tsx
index 0041a2ccc..e539dafb4 100644
--- a/src/lib/utils/highlighter.tsx
+++ b/src/lib/utils/highlighter.tsx
@@ -2,7 +2,8 @@ import * as shiki from "@gerrit0/mini-shiki";
import { JSX, unique } from "#utils";
import assert from "assert";
-const aliases = new Map();
+const tsAliases: [string, string][] = [["mts", "typescript"], ["cts", "typescript"]];
+const aliases = new Map(tsAliases);
for (const lang of shiki.bundledLanguagesInfo) {
for (const alias of lang.aliases || []) {
aliases.set(alias, lang.id);
@@ -161,8 +162,12 @@ export async function loadHighlighter(
highlighter = new ShikiHighlighter(hl, lightTheme, darkTheme);
}
+function isPlainLanguage(lang: string) {
+ return ignoredLanguages?.includes(lang) || plaintextLanguages.includes(lang);
+}
+
export function isSupportedLanguage(lang: string) {
- return ignoredLanguages?.includes(lang) || getSupportedLanguages().includes(lang);
+ return isPlainLanguage(lang) || supportedLanguages.includes(lang);
}
export function getSupportedLanguages(): string[] {
@@ -174,9 +179,7 @@ export function getSupportedThemes(): string[] {
}
export function isLoadedLanguage(lang: string): boolean {
- return (
- plaintextLanguages.includes(lang) || ignoredLanguages?.includes(lang) || highlighter?.supports(lang) || false
- );
+ return isPlainLanguage(lang) || highlighter?.supports(lang) || false;
}
export function highlight(code: string, lang: string): string {
diff --git a/src/lib/utils/index.ts b/src/lib/utils/index.ts
index 605a8b406..a48c4f739 100644
--- a/src/lib/utils/index.ts
+++ b/src/lib/utils/index.ts
@@ -44,6 +44,7 @@ export type { SortStrategy } from "./sort.js";
export * from "./entry-point.js";
+export * from "./declaration-maps.js";
export * from "./highlighter.js";
export * from "./html.js";
export * from "./tsconfig.js";
diff --git a/src/lib/utils/options/declaration.ts b/src/lib/utils/options/declaration.ts
index 6a8c476b4..ef5613ca8 100644
--- a/src/lib/utils/options/declaration.ts
+++ b/src/lib/utils/options/declaration.ts
@@ -10,10 +10,13 @@ import {
type NeverIfInternal,
type NormalizedPath,
type NormalizedPathOrModule,
+ type NormalizedPathOrModuleOrFunction,
+ type TagString,
type TranslatedString,
} from "#utils";
import type { TranslationProxy } from "../../internationalization/internationalization.js";
import { createGlobString, normalizePath } from "../paths.js";
+import type { Application } from "../../application.js";
/** @enum */
export const EmitStrategy = {
@@ -122,7 +125,8 @@ export type TypeDocOptions = {
TypeDocOptionMap[K] extends ManuallyValidatedOption<
infer ManuallyValidated
> ? ManuallyValidated :
- TypeDocOptionMap[K] extends NormalizedPath[] | NormalizedPathOrModule[] | GlobString[] ? string[] :
+ TypeDocOptionMap[K] extends
+ NormalizedPath[] | NormalizedPathOrModule[] | NormalizedPathOrModuleOrFunction[] | GlobString[] ? string[] :
TypeDocOptionMap[K] extends NormalizedPath ? string :
TypeDocOptionMap[K] extends
| string
@@ -150,6 +154,8 @@ export type TypeDocOptionValues = {
| string
| string[]
| GlobString[]
+ | NormalizedPathOrModule[]
+ | NormalizedPathOrModuleOrFunction[]
| number
| boolean
| Record ? TypeDocOptionMap[K] :
@@ -183,7 +189,7 @@ export interface TypeDocOptionMap {
options: NormalizedPath;
tsconfig: NormalizedPath;
compilerOptions: unknown;
- plugin: NormalizedPathOrModule[];
+ plugin: NormalizedPathOrModuleOrFunction[];
lang: string;
locales: ManuallyValidatedOption>>;
packageOptions: ManuallyValidatedOption<
@@ -201,6 +207,7 @@ export interface TypeDocOptionMap {
excludeNotDocumented: boolean;
excludeNotDocumentedKinds: ReflectionKind.KindString[];
excludeInternal: boolean;
+ excludePrivateClassFields: boolean;
excludePrivate: boolean;
excludeProtected: boolean;
excludeReferences: boolean;
@@ -216,6 +223,7 @@ export interface TypeDocOptionMap {
gitRevision: string;
gitRemote: string;
readme: string;
+ basePath: NormalizedPath;
// Output
outputs: ManuallyValidatedOption>;
@@ -255,7 +263,7 @@ export interface TypeDocOptionMap {
* strictly typed here.
*/
markdownItLoader: ManuallyValidatedOption<(parser: any) => void>;
- basePath: NormalizedPath;
+ displayBasePath: NormalizedPath;
cname: string;
favicon: NormalizedPath;
githubPages: boolean;
@@ -292,7 +300,7 @@ export interface TypeDocOptionMap {
private?: boolean;
inherited?: boolean;
external?: boolean;
- [tag: `@${string}`]: boolean;
+ [tag: TagString]: boolean;
}>;
searchCategoryBoosts: ManuallyValidatedOption>;
searchGroupBoosts: ManuallyValidatedOption>;
@@ -304,15 +312,16 @@ export interface TypeDocOptionMap {
preserveLinkText: boolean;
jsDocCompatibility: JsDocCompatibility;
suppressCommentWarningsInDeclarationFiles: boolean;
- blockTags: `@${string}`[];
- inlineTags: `@${string}`[];
- modifierTags: `@${string}`[];
- excludeTags: `@${string}`[];
- notRenderedTags: `@${string}`[];
+ blockTags: TagString[];
+ inlineTags: TagString[];
+ modifierTags: TagString[];
+ excludeTags: TagString[];
+ notRenderedTags: TagString[];
externalSymbolLinkMappings: ManuallyValidatedOption<
Record>
>;
- cascadedModifierTags: `@${string}`[];
+ cascadedModifierTags: TagString[];
+ preservedTypeAnnotationTags: TagString[];
// Organization
categorizeByGroup: boolean;
@@ -404,7 +413,9 @@ export type KeyToDeclaration = TypeDocOptionMa
TypeDocOptionMap[K] extends string | NormalizedPath ? StringDeclarationOption :
TypeDocOptionMap[K] extends number ? NumberDeclarationOption :
TypeDocOptionMap[K] extends GlobString[] ? GlobArrayDeclarationOption :
- TypeDocOptionMap[K] extends string[] | NormalizedPath[] | NormalizedPathOrModule[] ? ArrayDeclarationOption :
+ TypeDocOptionMap[K] extends
+ string[] | NormalizedPath[] | NormalizedPathOrModule[] | NormalizedPathOrModuleOrFunction[] ?
+ ArrayDeclarationOption :
unknown extends TypeDocOptionMap[K] ? MixedDeclarationOption | ObjectDeclarationOption :
TypeDocOptionMap[K] extends ManuallyValidatedOption ?
| (MixedDeclarationOption & {
@@ -452,8 +463,14 @@ export enum ParameterType {
PathArray,
/**
* Resolved according to the config directory if it starts with `.`
+ * @deprecated since 0.28.8, will be removed in 0.29
*/
ModuleArray,
+ /**
+ * Resolved according to the config directory if it starts with `.`
+ * @internal - only intended for use with the plugin option
+ */
+ PluginArray,
/**
* Relative to the config directory.
*/
@@ -567,7 +584,9 @@ export interface ArrayDeclarationOption extends DeclarationOptionBase {
type:
| ParameterType.Array
| ParameterType.PathArray
- | ParameterType.ModuleArray;
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
+ | ParameterType.ModuleArray
+ | ParameterType.PluginArray;
/**
* If not specified defaults to an empty array.
@@ -673,7 +692,9 @@ export interface ParameterTypeToOptionTypeMap {
[ParameterType.Object]: unknown;
[ParameterType.Array]: string[];
[ParameterType.PathArray]: NormalizedPath[];
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
[ParameterType.ModuleArray]: NormalizedPathOrModule[];
+ [ParameterType.PluginArray]: Array void | Promise)>;
[ParameterType.GlobArray]: GlobString[];
[ParameterType.Flags]: Record;
@@ -685,6 +706,29 @@ export type DeclarationOptionToOptionType = T exten
T extends FlagsDeclarationOption ? U :
ParameterTypeToOptionTypeMap[Exclude];
+function toStringArray(value: unknown, option: DeclarationOption): string[] {
+ if (Array.isArray(value) && value.every(v => typeof v === "string")) {
+ return value;
+ } else if (typeof value === "string") {
+ return [value];
+ }
+
+ throw new Error(i18n.option_0_must_be_an_array_of_string(option.name));
+}
+
+function toStringOrFunctionArray(
+ value: unknown,
+ option: DeclarationOption,
+): Array void | Promise)> {
+ if (Array.isArray(value) && value.every(v => typeof v === "string" || typeof v === "function")) {
+ return value;
+ } else if (typeof value === "string") {
+ return [value];
+ }
+
+ throw new Error(i18n.option_0_must_be_an_array_of_string_or_functions(option.name));
+}
+
const converters: {
[K in ParameterType]: (
value: unknown,
@@ -737,40 +781,46 @@ const converters: {
return !!value;
},
[ParameterType.Array](value, option) {
- let strArrValue: string[] = [];
- if (Array.isArray(value)) {
- strArrValue = value.map(String);
- } else if (typeof value === "string") {
- strArrValue = [value];
- }
+ const strArrValue = toStringArray(value, option);
option.validate?.(strArrValue);
return strArrValue;
},
[ParameterType.PathArray](value, option, configPath) {
- let strArrValue: string[] = [];
- if (Array.isArray(value)) {
- strArrValue = value.map(String);
- } else if (typeof value === "string") {
- strArrValue = [value];
- }
+ const strArrValue = toStringArray(value, option);
const normalized = strArrValue.map((path) => normalizePath(resolve(configPath, path)));
option.validate?.(normalized);
return normalized;
},
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
[ParameterType.ModuleArray](value, option, configPath) {
- let strArrValue: string[] = [];
- if (Array.isArray(value)) {
- strArrValue = value.map(String);
- } else if (typeof value === "string") {
- strArrValue = [value];
- }
+ const strArrValue = toStringArray(value, option);
const resolved = resolveModulePaths(strArrValue, configPath);
option.validate?.(resolved);
return resolved;
},
+ [ParameterType.PluginArray](value, option, configPath) {
+ const arrayValue = toStringOrFunctionArray(value, option);
+ const resolved = arrayValue.map(plugin =>
+ typeof plugin === "function" ? plugin : resolveModulePath(plugin, configPath)
+ );
+ return resolved;
+ },
[ParameterType.GlobArray](value, option, configPath) {
- const toGlobString = (v: unknown) => createGlobString(configPath, String(v));
- const globs = Array.isArray(value) ? value.map(toGlobString) : [toGlobString(value)];
+ const toGlobString = (v: unknown) => {
+ const s = String(v);
+
+ // If the string tries to escape a character which isn't a special
+ // glob character, the user probably provided a Windows style path
+ // by accident due to shell completion, tell them to either remove
+ // the useless escape or switch to Unix path separators.
+ if (/\\[^?*()[\]\\{}]/.test(s)) {
+ throw new Error(i18n.glob_0_should_use_posix_slash(s));
+ }
+
+ return createGlobString(configPath, s);
+ };
+ const strArrValue = toStringArray(value, option);
+ const globs = strArrValue.map(toGlobString);
option.validate?.(globs);
return globs;
},
@@ -928,12 +978,19 @@ const defaultGetters: {
option.defaultValue?.map((value) => normalizePath(resolve(process.cwd(), value))) ?? []
);
},
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
[ParameterType.ModuleArray](option) {
if (option.defaultValue) {
return resolveModulePaths(option.defaultValue, process.cwd());
}
return [];
},
+ [ParameterType.PluginArray](option) {
+ if (option.defaultValue) {
+ return resolveModulePaths(option.defaultValue, process.cwd());
+ }
+ return [];
+ },
[ParameterType.GlobArray](option) {
return (option.defaultValue ?? []).map(g => createGlobString(normalizePath(process.cwd()), g));
},
@@ -951,12 +1008,14 @@ export function getDefaultValue(option: DeclarationOption) {
}
function resolveModulePaths(modules: readonly string[], configPath: string): NormalizedPathOrModule[] {
- return modules.map((path) => {
- if (path.startsWith(".")) {
- return normalizePath(resolve(configPath, path));
- }
- return normalizePath(path);
- });
+ return modules.map(path => resolveModulePath(path, configPath));
+}
+
+function resolveModulePath(path: string, configPath: string): NormalizedPathOrModule {
+ if (path.startsWith(".")) {
+ return normalizePath(resolve(configPath, path));
+ }
+ return normalizePath(path);
}
function isTsNumericEnum(map: Record) {
diff --git a/src/lib/utils/options/defaults.ts b/src/lib/utils/options/defaults.ts
index 20d6d1472..3751c3183 100644
--- a/src/lib/utils/options/defaults.ts
+++ b/src/lib/utils/options/defaults.ts
@@ -4,7 +4,7 @@
*/
import type { BundledLanguage } from "@gerrit0/mini-shiki";
import * as TagDefaults from "./tsdoc-defaults.js";
-import type { EnumKeys } from "#utils";
+import type { EnumKeys, TagString } from "#utils";
import type { ReflectionKind } from "../../models/index.js";
export const excludeNotDocumentedKinds: readonly EnumKeys<
@@ -31,7 +31,7 @@ export const excludeNotDocumentedKinds: readonly EnumKeys<
"Reference",
];
-export const excludeTags: readonly `@${string}`[] = [
+export const excludeTags: readonly TagString[] = [
"@override",
"@virtual",
"@privateRemarks",
@@ -41,17 +41,19 @@ export const excludeTags: readonly `@${string}`[] = [
"@inlineType",
];
-export const blockTags: readonly `@${string}`[] = TagDefaults.blockTags;
-export const inlineTags: readonly `@${string}`[] = TagDefaults.inlineTags;
-export const modifierTags: readonly `@${string}`[] = TagDefaults.modifierTags;
+export const blockTags: readonly TagString[] = TagDefaults.blockTags;
+export const inlineTags: readonly TagString[] = TagDefaults.inlineTags;
+export const modifierTags: readonly TagString[] = TagDefaults.modifierTags;
-export const cascadedModifierTags: readonly `@${string}`[] = [
+export const cascadedModifierTags: readonly TagString[] = [
"@alpha",
"@beta",
"@experimental",
];
-export const notRenderedTags: readonly `@${string}`[] = [
+export const preservedTypeAnnotationTags: readonly TagString[] = [];
+
+export const notRenderedTags: readonly TagString[] = [
"@showCategories",
"@showGroups",
"@hideCategories",
diff --git a/src/lib/utils/options/options.ts b/src/lib/utils/options/options.ts
index 49e0798d8..797cccb01 100644
--- a/src/lib/utils/options/options.ts
+++ b/src/lib/utils/options/options.ts
@@ -1,4 +1,4 @@
-import type ts from "typescript";
+import ts from "typescript";
import { resolve } from "path";
import { ParameterType } from "./declaration.js";
import type { OutputSpecification } from "../index.js";
@@ -361,19 +361,34 @@ export class Options {
/**
* Gets the set compiler options.
*/
- getCompilerOptions(): ts.CompilerOptions {
- return this.fixCompilerOptions(this._compilerOptions);
+ getCompilerOptions(logger: Logger): ts.CompilerOptions {
+ return this.fixCompilerOptions(this._compilerOptions, logger);
}
/** @internal */
fixCompilerOptions(
options: Readonly,
+ logger: Logger,
): ts.CompilerOptions {
const overrides = this.getValue("compilerOptions");
const result = { ...options };
if (overrides) {
- Object.assign(result, overrides);
+ const tsOptions = ts.convertCompilerOptionsFromJson(overrides, ".", "typedoc-overrides.json");
+
+ if (tsOptions.errors.length) {
+ for (const error of tsOptions.errors) {
+ logger.error(
+ i18n.failed_to_apply_compilerOptions_overrides_0(
+ ts.flattenDiagnosticMessageText(error.messageText, "\n"),
+ ),
+ );
+ }
+ } else {
+ for (const key in overrides) {
+ result[key] = tsOptions.options[key];
+ }
+ }
}
if (this.getValue("emit") !== "both") {
diff --git a/src/lib/utils/options/readers/arguments.ts b/src/lib/utils/options/readers/arguments.ts
index bc8ceb2e5..2e8dbb3c6 100644
--- a/src/lib/utils/options/readers/arguments.ts
+++ b/src/lib/utils/options/readers/arguments.ts
@@ -6,7 +6,9 @@ import { i18n, type Logger, type TranslatedString } from "#utils";
const ARRAY_OPTION_TYPES = new Set([
ParameterType.Array,
ParameterType.PathArray,
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
ParameterType.ModuleArray,
+ ParameterType.PluginArray,
ParameterType.GlobArray,
]);
@@ -18,12 +20,18 @@ export class ArgumentsReader implements OptionsReader {
readonly order: number;
readonly supportsPackages = false;
private args: string[];
+ private skipErrorReporting = false;
constructor(priority: number, args = process.argv.slice(2)) {
this.order = priority;
this.args = args;
}
+ ignoreErrors() {
+ this.skipErrorReporting = true;
+ return this;
+ }
+
read(container: Options, logger: Logger): void {
// Make container's type more lax, we do the appropriate checks manually.
const options = container as Options & {
@@ -38,7 +46,9 @@ export class ArgumentsReader implements OptionsReader {
options.setValue(name, value);
} catch (err) {
ok(err instanceof Error);
- logger.error(err.message as TranslatedString);
+ if (!this.skipErrorReporting) {
+ logger.error(err.message as TranslatedString);
+ }
}
};
@@ -50,11 +60,13 @@ export class ArgumentsReader implements OptionsReader {
if (decl) {
if (decl.configFileOnly) {
- logger.error(
- i18n.option_0_can_only_be_specified_by_config_file(
- decl.name,
- ),
- );
+ if (!this.skipErrorReporting) {
+ logger.error(
+ i18n.option_0_can_only_be_specified_by_config_file(
+ decl.name,
+ ),
+ );
+ }
continue;
}
@@ -69,7 +81,7 @@ export class ArgumentsReader implements OptionsReader {
decl.type === ParameterType.Boolean ||
decl.type === ParameterType.Flags
) {
- const value = String(this.args[index]).toLowerCase();
+ const value = String(this.args.at(index)).toLowerCase();
if (value === "true" || value === "false") {
trySet(decl.name, value === "true");
@@ -81,11 +93,13 @@ export class ArgumentsReader implements OptionsReader {
} else {
if (index === this.args.length) {
// Only boolean values have optional values.
- logger.warn(
- i18n.option_0_expected_a_value_but_none_provided(
- decl.name,
- ),
- );
+ if (!this.skipErrorReporting) {
+ logger.warn(
+ i18n.option_0_expected_a_value_but_none_provided(
+ decl.name,
+ ),
+ );
+ }
}
trySet(decl.name, this.args[index]);
}
@@ -100,7 +114,7 @@ export class ArgumentsReader implements OptionsReader {
if (decl && decl.type === ParameterType.Flags) {
const flagName = name.split(".", 2)[1];
- const value = String(this.args[index]).toLowerCase();
+ const value = String(this.args.at(index)).toLowerCase();
if (value === "true" || value === "false") {
trySet(decl.name, { [flagName]: value === "true" });
@@ -115,12 +129,14 @@ export class ArgumentsReader implements OptionsReader {
}
}
- logger.error(
- i18n.unknown_option_0_may_have_meant_1(
- name,
- options.getSimilarOptions(name).join("\n\t"),
- ),
- );
+ if (!this.skipErrorReporting) {
+ logger.error(
+ i18n.unknown_option_0_may_have_meant_1(
+ name,
+ options.getSimilarOptions(name).join("\n\t"),
+ ),
+ );
+ }
index++;
}
}
diff --git a/src/lib/utils/options/readers/tsconfig.ts b/src/lib/utils/options/readers/tsconfig.ts
index 45add3be1..42d1a439f 100644
--- a/src/lib/utils/options/readers/tsconfig.ts
+++ b/src/lib/utils/options/readers/tsconfig.ts
@@ -5,14 +5,14 @@ import ts from "typescript";
import type { Options, OptionsReader } from "../options.js";
import { isFile } from "../../fs.js";
import { ok } from "assert";
-import { i18n, type Logger, type TranslatedString, unique, Validation } from "#utils";
+import { i18n, type Logger, type TagString, type TranslatedString, unique, Validation } from "#utils";
import { nicePath, normalizePath } from "../../paths.js";
import { createRequire } from "module";
import { tsdocBlockTags, tsdocInlineTags, tsdocModifierTags } from "../tsdoc-defaults.js";
import { findTsConfigFile, getTypeDocOptionsFromTsConfig, readTsConfig } from "../../tsconfig.js";
import { diagnostics } from "../../loggers.js";
-function isSupportForTags(obj: unknown): obj is Record<`@${string}`, boolean> {
+function isSupportForTags(obj: unknown): obj is Record {
return (
Validation.validate({}, obj) &&
Object.entries(obj).every(([key, val]) => {
@@ -148,15 +148,15 @@ export class TSConfigReader implements OptionsReader {
const config = this.readTsDoc(logger, tsdoc);
if (!config) return;
- const supported = (tag: { tagName: `@${string}` }) => {
+ const supported = (tag: { tagName: TagString }) => {
return config.supportForTags
? !!config.supportForTags[tag.tagName]
: true;
};
- const blockTags: `@${string}`[] = [];
- const inlineTags: `@${string}`[] = [];
- const modifierTags: `@${string}`[] = [];
+ const blockTags: TagString[] = [];
+ const inlineTags: TagString[] = [];
+ const modifierTags: TagString[] = [];
if (!config.noStandardTags) {
blockTags.push(...tsdocBlockTags);
diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
index c87d7c4e5..f572bfd33 100644
--- a/src/lib/utils/options/sources/typedoc.ts
+++ b/src/lib/utils/options/sources/typedoc.ts
@@ -20,9 +20,7 @@ function makeTagArrayValidator(name: keyof TypeDocOptionMap) {
// For convenience, added in the same order as they are documented on the website.
export function addTypeDocOptions(options: Pick) {
- ///////////////////////////
- // Configuration Options //
- ///////////////////////////
+ // MARK: Configuration Options
options.addDeclaration({
type: ParameterType.Path,
@@ -96,9 +94,7 @@ export function addTypeDocOptions(options: Pick) {
},
});
- ///////////////////////////
- ////// Input Options //////
- ///////////////////////////
+ // MARK: Input Options
options.addDeclaration({
name: "entryPoints",
@@ -193,6 +189,12 @@ export function addTypeDocOptions(options: Pick) {
type: ParameterType.Boolean,
defaultValue: true,
});
+ options.addDeclaration({
+ name: "excludePrivateClassFields",
+ help: () => i18n.help_excludePrivateClassFields(),
+ type: ParameterType.Boolean,
+ defaultValue: true,
+ });
options.addDeclaration({
name: "excludeProtected",
help: () => i18n.help_excludeProtected(),
@@ -232,10 +234,18 @@ export function addTypeDocOptions(options: Pick) {
}
},
});
+ options.addDeclaration({
+ name: "readme",
+ help: () => i18n.help_readme(),
+ type: ParameterType.Path,
+ });
+ options.addDeclaration({
+ name: "basePath",
+ help: () => i18n.help_basePath(),
+ type: ParameterType.Path,
+ });
- ///////////////////////////
- ///// Output Options //////
- ///////////////////////////
+ // MARK: Output Options
options.addDeclaration({
name: "outputs",
@@ -454,13 +464,8 @@ export function addTypeDocOptions(options: Pick) {
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({
@@ -650,7 +655,7 @@ export function addTypeDocOptions(options: Pick) {
},
validate(value) {
const knownKeys = ["protected", "private", "inherited", "external"];
- if (!value || typeof value !== "object") {
+ if (typeof value !== "object" || !value) {
throw new Error(
i18n.option_0_must_be_an_object("visibilityFilters"),
);
@@ -720,9 +725,7 @@ export function addTypeDocOptions(options: Pick) {
type: ParameterType.Boolean,
});
- ///////////////////////////
- ///// Comment Options /////
- ///////////////////////////
+ // MARK: Comment Options
options.addDeclaration({
name: "jsDocCompatibility",
@@ -806,10 +809,15 @@ export function addTypeDocOptions(options: Pick) {
defaultValue: OptionDefaults.cascadedModifierTags,
validate: makeTagArrayValidator("cascadedModifierTags"),
});
+ options.addDeclaration({
+ name: "preservedTypeAnnotationTags",
+ help: () => i18n.help_preservedTypeAnnotationTags(),
+ type: ParameterType.Array,
+ defaultValue: OptionDefaults.preservedTypeAnnotationTags,
+ validate: makeTagArrayValidator("preservedTypeAnnotationTags"),
+ });
- ///////////////////////////
- // Organization Options ///
- ///////////////////////////
+ // MARK: Organization Options
options.addDeclaration({
name: "categorizeByGroup",
@@ -845,10 +853,7 @@ export function addTypeDocOptions(options: Pick) {
type: ParameterType.Array,
defaultValue: OptionDefaults.sort,
validate(value) {
- const invalid = new Set(value);
- for (const v of SORT_STRATEGIES) {
- invalid.delete(v);
- }
+ const invalid = setDifference(value, SORT_STRATEGIES);
if (invalid.size !== 0) {
throw new Error(
@@ -887,9 +892,7 @@ export function addTypeDocOptions(options: Pick) {
},
});
- ///////////////////////////
- ///// General Options /////
- ///////////////////////////
+ // MARK: General Options
options.addDeclaration({
name: "watch",
@@ -926,7 +929,7 @@ export function addTypeDocOptions(options: Pick) {
options.addDeclaration({
name: "plugin",
help: () => i18n.help_plugin(),
- type: ParameterType.ModuleArray,
+ type: ParameterType.PluginArray,
});
options.addDeclaration({
name: "logLevel",
diff --git a/src/lib/utils/options/tsdoc-defaults.ts b/src/lib/utils/options/tsdoc-defaults.ts
index 39da35ef6..1aeabc65a 100644
--- a/src/lib/utils/options/tsdoc-defaults.ts
+++ b/src/lib/utils/options/tsdoc-defaults.ts
@@ -37,7 +37,9 @@ export const blockTags = [
"@return",
"@satisfies",
"@since",
+ "@sortStrategy",
"@template", // Alias for @typeParam
+ "@this",
"@type",
"@typedef",
"@summary",
diff --git a/src/lib/utils/plugins.ts b/src/lib/utils/plugins.ts
index 99f726639..591a9cceb 100644
--- a/src/lib/utils/plugins.ts
+++ b/src/lib/utils/plugins.ts
@@ -3,35 +3,42 @@ import { pathToFileURL } from "url";
import type { Application } from "../application.js";
import { nicePath } from "./paths.js";
-import { i18n, type TranslatedString } from "#utils";
+import { i18n, type NormalizedPathOrModuleOrFunction, type TranslatedString } from "#utils";
export async function loadPlugins(
app: Application,
- plugins: readonly string[],
+ plugins: readonly NormalizedPathOrModuleOrFunction[],
) {
for (const plugin of plugins) {
const pluginDisplay = getPluginDisplayName(plugin);
try {
- let instance: any;
- // Try importing first to avoid warnings about requiring ESM being experimental.
- // If that fails due to importing a directory, fall back to require.
- try {
- // On Windows, we need to ensure this path is a file path.
- // Or we'll get ERR_UNSUPPORTED_ESM_URL_SCHEME
- const esmPath = isAbsolute(plugin)
- ? pathToFileURL(plugin).toString()
- : plugin;
- instance = await import(esmPath);
- } catch (error: any) {
- if (error.code === "ERR_UNSUPPORTED_DIR_IMPORT") {
- // eslint-disable-next-line @typescript-eslint/no-require-imports
- instance = require(plugin);
- } else {
- throw error;
+ let initFunction: any;
+
+ if (typeof plugin === "function") {
+ initFunction = plugin;
+ } else {
+ let instance: any;
+
+ // Try importing first to avoid warnings about requiring ESM being experimental.
+ // If that fails due to importing a directory, fall back to require.
+ try {
+ // On Windows, we need to ensure this path is a file path.
+ // Or we'll get ERR_UNSUPPORTED_ESM_URL_SCHEME
+ const esmPath = isAbsolute(plugin)
+ ? pathToFileURL(plugin).toString()
+ : plugin;
+ instance = await import(esmPath);
+ } catch (error: any) {
+ if (error.code === "ERR_UNSUPPORTED_DIR_IMPORT") {
+ // eslint-disable-next-line @typescript-eslint/no-require-imports
+ instance = require(plugin);
+ } else {
+ throw error;
+ }
}
+ initFunction = instance.load;
}
- const initFunction = instance.load;
if (typeof initFunction === "function") {
await initFunction(app);
@@ -54,7 +61,11 @@ export async function loadPlugins(
}
}
-function getPluginDisplayName(plugin: string) {
+function getPluginDisplayName(plugin: NormalizedPathOrModuleOrFunction) {
+ if (typeof plugin === "function") {
+ return plugin.name || "function";
+ }
+
const path = nicePath(plugin);
if (path.startsWith("./node_modules/")) {
return path.substring("./node_modules/".length);
diff --git a/src/lib/utils/sort.ts b/src/lib/utils/sort.ts
index 303f95113..b3d974ca8 100644
--- a/src/lib/utils/sort.ts
+++ b/src/lib/utils/sort.ts
@@ -163,7 +163,11 @@ const sorts: Record<
},
};
-export function getSortFunction(opts: Options) {
+export function isValidSortStrategy(strategy: string): strategy is SortStrategy {
+ return SORT_STRATEGIES.includes(strategy as never);
+}
+
+export function getSortFunction(opts: Options, strategies: readonly SortStrategy[] = opts.getValue("sort")) {
const kindSortOrder = opts
.getValue("kindSortOrder")
.map((k) => ReflectionKind[k]);
@@ -174,7 +178,6 @@ export function getSortFunction(opts: Options) {
}
}
- const strategies = opts.getValue("sort");
const data = { kindSortOrder };
return function sortReflections(
diff --git a/src/lib/validation/links.ts b/src/lib/validation/links.ts
index ac1b80dc5..e5067d42d 100644
--- a/src/lib/validation/links.ts
+++ b/src/lib/validation/links.ts
@@ -2,6 +2,7 @@ import { i18n, type Logger } from "#utils";
import {
type Comment,
type CommentDisplayPart,
+ type InlineTagDisplayPart,
type ProjectReflection,
type Reflection,
ReflectionKind,
@@ -11,7 +12,7 @@ import {
const linkTags = ["@link", "@linkcode", "@linkplain"];
function getBrokenPartLinks(parts: readonly CommentDisplayPart[]) {
- const links: string[] = [];
+ const links: InlineTagDisplayPart[] = [];
for (const part of parts) {
if (
@@ -19,7 +20,7 @@ function getBrokenPartLinks(parts: readonly CommentDisplayPart[]) {
linkTags.includes(part.tag) &&
(!part.target || part.target instanceof ReflectionSymbolId)
) {
- links.push(part.text.trim());
+ links.push(part);
}
}
@@ -44,30 +45,27 @@ export function validateLinks(
for (const id in project.reflections) {
checkReflection(project.reflections[id], logger);
}
-
- if (!(project.id in project.reflections)) {
- checkReflection(project, logger);
- }
}
function checkReflection(reflection: Reflection, logger: Logger) {
if (reflection.isProject() || reflection.isDeclaration()) {
for (const broken of getBrokenPartLinks(reflection.readme || [])) {
+ const linkText = broken.text.trim();
// #2360, "@" is a future reserved character in TSDoc component paths
// If a link starts with it, and doesn't include a module source indicator "!"
// then the user probably is trying to link to a package containing "@" with an absolute link.
- if (broken.startsWith("@") && !broken.includes("!")) {
+ if (linkText.startsWith("@") && !linkText.includes("!")) {
logger.warn(
i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(
- broken,
+ linkText,
reflection.getFriendlyFullName(),
- broken.replace(/[.#~]/, "!"),
+ linkText.replace(/[.#~]/, "!"),
),
);
} else {
logger.warn(
i18n.failed_to_resolve_link_to_0_in_readme_for_1(
- broken,
+ linkText,
reflection.getFriendlyFullName(),
),
);
@@ -77,21 +75,19 @@ function checkReflection(reflection: Reflection, logger: Logger) {
if (reflection.isDocument()) {
for (const broken of getBrokenPartLinks(reflection.content)) {
- // #2360, "@" is a future reserved character in TSDoc component paths
- // If a link starts with it, and doesn't include a module source indicator "!"
- // then the user probably is trying to link to a package containing "@" with an absolute link.
- if (broken.startsWith("@") && !broken.includes("!")) {
+ const linkText = broken.text.trim();
+ if (linkText.startsWith("@") && !linkText.includes("!")) {
logger.warn(
i18n.failed_to_resolve_link_to_0_in_document_1_may_have_meant_2(
- broken,
+ linkText,
reflection.getFriendlyFullName(),
- broken.replace(/[.#~]/, "!"),
+ linkText.replace(/[.#~]/, "!"),
),
);
} else {
logger.warn(
i18n.failed_to_resolve_link_to_0_in_document_1(
- broken,
+ linkText,
reflection.getFriendlyFullName(),
),
);
@@ -100,25 +96,7 @@ function checkReflection(reflection: Reflection, logger: Logger) {
}
for (const broken of getBrokenLinks(reflection.comment)) {
- // #2360, "@" is a future reserved character in TSDoc component paths
- // If a link starts with it, and doesn't include a module source indicator "!"
- // then the user probably is trying to link to a package containing "@" with an absolute link.
- if (broken.startsWith("@") && !broken.includes("!")) {
- logger.warn(
- i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(
- broken,
- reflection.getFriendlyFullName(),
- broken.replace(/[.#~]/, "!"),
- ),
- );
- } else {
- logger.warn(
- i18n.failed_to_resolve_link_to_0_in_comment_for_1(
- broken,
- reflection.getFriendlyFullName(),
- ),
- );
- }
+ reportBrokenCommentLink(broken, reflection, logger);
}
if (
@@ -132,22 +110,35 @@ function checkReflection(reflection: Reflection, logger: Logger) {
getBrokenPartLinks,
)
) {
- if (broken.startsWith("@") && !broken.includes("!")) {
- logger.warn(
- i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(
- broken,
- reflection.getFriendlyFullName(),
- broken.replace(/[.#~]/, "!"),
- ),
- );
- } else {
- logger.warn(
- i18n.failed_to_resolve_link_to_0_in_comment_for_1(
- broken,
- reflection.getFriendlyFullName(),
- ),
- );
- }
+ reportBrokenCommentLink(broken, reflection, logger);
}
}
}
+
+function reportBrokenCommentLink(broken: InlineTagDisplayPart, reflection: Reflection, logger: Logger) {
+ const linkText = broken.text.trim();
+ if (broken.target instanceof ReflectionSymbolId) {
+ logger.warn(
+ i18n.comment_for_0_links_to_1_not_included_in_docs_use_external_link_2(
+ reflection.getFriendlyFullName(),
+ linkText,
+ `{ "${broken.target.packageName}": { "${broken.target.qualifiedName}": "#" }}`,
+ ),
+ );
+ } else if (linkText.startsWith("@") && !linkText.includes("!")) {
+ logger.warn(
+ i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(
+ linkText,
+ reflection.getFriendlyFullName(),
+ linkText.replace(/[.#~]/, "!"),
+ ),
+ );
+ } else {
+ logger.warn(
+ i18n.failed_to_resolve_link_to_0_in_comment_for_1(
+ linkText,
+ reflection.getFriendlyFullName(),
+ ),
+ );
+ }
+}
diff --git a/src/test/Repository.test.ts b/src/test/Repository.test.ts
index a3995d5b0..014addabb 100644
--- a/src/test/Repository.test.ts
+++ b/src/test/Repository.test.ts
@@ -260,7 +260,7 @@ describe("RepositoryManager - git enabled", () => {
it("Handles a nested repository", () => {
const sub = normalizePath(join(fix.cwd, "sub_repo/repo.txt"));
- const repo = manager.getRepository(sub) as GitRepository;
+ const repo = manager.getRepository(sub) as GitRepository | undefined;
ok(repo);
equal(repo.path, normalizePath(join(fix.cwd, "sub_repo")));
equal(repo.getURL(sub, 1), "link:repo.txt");
@@ -314,3 +314,51 @@ describe("RepositoryManager - git enabled", () => {
equal(repo.getURL(ign, 1), undefined);
});
});
+
+describe("RepositoryManager - edge cases", () => {
+ let fix: Project;
+ const logger = new TestLogger();
+ const manager = new RepositoryManager(
+ "",
+ "",
+ "remote",
+ "",
+ false, // disable git
+ logger,
+ );
+
+ beforeEach(() => {
+ fix = tempdirProject();
+ });
+
+ afterEach(() => {
+ fix.rm();
+ logger.expectNoOtherMessages();
+ });
+
+ it("Handles repositories without any commit", () => {
+ fix.write();
+ git(fix.cwd, "init", "-b", "test");
+ equal(manager.getRepository(fix.cwd + "/test.txt"), undefined);
+ });
+
+ it("Handles a remote which does not exist", () => {
+ fix.addFile("test.txt");
+ fix.write();
+ git(fix.cwd, "init", "-b", "test");
+ git(fix.cwd, "add", ".");
+ git(fix.cwd, "commit", "-m", "test", "--no-gpg-sign");
+ equal(manager.getRepository(fix.cwd + "/test.txt"), undefined);
+ logger.expectMessage('warn: The provided git remote "remote" was not valid. Source links will be broken');
+ });
+
+ it("Handles a remote which does not match a known domain", () => {
+ fix.addFile("test.txt");
+ fix.write();
+ git(fix.cwd, "init", "-b", "test");
+ git(fix.cwd, "add", ".");
+ git(fix.cwd, "commit", "-m", "test", "--no-gpg-sign");
+ git(fix.cwd, "remote", "add", "remote", "https://example.com/fake.git");
+ equal(manager.getRepository(fix.cwd + "/test.txt"), undefined);
+ });
+});
diff --git a/src/test/TestLogger.ts b/src/test/TestLogger.ts
index f94670d1b..0975b1692 100644
--- a/src/test/TestLogger.ts
+++ b/src/test/TestLogger.ts
@@ -41,10 +41,8 @@ export class TestLogger extends Logger {
}
}
- expectNoOtherMessages({ ignoreDebug } = { ignoreDebug: true }) {
- const messages = ignoreDebug
- ? this.messages.filter((msg) => !msg.startsWith("debug"))
- : this.messages;
+ expectNoOtherMessages() {
+ const messages = this.messages.filter((msg) => !msg.startsWith("debug"));
ok(
messages.length === 0,
diff --git a/src/test/behavior.c2.test.ts b/src/test/behavior.c2.test.ts
index d410bcd29..c35d2e91a 100644
--- a/src/test/behavior.c2.test.ts
+++ b/src/test/behavior.c2.test.ts
@@ -887,6 +887,26 @@ describe("Behavior Tests", () => {
]);
});
+ it("Handles links which do not resolve correctly", () => {
+ const project = convert("linkResolutionErrors");
+ app.options.setValue("validation", {
+ invalidLink: true,
+ notDocumented: false,
+ notExported: false,
+ });
+
+ app.validate(project);
+ logger.expectMessage(
+ 'warn: The comment for abc links to "Map.size" which was resolved but is not included in the documentation. To fix this warning export it or add { "typescript": { "Map.size": "#" }} to the externalSymbolLinkMappings option',
+ );
+ logger.expectMessage(
+ 'warn: Failed to resolve link to "DoesNotExist" in comment for abc',
+ );
+ logger.expectMessage(
+ 'warn: Failed to resolve link to "@typedoc/foo.DoesNotExist" in comment for abc. You may have wanted "@typedoc/foo!DoesNotExist"',
+ );
+ });
+
it("Handles merged declarations", () => {
const project = convert("mergedDeclarations");
const a = query(project, "SingleCommentMultiDeclaration");
@@ -988,10 +1008,25 @@ describe("Behavior Tests", () => {
project.removeReflection(query(project, "nested"));
equal(
Object.values(project.reflections).map((r) => r.name),
- ["typedoc"],
+ ["typedoc", "Base", "NotHidden", "NotHiddenImpl", "constructor", "NotHiddenImpl"],
);
});
+ it("Removes heritage clause references to hidden classes.", () => {
+ const project = convert("removeReflection");
+ const Base = query(project, "Base");
+ equal(Base.extendedBy, undefined);
+ equal(Base.implementedBy, undefined);
+
+ const NotHidden = query(project, "NotHidden");
+ equal(NotHidden.extendedTypes, undefined);
+ equal(NotHidden.implementedTypes, undefined);
+
+ const NotHiddenImpl = query(project, "NotHiddenImpl");
+ equal(NotHiddenImpl.extendedTypes, undefined);
+ equal(NotHiddenImpl.implementedTypes, undefined);
+ });
+
it("Handles @see tags", () => {
const project = convert("seeTags");
const foo = query(project, "foo");
@@ -1083,36 +1118,17 @@ describe("Behavior Tests", () => {
const params = (name: string) => querySig(project, name).parameters?.map((p) => p.name);
- equal(params("functionWithADestructuredParameter"), [
- "destructuredParam",
- ]);
+ equal(params("singleParam"), ["params"]);
- equal(params("functionWithADestructuredParameterAndExtraParameters"), [
- "__namedParameters",
- "extraParameter",
- ]);
+ equal(params("extraParam"), ["params", "extraParameter"]);
- equal(
- params(
- "functionWithADestructuredParameterAndAnExtraParamDirective",
- ),
- ["__namedParameters"],
- );
-
- const logs = [
- 'warn: The signature functionWithADestructuredParameterAndExtraParameters has an @param with name "destructuredParam", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndExtraParameters has an @param with name "destructuredParam.paramZ", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndExtraParameters has an @param with name "destructuredParam.paramG", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndExtraParameters has an @param with name "destructuredParam.paramA", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndAnExtraParamDirective has an @param with name "fakeParameter", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndAnExtraParamDirective has an @param with name "destructuredParam", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndAnExtraParamDirective has an @param with name "destructuredParam.paramZ", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndAnExtraParamDirective has an @param with name "destructuredParam.paramG", which was not used',
- 'warn: The signature functionWithADestructuredParameterAndAnExtraParamDirective has an @param with name "destructuredParam.paramA", which was not used',
- ];
- for (const log of logs) {
- logger.expectMessage(log);
- }
+ equal(params("extraParamComment"), ["params"]);
+
+ equal(params("multiParam"), ["params", "params2", "__namedParameters"]);
+
+ logger.expectMessage(
+ 'warn: The signature extraParamComment has an @param with name "fakeParameter", which was not used',
+ );
logger.expectNoOtherMessages();
});
@@ -1431,17 +1447,66 @@ describe("Behavior Tests", () => {
});
it("Supports @document tags", () => {
- const project = convert("documentTag");
+ const project = convert("documents/docs");
equal(reflToTree(project), {
- HasDescriptor: "Interface",
+ hasDocs: "Variable",
});
- const refl = query(project, "HasDescriptor");
- equal(refl.documents?.length, 1);
+ equal(project.documents?.length, 1);
+
+ equal(project.documents[0].content, [
+ { kind: "text", text: "Link to [project](" },
+ { kind: "relative-link", target: 1, targetAnchor: undefined, text: "./docs.ts" },
+ { kind: "text", text: ")" },
+ ]);
+
+ equal(project.readme, [
+ { kind: "text", text: "Doc projects readme: [docs](" },
+ { kind: "relative-link", target: 2, targetAnchor: undefined, text: "./doc.md" },
+ { kind: "text", text: ")" },
+ ]);
+ });
+
+ it("Supports the @sortStrategy tag #2965", () => {
+ const project = convert("sortStrategyTag");
+
+ const getOrder = (name: string) => query(project, name).children?.map(c => c.name);
+
+ equal(getOrder("A"), ["b", "c", "a"]);
+ equal(getOrder("B"), ["a", "b", "c"]);
+ equal(getOrder("C"), ["b", "c", "a"]);
+
+ const getGroupOrders = (name: string) =>
+ query(project, name).groups?.map(g => [g.title, g.children.map(c => c.name)]);
+
+ equal(getGroupOrders("A"), [
+ ["Variables", ["b", "a"]],
+ ["Functions", ["c"]],
+ ]);
+
+ equal(getGroupOrders("B"), [
+ ["Variables", ["a", "b"]],
+ ["Functions", ["c"]],
+ ]);
+
+ equal(getGroupOrders("C"), [
+ ["Variables", ["b", "c"]],
+ ["Functions", ["a"]],
+ ]);
+
+ const getCategoryOrders = (name: string) =>
+ query(project, name).categories?.map(g => [g.title, g.children.map(c => c.name)]);
- equal(refl.documents[0].content, [
- { kind: "text", text: "External doc!" },
+ equal(getCategoryOrders("D"), [
+ ["Cat", ["b", "a", "c"]],
]);
+
+ logger.expectMessage(
+ `warn: Comment for E specifies @sortStrategy with "invalid", which is an invalid sort strategy*`,
+ );
+ logger.expectMessage(
+ `warn: Comment for E specifies @sortStrategy with "invalid2", which is an invalid sort strategy*`,
+ );
});
});
diff --git a/src/test/comments.test.ts b/src/test/comments.test.ts
index cc1d9c6f1..8a95a98c0 100644
--- a/src/test/comments.test.ts
+++ b/src/test/comments.test.ts
@@ -5,14 +5,18 @@ import type { CommentParserConfig } from "../lib/converter/comments/index.js";
import { lexBlockComment } from "../lib/converter/comments/blockLexer.js";
import { lexLineComments } from "../lib/converter/comments/lineLexer.js";
import { type Token, TokenSyntaxKind } from "../lib/converter/comments/lexer.js";
-import { parseComment } from "../lib/converter/comments/parser.js";
+import { parseComment, parseCommentString } from "../lib/converter/comments/parser.js";
import { lexCommentString } from "../lib/converter/comments/rawLexer.js";
import { Comment, type CommentDisplayPart, CommentTag } from "../lib/models/index.js";
import { TestLogger } from "./TestLogger.js";
import { extractTagName } from "../lib/converter/comments/tagName.js";
-import { FileRegistry } from "../lib/models/FileRegistry.js";
+import { type FileId, FileRegistry } from "../lib/models/FileRegistry.js";
import { dedent, MinimalSourceFile, type NormalizedPath } from "#utils";
+const neverCalled = () => {
+ throw new Error("Should not be called");
+};
+
describe("Block Comment Lexer", () => {
function lex(text: string): Token[] {
return Array.from(lexBlockComment(text));
@@ -186,7 +190,7 @@ describe("Block Comment Lexer", () => {
});
it("Should recognize tags", () => {
- const tokens = lex("/* @tag @a @abc234 */");
+ const tokens = lex("/* @tag @a @abc234 @abc-234 */");
equal(tokens, [
{ kind: TokenSyntaxKind.Tag, text: "@tag", pos: 3 },
@@ -194,6 +198,8 @@ describe("Block Comment Lexer", () => {
{ kind: TokenSyntaxKind.Tag, text: "@a", pos: 8 },
{ kind: TokenSyntaxKind.Text, text: " ", pos: 10 },
{ kind: TokenSyntaxKind.Tag, text: "@abc234", pos: 11 },
+ { kind: TokenSyntaxKind.Text, text: " ", pos: 18 },
+ { kind: TokenSyntaxKind.Tag, text: "@abc-234", pos: 19 },
]);
});
@@ -641,7 +647,7 @@ describe("Line Comment Lexer", () => {
});
it("Should recognize tags", () => {
- const tokens = lex("// @tag @a @abc234");
+ const tokens = lex("// @tag @a @abc234 @abc-234");
equal(tokens, [
{ kind: TokenSyntaxKind.Tag, text: "@tag", pos: 3 },
@@ -649,6 +655,8 @@ describe("Line Comment Lexer", () => {
{ kind: TokenSyntaxKind.Tag, text: "@a", pos: 8 },
{ kind: TokenSyntaxKind.Text, text: " ", pos: 10 },
{ kind: TokenSyntaxKind.Tag, text: "@abc234", pos: 11 },
+ { kind: TokenSyntaxKind.Text, text: " ", pos: 18 },
+ { kind: TokenSyntaxKind.Tag, text: "@abc-234", pos: 19 },
]);
});
@@ -993,12 +1001,12 @@ describe("Raw Lexer", () => {
});
it("Should not recognize tags", () => {
- const tokens = lex("@123 @@ @ @tag @a @abc234");
+ const tokens = lex("@123 @@ @ @tag @a @abc234 @abc-234");
equal(tokens, [
{
kind: TokenSyntaxKind.Text,
- text: "@123 @@ @ @tag @a @abc234",
+ text: "@123 @@ @ @tag @a @abc234 @abc-234",
pos: 0,
},
]);
@@ -1137,6 +1145,7 @@ describe("Comment Parser", () => {
"@event",
"@packageDocumentation",
]),
+ preservedTypeAnnotationTags: new Set(["@fires"]),
jsDocCompatibility: {
defaultTag: true,
exampleTag: true,
@@ -1155,10 +1164,8 @@ describe("Comment Parser", () => {
const content = lexBlockComment(file);
const comment = parseComment(
content,
- config,
new MinimalSourceFile(file, "/dev/zero" as NormalizedPath),
- logger,
- files,
+ { logger, files, config, createSymbolId: neverCalled },
);
equal(
@@ -1182,10 +1189,8 @@ describe("Comment Parser", () => {
const content = lexBlockComment(file);
const comment = parseComment(
content,
- config,
new MinimalSourceFile(file, "/dev/zero" as NormalizedPath),
- logger,
- files,
+ { logger, files, config, createSymbolId: neverCalled },
);
equal(
@@ -1210,10 +1215,8 @@ describe("Comment Parser", () => {
const content = lexBlockComment(file);
const comment = parseComment(
content,
- config,
new MinimalSourceFile(file, "/dev/zero" as NormalizedPath),
- logger,
- files,
+ { logger, files, config, createSymbolId: neverCalled },
);
equal(
@@ -1238,10 +1241,8 @@ describe("Comment Parser", () => {
const content = lexBlockComment(file);
const comment = parseComment(
content,
- config,
new MinimalSourceFile(file, "/dev/zero" as NormalizedPath),
- logger,
- files,
+ { logger, files, config, createSymbolId: neverCalled },
);
logger.expectMessage(
@@ -1258,10 +1259,8 @@ describe("Comment Parser", () => {
const content = lexBlockComment(text);
const comment = parseComment(
content,
- config,
new MinimalSourceFile(text, "/dev/zero" as NormalizedPath),
- logger,
- files,
+ { logger, files, config, createSymbolId: neverCalled },
);
logger.expectNoOtherMessages();
return comment;
@@ -1418,14 +1417,14 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./relative.md",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
{ kind: "text", text: ") ![](" },
{
kind: "relative-link",
text: "image.png",
- target: 2,
+ target: 2 as FileId,
targetAnchor: undefined,
},
{
@@ -1457,7 +1456,7 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./relative.md",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
// Labels can also include single newlines
@@ -1467,7 +1466,7 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./relative.md",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
// But not double!
@@ -1492,7 +1491,7 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./relative.md",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
{ kind: "text", text: ")" },
@@ -1500,12 +1499,67 @@ describe("Comment Parser", () => {
);
});
+ it("Recognizes markdown links which contain parentheses and escapes in the label", () => {
+ const comment = getComment(String.raw`/**
+ * [(parens) \[brackets\]](./relative.md)
+ *
+ * [
+ * multi-line
+ * \[brackets\]
+ * (parens)
+ * ](
+ * ./relative.md
+ * )
+ */`);
+
+ const link = {
+ kind: "relative-link",
+ text: "./relative.md",
+ target: 1 as FileId,
+ targetAnchor: undefined,
+ } as const;
+
+ equal(
+ comment.summary,
+ [
+ { kind: "text", text: String.raw`[(parens) \[brackets\]](` },
+ link,
+ { kind: "text", text: `)\n\n[\n multi-line\n ${String.raw`\[brackets\]`}\n (parens)\n](\n ` },
+ link,
+ { kind: "text", text: "\n )" },
+ ] satisfies CommentDisplayPart[],
+ );
+ });
+
+ it("Parses markdown link titles with arbitrarily-separated arbitrary combinations of text and code", () => {
+ const comment = `/**
+ [text](./1)
+ [text \`code\`]( \t ./2 )
+ [\ntext \`code\`\n](./3)
+ [\ntext\n\`code\`\n]( ./4 )
+ [ \t\`code\` text]( \t./5\t )
+
+ [\n\n\`code\`](./no1)
+ [text\n\n](./no2)
+ [ text\n](\n \n ./no3 \n)
+ [ text\n\ntext](./no4)
+ */`;
+
+ const relativeParts = getComment(comment).summary.filter(p => p.kind === "relative-link");
+
+ for (let i = 0; i < relativeParts.length; i++) {
+ equal(relativeParts[i].text, `./${i + 1}`);
+ }
+ equal(relativeParts.length, 5);
+ });
+
it("Recognizes markdown reference definition blocks", () => {
const comment = getComment(`/**
* [1]: ./example.md
* [2]:<./example with space>
* [3]: https://example.com
* [4]: #hash
+ * [^footnote]: ./example.md
*/`);
equal(
@@ -1515,19 +1569,19 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./example.md",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
{ kind: "text", text: "\n[2]:" },
{
kind: "relative-link",
text: "<./example with space>",
- target: 2,
+ target: 2 as FileId,
targetAnchor: undefined,
},
{
kind: "text",
- text: "\n[3]: https://example.com\n[4]: #hash",
+ text: "\n[3]: https://example.com\n[4]: #hash\n[^footnote]: ./example.md",
},
] satisfies CommentDisplayPart[],
);
@@ -1560,14 +1614,14 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./test.png",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
{ kind: "text", text: '" >\n
{
);
});
+ it("Recognizes HTML picture source srcset links", () => {
+ const comment = getComment(`/**
+ *
+ *
+ *
+ */`);
+
+ equal(
+ comment.summary,
+ [
+ { kind: "text", text: '\n\n',
+ },
+ ] satisfies CommentDisplayPart[],
+ );
+ });
+
+ it("Recognizes links", () => {
+ const comment = getComment(`/**
+ *
+ */`);
+
+ equal(
+ comment.summary,
+ [
+ { kind: "text", text: '' },
+ ] satisfies CommentDisplayPart[],
+ );
+ });
+
+ it("Recognizes HTML audio and video src links", () => {
+ const comment = getComment(`/**
+ *
+ *
+ */`);
+
+ equal(
+ comment.summary,
+ [
+ { kind: "text", text: '\n',
+ },
+ ] satisfies CommentDisplayPart[],
+ );
+ });
+
+ it("Recognizes img tag with both src and srcset", () => {
+ const comment = getComment(`/**
+ * 
+ */`);
+
+ equal(
+ comment.summary,
+ [
+ { kind: "text", text: '
',
+ },
+ ] satisfies CommentDisplayPart[],
+ );
+ });
+
it("Recognizes HTML anchor links", () => {
const comment = getComment(`/**
*
@@ -1593,14 +1789,14 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./test.png",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
{ kind: "text", text: '" >\n {
{
kind: "relative-link",
text: "./path.md#foo",
- target: 1,
+ target: 1 as FileId,
targetAnchor: "foo",
},
{ kind: "text", text: '" >\n[test](' },
{
kind: "relative-link",
text: "./test.txt#bar",
- target: 2,
+ target: 2 as FileId,
targetAnchor: "bar",
},
{ kind: "text", text: ")" },
@@ -1651,15 +1847,116 @@ describe("Comment Parser", () => {
{
kind: "relative-link",
text: "./&a.png",
- target: 1,
+ target: 1 as FileId,
targetAnchor: undefined,
},
{ kind: "text", text: '" >' },
] satisfies CommentDisplayPart[],
);
- equal(files.getName(1), "&a.png");
- equal(files.getName(1), "&a.png");
+ equal(files.getName(1 as FileId), "&a.png");
+ equal(files.getName(1 as FileId), "&a.png");
+ });
+});
+
+describe("Raw Comment Parser", () => {
+ const config: CommentParserConfig = {
+ blockTags: new Set([
+ "@param",
+ "@remarks",
+ "@module",
+ "@inheritDoc",
+ "@defaultValue",
+ ]),
+ inlineTags: new Set(["@link"]),
+ modifierTags: new Set([
+ "@public",
+ "@private",
+ "@protected",
+ "@readonly",
+ "@enum",
+ "@event",
+ "@packageDocumentation",
+ ]),
+ preservedTypeAnnotationTags: new Set(["@fires"]),
+ jsDocCompatibility: {
+ defaultTag: true,
+ exampleTag: true,
+ ignoreUnescapedBraces: false,
+ inheritDocTag: false,
+ },
+ suppressCommentWarningsInDeclarationFiles: false,
+ useTsLinkResolution: false,
+ commentStyle: "jsdoc",
+ };
+
+ function getComment(text: string) {
+ const files = new FileRegistry();
+ const logger = new TestLogger();
+ const content = lexCommentString(text);
+ const comment = parseCommentString(
+ content,
+ config,
+ new MinimalSourceFile(text, "/dev/zero" as NormalizedPath),
+ logger,
+ files,
+ );
+ logger.expectNoOtherMessages();
+ return comment;
+ }
+
+ it("Recognizes markdown links which contain parentheses and escapes in the label", () => {
+ const comment = getComment(dedent(String.raw`
+ [(parens) \[brackets\]](./relative.md)
+
+ [
+ multi-line
+ \[brackets\]
+ (parens)
+ ](
+ ./relative.md
+ )
+ `));
+
+ const link = {
+ kind: "relative-link",
+ text: "./relative.md",
+ target: 1 as FileId,
+ targetAnchor: undefined,
+ } as const;
+
+ equal(
+ comment.content,
+ [
+ { kind: "text", text: String.raw`[(parens) \[brackets\]](` },
+ link,
+ { kind: "text", text: `)\n\n[\n multi-line\n ${String.raw`\[brackets\]`}\n (parens)\n](\n ` },
+ link,
+ { kind: "text", text: "\n )" },
+ ] satisfies CommentDisplayPart[],
+ );
+ });
+
+ it("Parses markdown link titles with arbitrarily-separated arbitrary combinations of text and code", () => {
+ const comment = `/**
+ [text](./1)
+ [text \`code\`]( \t ./2 )
+ [\ntext \`code\`\n](./3)
+ [\ntext\n\`code\`\n]( ./4 )
+ [ \t\`code\` text]( \t./5\t )
+
+ [\n\n\`code\`](./no1)
+ [text\n\n](./no2)
+ [ text\n](\n \n ./no3 \n)
+ [ text\n\ntext](./no4)
+ */`;
+
+ const relativeParts = getComment(comment).content.filter(p => p.kind === "relative-link");
+
+ for (let i = 0; i < relativeParts.length; i++) {
+ equal(relativeParts[i].text, `./${i + 1}`);
+ }
+ equal(relativeParts.length, 5);
});
});
diff --git a/src/test/converter.test.ts b/src/test/converter.test.ts
index bad427dc4..ce1072d2a 100644
--- a/src/test/converter.test.ts
+++ b/src/test/converter.test.ts
@@ -21,7 +21,6 @@ import type { ModelToObject } from "../lib/serialization/schema.js";
import { getExpandedEntryPointsForPaths, normalizePath } from "../lib/utils/index.js";
import { getConverterApp, getConverterBase, getConverterProgram } from "./programs.js";
import { FileRegistry } from "../lib/models/FileRegistry.js";
-import { ValidatingFileRegistry } from "../lib/utils/ValidatingFileRegistry.js";
const comparisonSerializer = new Serializer();
comparisonSerializer.addSerializer({
@@ -201,7 +200,7 @@ describe("Converter", function () {
it(`[${file}] converts fixtures`, function () {
before();
resetReflectionID();
- app.files = new ValidatingFileRegistry();
+ app.files = new FileRegistry();
const entryPoints = getExpandedEntryPointsForPaths(
app.logger,
[path],
diff --git a/src/test/converter/class/class.ts b/src/test/converter/class/class.ts
index e46637b75..a1b693ce2 100644
--- a/src/test/converter/class/class.ts
+++ b/src/test/converter/class/class.ts
@@ -106,7 +106,7 @@ export interface TestSubClass {
mergedMethod();
}
-export module TestSubClass {
+export namespace TestSubClass {
/**
* staticMergedMethod short text.
*/
diff --git a/src/test/converter/class/specs-with-lump-categories.json b/src/test/converter/class/specs-with-lump-categories.json
index 96ab944f1..e63c9b6a6 100644
--- a/src/test/converter/class/specs-with-lump-categories.json
+++ b/src/test/converter/class/specs-with-lump-categories.json
@@ -565,7 +565,7 @@
{
"fileName": "class.ts",
"line": 109,
- "character": 14,
+ "character": 17,
"url": "typedoc://class.ts#L109"
}
]
@@ -2239,7 +2239,7 @@
{
"fileName": "class.ts",
"line": 109,
- "character": 14,
+ "character": 17,
"url": "typedoc://class.ts#L109"
}
],
@@ -4824,7 +4824,11 @@
"character": 13,
"url": "typedoc://getter-setter.ts#L22"
}
- ]
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
},
{
"id": 190,
diff --git a/src/test/converter/class/specs.json b/src/test/converter/class/specs.json
index 96ab944f1..e63c9b6a6 100644
--- a/src/test/converter/class/specs.json
+++ b/src/test/converter/class/specs.json
@@ -565,7 +565,7 @@
{
"fileName": "class.ts",
"line": 109,
- "character": 14,
+ "character": 17,
"url": "typedoc://class.ts#L109"
}
]
@@ -2239,7 +2239,7 @@
{
"fileName": "class.ts",
"line": 109,
- "character": 14,
+ "character": 17,
"url": "typedoc://class.ts#L109"
}
],
@@ -4824,7 +4824,11 @@
"character": 13,
"url": "typedoc://getter-setter.ts#L22"
}
- ]
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
},
{
"id": 190,
diff --git a/src/test/converter/comment/comment.ts b/src/test/converter/comment/comment.ts
index c8c079e7a..785827ab1 100644
--- a/src/test/converter/comment/comment.ts
+++ b/src/test/converter/comment/comment.ts
@@ -1,5 +1,5 @@
/**
- * Module doc comment with document.
+ * Module doc comment with document and link to [self](./comment.ts) and {@link https://example.com}
*
* @document document.md
* @packageDocumentation
@@ -32,6 +32,8 @@ import "./comment2";
*
* @groupDescription Methods
* Methods description!
+ *
+ * @gh3020 {type annotation}
*/
export class CommentedClass {
/**
diff --git a/src/test/converter/comment/specs.json b/src/test/converter/comment/specs.json
index 50d02f6c3..509d4b241 100644
--- a/src/test/converter/comment/specs.json
+++ b/src/test/converter/comment/specs.json
@@ -16,7 +16,22 @@
"summary": [
{
"kind": "text",
- "text": "Module doc comment with document."
+ "text": "Module doc comment with document and link to [self]("
+ },
+ {
+ "kind": "relative-link",
+ "text": "./comment.ts",
+ "target": 1
+ },
+ {
+ "kind": "text",
+ "text": ") and "
+ },
+ {
+ "kind": "inline-tag",
+ "tag": "@link",
+ "text": "https://example.com",
+ "target": "https://example.com"
}
]
},
@@ -51,6 +66,11 @@
"text": "Methods\nMethods description!"
}
]
+ },
+ {
+ "tag": "@gh3020",
+ "content": [],
+ "typeAnnotation": "{type annotation}"
}
]
},
@@ -94,9 +114,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 40,
+ "line": 42,
"character": 4,
- "url": "typedoc://comment.ts#L40"
+ "url": "typedoc://comment.ts#L42"
}
],
"type": {
@@ -113,9 +133,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 80,
+ "line": 82,
"character": 4,
- "url": "typedoc://comment.ts#L80"
+ "url": "typedoc://comment.ts#L82"
}
],
"signatures": [
@@ -136,9 +156,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 80,
+ "line": 82,
"character": 4,
- "url": "typedoc://comment.ts#L80"
+ "url": "typedoc://comment.ts#L82"
}
],
"parameters": [
@@ -202,9 +222,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 36,
+ "line": 38,
"character": 13,
- "url": "typedoc://comment.ts#L36"
+ "url": "typedoc://comment.ts#L38"
}
]
},
@@ -217,9 +237,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 89,
+ "line": 91,
"character": 12,
- "url": "typedoc://comment.ts#L89"
+ "url": "typedoc://comment.ts#L91"
}
],
"type": {
diff --git a/src/test/converter/enum/enum.ts b/src/test/converter/enum/enum.ts
index 5152f41ff..394ee4a47 100644
--- a/src/test/converter/enum/enum.ts
+++ b/src/test/converter/enum/enum.ts
@@ -41,7 +41,7 @@ export enum ModuleEnum {
/**
* This is a module extending an enumeration.
*/
-export module ModuleEnum {
+export namespace ModuleEnum {
/**
* This is a variable appended to an enumeration.
*/
diff --git a/src/test/converter/enum/specs.json b/src/test/converter/enum/specs.json
index d59f01d7e..144d9a4ff 100644
--- a/src/test/converter/enum/specs.json
+++ b/src/test/converter/enum/specs.json
@@ -117,7 +117,7 @@
{
"fileName": "enum.ts",
"line": 44,
- "character": 14,
+ "character": 17,
"url": "typedoc://enum.ts#L44"
}
]
@@ -313,7 +313,7 @@
{
"fileName": "enum.ts",
"line": 44,
- "character": 14,
+ "character": 17,
"url": "typedoc://enum.ts#L44"
}
]
diff --git a/src/test/converter/enum/specs.nodoc.json b/src/test/converter/enum/specs.nodoc.json
index d59f01d7e..144d9a4ff 100644
--- a/src/test/converter/enum/specs.nodoc.json
+++ b/src/test/converter/enum/specs.nodoc.json
@@ -117,7 +117,7 @@
{
"fileName": "enum.ts",
"line": 44,
- "character": 14,
+ "character": 17,
"url": "typedoc://enum.ts#L44"
}
]
@@ -313,7 +313,7 @@
{
"fileName": "enum.ts",
"line": 44,
- "character": 14,
+ "character": 17,
"url": "typedoc://enum.ts#L44"
}
]
diff --git a/src/test/converter/function/function.ts b/src/test/converter/function/function.ts
index f90d3c5af..077a9a6f7 100644
--- a/src/test/converter/function/function.ts
+++ b/src/test/converter/function/function.ts
@@ -161,7 +161,7 @@ export function isNonNull(arg: T | null | undefined): arg is T {
/**
* This is the module extending the function moduleFunction().
*/
-export module moduleFunction {
+export namespace moduleFunction {
/**
* This variable is appended to a function.
*/
diff --git a/src/test/converter/function/specs.json b/src/test/converter/function/specs.json
index eb4d6085a..6c66ee7ef 100644
--- a/src/test/converter/function/specs.json
+++ b/src/test/converter/function/specs.json
@@ -169,7 +169,7 @@
{
"fileName": "function.ts",
"line": 164,
- "character": 14,
+ "character": 17,
"url": "typedoc://function.ts#L164"
}
]
@@ -841,19 +841,19 @@
"type": "union",
"types": [
{
- "type": "intrinsic",
- "name": "undefined"
+ "type": "reference",
+ "target": 47,
+ "name": "T",
+ "package": "typedoc",
+ "refersToTypeParameter": true
},
{
"type": "literal",
"value": null
},
{
- "type": "reference",
- "target": 47,
- "name": "T",
- "package": "typedoc",
- "refersToTypeParameter": true
+ "type": "intrinsic",
+ "name": "undefined"
}
]
}
@@ -921,11 +921,11 @@
"types": [
{
"type": "intrinsic",
- "name": "undefined"
+ "name": "boolean"
},
{
"type": "intrinsic",
- "name": "boolean"
+ "name": "undefined"
}
]
}
@@ -1543,19 +1543,19 @@
"type": "union",
"types": [
{
- "type": "intrinsic",
- "name": "undefined"
+ "type": "reference",
+ "target": 51,
+ "name": "T",
+ "package": "typedoc",
+ "refersToTypeParameter": true
},
{
"type": "literal",
"value": null
},
{
- "type": "reference",
- "target": 51,
- "name": "T",
- "package": "typedoc",
- "refersToTypeParameter": true
+ "type": "intrinsic",
+ "name": "undefined"
}
]
}
@@ -1680,7 +1680,7 @@
{
"fileName": "function.ts",
"line": 164,
- "character": 14,
+ "character": 17,
"url": "typedoc://function.ts#L164"
}
],
diff --git a/src/test/converter/inheritance/inherit-doc.ts b/src/test/converter/inheritance/inherit-doc.ts
index 6e0c495d2..09a330282 100644
--- a/src/test/converter/inheritance/inherit-doc.ts
+++ b/src/test/converter/inheritance/inherit-doc.ts
@@ -71,7 +71,6 @@ export function functionSource(arg1: T, arg2: T): string {
* @typeParam T - This will be inherited
* @param arg1 - This will be inherited
* @param arg2 - This will be inherited
- * @returns This will be inherited
*/
export function functionTargetLocal(arg1: T, arg2: T) {
return "";
diff --git a/src/test/converter/inheritance/specs.json b/src/test/converter/inheritance/specs.json
index 4e458b53e..74aabc605 100644
--- a/src/test/converter/inheritance/specs.json
+++ b/src/test/converter/inheritance/specs.json
@@ -466,9 +466,9 @@
"sources": [
{
"fileName": "inherit-doc.ts",
- "line": 76,
+ "line": 75,
"character": 16,
- "url": "typedoc://inherit-doc.ts#L76"
+ "url": "typedoc://inherit-doc.ts#L75"
}
],
"signatures": [
@@ -504,15 +504,6 @@
}
]
},
- {
- "tag": "@returns",
- "content": [
- {
- "kind": "text",
- "text": "This will be inherited"
- }
- ]
- },
{
"tag": "@returns",
"content": [
@@ -527,9 +518,9 @@
"sources": [
{
"fileName": "inherit-doc.ts",
- "line": 76,
+ "line": 75,
"character": 16,
- "url": "typedoc://inherit-doc.ts#L76"
+ "url": "typedoc://inherit-doc.ts#L75"
}
],
"typeParameters": [
@@ -680,14 +671,16 @@
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "My.constructor"
+ "name": "My.constructor",
+ "package": "typedoc"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "My.constructor"
+ "name": "My.constructor",
+ "package": "typedoc"
}
},
{
diff --git a/src/test/converter/interface/interface-implementation.ts b/src/test/converter/interface/interface-implementation.ts
index df9f78650..aefd892fb 100644
--- a/src/test/converter/interface/interface-implementation.ts
+++ b/src/test/converter/interface/interface-implementation.ts
@@ -1,4 +1,4 @@
-export module Forms {
+export namespace Forms {
/**
* Function signature of an event listener callback
*/
diff --git a/src/test/converter/interface/specs.json b/src/test/converter/interface/specs.json
index b629a2d17..c554d89a9 100644
--- a/src/test/converter/interface/specs.json
+++ b/src/test/converter/interface/specs.json
@@ -2235,7 +2235,7 @@
{
"fileName": "interface-implementation.ts",
"line": 1,
- "character": 14,
+ "character": 17,
"url": "typedoc://interface-implementation.ts#L1"
}
]
@@ -2546,8 +2546,8 @@
},
"inheritedFrom": {
"type": "reference",
- "target": 106,
- "name": "Base.base"
+ "target": 112,
+ "name": "Child.base"
}
},
{
diff --git a/src/test/converter/mixin/specs.json b/src/test/converter/mixin/specs.json
index 146ed2189..9ec8e447f 100644
--- a/src/test/converter/mixin/specs.json
+++ b/src/test/converter/mixin/specs.json
@@ -426,14 +426,16 @@
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin2(Mixin1Func(Base)).method1"
+ "name": "Mixin2(Mixin1Func(Base)).method1",
+ "package": "typedoc"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin2(Mixin1Func(Base)).method1"
+ "name": "Mixin2(Mixin1Func(Base)).method1",
+ "package": "typedoc"
}
},
{
@@ -493,14 +495,16 @@
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin2(Mixin1Func(Base)).method2"
+ "name": "Mixin2(Mixin1Func(Base)).method2",
+ "package": "typedoc"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin2(Mixin1Func(Base)).method2"
+ "name": "Mixin2(Mixin1Func(Base)).method2",
+ "package": "typedoc"
}
}
],
@@ -875,14 +879,16 @@
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin.method1"
+ "name": "Mixin.method1",
+ "package": "typedoc"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin.method1"
+ "name": "Mixin.method1",
+ "package": "typedoc"
}
}
],
@@ -1139,14 +1145,16 @@
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin.method1"
+ "name": "Mixin.method1",
+ "package": "typedoc"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin.method1"
+ "name": "Mixin.method1",
+ "package": "typedoc"
}
},
{
@@ -1206,14 +1214,16 @@
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin.method2"
+ "name": "Mixin.method2",
+ "package": "typedoc"
}
}
],
"inheritedFrom": {
"type": "reference",
"target": -1,
- "name": "Mixin.method2"
+ "name": "Mixin.method2",
+ "package": "typedoc"
}
}
],
diff --git a/src/test/converter/types/specs.json b/src/test/converter/types/specs.json
index 1ee7e6aad..4431c5bab 100644
--- a/src/test/converter/types/specs.json
+++ b/src/test/converter/types/specs.json
@@ -1339,6 +1339,24 @@
"kind": 2,
"flags": {},
"children": [
+ {
+ "id": 68,
+ "name": "Empty",
+ "variant": "declaration",
+ "kind": 2097152,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "tuple.ts",
+ "line": 18,
+ "character": 12,
+ "url": "typedoc://tuple.ts#L18"
+ }
+ ],
+ "type": {
+ "type": "tuple"
+ }
+ },
{
"id": 66,
"name": "LeadingRest",
@@ -1732,6 +1750,7 @@
{
"title": "Type Aliases",
"children": [
+ 68,
66,
58,
64,
@@ -1760,14 +1779,14 @@
]
},
{
- "id": 68,
+ "id": 69,
"name": "type-operator",
"variant": "declaration",
"kind": 2,
"flags": {},
"children": [
{
- "id": 70,
+ "id": 71,
"name": "B",
"variant": "declaration",
"kind": 2097152,
@@ -1793,14 +1812,14 @@
}
},
{
- "id": 71,
+ "id": 72,
"name": "C",
"variant": "declaration",
"kind": 2097152,
"flags": {},
"children": [
{
- "id": 73,
+ "id": 74,
"name": "prop1",
"variant": "declaration",
"kind": 1024,
@@ -1819,7 +1838,7 @@
}
},
{
- "id": 74,
+ "id": 75,
"name": "prop2",
"variant": "declaration",
"kind": 1024,
@@ -1842,8 +1861,8 @@
{
"title": "Properties",
"children": [
- 73,
- 74
+ 74,
+ 75
]
}
],
@@ -1857,7 +1876,7 @@
]
},
{
- "id": 75,
+ "id": 76,
"name": "D",
"variant": "declaration",
"kind": 2097152,
@@ -1875,14 +1894,14 @@
"operator": "keyof",
"target": {
"type": "reference",
- "target": 71,
+ "target": 72,
"name": "C",
"package": "typedoc"
}
}
},
{
- "id": 69,
+ "id": 70,
"name": "a",
"variant": "declaration",
"kind": 32,
@@ -1912,15 +1931,15 @@
{
"title": "Type Aliases",
"children": [
- 70,
71,
- 75
+ 72,
+ 76
]
},
{
"title": "Variables",
"children": [
- 69
+ 70
]
}
],
@@ -1934,14 +1953,14 @@
]
},
{
- "id": 76,
+ "id": 77,
"name": "union-or-intersection",
"variant": "declaration",
"kind": 2,
"flags": {},
"children": [
{
- "id": 77,
+ "id": 78,
"name": "FirstType",
"variant": "declaration",
"kind": 256,
@@ -1956,7 +1975,7 @@
},
"children": [
{
- "id": 78,
+ "id": 79,
"name": "firstProperty",
"variant": "declaration",
"kind": 1024,
@@ -1987,7 +2006,7 @@
{
"title": "Properties",
"children": [
- 78
+ 79
]
}
],
@@ -2001,7 +2020,7 @@
]
},
{
- "id": 79,
+ "id": 80,
"name": "SecondType",
"variant": "declaration",
"kind": 256,
@@ -2016,7 +2035,7 @@
},
"children": [
{
- "id": 80,
+ "id": 81,
"name": "secondProperty",
"variant": "declaration",
"kind": 1024,
@@ -2047,7 +2066,7 @@
{
"title": "Properties",
"children": [
- 80
+ 81
]
}
],
@@ -2061,7 +2080,7 @@
]
},
{
- "id": 81,
+ "id": 82,
"name": "ThirdType",
"variant": "declaration",
"kind": 256,
@@ -2076,7 +2095,7 @@
},
"children": [
{
- "id": 84,
+ "id": 85,
"name": "thirdComplexProperty",
"variant": "declaration",
"kind": 1024,
@@ -2113,13 +2132,13 @@
"types": [
{
"type": "reference",
- "target": 77,
+ "target": 78,
"name": "FirstType",
"package": "typedoc"
},
{
"type": "reference",
- "target": 79,
+ "target": 80,
"name": "SecondType",
"package": "typedoc"
}
@@ -2131,7 +2150,7 @@
}
},
{
- "id": 83,
+ "id": 84,
"name": "thirdIntersectionProperty",
"variant": "declaration",
"kind": 1024,
@@ -2157,13 +2176,13 @@
"types": [
{
"type": "reference",
- "target": 77,
+ "target": 78,
"name": "FirstType",
"package": "typedoc"
},
{
"type": "reference",
- "target": 81,
+ "target": 82,
"name": "ThirdType",
"package": "typedoc"
}
@@ -2171,7 +2190,7 @@
}
},
{
- "id": 82,
+ "id": 83,
"name": "thirdUnionProperty",
"variant": "declaration",
"kind": 1024,
@@ -2197,13 +2216,13 @@
"types": [
{
"type": "reference",
- "target": 77,
+ "target": 78,
"name": "FirstType",
"package": "typedoc"
},
{
"type": "reference",
- "target": 79,
+ "target": 80,
"name": "SecondType",
"package": "typedoc"
}
@@ -2215,9 +2234,9 @@
{
"title": "Properties",
"children": [
+ 85,
84,
- 83,
- 82
+ 83
]
}
],
@@ -2235,9 +2254,9 @@
{
"title": "Interfaces",
"children": [
- 77,
- 79,
- 81
+ 78,
+ 80,
+ 82
]
}
],
@@ -2261,8 +2280,8 @@
50,
54,
57,
- 68,
- 76
+ 69,
+ 77
]
}
],
@@ -2559,81 +2578,86 @@
"qualifiedName": "leadingRest"
},
"68": {
+ "packageName": "typedoc",
+ "packagePath": "src/test/converter/types/tuple.ts",
+ "qualifiedName": "Empty"
+ },
+ "69": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/type-operator.ts",
"qualifiedName": ""
},
- "69": {
+ "70": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/type-operator.ts",
"qualifiedName": "a"
},
- "70": {
+ "71": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/type-operator.ts",
"qualifiedName": "B"
},
- "71": {
+ "72": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/type-operator.ts",
"qualifiedName": "C"
},
- "73": {
+ "74": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/type-operator.ts",
"qualifiedName": "__type.prop1"
},
- "74": {
+ "75": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/type-operator.ts",
"qualifiedName": "__type.prop2"
},
- "75": {
+ "76": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/type-operator.ts",
"qualifiedName": "D"
},
- "76": {
+ "77": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": ""
},
- "77": {
+ "78": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "FirstType"
},
- "78": {
+ "79": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "FirstType.firstProperty"
},
- "79": {
+ "80": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "SecondType"
},
- "80": {
+ "81": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "SecondType.secondProperty"
},
- "81": {
+ "82": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "ThirdType"
},
- "82": {
+ "83": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "ThirdType.thirdUnionProperty"
},
- "83": {
+ "84": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "ThirdType.thirdIntersectionProperty"
},
- "84": {
+ "85": {
"packageName": "typedoc",
"packagePath": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "ThirdType.thirdComplexProperty"
@@ -2657,8 +2681,8 @@
"4": 50,
"5": 54,
"6": 57,
- "7": 68,
- "8": 76
+ "7": 69,
+ "8": 77
}
}
}
diff --git a/src/test/converter/types/tuple.ts b/src/test/converter/types/tuple.ts
index fe473906b..7bc3116e1 100644
--- a/src/test/converter/types/tuple.ts
+++ b/src/test/converter/types/tuple.ts
@@ -15,6 +15,8 @@ export type LeadingRest = [...string[], number];
// returnMapped isn't good enough here.
export const leadingRest = {} as any as [...string[], number];
+export type Empty = [];
+
// Helper to force TS to give us types, rather than type nodes, for a given declaration.
function returnMapped() {
return {} as any as { [K in keyof T]: T[K] };
diff --git a/src/test/converter2/behavior/destructuredParamRenames.ts b/src/test/converter2/behavior/destructuredParamRenames.ts
index 437090c80..83fdd1600 100644
--- a/src/test/converter2/behavior/destructuredParamRenames.ts
+++ b/src/test/converter2/behavior/destructuredParamRenames.ts
@@ -1,95 +1,34 @@
/**
- * This is a function with a destructured parameter.
- *
- * @param destructuredParam - This is the parameter that is destructured.
- * @param destructuredParam.paramZ - This is a string parameter.
- * @param destructuredParam.paramG - This is a parameter flagged with any.
- * This sentence is placed in the next line.
- *
- * @param destructuredParam.paramA
- * This is a **parameter** pointing to an interface.
- *
- * ```
- * const value:BaseClass = new BaseClass('test');
- * functionWithArguments('arg', 0, value);
- * ```
- *
- * @returns This is the return value of the function.
+ * @param params - desc
+ * @param params.a - paramZ desc
*/
-export function functionWithADestructuredParameter({
- paramZ,
- paramG,
- paramA,
-}: {
- paramZ: string;
- paramG: any;
- paramA: Object;
-}): number {
+export function singleParam({ a }: { a: string }) {
return 0;
}
/**
- * This is a function with a destructured parameter and additional undocumented parameters.
- * The `@param` directives are ignored because we cannot be certain which parameter they refer to.
- *
- * @param destructuredParam - This is the parameter that is destructured.
- * @param destructuredParam.paramZ - This is a string parameter.
- * @param destructuredParam.paramG - This is a parameter flagged with any.
- * This sentence is placed in the next line.
- *
- * @param destructuredParam.paramA
- * This is a **parameter** pointing to an interface.
- *
- * ```
- * const value:BaseClass = new BaseClass('test');
- * functionWithArguments('arg', 0, value);
- * ```
- *
- * @returns This is the return value of the function.
+ * @param params - desc
*/
-export function functionWithADestructuredParameterAndExtraParameters(
- {
- paramZ,
- paramG,
- paramA,
- }: {
- paramZ: string;
- paramG: any;
- paramA: Object;
- },
- extraParameter: string,
-): number {
+export function extraParam({ a }: { a: string }, extraParameter: string) {
return 0;
}
/**
- * This is a function with a destructured parameter and an extra `@param` directive with no corresponding parameter.
- * The `@param` directives are ignored because we cannot be certain which corresponds to the real parameter.
- *
- * @param fakeParameter - This directive does not have a corresponding parameter.
- * @param destructuredParam - This is the parameter that is destructured.
- * @param destructuredParam.paramZ - This is a string parameter.
- * @param destructuredParam.paramG - This is a parameter flagged with any.
- * This sentence is placed in the next line.
- *
- * @param destructuredParam.paramA
- * This is a **parameter** pointing to an interface.
- *
- * ```
- * const value:BaseClass = new BaseClass('test');
- * functionWithArguments('arg', 0, value);
- * ```
- *
- * @returns This is the return value of the function.
+ * @param params param
+ * @param fakeParameter param2
*/
-export function functionWithADestructuredParameterAndAnExtraParamDirective({
- paramZ,
- paramG,
- paramA,
-}: {
- paramZ: string;
- paramG: any;
- paramA: Object;
-}): number {
+export function extraParamComment({ a }: { a: string }) {
+ return 0;
+}
+
+/**
+ * @param params params
+ * @param params2 params2
+ */
+export function multiParam(
+ { a }: { a: string },
+ { b }: { b: number },
+ { c }: { c: boolean },
+) {
return 0;
}
diff --git a/src/test/converter2/behavior/document.md b/src/test/converter2/behavior/document.md
deleted file mode 100644
index 794870100..000000000
--- a/src/test/converter2/behavior/document.md
+++ /dev/null
@@ -1 +0,0 @@
-External doc!
diff --git a/src/test/converter2/behavior/documentTag.ts b/src/test/converter2/behavior/documentTag.ts
deleted file mode 100644
index 71e00d05a..000000000
--- a/src/test/converter2/behavior/documentTag.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-/**
- * @document ./document.md
- */
-export interface HasDescriptor {
-}
diff --git a/src/test/converter2/behavior/documents/doc.md b/src/test/converter2/behavior/documents/doc.md
new file mode 100644
index 000000000..69daae76d
--- /dev/null
+++ b/src/test/converter2/behavior/documents/doc.md
@@ -0,0 +1 @@
+Link to [project](./docs.ts)
diff --git a/src/test/converter2/behavior/documents/docs.ts b/src/test/converter2/behavior/documents/docs.ts
new file mode 100644
index 000000000..c73719e9d
--- /dev/null
+++ b/src/test/converter2/behavior/documents/docs.ts
@@ -0,0 +1,8 @@
+/**
+ * Link to [doc](./doc.md)
+ *
+ * @module
+ * @document doc.md
+ */
+
+export const hasDocs = true;
diff --git a/src/test/converter2/behavior/documents/package.json b/src/test/converter2/behavior/documents/package.json
new file mode 100644
index 000000000..b724be201
--- /dev/null
+++ b/src/test/converter2/behavior/documents/package.json
@@ -0,0 +1,3 @@
+{
+ "name": "docs"
+}
diff --git a/src/test/converter2/behavior/documents/readme.md b/src/test/converter2/behavior/documents/readme.md
new file mode 100644
index 000000000..811c08d76
--- /dev/null
+++ b/src/test/converter2/behavior/documents/readme.md
@@ -0,0 +1 @@
+Doc projects readme: [docs](./doc.md)
diff --git a/src/test/converter2/behavior/linkResolutionErrors.ts b/src/test/converter2/behavior/linkResolutionErrors.ts
new file mode 100644
index 000000000..02e8d9f22
--- /dev/null
+++ b/src/test/converter2/behavior/linkResolutionErrors.ts
@@ -0,0 +1,6 @@
+/**
+ * {@link Map.size} TS resolves link, not included in docs #2700 #2967
+ * {@link DoesNotExist} Symbol does not exist #2681
+ * {@link @typedoc/foo.DoesNotExist} Symbol does not exist, looks like an attempt to link to a package directly #2360
+ */
+export const abc = new Map();
diff --git a/src/test/converter2/behavior/removeReflection.ts b/src/test/converter2/behavior/removeReflection.ts
index 159f0781c..33d99802f 100644
--- a/src/test/converter2/behavior/removeReflection.ts
+++ b/src/test/converter2/behavior/removeReflection.ts
@@ -5,3 +5,10 @@ export function foo(first: string, second: string, third: string) {
}
export function nested(a: 1 | { a; 1 }) {}
+
+export interface Base {}
+/** @hidden */
+export interface Hidden extends Base {}
+export interface NotHidden extends Hidden {}
+
+export class NotHiddenImpl implements Hidden {}
diff --git a/src/test/converter2/behavior/sortStrategyTag.ts b/src/test/converter2/behavior/sortStrategyTag.ts
new file mode 100644
index 000000000..f217b2e64
--- /dev/null
+++ b/src/test/converter2/behavior/sortStrategyTag.ts
@@ -0,0 +1,33 @@
+/** @sortStrategy source-order */
+export namespace A {
+ export const b = 1;
+ export function c() {}
+ export const a = 2;
+}
+
+/** @sortStrategy alphabetical */
+export namespace B {
+ export function c() {}
+ export const b = 1;
+ export const a = 1;
+}
+
+// Default is kind then alphabetical
+export namespace C {
+ export const c = 1;
+ export function a() {}
+ export const b = 1;
+}
+
+/** @sortStrategy source-order */
+export namespace D {
+ /** @category Cat */
+ export const b = 1;
+ /** @category Cat */
+ export const a = 1;
+ /** @category Cat */
+ export const c = 1;
+}
+
+/** @sortStrategy invalid, source-order, invalid2 */
+export namespace E {}
diff --git a/src/test/converter2/issues/gh2631/crlf.md b/src/test/converter2/issues/gh2631/crlf.md
index aa988a781..3d0cf7580 100644
--- a/src/test/converter2/issues/gh2631/crlf.md
+++ b/src/test/converter2/issues/gh2631/crlf.md
@@ -1,5 +1,5 @@
----
-title: "Windows Line Endings"
----
-
-This file contains CRLF line endings
+---
+title: "Windows Line Endings"
+---
+
+This file contains CRLF line endings
diff --git a/src/test/converter2/issues/gh2681.ts b/src/test/converter2/issues/gh2681.ts
deleted file mode 100644
index 1bf23a79a..000000000
--- a/src/test/converter2/issues/gh2681.ts
+++ /dev/null
@@ -1,4 +0,0 @@
-/**
- * {@link Generator}
- */
-export const bug = 123;
diff --git a/src/test/converter2/issues/gh2932.ts b/src/test/converter2/issues/gh2932.ts
new file mode 100644
index 000000000..653cf373b
--- /dev/null
+++ b/src/test/converter2/issues/gh2932.ts
@@ -0,0 +1,6 @@
+/**
+ * @inline
+ */
+type Vector2D = [start: number, end: number];
+
+export function doStuff([start, end]: Vector2D) {}
diff --git a/src/test/converter2/issues/gh2937/index.ts b/src/test/converter2/issues/gh2937/index.ts
new file mode 100644
index 000000000..3b34129fa
--- /dev/null
+++ b/src/test/converter2/issues/gh2937/index.ts
@@ -0,0 +1,2 @@
+export const excluded = true;
+export { notExcluded } from "./not-excluded.js";
diff --git a/src/test/converter2/issues/gh2937/not-excluded.ts b/src/test/converter2/issues/gh2937/not-excluded.ts
new file mode 100644
index 000000000..c506c4a71
--- /dev/null
+++ b/src/test/converter2/issues/gh2937/not-excluded.ts
@@ -0,0 +1 @@
+export const notExcluded = true;
diff --git a/src/test/converter2/issues/gh2949.js b/src/test/converter2/issues/gh2949.js
new file mode 100644
index 000000000..724ffc586
--- /dev/null
+++ b/src/test/converter2/issues/gh2949.js
@@ -0,0 +1,5 @@
+/**
+ * @callback Test
+ * @returns {Promise<*>}
+ */
+export {};
diff --git a/src/test/converter2/issues/gh2954.ts b/src/test/converter2/issues/gh2954.ts
new file mode 100644
index 000000000..b45a00eb2
--- /dev/null
+++ b/src/test/converter2/issues/gh2954.ts
@@ -0,0 +1,11 @@
+export type AliasA = Readonly>;
+
+export type AliasB = Readonly>;
+
+export type AliasC = Readonly<{}>;
+
+export interface InterfaceA {
+ propertyA: AliasA;
+ propertyB: AliasB;
+ propertyC: AliasC;
+}
diff --git a/src/test/converter2/issues/gh2962.ts b/src/test/converter2/issues/gh2962.ts
new file mode 100644
index 000000000..9a41ee059
--- /dev/null
+++ b/src/test/converter2/issues/gh2962.ts
@@ -0,0 +1,18 @@
+class Class {
+ msg: string;
+
+ constructor(msg: string) {
+ this.msg = msg;
+ }
+}
+
+const Var = 123;
+
+function Func(a: T) {}
+
+export { type Class, type Func, type Var };
+
+class Class2 {}
+const Var2 = 123;
+function Func2() {}
+export type { Class2, Func2, Var2 };
diff --git a/src/test/converter2/issues/gh2964.d.ts b/src/test/converter2/issues/gh2964.d.ts
new file mode 100644
index 000000000..4ec53bb25
--- /dev/null
+++ b/src/test/converter2/issues/gh2964.d.ts
@@ -0,0 +1,17 @@
+declare module "*.gh2964" {
+ export const data: "string";
+}
+
+/** @ignore */
+export { data as first } from "test.gh2964";
+/** @ignore */
+export { data as second } from "test.gh2964";
+
+/** Comment on variable */
+const third: "not ignored";
+/** @ignore -- does not work as third has a comment */
+export { third };
+
+const fourth: "ignored";
+/** @ignore -- works as fourth does not have a comment */
+export { fourth };
diff --git a/src/test/converter2/issues/gh2970.ts b/src/test/converter2/issues/gh2970.ts
new file mode 100644
index 000000000..0a357dcd2
--- /dev/null
+++ b/src/test/converter2/issues/gh2970.ts
@@ -0,0 +1,10 @@
+/** Comment */
+class Class {}
+
+/** Comment */
+const Var = 123;
+
+/** Comment */
+function Func() {}
+
+export type { Class, Func, Var };
diff --git a/src/test/converter2/issues/gh2978.ts b/src/test/converter2/issues/gh2978.ts
new file mode 100644
index 000000000..9dd8876aa
--- /dev/null
+++ b/src/test/converter2/issues/gh2978.ts
@@ -0,0 +1,15 @@
+export interface Parent {
+ prop: string;
+}
+
+export interface Child extends Partial {}
+
+export type Tricky = Omit & { x: number };
+
+export interface HasX {
+ x: string;
+}
+
+export interface InheritsX extends Tricky {
+ // InheritsX.x should *not* be linked to HasX.x
+}
diff --git a/src/test/converter2/issues/gh2994.d.ts b/src/test/converter2/issues/gh2994.d.ts
new file mode 100644
index 000000000..9d4b50e16
--- /dev/null
+++ b/src/test/converter2/issues/gh2994.d.ts
@@ -0,0 +1,13 @@
+/**
+ * {@link x} <-- should be resolved with TS resolution
+ * @packageDocumentation
+ */
+
+/** Required comment */
+import { x } from "gh2994";
+
+export var y: 2;
+
+declare module "gh2994" {
+ var x: 1;
+}
diff --git a/src/test/converter2/issues/gh2999.ts b/src/test/converter2/issues/gh2999.ts
new file mode 100644
index 000000000..fabc7c768
--- /dev/null
+++ b/src/test/converter2/issues/gh2999.ts
@@ -0,0 +1,10 @@
+/**
+ * A test object with property a.
+ */
+const LocalObject = {
+ a: 1,
+};
+
+export const Options = {
+ LocalObject,
+};
diff --git a/src/test/converter2/issues/gh3003/enums.ts b/src/test/converter2/issues/gh3003/enums.ts
new file mode 100644
index 000000000..32a4410ac
--- /dev/null
+++ b/src/test/converter2/issues/gh3003/enums.ts
@@ -0,0 +1,9 @@
+/**
+ * This is a custom enum that is exported as a constant object.
+ *
+ * @enum
+ */
+export const CustomEnum = {
+ /** A */
+ A: "A",
+} as const;
diff --git a/src/test/converter2/issues/gh3003/index.ts b/src/test/converter2/issues/gh3003/index.ts
new file mode 100644
index 000000000..142ac290b
--- /dev/null
+++ b/src/test/converter2/issues/gh3003/index.ts
@@ -0,0 +1,17 @@
+import { CustomEnum } from "./enums.js";
+
+/**
+ * This is a second custom enum that is exported as a constant object.
+ *
+ * @enum
+ */
+const CustomEnum2 = {
+ ...CustomEnum,
+ D: "D",
+} as const;
+
+/** @namespace */
+export const ExportedObject = {
+ CustomEnum,
+ CustomEnum2,
+};
diff --git a/src/test/converter2/issues/gh3006/index.ts b/src/test/converter2/issues/gh3006/index.ts
new file mode 100644
index 000000000..990e7896a
--- /dev/null
+++ b/src/test/converter2/issues/gh3006/index.ts
@@ -0,0 +1,9 @@
+/**
+ * @document two words.md
+ * @module
+ */
+
+/**
+ * [link](./two%20words.md)
+ */
+export const x = 1;
diff --git a/src/test/converter2/issues/gh3006/two words.md b/src/test/converter2/issues/gh3006/two words.md
new file mode 100644
index 000000000..feafbd5dd
--- /dev/null
+++ b/src/test/converter2/issues/gh3006/two words.md
@@ -0,0 +1 @@
+This document's name contains a space, #3006
diff --git a/src/test/converter2/issues/gh3009.ts b/src/test/converter2/issues/gh3009.ts
new file mode 100644
index 000000000..ac9e243da
--- /dev/null
+++ b/src/test/converter2/issues/gh3009.ts
@@ -0,0 +1,7 @@
+/**
+ * [link with base path](src/test/converter2/issues/gh3009.ts)
+ * [link direct](gh3009.ts)
+ *
+ * [asset link](CHANGELOG.md)
+ */
+export const x = 1;
diff --git a/src/test/converter2/issues/gh3012.ts b/src/test/converter2/issues/gh3012.ts
new file mode 100644
index 000000000..6a226968d
--- /dev/null
+++ b/src/test/converter2/issues/gh3012.ts
@@ -0,0 +1,12 @@
+/**
+ * @remarks DictRemarks
+ */
+export const DictionarySchema = {};
+
+/**
+ * {@inheritDoc DictionarySchema}
+ *
+ * @remarks
+ * Alias of {@link DictionarySchema}
+ */
+export const NullProtoObjectSchema = DictionarySchema;
diff --git a/src/test/converter2/issues/gh3017.ts b/src/test/converter2/issues/gh3017.ts
new file mode 100644
index 000000000..83627d4ac
--- /dev/null
+++ b/src/test/converter2/issues/gh3017.ts
@@ -0,0 +1,8 @@
+export class GH3017 {
+ /** @hidden */
+ constructor() {}
+ #hashPriv = 1;
+ private priv = 2;
+ protected prot = 3;
+ public pub = 4;
+}
diff --git a/src/test/converter2/issues/gh3019.ts b/src/test/converter2/issues/gh3019.ts
new file mode 100644
index 000000000..0dc0ee36c
--- /dev/null
+++ b/src/test/converter2/issues/gh3019.ts
@@ -0,0 +1,4 @@
+class GH3019 {
+ accessor x: string = "";
+ accessor y: number = 123;
+}
diff --git a/src/test/converter2/issues/gh3020.ts b/src/test/converter2/issues/gh3020.ts
new file mode 100644
index 000000000..e27024db3
--- /dev/null
+++ b/src/test/converter2/issues/gh3020.ts
@@ -0,0 +1,7 @@
+/**
+ * Component demo.
+ *
+ * @fires {CustomEvent<{id: string, source: Element}>} item-click - event when item is clicked.
+ */
+export class ButtonControlElement extends Object {
+}
diff --git a/src/test/converter2/issues/gh3024.ts b/src/test/converter2/issues/gh3024.ts
new file mode 100644
index 000000000..7d45c6c4f
--- /dev/null
+++ b/src/test/converter2/issues/gh3024.ts
@@ -0,0 +1,5 @@
+export class GH3024 {
+ method(x: string | undefined) {}
+ method2(x: string | null) {}
+ method3(x: string | null | undefined) {}
+}
diff --git a/src/test/converter2/issues/gh3026.js b/src/test/converter2/issues/gh3026.js
new file mode 100644
index 000000000..ecd21a98b
--- /dev/null
+++ b/src/test/converter2/issues/gh3026.js
@@ -0,0 +1,7 @@
+/**
+ * @param {object} params params
+ * @param {string} params.y y
+ * @returns {Promise}
+ * @this {{ x: string }} this param
+ */
+export async function extendedResponse({ y }) {}
diff --git a/src/test/converter2/renderer/gh2982.ts b/src/test/converter2/renderer/gh2982.ts
new file mode 100644
index 000000000..678f957ec
--- /dev/null
+++ b/src/test/converter2/renderer/gh2982.ts
@@ -0,0 +1,6 @@
+export type TMXNode = {} & {
+ base: T;
+};
+
+export interface TMXDataNode extends TMXNode<{ extra: any }> {
+}
diff --git a/src/test/converter2/renderer/gh2995.ts b/src/test/converter2/renderer/gh2995.ts
new file mode 100644
index 000000000..09f1a0e0d
--- /dev/null
+++ b/src/test/converter2/renderer/gh2995.ts
@@ -0,0 +1,3 @@
+export interface gh2995 {
+ optionalMethod?(filter: string, args: string[]): any;
+}
diff --git a/src/test/converter2/renderer/gh3007.ts b/src/test/converter2/renderer/gh3007.ts
new file mode 100644
index 000000000..5b00f7d70
--- /dev/null
+++ b/src/test/converter2/renderer/gh3007.ts
@@ -0,0 +1,16 @@
+interface MixinConstructor U, U> {
+ new (...args: ConstructorParameters): U;
+}
+
+export declare class DOMBase {
+ [Symbol.iterator](): Iterator;
+}
+
+export interface DOMIterable extends Partial> {
+}
+
+declare const DOMClass_base: MixinConstructor & object>;
+
+export declare class DOMClass extends DOMClass_base {
+ private constructor();
+}
diff --git a/src/test/converter2/renderer/gh3014.ts b/src/test/converter2/renderer/gh3014.ts
new file mode 100644
index 000000000..acd3ea124
--- /dev/null
+++ b/src/test/converter2/renderer/gh3014.ts
@@ -0,0 +1,7 @@
+import { GH3014Base } from "@typedoc/gh3014";
+
+export class GH3014 extends GH3014Base {
+ constructor() {
+ super();
+ }
+}
diff --git a/src/test/converter2/renderer/index.ts b/src/test/converter2/renderer/index.ts
index 92b7b987a..d43e25ccc 100644
--- a/src/test/converter2/renderer/index.ts
+++ b/src/test/converter2/renderer/index.ts
@@ -68,6 +68,9 @@ export class ModifiersClass {
readonly read = 4;
/** @deprecated */
dep = 5;
+
+ /** #2934 same page link {@linkcode ModifiersClass} */
+ constructor() {}
}
/**
@@ -128,7 +131,13 @@ export interface NoneGroup {
/** @disableGroups */
export interface DisabledGroups {
a: 1;
+ /** [link to readme #3006](./index.ts) */
b(): void;
}
export * as ExpandType from "./expandType";
+export * as GH2982 from "./gh2982";
+export { gh2995 } from "./gh2995";
+export * as GH3007 from "./gh3007";
+export { GH3014 } from "./gh3014";
+export { box as boxAlias };
diff --git a/src/test/converter2/renderer/node_modules/@typedoc/gh3014/index.d.ts b/src/test/converter2/renderer/node_modules/@typedoc/gh3014/index.d.ts
new file mode 100644
index 000000000..5eec32d15
--- /dev/null
+++ b/src/test/converter2/renderer/node_modules/@typedoc/gh3014/index.d.ts
@@ -0,0 +1,3 @@
+export class GH3014Base {
+ constructor();
+}
diff --git a/src/test/converter2/renderer/node_modules/@typedoc/gh3014/package.json b/src/test/converter2/renderer/node_modules/@typedoc/gh3014/package.json
new file mode 100644
index 000000000..c204a035b
--- /dev/null
+++ b/src/test/converter2/renderer/node_modules/@typedoc/gh3014/package.json
@@ -0,0 +1,3 @@
+{
+ "name": "@typedoc/gh3014"
+}
diff --git a/src/test/converter2/renderer/renderer-readme.md b/src/test/converter2/renderer/renderer-readme.md
new file mode 100644
index 000000000..e6cd8f720
--- /dev/null
+++ b/src/test/converter2/renderer/renderer-readme.md
@@ -0,0 +1,3 @@
+# gh3023 <test>
+
+Anchor for above heading should be `gh3023-test`
diff --git a/src/test/converter2/typedoc.json b/src/test/converter2/typedoc.json
index 029de8ae6..bcdc04f8d 100644
--- a/src/test/converter2/typedoc.json
+++ b/src/test/converter2/typedoc.json
@@ -15,12 +15,22 @@
"sourceLinkTemplate": "{path}",
"excludeExternals": true,
"tsconfig": "tsconfig.json",
- "validation": true,
+ "validation": {
+ "invalidLink": true,
+ "notDocumented": false,
+ "notExported": true,
+ "rewrittenLink": true,
+ "unusedMergeModuleWith": true
+ },
"skipErrorChecking": true,
"externalSymbolLinkMappings": {
// used by {@link !Promise}
"global": {
"Promise": "#"
+ },
+ "@typedoc/gh3014": {
+ "GH3014Base": "typedoc://GH3014Base",
+ "GH3014Base.constructor": "typedoc://GH3014Base.constructor"
}
}
}
diff --git a/src/test/converter2/validation/unusedMergeModuleWith.ts b/src/test/converter2/validation/unusedMergeModuleWith.ts
new file mode 100644
index 000000000..dce95101e
--- /dev/null
+++ b/src/test/converter2/validation/unusedMergeModuleWith.ts
@@ -0,0 +1,5 @@
+/**
+ * @module
+ * @mergeModuleWith notUsed
+ */
+export const test = 1;
diff --git a/src/test/declarationReference.test.ts b/src/test/declarationReference.test.ts
index 2f525dddb..a01e8890e 100644
--- a/src/test/declarationReference.test.ts
+++ b/src/test/declarationReference.test.ts
@@ -1,5 +1,6 @@
import { deepStrictEqual as equal } from "assert";
import {
+ meaningToString,
parseComponent,
parseComponentPath,
parseDeclarationReference,
@@ -226,4 +227,13 @@ describe("Declaration References", () => {
});
});
});
+
+ describe("meaningToString", () => {
+ it("Converts to string", () => {
+ equal(meaningToString({ keyword: "class" }), "class");
+ equal(meaningToString({ keyword: "class", index: 1 }), "class(1)");
+ equal(meaningToString({ label: "X" }), "X");
+ equal(meaningToString({}), "");
+ });
+ });
});
diff --git a/src/test/internationalization.test.ts b/src/test/internationalization.test.ts
index 685bf4b1a..1e076520d 100644
--- a/src/test/internationalization.test.ts
+++ b/src/test/internationalization.test.ts
@@ -18,7 +18,10 @@ allValidTranslationKeys.push(
allValidTranslationKeys.push(...inlineTags.map((s) => "tag_" + s.substring(1)));
describe("Internationalization", () => {
- const inter = new Internationalization();
+ let inter: Internationalization;
+ beforeEach(() => {
+ inter = new Internationalization();
+ });
afterEach(() => inter.setLocale("en"));
it("Supports getting the list of supported languages", () => {
@@ -26,6 +29,7 @@ describe("Internationalization", () => {
ok(langs.includes("en"));
ok(langs.includes("ko"));
ok(langs.includes("ja"));
+ ok(langs.includes("de"));
});
it("Supports translating without placeholders", () => {
@@ -42,6 +46,31 @@ describe("Internationalization", () => {
inter.setLocale("zh");
equal(i18n.loaded_plugin_0("X"), "已加载插件 X");
});
+
+ it("Handles locales which do not exist", () => {
+ equal(i18n.loaded_plugin_0("X"), "Loaded plugin X");
+ inter.setLocale("fakeLocale");
+ equal(i18n.loaded_plugin_0("X"), "Loaded plugin X");
+ });
+
+ it("Supports adding translations for loaded locale", () => {
+ inter.addTranslations("en", { testTranslation: "Test translation" });
+ // @ts-expect-error testTranslation isn't a defined translation
+ equal(i18n.testTranslation(), "Test translation");
+ });
+
+ it("Supports adding translations for not-loaded locale", () => {
+ inter.addTranslations("fake", { testTranslation: "Fake translation" });
+ inter.setLocale("fake");
+ // @ts-expect-error testTranslation isn't a defined translation
+ equal(i18n.testTranslation(), "Fake translation");
+ });
+
+ it("Considers translations which have only been added by plugins to be real", () => {
+ inter.addTranslations("fake", { testTranslation: "Fake translation" });
+ const supported = inter.getSupportedLanguages();
+ ok(supported.includes("fake"));
+ });
});
describe("Locales", () => {
diff --git a/src/test/issues.c2.test.ts b/src/test/issues.c2.test.ts
index 2070065af..858bda67b 100644
--- a/src/test/issues.c2.test.ts
+++ b/src/test/issues.c2.test.ts
@@ -9,7 +9,6 @@ import {
QueryType,
ReferenceReflection,
ReflectionKind,
- ReflectionSymbolId,
ReflectionType,
SignatureReflection,
UnionType,
@@ -18,7 +17,9 @@ import type { InlineTagDisplayPart } from "../lib/models/Comment.js";
import { getConverter2App, getConverter2Project } from "./programs.js";
import { TestLogger } from "./TestLogger.js";
import { equalKind, getComment, getLinks, getSigComment, query, querySig, reflToTree } from "./utils.js";
-import { DefaultTheme, KindRouter, PageEvent } from "../index.js";
+import { DefaultTheme, type FileId, KindRouter, PageEvent, ReflectionSymbolId } from "../index.js";
+import { normalizePath, TYPEDOC_ROOT } from "#node-utils";
+import { NormalizedPathUtils } from "#utils";
const app = getConverter2App();
@@ -281,7 +282,7 @@ describe("Issue Tests", () => {
const project = convert();
const nullableParam = query(project, "nullable").signatures?.[0]
?.parameters?.[0];
- equal(nullableParam?.type?.toString(), "null | string");
+ equal(nullableParam?.type?.toString(), "string | null");
const nonNullableParam = query(project, "nonNullable").signatures?.[0]
?.parameters?.[0];
@@ -553,6 +554,7 @@ describe("Issue Tests", () => {
});
it("#1898", () => {
+ app.options.setValue("validation", true);
const project = convert();
app.validate(project);
logger.expectMessage(
@@ -1670,16 +1672,6 @@ describe("Issue Tests", () => {
logger.expectNoOtherMessages();
});
- it("#2681 reports warnings on @link tags which resolve to a type not included in the documentation", () => {
- const project = convert();
- app.options.setValue("validation", false);
- app.options.setValue("validation", { invalidLink: true });
- app.validate(project);
- logger.expectMessage(
- 'warn: Failed to resolve link to "Generator" in comment for bug',
- );
- });
-
it("#2683 supports @param on parameters with functions", () => {
const project = convert();
const action = querySig(project, "action");
@@ -1732,31 +1724,7 @@ describe("Issue Tests", () => {
);
});
- it("#2700a correctly parses links to global properties", () => {
- const project = convert();
- app.options.setValue("validation", {
- invalidLink: true,
- notDocumented: false,
- notExported: false,
- });
-
- app.validate(project);
- logger.expectMessage(
- 'warn: Failed to resolve link to "Map.size | size user specified" in comment for abc',
- );
- logger.expectMessage(
- 'warn: Failed to resolve link to "Map.size user specified" in comment for abc',
- );
- logger.expectMessage(
- 'warn: Failed to resolve link to "Map.size" in comment for abc',
- );
-
- const abc = query(project, "abc");
- const link = abc.comment?.summary.find((c) => c.kind === "inline-tag");
- ok(link?.target instanceof ReflectionSymbolId);
- });
-
- it("#2700b respects user specified link text when resolving external links", () => {
+ it("#2700 respects user specified link text when resolving external links", () => {
const project = convert();
const abc = query(project, "abc");
@@ -1769,7 +1737,7 @@ describe("Issue Tests", () => {
caption: "resolver caption",
};
});
- app.converter.resolveLinks(abc.comment, abc);
+ app.converter.resolveLinks(abc);
app.converter["_externalSymbolResolvers"] = resolvers;
equal(getLinks(abc), [
@@ -2115,4 +2083,193 @@ describe("Issue Tests", () => {
const EdgeCases = query(project, "EdgeCases");
equal(EdgeCases.typeParameters?.map(t => t.type?.toString()), ["number", undefined]);
});
+
+ it("#2932 handles @inline on tuple types", () => {
+ const project = convert();
+ const sig = querySig(project, "doStuff");
+ equal(sig.parameters?.[0].type?.toString(), "[start: number, end: number]");
+ });
+
+ it("#2937 resolves symbols before checking if they are excluded/external", () => {
+ app.options.setValue("exclude", ["!**/not-excluded.ts"]);
+ const project = convert();
+ equal(project.children?.map(c => c.name), ["notExcluded"]);
+ });
+
+ it("#2949 handles JSDoc wildcard types", () => {
+ const project = convert();
+ equal(query(project, "Test").type?.toString(), "() => Promise");
+ });
+
+ it("#2954 handles Readonly with Record type", () => {
+ const project = convert();
+ equal(query(project, "InterfaceA.propertyA").type?.toString(), "AliasA");
+ equal(query(project, "InterfaceA.propertyB").type?.toString(), "AliasB");
+ equal(query(project, "InterfaceA.propertyC").type?.toString(), "AliasC");
+ });
+
+ it("#2962 handles type-only exports", () => {
+ const project = convert();
+ equal(project.children?.map(c => [c.name, ReflectionKind[c.kind]]), [
+ ["Class", "Interface"],
+ ["Class2", "Interface"],
+ ["Func", "TypeAlias"],
+ ["Func2", "TypeAlias"],
+ ["Var", "TypeAlias"],
+ ["Var2", "TypeAlias"],
+ ]);
+
+ equal(query(project, "Class").children?.map(c => c.name), ["msg"]);
+ equal(query(project, "Func").type?.toString(), "(a: T) => void");
+ equal(query(project, "Var").type?.toString(), "123");
+ });
+
+ it("#2964 handles ignored instances of wildcard declared modules", () => {
+ const project = convert();
+ equal(project.children?.map(c => c.name), ["third"]);
+ });
+
+ it("#2970 includes comments on type only exports", () => {
+ const project = convert();
+ equal(project.children?.map(c => [c.name, Comment.combineDisplayParts(c.comment?.summary)]), [
+ ["Class", "Comment"],
+ ["Func", "Comment"],
+ ["Var", "Comment"],
+ ]);
+ });
+
+ it("#2978 handles parent properties through mapped types", () => {
+ const project = convert();
+ const prop = query(project, "Child.prop");
+ equal(prop.inheritedFrom?.reflection?.getFullName(), "Parent.prop");
+ const x = query(project, "InheritsX.x");
+ equal(x.inheritedFrom?.reflection?.getFullName(), undefined);
+ equal(x.inheritedFrom?.name, "Tricky.x");
+ });
+
+ it("#2994 uses TS link resolution in first comment of file", () => {
+ const project = convert();
+ const link = project.comment?.summary.find(part => part.kind === "inline-tag");
+ ok(link?.target instanceof ReflectionSymbolId);
+ });
+
+ it("#2999 picks up parent comments from shorthand property assignments", () => {
+ const project = convert();
+ const opts = query(project, "Options");
+ equal(opts.type?.type, "reflection");
+ const local = opts.type.declaration.getChildByName("LocalObject");
+ equal(Comment.combineDisplayParts(local?.comment?.summary), "A test object with property a.");
+ });
+
+ it("#3003 handles @enum on properties within @namespace", () => {
+ const project = convert();
+
+ const a = query(project, "ExportedObject.CustomEnum");
+ equalKind(a, ReflectionKind.Enum);
+ equal(a.children?.map(c => c.name), ["A"]);
+ equal(a.children?.map(c => c.type?.toString()), ['"A"']);
+ const b = query(project, "ExportedObject.CustomEnum2");
+ equalKind(b, ReflectionKind.Enum);
+ equal(b.children?.map(c => c.name), ["A", "D"]);
+ equal(b.children?.map(c => c.type?.toString()), ['"A"', '"D"']);
+ });
+
+ it("#3006 handles documents containing spaces in their names", () => {
+ const project = convert();
+ equal(["two words"], project.documents?.map(doc => doc.name));
+ const doc = project.documents?.[0];
+ const x = query(project, "x");
+
+ ok(x.comment?.summary[1].kind === "relative-link");
+ ok(x.comment.summary[1].target);
+ ok(project.files.resolve(x.comment.summary[1].target, project) === doc);
+ });
+
+ it("#3009 supports a base path for resolving relative links", () => {
+ app.options.setValue("basePath", TYPEDOC_ROOT);
+ const project = convert();
+ const x = query(project, "x");
+ const links = x.comment?.summary.filter(part => part.kind === "relative-link");
+ equal(links?.length, 3);
+ equal(links[0].target, 1);
+ equal(links[1].target, 1);
+ equal(links[2].target, 2);
+ ok(app.files.resolve(1 as FileId, project) == project);
+ equal(
+ app.files.resolve(2 as FileId, project),
+ NormalizedPathUtils.resolve(normalizePath(TYPEDOC_ROOT), normalizePath("CHANGELOG.md")),
+ );
+ });
+
+ it("#3012 removes @remarks from inheriting comment", () => {
+ const project = convert();
+ const nullProto = query(project, "NullProtoObjectSchema");
+ equal(nullProto.comment?.blockTags.map(t => t.tag), ["@remarks"]);
+ equal(nullProto.comment?.blockTags.map(t => Comment.combineDisplayParts(t.content)), ["DictRemarks"]);
+
+ logger.expectMessage("warn: Content in the @remarks block will be overwritten*");
+ });
+
+ it("#3017 supports excluding #private fields only", () => {
+ app.options.setValue("excludePrivate", false);
+ app.options.setValue("excludePrivateClassFields", false);
+ let project = convert();
+ equal(query(project, "GH3017").children?.map(c => c.name), ["#hashPriv", "priv", "prot", "pub"]);
+
+ app.options.setValue("excludePrivate", false);
+ app.options.setValue("excludePrivateClassFields", true);
+ project = convert();
+ equal(query(project, "GH3017").children?.map(c => c.name), ["priv", "prot", "pub"]);
+
+ app.options.setValue("excludePrivate", true);
+ app.options.setValue("excludePrivateClassFields", false);
+ project = convert();
+ equal(query(project, "GH3017").children?.map(c => c.name), ["prot", "pub"]);
+
+ app.options.setValue("excludePrivate", true);
+ app.options.setValue("excludePrivateClassFields", true);
+ project = convert();
+ equal(query(project, "GH3017").children?.map(c => c.name), ["prot", "pub"]);
+ });
+
+ it("#3019 correctly parses accessor types", () => {
+ const project = convert();
+ equal(query(project, "GH3019.x").type?.toString(), "string");
+ equal(query(project, "GH3019.y").type?.toString(), "number");
+ });
+
+ it("#3020 permits preserving type annotations", () => {
+ app.options.setValue("blockTags", ["@fires"]);
+ app.options.setValue("preservedTypeAnnotationTags", ["@fires"]);
+ const project = convert();
+ const btn = query(project, "ButtonControlElement");
+
+ equal(btn.comment?.blockTags.length, 1);
+ equal(btn.comment.blockTags[0].tag, "@fires");
+ equal(btn.comment.blockTags[0].typeAnnotation, "{CustomEvent<{id: string, source: Element}>}");
+ });
+
+ it("#3024 places null and undefined last in unions converted from types", () => {
+ const project = convert();
+ const method = querySig(project, "GH3024.method");
+ equal(method.parameters?.[0].type?.toString(), "string | undefined");
+
+ const method2 = querySig(project, "GH3024.method2");
+ equal(method2.parameters?.[0].type?.toString(), "string | null");
+
+ const method3 = querySig(project, "GH3024.method3");
+ equal(method3.parameters?.[0].type?.toString(), "string | null | undefined");
+ });
+
+ it("#3026 handles @this parameter comments and destructured parameter renames with this parameters", () => {
+ const project = convert();
+ const sig = querySig(project, "extendedResponse");
+ equal(sig.parameters?.map(p => p.name), ["this", "params"]);
+
+ const comments = sig.parameters.map(p => Comment.combineDisplayParts(p.comment?.summary));
+ equal(comments, ["this param", "params"]);
+
+ const types = sig.parameters.map(p => p.type?.toString());
+ equal(types, ["{ x: string }", "{ y: string }"]);
+ });
});
diff --git a/src/test/merge.test.ts b/src/test/merge.test.ts
index 65d58c782..b38356bc2 100644
--- a/src/test/merge.test.ts
+++ b/src/test/merge.test.ts
@@ -1,8 +1,9 @@
import { deepStrictEqual as equal, ok } from "assert";
import { join } from "path";
-import { Application, type DeclarationReflection, EntryPointStrategy, normalizePath, ReferenceType } from "../index.js";
+import { Application, EntryPointStrategy, normalizePath, ReferenceType } from "../index.js";
import { getConverterBase } from "./programs.js";
import { TestLogger } from "./TestLogger.js";
+import { query } from "./utils.js";
const base = getConverterBase();
@@ -29,12 +30,8 @@ describe("Merging projects", () => {
["alias", "class"],
);
- const crossRef = project.getChildByName(
- "alias.MergedCrossReference",
- ) as DeclarationReflection;
- const testClass = project.getChildByName("class.class.TestClass");
- ok(testClass, "Missing test class");
- ok(crossRef, "Missing MergedCrossReference");
+ const crossRef = query(project, "alias.MergedCrossReference");
+ const testClass = query(project, "class.class.TestClass");
ok(crossRef.type instanceof ReferenceType);
ok(
diff --git a/src/test/models/comment.test.ts b/src/test/models/comment.test.ts
index e302b7c0f..b4e4b91f4 100644
--- a/src/test/models/comment.test.ts
+++ b/src/test/models/comment.test.ts
@@ -1,6 +1,38 @@
import { deepStrictEqual as equal } from "assert";
import { Comment, type CommentDisplayPart, CommentTag } from "../../index.js";
+describe("Comment.similarTo", () => {
+ it("Checks for similar summaries", () => {
+ const a = new Comment([{ kind: "text", text: "a" }]);
+ const b = new Comment([{ kind: "text", text: "a" }]);
+ const c = new Comment([{ kind: "text", text: "c" }]);
+
+ equal(a.similarTo(b), true);
+ equal(a.similarTo(c), false);
+ });
+
+ it("Ignores modifier tags", () => {
+ const a = new Comment([{ kind: "text", text: "a" }]);
+ a.modifierTags.add("@test");
+ const b = new Comment([{ kind: "text", text: "a" }]);
+
+ equal(a.similarTo(b), true);
+ });
+
+ it("Checks block tags", () => {
+ const a = new Comment([], [new CommentTag("@test", [{ kind: "text", text: "a" }])]);
+ const b = new Comment([], [new CommentTag("@test", [{ kind: "text", text: "a" }])]);
+ const c = new Comment([], [new CommentTag("@test", [{ kind: "text", text: "c" }])]);
+ const d = new Comment([], [new CommentTag("@test2", [{ kind: "text", text: "c" }])]);
+ const e = new Comment();
+
+ equal(a.similarTo(b), true);
+ equal(a.similarTo(c), false);
+ equal(a.similarTo(d), false);
+ equal(a.similarTo(e), false);
+ });
+});
+
describe("Comment.combineDisplayParts", () => {
it("Handles text and code", () => {
const parts: CommentDisplayPart[] = [
diff --git a/src/test/models/types.test.ts b/src/test/models/types.test.ts
index 516e4990d..d9dd945a5 100644
--- a/src/test/models/types.test.ts
+++ b/src/test/models/types.test.ts
@@ -266,7 +266,7 @@ describe("Type.toString", () => {
const project = new ProjectReflection("test", new FileRegistry());
const type = new T.OptionalType(
new T.QueryType(
- T.ReferenceType.createResolvedReference("X", -1, project),
+ T.ReferenceType.createBrokenReference("X", project, undefined),
),
);
equal(type.toString(), "typeof X?");
@@ -287,7 +287,7 @@ describe("Type.toString", () => {
const project = new ProjectReflection("test", new FileRegistry());
const type = new T.TypeOperatorType(
new T.QueryType(
- T.ReferenceType.createResolvedReference("X", -1, project),
+ T.ReferenceType.createBrokenReference("X", project, undefined),
),
"keyof",
);
diff --git a/src/test/output/Slugger.test.ts b/src/test/output/Slugger.test.ts
index f11f9c1b6..f0c839a22 100644
--- a/src/test/output/Slugger.test.ts
+++ b/src/test/output/Slugger.test.ts
@@ -13,4 +13,15 @@ describe("Slugger", () => {
equal(slugger.slug("model"), "model");
equal(slugger.slug("Model"), "Model-1");
});
+
+ it("Handles embedded html characters", () => {
+ const slugger = new Slugger({ lowercase: true });
+ equal(slugger.slug("test "), "test-t");
+ equal(slugger.slug("test "), "test-t-1");
+ });
+
+ it("Handles adjacent whitespace", () => {
+ const slugger = new Slugger({ lowercase: true });
+ equal(slugger.slug("test test2"), "test-test2");
+ });
});
diff --git a/src/test/output/formatter.test.ts b/src/test/output/formatter.test.ts
index d8b9db60f..cfe2f4a4b 100644
--- a/src/test/output/formatter.test.ts
+++ b/src/test/output/formatter.test.ts
@@ -228,7 +228,7 @@ describe("Formatter", () => {
it("Handles query types", () => {
const project = new ProjectReflection("", new FileRegistry());
const type = new QueryType(
- ReferenceType.createBrokenReference("x", project),
+ ReferenceType.createBrokenReference("x", project, undefined),
);
const text = renderElementToText(renderType(type));
equal(text, `typeof x`);
@@ -236,7 +236,7 @@ describe("Formatter", () => {
it("Handles a simple reference type", () => {
const project = new ProjectReflection("", new FileRegistry());
- const type = ReferenceType.createBrokenReference("x", project);
+ const type = ReferenceType.createBrokenReference("x", project, undefined);
const text = renderElementToText(renderType(type));
equal(text, `x`);
});
@@ -277,7 +277,7 @@ describe("Formatter", () => {
it("Handles a reference type pointing to an external url", () => {
const project = new ProjectReflection("", new FileRegistry());
- const type = ReferenceType.createBrokenReference("x", project);
+ const type = ReferenceType.createBrokenReference("x", project, undefined);
type.externalUrl = "https://example.com";
const text = renderElementToText(renderType(type));
equal(text, `x`);
@@ -285,7 +285,7 @@ describe("Formatter", () => {
it("Handles a reference type targeting a type parameter", () => {
const project = new ProjectReflection("", new FileRegistry());
- const type = ReferenceType.createBrokenReference("x", project);
+ const type = ReferenceType.createBrokenReference("x", project, undefined);
type.refersToTypeParameter = true;
const text = renderElementToText(renderType(type));
equal(text, `x`);
@@ -293,7 +293,7 @@ describe("Formatter", () => {
it("Handles a reference type with type arguments", () => {
const project = new ProjectReflection("", new FileRegistry());
- const type = ReferenceType.createBrokenReference("x", project);
+ const type = ReferenceType.createBrokenReference("x", project, undefined);
type.typeArguments = [
new LiteralType(123),
new LiteralType(456),
diff --git a/src/test/output/lib.test.tsx b/src/test/output/lib.test.tsx
new file mode 100644
index 000000000..9acf34fab
--- /dev/null
+++ b/src/test/output/lib.test.tsx
@@ -0,0 +1,28 @@
+import { deepStrictEqual as equal } from "node:assert";
+import { wbr } from "../../lib/output/themes/lib.js";
+import { JSX } from "#utils";
+
+describe("wbr", () => {
+ it("No breaks", () => {
+ equal(wbr("hello"), ["hello"]);
+ });
+
+ it("Adds to camelCased text", () => {
+ equal(wbr("helloWorld"), ["hello", to snake_cased text", () => {
+ equal(wbr("snake_case_text"), ["snake_", to dashed-text", () => {
+ equal(wbr("dashed-text"), ["dashed-", appropriately with acronyms", () => {
+ equal(wbr("HTMLImageElement"), ["HTML", "
+ }
+ ]
+ },
+ {
+ "section.tsd-panel": [
+ {
+ "h4": "Type Parameters"
+ },
+ {
+ "ul.tsd-type-parameter-list": {
+ "li": {
+ "span#t": [
+ {
+ "span.tsd-kind-type-parameter": "T"
+ },
+ " ",
+ {
+ "span.tsd-signature-keyword": "extends"
+ },
+ " ",
+ {
+ "span.tsd-signature-type": "Node"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "aside.tsd-sources": {
+ "ul": {
+ "li": [
+ "Defined in ",
+ {
+ "tag": "a",
+ "props": {
+ "href": "gh3007.ts"
+ },
+ "children": "gh3007.ts:5"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "section.tsd-panel-group.tsd-index-group": {
+ "section.tsd-panel.tsd-index-panel": {
+ "tag": "details.tsd-index-content.tsd-accordion",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "summary.tsd-accordion-summary.tsd-index-summary": {
+ "h5.tsd-index-heading.uppercase": "Index"
+ }
+ },
+ {
+ "div.tsd-accordion-details": [
+ {
+ "section.tsd-index-section": [
+ {
+ "h3.tsd-index-heading": "Constructors"
+ },
+ {
+ "div.tsd-index-list": [
+ {
+ "tag": "a.tsd-index-link",
+ "props": {
+ "href": "#constructor"
+ },
+ "children": {
+ "span": "constructor"
+ }
+ },
+ "\n"
+ ]
+ }
+ ]
+ },
+ {
+ "section.tsd-index-section": [
+ {
+ "h3.tsd-index-heading": "Methods"
+ },
+ {
+ "div.tsd-index-list": [
+ {
+ "tag": "a.tsd-index-link",
+ "props": {
+ "href": "#iterator"
+ },
+ "children": {
+ "span": "[iterator]"
+ }
+ },
+ "\n"
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ },
+ {
+ "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Constructors"
+ },
+ "children": {
+ "h2": "Constructors"
+ }
+ },
+ {
+ "section": {
+ "section.tsd-panel.tsd-member": [
+ {
+ "h3.tsd-anchor-link#constructor": [
+ {
+ "span": "constructor"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#constructor",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "ul.tsd-signatures": {
+ "li.": [
+ {
+ "div.tsd-signature.tsd-anchor-link#constructordombase": [
+ {
+ "span.tsd-signature-keyword": "new"
+ },
+ " ",
+ {
+ "span.tsd-kind-constructor-signature": "DOMBase"
+ },
+ {
+ "span.tsd-signature-symbol": "<"
+ },
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-type-parameter",
+ "props": {
+ "href": "#constructordombaset"
+ },
+ "children": "T"
+ },
+ " ",
+ {
+ "span.tsd-signature-keyword": "extends"
+ },
+ " ",
+ {
+ "span.tsd-signature-type": "Node"
+ },
+ {
+ "span.tsd-signature-symbol": ">"
+ },
+ {
+ "span.tsd-signature-symbol": "()"
+ },
+ {
+ "span.tsd-signature-symbol": ":"
+ },
+ " ",
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-class",
+ "props": {
+ "href": ""
+ },
+ "children": "DOMBase"
+ },
+ {
+ "span.tsd-signature-symbol": "<"
+ },
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-type-parameter",
+ "props": {
+ "href": "#constructordombaset"
+ },
+ "children": "T"
+ },
+ {
+ "span.tsd-signature-symbol": ">"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#constructordombase",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "div.tsd-description": [
+ {
+ "section.tsd-panel": [
+ {
+ "h4": "Type Parameters"
+ },
+ {
+ "ul.tsd-type-parameter-list": {
+ "li": {
+ "span#constructordombaset": [
+ {
+ "span.tsd-kind-type-parameter": "T"
+ },
+ " ",
+ {
+ "span.tsd-signature-keyword": "extends"
+ },
+ " ",
+ {
+ "span.tsd-signature-type": "Node"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "h4.tsd-returns-title": [
+ "Returns ",
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-class",
+ "props": {
+ "href": ""
+ },
+ "children": "DOMBase"
+ },
+ {
+ "span.tsd-signature-symbol": "<"
+ },
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-type-parameter",
+ "props": {
+ "href": "#constructordombaset"
+ },
+ "children": "T"
+ },
+ {
+ "span.tsd-signature-symbol": ">"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Methods"
+ },
+ "children": {
+ "h2": "Methods"
+ }
+ },
+ {
+ "section": {
+ "section.tsd-panel.tsd-member": [
+ {
+ "h3.tsd-anchor-link#iterator": [
+ {
+ "span": "[iterator]"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#iterator",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "ul.tsd-signatures": {
+ "li.": [
+ {
+ "div.tsd-signature.tsd-anchor-link#iterator-1": [
+ {
+ "span.tsd-kind-call-signature": "\"[iterator]\""
+ },
+ {
+ "span.tsd-signature-symbol": "()"
+ },
+ {
+ "span.tsd-signature-symbol": ":"
+ },
+ " ",
+ {
+ "span.tsd-signature-type": "Iterator"
+ },
+ {
+ "span.tsd-signature-symbol": "<"
+ },
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-type-parameter",
+ "props": {
+ "href": "#constructordombaset"
+ },
+ "children": "T"
+ },
+ {
+ "span.tsd-signature-symbol": ">"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#iterator-1",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "div.tsd-description": [
+ {
+ "h4.tsd-returns-title": [
+ "Returns ",
+ {
+ "span.tsd-signature-type": "Iterator"
+ },
+ {
+ "span.tsd-signature-symbol": "<"
+ },
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-type-parameter",
+ "props": {
+ "href": "#constructordombaset"
+ },
+ "children": "T"
+ },
+ {
+ "span.tsd-signature-symbol": ">"
+ }
+ ]
+ },
+ {
+ "aside.tsd-sources": {
+ "ul": {
+ "li": [
+ "Defined in ",
+ {
+ "tag": "a",
+ "props": {
+ "href": "gh3007.ts"
+ },
+ "children": "gh3007.ts:6"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "div.col-sidebar": {
+ "div.page-menu": {
+ "tag": "details.tsd-accordion.tsd-page-navigation",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "summary.tsd-accordion-summary": {
+ "h3": "On This Page"
+ }
+ },
+ {
+ "div.tsd-accordion-details": [
+ {
+ "tag": "details.tsd-accordion.tsd-page-navigation-section",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Constructors"
+ },
+ "children": "Constructors"
+ },
+ {
+ "div": {
+ "tag": "a",
+ "props": {
+ "href": "#constructor"
+ },
+ "children": {
+ "span": "constructor"
+ }
+ }
+ }
+ ]
+ },
+ {
+ "tag": "details.tsd-accordion.tsd-page-navigation-section",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Methods"
+ },
+ "children": "Methods"
+ },
+ {
+ "div": {
+ "tag": "a",
+ "props": {
+ "href": "#iterator"
+ },
+ "children": {
+ "span": "[iterator]"
+ }
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ }
+ ]
+}
diff --git a/src/test/renderer/specs/classes/GH3007.DOMClass.json b/src/test/renderer/specs/classes/GH3007.DOMClass.json
new file mode 100644
index 000000000..8bfe89f19
--- /dev/null
+++ b/src/test/renderer/specs/classes/GH3007.DOMClass.json
@@ -0,0 +1,288 @@
+{
+ "div.container.container-main": [
+ {
+ "div.col-content": [
+ {
+ "div.tsd-page-title": [
+ {
+ "tag": "ul.tsd-breadcrumb",
+ "props": {
+ "aria-label": "Breadcrumb"
+ },
+ "children": [
+ {
+ "li": {
+ "tag": "a",
+ "props": {
+ "href": "../modules/GH3007.json"
+ },
+ "children": "GH3007"
+ }
+ },
+ {
+ "li": {
+ "tag": "a",
+ "props": {
+ "href": "",
+ "aria-current": "page"
+ },
+ "children": "DOMClass"
+ }
+ }
+ ]
+ },
+ {
+ "h1": "Class DOMClass"
+ }
+ ]
+ },
+ {
+ "tag": "section.tsd-panel.tsd-hierarchy",
+ "props": {
+ "data-refl": "146"
+ },
+ "children": [
+ {
+ "h4": "Hierarchy"
+ },
+ {
+ "ul.tsd-hierarchy": {
+ "li.tsd-hierarchy-item": [
+ {
+ "span.tsd-signature-type": "DOMClass_base"
+ },
+ {
+ "ul.tsd-hierarchy": {
+ "li.tsd-hierarchy-item": {
+ "span.tsd-hierarchy-target": "DOMClass"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "aside.tsd-sources": {
+ "ul": {
+ "li": [
+ "Defined in ",
+ {
+ "tag": "a",
+ "props": {
+ "href": "gh3007.ts"
+ },
+ "children": "gh3007.ts:14"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "section.tsd-panel-group.tsd-index-group": {
+ "section.tsd-panel.tsd-index-panel": {
+ "tag": "details.tsd-index-content.tsd-accordion",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "summary.tsd-accordion-summary.tsd-index-summary": {
+ "h5.tsd-index-heading.uppercase": "Index"
+ }
+ },
+ {
+ "div.tsd-accordion-details": {
+ "section.tsd-index-section": [
+ {
+ "h3.tsd-index-heading": "Methods"
+ },
+ {
+ "div.tsd-index-list": [
+ {
+ "tag": "a.tsd-index-link.tsd-is-inherited",
+ "props": {
+ "href": "#iterator"
+ },
+ "children": {
+ "span": "[iterator]"
+ }
+ },
+ "\n"
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Methods"
+ },
+ "children": {
+ "h2": "Methods"
+ }
+ },
+ {
+ "section": {
+ "section.tsd-panel.tsd-member.tsd-is-inherited": [
+ {
+ "h3.tsd-anchor-link#iterator": [
+ {
+ "span": "[iterator]"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#iterator",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "ul.tsd-signatures.tsd-is-inherited": {
+ "li.tsd-is-inherited": [
+ {
+ "div.tsd-signature.tsd-anchor-link#iterator-1": [
+ {
+ "span.tsd-kind-call-signature": "\"[iterator]\""
+ },
+ {
+ "span.tsd-signature-symbol": "()"
+ },
+ {
+ "span.tsd-signature-symbol": ":"
+ },
+ " ",
+ {
+ "span.tsd-signature-type": "Iterator"
+ },
+ {
+ "span.tsd-signature-symbol": "<"
+ },
+ {
+ "span.tsd-signature-type": "Node"
+ },
+ {
+ "span.tsd-signature-symbol": ">"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#iterator-1",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "div.tsd-description": [
+ {
+ "h4.tsd-returns-title": [
+ "Returns ",
+ {
+ "span.tsd-signature-type": "Iterator"
+ },
+ {
+ "span.tsd-signature-symbol": "<"
+ },
+ {
+ "span.tsd-signature-type": "Node"
+ },
+ {
+ "span.tsd-signature-symbol": ">"
+ }
+ ]
+ },
+ {
+ "aside.tsd-sources": [
+ {
+ "p": "Inherited from DOMClass_base.[iterator]"
+ },
+ {
+ "ul": {
+ "li": [
+ "Defined in ",
+ {
+ "tag": "a",
+ "props": {
+ "href": "gh3007.ts"
+ },
+ "children": "gh3007.ts:6"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "div.col-sidebar": {
+ "div.page-menu": {
+ "tag": "details.tsd-accordion.tsd-page-navigation",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "summary.tsd-accordion-summary": {
+ "h3": "On This Page"
+ }
+ },
+ {
+ "div.tsd-accordion-details": {
+ "tag": "details.tsd-accordion.tsd-page-navigation-section",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Methods"
+ },
+ "children": "Methods"
+ },
+ {
+ "div": {
+ "tag": "a.tsd-is-inherited",
+ "props": {
+ "href": "#iterator"
+ },
+ "children": {
+ "span": "[iterator]"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+}
diff --git a/src/test/renderer/specs/classes/GH3014.json b/src/test/renderer/specs/classes/GH3014.json
new file mode 100644
index 000000000..f764dc955
--- /dev/null
+++ b/src/test/renderer/specs/classes/GH3014.json
@@ -0,0 +1,286 @@
+{
+ "div.container.container-main": [
+ {
+ "div.col-content": [
+ {
+ "div.tsd-page-title": [
+ {
+ "tag": "ul.tsd-breadcrumb",
+ "props": {
+ "aria-label": "Breadcrumb"
+ },
+ "children": {
+ "li": {
+ "tag": "a",
+ "props": {
+ "href": "",
+ "aria-current": "page"
+ },
+ "children": "GH3014"
+ }
+ }
+ },
+ {
+ "h1": "Class GH3014"
+ }
+ ]
+ },
+ {
+ "tag": "section.tsd-panel.tsd-hierarchy",
+ "props": {
+ "data-refl": "151"
+ },
+ "children": [
+ {
+ "h4": "Hierarchy"
+ },
+ {
+ "ul.tsd-hierarchy": {
+ "li.tsd-hierarchy-item": [
+ {
+ "tag": "a.tsd-signature-type.external",
+ "props": {
+ "href": "typedoc://GH3014Base",
+ "target": "_blank"
+ },
+ "children": "GH3014Base"
+ },
+ {
+ "ul.tsd-hierarchy": {
+ "li.tsd-hierarchy-item": {
+ "span.tsd-hierarchy-target": "GH3014"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ },
+ {
+ "aside.tsd-sources": {
+ "ul": {
+ "li": [
+ "Defined in ",
+ {
+ "tag": "a",
+ "props": {
+ "href": "gh3014.ts"
+ },
+ "children": "gh3014.ts:3"
+ }
+ ]
+ }
+ }
+ },
+ {
+ "section.tsd-panel-group.tsd-index-group": {
+ "section.tsd-panel.tsd-index-panel": {
+ "tag": "details.tsd-index-content.tsd-accordion",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "summary.tsd-accordion-summary.tsd-index-summary": {
+ "h5.tsd-index-heading.uppercase": "Index"
+ }
+ },
+ {
+ "div.tsd-accordion-details": {
+ "section.tsd-index-section": [
+ {
+ "h3.tsd-index-heading": "Constructors"
+ },
+ {
+ "div.tsd-index-list": [
+ {
+ "tag": "a.tsd-index-link",
+ "props": {
+ "href": "#constructor"
+ },
+ "children": {
+ "span": "constructor"
+ }
+ },
+ "\n"
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ },
+ {
+ "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Constructors"
+ },
+ "children": {
+ "h2": "Constructors"
+ }
+ },
+ {
+ "section": {
+ "section.tsd-panel.tsd-member": [
+ {
+ "h3.tsd-anchor-link#constructor": [
+ {
+ "span": "constructor"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#constructor",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "ul.tsd-signatures": {
+ "li.": [
+ {
+ "div.tsd-signature.tsd-anchor-link#constructorgh3014": [
+ {
+ "span.tsd-signature-keyword": "new"
+ },
+ " ",
+ {
+ "span.tsd-kind-constructor-signature": "GH3014"
+ },
+ {
+ "span.tsd-signature-symbol": "()"
+ },
+ {
+ "span.tsd-signature-symbol": ":"
+ },
+ " ",
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-class",
+ "props": {
+ "href": ""
+ },
+ "children": "GH3014"
+ },
+ {
+ "tag": "a.tsd-anchor-icon",
+ "props": {
+ "href": "#constructorgh3014",
+ "aria-label": "Permalink"
+ }
+ }
+ ]
+ },
+ {
+ "div.tsd-description": [
+ {
+ "h4.tsd-returns-title": [
+ "Returns ",
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-class",
+ "props": {
+ "href": ""
+ },
+ "children": "GH3014"
+ }
+ ]
+ },
+ {
+ "aside.tsd-sources": [
+ {
+ "p": [
+ "Overrides ",
+ {
+ "tag": "a.external",
+ "props": {
+ "href": "typedoc://GH3014Base.constructor",
+ "target": "_blank"
+ },
+ "children": "GH3014Base.constructor"
+ }
+ ]
+ },
+ {
+ "ul": {
+ "li": [
+ "Defined in ",
+ {
+ "tag": "a",
+ "props": {
+ "href": "gh3014.ts"
+ },
+ "children": "gh3014.ts:4"
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "div.col-sidebar": {
+ "div.page-menu": {
+ "tag": "details.tsd-accordion.tsd-page-navigation",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "summary.tsd-accordion-summary": {
+ "h3": "On This Page"
+ }
+ },
+ {
+ "div.tsd-accordion-details": {
+ "tag": "details.tsd-accordion.tsd-page-navigation-section",
+ "props": {
+ "open": true
+ },
+ "children": [
+ {
+ "tag": "summary.tsd-accordion-summary",
+ "props": {
+ "data-key": "section-Constructors"
+ },
+ "children": "Constructors"
+ },
+ {
+ "div": {
+ "tag": "a",
+ "props": {
+ "href": "#constructor"
+ },
+ "children": {
+ "span": "constructor"
+ }
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }
+ }
+ }
+ ]
+}
diff --git a/src/test/renderer/specs/classes/GenericClass.json b/src/test/renderer/specs/classes/GenericClass.json
index 0322a9cfe..38529a94c 100644
--- a/src/test/renderer/specs/classes/GenericClass.json
+++ b/src/test/renderer/specs/classes/GenericClass.json
@@ -26,14 +26,11 @@
]
},
{
- "section.tsd-panel.tsd-comment": [
- {
- "div.tsd-comment.tsd-typography": "\n"
+ "div.tsd-panel.tsd-typography": [
+ {
+ "p": "Rendered document"
+ },
+ {
+ "p": [
+ "Link to this doc:",
+ {
+ "tag": "a",
+ "props": {
+ "href": ""
+ },
+ "children": "link"
+ }
+ ]
+ },
+ {
+ "pre": [
+ {
+ "code.ts": "test();"
+ },
+ {
+ "tag": "button",
+ "props": {
+ "type": "button"
+ },
+ "children": "Copy"
+ }
+ ]
+ },
+ {
+ "div.tsd-alert.tsd-alert-note": [
+ {
+ "div.tsd-alert-title": {
+ "span": "Note"
+ }
+ },
+ {
+ "p": "This is an alert"
+ }
+ ]
+ }
+ ]
}
]
},
diff --git a/src/test/renderer/specs/enums/Enumeration.json b/src/test/renderer/specs/enums/Enumeration.json
index e5b4f9c9f..966a9f2d8 100644
--- a/src/test/renderer/specs/enums/Enumeration.json
+++ b/src/test/renderer/specs/enums/Enumeration.json
@@ -28,7 +28,18 @@
{
"section.tsd-panel.tsd-comment": [
{
- "div.tsd-comment.tsd-typography": ""
+ }
+ }
+ }
+ ]
+ }
}
}
]
diff --git a/src/test/renderer/specs/interfaces/BaseInterface.json b/src/test/renderer/specs/interfaces/BaseInterface.json
index 46980afe2..984a18ba0 100644
--- a/src/test/renderer/specs/interfaces/BaseInterface.json
+++ b/src/test/renderer/specs/interfaces/BaseInterface.json
@@ -41,7 +41,7 @@
{
"br": []
},
- " ",
+ " ",
{
"tag": "a.tsd-kind-call-signature",
"props": {
@@ -65,7 +65,7 @@
{
"br": []
},
- " ",
+ " ",
{
"tag": "a.tsd-kind-call-signature",
"props": {
@@ -325,7 +325,9 @@
{
"div.tsd-description": [
{
- "div.tsd-comment.tsd-typography": ""
+ }
+ ]
+ },
+ {
+ "div.tsd-signature": [
+ {
+ "span.tsd-kind-type-alias": "TMXNode"
+ },
+ {
+ "span.tsd-signature-symbol": ":"
+ },
+ " ",
+ {
+ "span.tsd-signature-symbol": "{}"
+ },
+ " ",
+ {
+ "span.tsd-signature-symbol": "&"
+ },
+ " ",
+ {
+ "span.tsd-signature-symbol": "{"
+ },
+ " ",
+ {
+ "span.tsd-kind-property": "base"
+ },
+ {
+ "span.tsd-signature-symbol": ":"
+ },
+ " ",
+ {
+ "tag": "a.tsd-signature-type.tsd-kind-type-parameter",
+ "props": {
+ "href": "#t"
+ },
+ "children": "T"
+ },
+ " ",
+ {
+ "span.tsd-signature-symbol": "}"
+ }
+ ]
+ },
+ {
+ "section.tsd-panel": [
+ {
+ "h4": "Type Parameters"
+ },
+ {
+ "ul.tsd-type-parameter-list": {
+ "li": {
+ "span#t": {
+ "span.tsd-kind-type-parameter": "T"
+ }
+ }
+ }
+ }
+ ]
+ },
+ {
+ "aside.tsd-sources": {
+ "ul": {
+ "li": [
+ "Defined in ",
+ {
+ "tag": "a",
+ "props": {
+ "href": "gh2982.ts"
+ },
+ "children": "gh2982.ts:1"
+ }
+ ]
+ }
+ }
+ }
+ ]
+ },
+ {
+ "div.col-sidebar": {
+ "div.page-menu": []
+ }
+ }
+ ]
+}
diff --git a/src/test/renderer/specs/types/Nested.json b/src/test/renderer/specs/types/Nested.json
index 434656ec1..18f04453c 100644
--- a/src/test/renderer/specs/types/Nested.json
+++ b/src/test/renderer/specs/types/Nested.json
@@ -26,14 +26,11 @@
]
},
{
- "section.tsd-panel.tsd-comment": [
- {
- "div.tsd-comment.tsd-typography": " = {};
+
+ while (parser.state !== ParserState.END) {
+ if (parser.state === ParserState.BeforeAttributeValue) {
+ parser.step();
+ props[parser.currentAttributeName] = parser.currentAttributeValue;
+ } else {
+ parser.step();
+ }
+ }
+
+ pos = parser.pos - 1;
+
+ const element = {
+ tag,
+ props,
+ children: [],
+ };
+
+ if (html[pos] === "/") {
+ // self closing tag
+ currentChildList().push(element);
+ ++pos;
+ skipWs();
+ } else {
+ currentChildList().push(element);
+ stack.push(element);
+ }
+
+ assert(html[pos] === ">");
+ ++pos;
+ last = pos;
+ }
+
+ function endTag() {
+ assert(html[pos] === "<" && html[pos + 1] === "/");
+ pos += 2;
+ skipWs();
+
+ const tag = takeWord();
+ if (stack.length === 0 || stack[stack.length - 1].tag !== tag) {
+ throw new Error(`Invalid HTML, failed to match end tag: ${tag}`);
+ }
+ stack.pop();
+
+ skipWs();
+ assert(html[pos] === ">");
+ ++pos;
+ last = pos;
+ }
+
+ function saveContent() {
+ if (pos !== last) {
+ const content = html.slice(last, pos);
+ currentChildList().push(content.trim());
+ }
+ last = pos;
+ }
+
+ while (pos < html.length) {
+ switch (html[pos]) {
+ case "<":
+ saveContent();
+ if (html[pos + 1] == "/") {
+ endTag();
+ } else {
+ startTag();
+ }
+ break;
+ default:
+ ++pos;
+ break;
+ }
+ }
+
+ saveContent();
+ return output;
+}
+
function renderElementToSnapshot(element: JsxChildren): unknown {
- if (!element || typeof element === "boolean") {
- return "";
+ if (typeof element === "string" || typeof element === "number" || typeof element === "bigint") {
+ return element.toString().replaceAll("\u00a0", " ");
}
- if (typeof element === "string" || typeof element === "number") {
- return element.toString();
+ if (!element || typeof element === "boolean") {
+ return "";
}
if (Array.isArray(element)) {
@@ -67,7 +182,7 @@ function renderElementToSnapshot(element: JsxChildren): unknown {
if (typeof tag === "function") {
if (tag === Raw) {
- return String((props as any).html);
+ return renderElementToSnapshot(parseHtmlToJsxElement(String((props as any).html)));
}
if (tag === JsxFragment) {
return collapseStrings(children.flatMap(renderElementToSnapshot).filter(Boolean));
@@ -155,10 +270,10 @@ export async function buildRendererSpecs(specPath: string) {
// Unfortunate not to set this in typedoc.json for converter2, but plenty
// of tests expect to test the default option, not this.
app2.options.setValue("categorizeByGroup", true);
+ app2.options.setValue("readme", "src/test/converter2/renderer/renderer-readme.md");
resetReflectionID();
const project = getConverter2Project(["renderer"], ".");
- project.readme = [{ kind: "text", text: "Readme text" }];
await app2.generateDocs(project, specPath);
await rm(`${specPath}/assets`, { recursive: true });
await rm(`${specPath}/.nojekyll`);
diff --git a/src/test/slow/internationalization-usage.test.ts b/src/test/slow/internationalization-usage.test.ts
index d1e4efd38..b669f03f2 100644
--- a/src/test/slow/internationalization-usage.test.ts
+++ b/src/test/slow/internationalization-usage.test.ts
@@ -9,7 +9,8 @@ describe("Internationalization", () => {
it("Does not include strings in translatable object which are unused", () => {
const options = new Options();
const tsconfigReader = new TSConfigReader();
- tsconfigReader.read(options, new Logger(), process.cwd());
+ const logger = new Logger();
+ tsconfigReader.read(options, logger, process.cwd());
const defaultLocaleTs = join(
fileURLToPath(import.meta.url),
@@ -26,7 +27,7 @@ describe("Internationalization", () => {
);
},
getCurrentDirectory: () => process.cwd(),
- getCompilationSettings: () => options.getCompilerOptions(),
+ getCompilationSettings: () => options.getCompilerOptions(logger),
getDefaultLibFileName: (opts) => ts.getDefaultLibFilePath(opts),
fileExists: ts.sys.fileExists,
readFile: ts.sys.readFile,
diff --git a/src/test/utils-common/enum.test.ts b/src/test/utils-common/enum.test.ts
index 1c58bc503..60fab2397 100644
--- a/src/test/utils-common/enum.test.ts
+++ b/src/test/utils-common/enum.test.ts
@@ -1,9 +1,45 @@
-import { ok } from "assert";
+import { deepStrictEqual as equal, ok } from "assert";
import { ReflectionKind } from "../../lib/models/index.js";
-import { getEnumKeys } from "#utils";
+import { debugFlags, getEnumFlags, getEnumKeys, hasAllFlags, hasAnyFlag, removeFlag } from "#utils";
describe("Enum utils", () => {
- it("Should be able to get enum keys", () => {
+ it("getEnumFlags", () => {
+ const keys = getEnumFlags(123);
+ equal(keys, [1, 2, 8, 16, 32, 64]);
+ });
+
+ it("removeFlag", () => {
+ equal(removeFlag(3, 2), 1);
+ equal(removeFlag(3, 1), 2);
+ equal(removeFlag(3, 4), 3);
+ });
+
+ it("hasAllFlags", () => {
+ equal(hasAllFlags(3, 1), true);
+ equal(hasAllFlags(3, 1 | 2), true);
+ equal(hasAllFlags(3, 1 | 4), false);
+ });
+
+ it("hasAnyFlag", () => {
+ equal(hasAnyFlag(3, 1), true);
+ equal(hasAnyFlag(3, 1 | 2), true);
+ equal(hasAnyFlag(3, 1 | 4), true);
+ equal(hasAnyFlag(3, 4), false);
+ });
+
+ it("debugFlags", () => {
+ enum Flags {
+ A = 1,
+ B = 2,
+ C = 4,
+ }
+ equal(debugFlags(Flags, Flags.A), ["A"]);
+ equal(debugFlags(Flags, Flags.A | Flags.B), ["A", "B"]);
+ equal(debugFlags(Flags, Flags.A | Flags.C), ["A", "C"]);
+ equal(debugFlags(Flags, 0), []);
+ });
+
+ it("getEnumKeys", () => {
const keys = getEnumKeys(ReflectionKind);
ok(keys.includes("Project"));
ok(!keys.includes("SignatureContainer"));
diff --git a/src/test/utils-common/jsx.test.tsx b/src/test/utils-common/jsx.test.tsx
index eef2abe8a..a642c0a31 100644
--- a/src/test/utils-common/jsx.test.tsx
+++ b/src/test/utils-common/jsx.test.tsx
@@ -1,9 +1,13 @@
import { deepStrictEqual as equal } from "assert";
import { JSX } from "#utils";
-
-const renderElement = JSX.renderElement;
+import { renderElement, renderElementToText } from "../../lib/utils-common/jsx.js";
describe("JSX", () => {
+ it("Handles null/undefined", () => {
+ equal(renderElement(null), ``);
+ equal(renderElement(undefined), ``);
+ });
+
it("Works with basic case", () => {
const element = (
- {...visibilityOptions}
{i18n.theme_type_declaration()}
@@ -194,7 +199,7 @@ export function typeDetailsIfUseful( "typeDetailsIfUseful(reflectionOwningType, type) called incorrectly", ); - if (type && renderingTypeDetailsIsUseful(reflectionOwningType, type)) { + if (type && renderingTypeDetailsIsUseful(reflectionOwningType, type, context.options.getValue("notRenderedTags"))) { return context.typeDetails(reflectionOwningType, type, false); } } @@ -290,9 +295,9 @@ function renderChild( return (- {!!child.flags.isRest && ...} + {child.flags.isRest && ...} {child.name} - {!!child.flags.isOptional && "?"}: function + {child.flags.isOptional && "?"}: function
{context.memberSignatures(child)} @@ -314,20 +319,22 @@ function renderChild( // standard type if (child.type) { + const notRenderedTags = context.options.getValue("notRenderedTags"); + return ({context.reflectionFlags(child)} - {!!child.flags.isRest && ...} + {child.flags.isRest && ...} {child.name} - {!!child.flags.isOptional && "?"} + {child.flags.isOptional && "?"} {": "} {context.type(child.type)}
{highlightOrComment(child)} - {child.getProperties().some(renderingChildIsUseful) && ( + {child.getProperties().some(prop => renderingChildIsUseful(prop, notRenderedTags)) && (-
{child.getProperties().map((c) => renderChild(context, c, renderAnchors))}
- {children}
- {children}
+ */`);
+
+ equal(
+ comment.summary,
+ [
+ { kind: "text", text: 'Base class method
\n" + "div.tsd-comment.tsd-typography": { + "p": "Base class method" + } }, { "div.tsd-parameters": [ @@ -433,9 +435,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { diff --git a/src/test/renderer/specs/classes/GH3007.DOMBase.json b/src/test/renderer/specs/classes/GH3007.DOMBase.json new file mode 100644 index 000000000..18378c675 --- /dev/null +++ b/src/test/renderer/specs/classes/GH3007.DOMBase.json @@ -0,0 +1,505 @@ +{ + "div.container.container-main": [ + { + "div.col-content": [ + { + "div.tsd-page-title": [ + { + "tag": "ul.tsd-breadcrumb", + "props": { + "aria-label": "Breadcrumb" + }, + "children": [ + { + "li": { + "tag": "a", + "props": { + "href": "../modules/GH3007.json" + }, + "children": "GH3007" + } + }, + { + "li": { + "tag": "a", + "props": { + "href": "", + "aria-current": "page" + }, + "children": "DOMBase" + } + } + ] + }, + { + "h1": "Class DOMBaseGeneric class
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "section.tsd-panel.tsd-comment": { + "div.tsd-comment.tsd-typography": { + "p": "Generic class" } - ] + } }, { "section.tsd-panel": [ diff --git a/src/test/renderer/specs/classes/ModifiersClass.json b/src/test/renderer/specs/classes/ModifiersClass.json index d2b69f253..e4650c528 100644 --- a/src/test/renderer/specs/classes/ModifiersClass.json +++ b/src/test/renderer/specs/classes/ModifiersClass.json @@ -202,18 +202,52 @@ ] }, { - "div.tsd-description": { - "h4.tsd-returns-title": [ - "Returns ", - { - "tag": "a.tsd-signature-type.tsd-kind-class", - "props": { - "href": "" - }, - "children": "ModifiersClass" + "div.tsd-description": [ + { + "div.tsd-comment.tsd-typography": { + "p": [ + "#2934 same page link", + { + "tag": "a.tsd-kind-class", + "props": { + "href": "#" + }, + "children": { + "code": "ModifiersClass" + } + } + ] } - ] - } + }, + { + "h4.tsd-returns-title": [ + "Returns ", + { + "tag": "a.tsd-signature-type.tsd-kind-class", + "props": { + "href": "" + }, + "children": "ModifiersClass" + } + ] + }, + { + "aside.tsd-sources": { + "ul": { + "li": [ + "Defined in ", + { + "tag": "a", + "props": { + "href": "index.ts" + }, + "children": "index.ts:73" + } + ] + } + } + } + ] } ] } diff --git a/src/test/renderer/specs/classes/RenderClass.json b/src/test/renderer/specs/classes/RenderClass.json index e87d21064..47a7ca9ee 100644 --- a/src/test/renderer/specs/classes/RenderClass.json +++ b/src/test/renderer/specs/classes/RenderClass.json @@ -26,14 +26,11 @@ ] }, { - "section.tsd-panel.tsd-comment": [ - { - "div.tsd-comment.tsd-typography": "Renderer class
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "section.tsd-panel.tsd-comment": { + "div.tsd-comment.tsd-typography": { + "p": "Renderer class" } - ] + } }, { "tag": "section.tsd-panel.tsd-hierarchy", @@ -106,10 +103,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "Index signature
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "Index signature" + } } ] } @@ -356,7 +352,9 @@ { "div.tsd-description": [ { - "div.tsd-comment.tsd-typography": "Ctor comment
\n" + "div.tsd-comment.tsd-typography": { + "p": "Ctor comment" + } }, { "div.tsd-parameters": [ @@ -392,9 +390,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": [ { @@ -493,10 +488,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "Property
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "Property" + } }, { "aside.tsd-sources": { @@ -956,7 +950,9 @@ { "div.tsd-description": [ { - "div.tsd-comment.tsd-typography": "Method comment
\n" + "div.tsd-comment.tsd-typography": { + "p": "Method comment" + } }, { "div.tsd-parameters": [ @@ -988,9 +984,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": [ { @@ -1083,7 +1076,9 @@ { "div.tsd-description": [ { - "div.tsd-comment.tsd-typography": "Sig 1 comment
\n" + "div.tsd-comment.tsd-typography": { + "p": "Sig 1 comment" + } }, { "h4.tsd-returns-title": [ @@ -1093,9 +1088,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { @@ -1158,7 +1150,9 @@ { "div.tsd-description": [ { - "div.tsd-comment.tsd-typography": "Sig 2 comment
\n" + "div.tsd-comment.tsd-typography": { + "p": "Sig 2 comment" + } }, { "div.tsd-parameters": [ @@ -1190,9 +1184,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { diff --git a/src/test/renderer/specs/documents/doc.json b/src/test/renderer/specs/documents/doc.json index e0a58f254..decb74ce4 100644 --- a/src/test/renderer/specs/documents/doc.json +++ b/src/test/renderer/specs/documents/doc.json @@ -21,7 +21,49 @@ } }, { - "div.tsd-panel.tsd-typography": "Rendered document
\nLink to this doc: link
\ntest();\nNote
\nThis is an alert
\nEnum comment Value1
\n" + "div.tsd-comment.tsd-typography": { + "p": [ + "Enum comment", + { + "tag": "a.tsd-kind-enum-member", + "props": { + "href": "#value1" + }, + "children": "Value1" + } + ] + } }, { "div.tsd-comment.tsd-typography": { @@ -45,7 +56,9 @@ } ] }, - "Block tag
\n" + { + "p": "Block tag" + } ] } } @@ -61,7 +74,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:77" + "children": "index.ts:80" } ] } @@ -165,10 +178,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "Value1 comment
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "Value1 comment" + } }, { "aside.tsd-sources": { @@ -180,7 +192,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:79" + "children": "index.ts:82" } ] } @@ -219,10 +231,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "Value2 comment
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "Value2 comment" + } }, { "aside.tsd-sources": { @@ -234,7 +245,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:81" + "children": "index.ts:84" } ] } diff --git a/src/test/renderer/specs/functions/box.json b/src/test/renderer/specs/functions/box.json index b597048fc..473fcb350 100644 --- a/src/test/renderer/specs/functions/box.json +++ b/src/test/renderer/specs/functions/box.json @@ -105,7 +105,9 @@ { "div.tsd-description": [ { - "div.tsd-comment.tsd-typography": "Signature comment\n#2921 !Promise
\n" + "div.tsd-comment.tsd-typography": { + "p": "Signature comment\n#2921 !Promise" + } }, { "section.tsd-panel": [ @@ -147,10 +149,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "Item comment
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "Item comment" + } } ] } @@ -184,9 +185,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { @@ -197,7 +195,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:110" + "children": "index.ts:113" } ] } diff --git a/src/test/renderer/specs/index.json b/src/test/renderer/specs/index.json index 358074286..68faaaf24 100644 --- a/src/test/renderer/specs/index.json +++ b/src/test/renderer/specs/index.json @@ -16,13 +16,57 @@ ] }, { - "div.tsd-panel.tsd-typography": "Readme text
\n" + "div.tsd-panel.tsd-typography": [ + { + "h1#gh3023-test.tsd-anchor-link": [ + "gh3023 <test>", + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#gh3023-test", + "aria-label": "Permalink" + } + } + ] + }, + { + "p": [ + "Anchor for above heading should be", + { + "code": "gh3023-test" + } + ] + } + ] } ] }, { "div.col-sidebar": { - "div.page-menu": [] + "div.page-menu": { + "tag": "details.tsd-accordion.tsd-page-navigation", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary": { + "h3": "On This Page" + } + }, + { + "div.tsd-accordion-details": { + "tag": "a", + "props": { + "href": "#gh3023-test" + }, + "children": { + "span": "gh3023Interface method
\n" + "div.tsd-comment.tsd-typography": { + "p": "Interface method" + } }, { "div.tsd-parameters": [ @@ -357,9 +359,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { diff --git a/src/test/renderer/specs/interfaces/DisabledGroups.json b/src/test/renderer/specs/interfaces/DisabledGroups.json index 187a56a4e..4d7363857 100644 --- a/src/test/renderer/specs/interfaces/DisabledGroups.json +++ b/src/test/renderer/specs/interfaces/DisabledGroups.json @@ -41,7 +41,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -62,7 +62,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-call-signature", "props": { @@ -101,7 +101,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:129" + "children": "index.ts:132" } ] } @@ -194,7 +194,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:130" + "children": "index.ts:133" } ] } @@ -247,6 +247,17 @@ }, { "div.tsd-description": [ + { + "div.tsd-comment.tsd-typography": { + "p": { + "tag": "a", + "props": { + "href": "../" + }, + "children": "link to readme #3006" + } + } + }, { "h4.tsd-returns-title": [ "Returns ", @@ -265,7 +276,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:131" + "children": "index.ts:135" } ] } diff --git a/src/test/renderer/specs/interfaces/ExpandType.ExpandedByDefault.json b/src/test/renderer/specs/interfaces/ExpandType.ExpandedByDefault.json index 4df2574ad..dd0a91628 100644 --- a/src/test/renderer/specs/interfaces/ExpandType.ExpandedByDefault.json +++ b/src/test/renderer/specs/interfaces/ExpandType.ExpandedByDefault.json @@ -52,7 +52,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -181,10 +181,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "B
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "B" + } }, { "aside.tsd-sources": { diff --git a/src/test/renderer/specs/interfaces/GH2982.TMXDataNode.json b/src/test/renderer/specs/interfaces/GH2982.TMXDataNode.json new file mode 100644 index 000000000..4a14d5c79 --- /dev/null +++ b/src/test/renderer/specs/interfaces/GH2982.TMXDataNode.json @@ -0,0 +1,352 @@ +{ + "div.container.container-main": [ + { + "div.col-content": [ + { + "div.tsd-page-title": [ + { + "tag": "ul.tsd-breadcrumb", + "props": { + "aria-label": "Breadcrumb" + }, + "children": [ + { + "li": { + "tag": "a", + "props": { + "href": "../modules/GH2982.json" + }, + "children": "GH2982" + } + }, + { + "li": { + "tag": "a", + "props": { + "href": "", + "aria-current": "page" + }, + "children": "TMXDataNode" + } + } + ] + }, + { + "h1": "Interface TMXDataNode" + } + ] + }, + { + "div.tsd-signature": [ + { + "span.tsd-signature-keyword": "interface" + }, + " ", + { + "span.tsd-kind-interface": "TMXDataNode" + }, + " ", + { + "span.tsd-signature-symbol": "{" + }, + { + "br": [] + }, + " ", + { + "tag": "a.tsd-kind-property", + "props": { + "href": "#base" + }, + "children": "base" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-symbol": "{" + }, + " ", + { + "span.tsd-kind-property": "extra" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "any" + }, + " ", + { + "span.tsd-signature-symbol": "}" + }, + { + "span.tsd-signature-symbol": ";" + }, + { + "br": [] + }, + { + "span.tsd-signature-symbol": "}" + } + ] + }, + { + "tag": "section.tsd-panel.tsd-hierarchy", + "props": { + "data-refl": "123" + }, + "children": [ + { + "h4": [ + "Hierarchy (", + { + "tag": "a", + "props": { + "href": "../hierarchy.html#GH2982.TMXDataNode" + }, + "children": "View Summary" + }, + ")" + ] + }, + { + "ul.tsd-hierarchy": { + "li.tsd-hierarchy-item": [ + { + "tag": "a.tsd-signature-type.tsd-kind-type-alias", + "props": { + "href": "../types/GH2982.TMXNode.json" + }, + "children": "TMXNode" + }, + { + "span.tsd-signature-symbol": "<" + }, + { + "span.tsd-signature-symbol": "{" + }, + " ", + { + "span.tsd-kind-property": "extra" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "any" + }, + " ", + { + "span.tsd-signature-symbol": "}" + }, + { + "span.tsd-signature-symbol": ">" + }, + { + "ul.tsd-hierarchy": { + "li.tsd-hierarchy-item": { + "span.tsd-hierarchy-target": "TMXDataNode" + } + } + } + ] + } + } + ] + }, + { + "aside.tsd-sources": { + "ul": { + "li": [ + "Defined in ", + { + "tag": "a", + "props": { + "href": "gh2982.ts" + }, + "children": "gh2982.ts:5" + } + ] + } + } + }, + { + "section.tsd-panel-group.tsd-index-group": { + "section.tsd-panel.tsd-index-panel": { + "tag": "details.tsd-index-content.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary.tsd-index-summary": { + "h5.tsd-index-heading.uppercase": "Index" + } + }, + { + "div.tsd-accordion-details": { + "section.tsd-index-section": [ + { + "h3.tsd-index-heading": "Properties" + }, + { + "div.tsd-index-list": [ + { + "tag": "a.tsd-index-link.tsd-is-inherited", + "props": { + "href": "#base" + }, + "children": { + "span": "base" + } + }, + "\n" + ] + } + ] + } + } + ] + } + } + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Properties" + }, + "children": { + "h2": "Properties" + } + }, + { + "section": { + "section.tsd-panel.tsd-member.tsd-is-inherited": [ + { + "h3.tsd-anchor-link#base": [ + { + "span": "base" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#base", + "aria-label": "Permalink" + } + } + ] + }, + { + "div.tsd-signature": [ + { + "span.tsd-kind-property": "base" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-symbol": "{" + }, + " ", + { + "span.tsd-kind-property": "extra" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "any" + }, + " ", + { + "span.tsd-signature-symbol": "}" + } + ] + }, + { + "aside.tsd-sources": [ + { + "p": "Inherited from TMXNode.base" + }, + { + "ul": { + "li": [ + "Defined in ", + { + "tag": "a", + "props": { + "href": "gh2982.ts" + }, + "children": "gh2982.ts:2" + } + ] + } + } + ] + } + ] + } + } + ] + } + ] + }, + { + "div.col-sidebar": { + "div.page-menu": { + "tag": "details.tsd-accordion.tsd-page-navigation", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary": { + "h3": "On This Page" + } + }, + { + "div.tsd-accordion-details": { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Properties" + }, + "children": "Properties" + }, + { + "div": { + "tag": "a.tsd-is-inherited", + "props": { + "href": "#base" + }, + "children": { + "span": "base" + } + } + } + ] + } + } + ] + } + } + } + ] +} diff --git a/src/test/renderer/specs/interfaces/GH3007.DOMIterable.json b/src/test/renderer/specs/interfaces/GH3007.DOMIterable.json new file mode 100644 index 000000000..e907f6478 --- /dev/null +++ b/src/test/renderer/specs/interfaces/GH3007.DOMIterable.json @@ -0,0 +1,343 @@ +{ + "div.container.container-main": [ + { + "div.col-content": [ + { + "div.tsd-page-title": [ + { + "tag": "ul.tsd-breadcrumb", + "props": { + "aria-label": "Breadcrumb" + }, + "children": [ + { + "li": { + "tag": "a", + "props": { + "href": "../modules/GH3007.json" + }, + "children": "GH3007" + } + }, + { + "li": { + "tag": "a", + "props": { + "href": "", + "aria-current": "page" + }, + "children": "DOMIterable" + } + } + ] + }, + { + "h1": "Interface DOMIterable" + } + ] + }, + { + "div.tsd-signature": [ + { + "span.tsd-signature-keyword": "interface" + }, + " ", + { + "span.tsd-kind-interface": "DOMIterable" + }, + " ", + { + "span.tsd-signature-symbol": "{" + }, + { + "br": [] + }, + " ", + { + "tag": "a.tsd-kind-property", + "props": { + "href": "#iterator" + }, + "children": "\"[iterator]\"" + }, + { + "span.tsd-signature-symbol": "?:" + }, + " ", + { + "span.tsd-signature-symbol": "()" + }, + " ", + { + "span.tsd-signature-symbol": "=>" + }, + " ", + { + "span.tsd-signature-type": "Iterator" + }, + { + "span.tsd-signature-symbol": "<" + }, + { + "span.tsd-signature-type": "Node" + }, + { + "span.tsd-signature-symbol": ">" + }, + { + "span.tsd-signature-symbol": ";" + }, + { + "br": [] + }, + { + "span.tsd-signature-symbol": "}" + } + ] + }, + { + "tag": "section.tsd-panel.tsd-hierarchy", + "props": { + "data-refl": "142" + }, + "children": [ + { + "h4": "Hierarchy" + }, + { + "ul.tsd-hierarchy": { + "li.tsd-hierarchy-item": [ + { + "span.tsd-signature-type": "Partial" + }, + { + "span.tsd-signature-symbol": "<" + }, + { + "tag": "a.tsd-signature-type.tsd-kind-class", + "props": { + "href": "../classes/GH3007.DOMBase.json" + }, + "children": "DOMBase" + }, + { + "span.tsd-signature-symbol": "<" + }, + { + "span.tsd-signature-type": "Node" + }, + { + "span.tsd-signature-symbol": ">" + }, + { + "span.tsd-signature-symbol": ">" + }, + { + "ul.tsd-hierarchy": { + "li.tsd-hierarchy-item": { + "span.tsd-hierarchy-target": "DOMIterable" + } + } + } + ] + } + } + ] + }, + { + "aside.tsd-sources": { + "ul": { + "li": [ + "Defined in ", + { + "tag": "a", + "props": { + "href": "gh3007.ts" + }, + "children": "gh3007.ts:9" + } + ] + } + } + }, + { + "section.tsd-panel-group.tsd-index-group": { + "section.tsd-panel.tsd-index-panel": { + "tag": "details.tsd-index-content.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary.tsd-index-summary": { + "h5.tsd-index-heading.uppercase": "Index" + } + }, + { + "div.tsd-accordion-details": { + "section.tsd-index-section": [ + { + "h3.tsd-index-heading": "Properties" + }, + { + "div.tsd-index-list": [ + { + "tag": "a.tsd-index-link.tsd-is-inherited", + "props": { + "href": "#iterator" + }, + "children": { + "span": "[iterator]?" + } + }, + "\n" + ] + } + ] + } + } + ] + } + } + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Properties" + }, + "children": { + "h2": "Properties" + } + }, + { + "section": { + "section.tsd-panel.tsd-member.tsd-is-inherited": [ + { + "h3.tsd-anchor-link#iterator": [ + { + "code.tsd-tag": "Optional" + }, + { + "span": "[iterator]" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#iterator", + "aria-label": "Permalink" + } + } + ] + }, + { + "div.tsd-signature": [ + { + "span.tsd-kind-property": "\"[iterator]\"" + }, + { + "span.tsd-signature-symbol": "?:" + }, + " ", + { + "span.tsd-signature-symbol": "()" + }, + " ", + { + "span.tsd-signature-symbol": "=>" + }, + " ", + { + "span.tsd-signature-type": "Iterator" + }, + { + "span.tsd-signature-symbol": "<" + }, + { + "span.tsd-signature-type": "Node" + }, + { + "span.tsd-signature-symbol": ">" + } + ] + }, + { + "aside.tsd-sources": [ + { + "p": "Inherited from Partial.[iterator]" + }, + { + "ul": { + "li": [ + "Defined in ", + { + "tag": "a", + "props": { + "href": "gh3007.ts" + }, + "children": "gh3007.ts:6" + } + ] + } + } + ] + } + ] + } + } + ] + } + ] + }, + { + "div.col-sidebar": { + "div.page-menu": { + "tag": "details.tsd-accordion.tsd-page-navigation", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary": { + "h3": "On This Page" + } + }, + { + "div.tsd-accordion-details": { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Properties" + }, + "children": "Properties" + }, + { + "div": { + "tag": "a.tsd-is-inherited", + "props": { + "href": "#iterator" + }, + "children": { + "span": "[iterator]" + } + } + } + ] + } + } + ] + } + } + } + ] +} diff --git a/src/test/renderer/specs/interfaces/NoneCategory.json b/src/test/renderer/specs/interfaces/NoneCategory.json index fbc092f71..8f9f12a08 100644 --- a/src/test/renderer/specs/interfaces/NoneCategory.json +++ b/src/test/renderer/specs/interfaces/NoneCategory.json @@ -41,7 +41,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -62,7 +62,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -83,7 +83,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -119,7 +119,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:114" + "children": "index.ts:117" } ] } @@ -235,9 +235,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { @@ -248,7 +245,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:119" + "children": "index.ts:122" } ] } @@ -303,9 +300,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { @@ -316,7 +310,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:116" + "children": "index.ts:119" } ] } @@ -383,7 +377,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:117" + "children": "index.ts:120" } ] } diff --git a/src/test/renderer/specs/interfaces/NoneGroup.json b/src/test/renderer/specs/interfaces/NoneGroup.json index e83fc182e..925274d34 100644 --- a/src/test/renderer/specs/interfaces/NoneGroup.json +++ b/src/test/renderer/specs/interfaces/NoneGroup.json @@ -41,7 +41,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -62,7 +62,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -98,7 +98,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:122" + "children": "index.ts:125" } ] } @@ -193,9 +193,6 @@ } ] }, - { - "div.tsd-comment.tsd-typography": [] - }, { "aside.tsd-sources": { "ul": { @@ -206,7 +203,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:124" + "children": "index.ts:127" } ] } @@ -271,7 +268,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:125" + "children": "index.ts:128" } ] } diff --git a/src/test/renderer/specs/interfaces/gh2995.json b/src/test/renderer/specs/interfaces/gh2995.json new file mode 100644 index 000000000..c4182b433 --- /dev/null +++ b/src/test/renderer/specs/interfaces/gh2995.json @@ -0,0 +1,399 @@ +{ + "div.container.container-main": [ + { + "div.col-content": [ + { + "div.tsd-page-title": [ + { + "tag": "ul.tsd-breadcrumb", + "props": { + "aria-label": "Breadcrumb" + }, + "children": { + "li": { + "tag": "a", + "props": { + "href": "", + "aria-current": "page" + }, + "children": "gh2995" + } + } + }, + { + "h1": "Interface gh2995" + } + ] + }, + { + "div.tsd-signature": [ + { + "span.tsd-signature-keyword": "interface" + }, + " ", + { + "span.tsd-kind-interface": "gh2995" + }, + " ", + { + "span.tsd-signature-symbol": "{" + }, + { + "br": [] + }, + " ", + { + "tag": "a.tsd-kind-call-signature", + "props": { + "href": "#optionalmethod-1" + }, + "children": "optionalMethod" + }, + { + "span.tsd-signature-symbol": "?" + }, + { + "span.tsd-signature-symbol": "(" + }, + { + "span.tsd-kind-parameter": "filter" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "string" + }, + { + "span.tsd-signature-symbol": "," + }, + " ", + { + "span.tsd-kind-parameter": "args" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "string" + }, + { + "span.tsd-signature-symbol": "[]" + }, + { + "span.tsd-signature-symbol": ")" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "any" + }, + { + "span.tsd-signature-symbol": ";" + }, + { + "br": [] + }, + { + "span.tsd-signature-symbol": "}" + } + ] + }, + { + "aside.tsd-sources": { + "ul": { + "li": [ + "Defined in ", + { + "tag": "a", + "props": { + "href": "gh2995.ts" + }, + "children": "gh2995.ts:1" + } + ] + } + } + }, + { + "section.tsd-panel-group.tsd-index-group": { + "section.tsd-panel.tsd-index-panel": { + "tag": "details.tsd-index-content.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary.tsd-index-summary": { + "h5.tsd-index-heading.uppercase": "Index" + } + }, + { + "div.tsd-accordion-details": { + "section.tsd-index-section": [ + { + "h3.tsd-index-heading": "Methods" + }, + { + "div.tsd-index-list": [ + { + "tag": "a.tsd-index-link", + "props": { + "href": "#optionalmethod" + }, + "children": { + "span": [ + "optional", + { + "wbr": [] + }, + "Method?" + ] + } + }, + "\n" + ] + } + ] + } + } + ] + } + } + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Methods" + }, + "children": { + "h2": "Methods" + } + }, + { + "section": { + "section.tsd-panel.tsd-member": [ + { + "h3.tsd-anchor-link#optionalmethod": [ + { + "code.tsd-tag": "Optional" + }, + { + "span": [ + "optional", + { + "wbr": [] + }, + "Method" + ] + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#optionalmethod", + "aria-label": "Permalink" + } + } + ] + }, + { + "ul.tsd-signatures": { + "li.": [ + { + "div.tsd-signature.tsd-anchor-link#optionalmethod-1": [ + { + "span.tsd-kind-call-signature": "optionalMethod" + }, + { + "span.tsd-signature-symbol": "?" + }, + { + "span.tsd-signature-symbol": "(" + }, + { + "span.tsd-kind-parameter": "filter" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "string" + }, + { + "span.tsd-signature-symbol": "," + }, + " ", + { + "span.tsd-kind-parameter": "args" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "string" + }, + { + "span.tsd-signature-symbol": "[]" + }, + { + "span.tsd-signature-symbol": ")" + }, + { + "span.tsd-signature-symbol": ":" + }, + " ", + { + "span.tsd-signature-type": "any" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#optionalmethod-1", + "aria-label": "Permalink" + } + } + ] + }, + { + "div.tsd-description": [ + { + "div.tsd-parameters": [ + { + "h4.tsd-parameters-title": "Parameters" + }, + { + "ul.tsd-parameter-list": [ + { + "li": { + "span": [ + { + "span.tsd-kind-parameter": "filter" + }, + ": ", + { + "span.tsd-signature-type": "string" + } + ] + } + }, + { + "li": { + "span": [ + { + "span.tsd-kind-parameter": "args" + }, + ": ", + { + "span.tsd-signature-type": "string" + }, + { + "span.tsd-signature-symbol": "[]" + } + ] + } + } + ] + } + ] + }, + { + "h4.tsd-returns-title": [ + "Returns ", + { + "span.tsd-signature-type": "any" + } + ] + }, + { + "aside.tsd-sources": { + "ul": { + "li": [ + "Defined in ", + { + "tag": "a", + "props": { + "href": "gh2995.ts" + }, + "children": "gh2995.ts:2" + } + ] + } + } + } + ] + } + ] + } + } + ] + } + } + ] + } + ] + }, + { + "div.col-sidebar": { + "div.page-menu": { + "tag": "details.tsd-accordion.tsd-page-navigation", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary": { + "h3": "On This Page" + } + }, + { + "div.tsd-accordion-details": { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Methods" + }, + "children": "Methods" + }, + { + "div": { + "tag": "a", + "props": { + "href": "#optionalmethod" + }, + "children": { + "span": [ + "optional", + { + "wbr": [] + }, + "Method" + ] + } + } + } + ] + } + } + ] + } + } + } + ] +} diff --git a/src/test/renderer/specs/modules.json b/src/test/renderer/specs/modules.json index 21b6084dd..c8247517c 100644 --- a/src/test/renderer/specs/modules.json +++ b/src/test/renderer/specs/modules.json @@ -16,14 +16,11 @@ ] }, { - "section.tsd-panel.tsd-comment": [ - { - "div.tsd-comment.tsd-typography": "Module comment
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "section.tsd-panel.tsd-comment": { + "div.tsd-comment.tsd-typography": { + "p": "Module comment" } - ] + } }, { "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", @@ -106,6 +103,52 @@ ] } }, + { + "dd.tsd-member-summary": [] + }, + { + "dt.tsd-member-summary#gh2982": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "modules/GH2982.json" + }, + "children": "GH2982" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#gh2982", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + }, + { + "dt.tsd-member-summary#gh3007": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "modules/GH3007.json" + }, + "children": "GH3007" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#gh3007", + "aria-label": "Permalink" + } + } + ] + } + }, { "dd.tsd-member-summary": [] } @@ -220,6 +263,29 @@ { "dd.tsd-member-summary": [] }, + { + "dt.tsd-member-summary#gh3014": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "classes/GH3014.json" + }, + "children": "GH3014" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#gh3014", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + }, { "dt.tsd-member-summary#modifiersclass": { "span.tsd-member-summary-name": [ @@ -333,6 +399,29 @@ { "dd.tsd-member-summary": [] }, + { + "dt.tsd-member-summary#gh2995": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "interfaces/gh2995.json" + }, + "children": "gh2995" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#gh2995", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + }, { "dt.tsd-member-summary#nonecategory": { "span.tsd-member-summary-name": [ @@ -493,6 +582,56 @@ ] } ] + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-References" + }, + "children": { + "h2": "References" + } + }, + { + "dl.tsd-member-summaries": [ + { + "dt.tsd-member-summary#boxalias": { + "span.tsd-member-summary-name": [ + { + "span": "boxAlias" + }, + { + "span": " → " + }, + { + "tag": "a", + "props": { + "href": "functions/box.json" + }, + "children": "box" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#boxalias", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + } + ] + } + ] } ] }, @@ -551,21 +690,41 @@ "children": "Namespaces" }, { - "div": { - "tag": "a", - "props": { - "href": "#expandtype" + "div": [ + { + "tag": "a", + "props": { + "href": "#expandtype" + }, + "children": { + "span": [ + "Expand", + { + "wbr": [] + }, + "Type" + ] + } }, - "children": { - "span": [ - "Expand", - { - "wbr": [] - }, - "Type" - ] + { + "tag": "a", + "props": { + "href": "#gh2982" + }, + "children": { + "span": "GH2982" + } + }, + { + "tag": "a", + "props": { + "href": "#gh3007" + }, + "children": { + "span": "GH3007" + } } - } + ] } ] }, @@ -640,6 +799,15 @@ ] } }, + { + "tag": "a", + "props": { + "href": "#gh3014" + }, + "children": { + "span": "GH3014" + } + }, { "tag": "a", "props": { @@ -719,6 +887,15 @@ ] } }, + { + "tag": "a", + "props": { + "href": "#gh2995" + }, + "children": { + "span": "gh2995" + } + }, { "tag": "a", "props": { @@ -821,6 +998,38 @@ } } ] + }, + { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-References" + }, + "children": "References" + }, + { + "div": { + "tag": "a", + "props": { + "href": "#boxalias" + }, + "children": { + "span": [ + "box", + { + "wbr": [] + }, + "Alias" + ] + } + } + } + ] } ] } diff --git a/src/test/renderer/specs/modules/ExpandType.NestedBehavior1.json b/src/test/renderer/specs/modules/ExpandType.NestedBehavior1.json index b6c548382..c78078397 100644 --- a/src/test/renderer/specs/modules/ExpandType.NestedBehavior1.json +++ b/src/test/renderer/specs/modules/ExpandType.NestedBehavior1.json @@ -36,11 +36,6 @@ } ] }, - { - "section.tsd-panel.tsd-comment": { - "div.tsd-comment.tsd-typography": [] - } - }, { "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", "props": { @@ -145,7 +140,13 @@ "href": "#aexpanded" }, "children": { - "span": "AExpanded" + "span": [ + "A", + { + "wbr": [] + }, + "Expanded" + ] } }, { diff --git a/src/test/renderer/specs/modules/ExpandType.json b/src/test/renderer/specs/modules/ExpandType.json index 5e9c63ab3..dc9662dd9 100644 --- a/src/test/renderer/specs/modules/ExpandType.json +++ b/src/test/renderer/specs/modules/ExpandType.json @@ -332,7 +332,13 @@ "href": "#aexpanded" }, "children": { - "span": "AExpanded" + "span": [ + "A", + { + "wbr": [] + }, + "Expanded" + ] } }, { @@ -341,7 +347,13 @@ "href": "#bexpanded" }, "children": { - "span": "BExpanded" + "span": [ + "B", + { + "wbr": [] + }, + "Expanded" + ] } }, { diff --git a/src/test/renderer/specs/modules/GH2982.json b/src/test/renderer/specs/modules/GH2982.json new file mode 100644 index 000000000..40c28d9dc --- /dev/null +++ b/src/test/renderer/specs/modules/GH2982.json @@ -0,0 +1,208 @@ +{ + "div.container.container-main": [ + { + "div.col-content": [ + { + "div.tsd-page-title": [ + { + "tag": "ul.tsd-breadcrumb", + "props": { + "aria-label": "Breadcrumb" + }, + "children": { + "li": { + "tag": "a", + "props": { + "href": "", + "aria-current": "page" + }, + "children": "GH2982" + } + } + }, + { + "h1": "Namespace GH2982" + } + ] + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Interfaces" + }, + "children": { + "h2": "Interfaces" + } + }, + { + "dl.tsd-member-summaries": [ + { + "dt.tsd-member-summary#tmxdatanode": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "../interfaces/GH2982.TMXDataNode.json" + }, + "children": "TMXDataNode" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#tmxdatanode", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + } + ] + } + ] + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Type Aliases" + }, + "children": { + "h2": "Type Aliases" + } + }, + { + "dl.tsd-member-summaries": [ + { + "dt.tsd-member-summary#tmxnode": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "../types/GH2982.TMXNode.json" + }, + "children": "TMXNode" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#tmxnode", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + } + ] + } + ] + } + ] + }, + { + "div.col-sidebar": { + "div.page-menu": { + "tag": "details.tsd-accordion.tsd-page-navigation", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary": { + "h3": "On This Page" + } + }, + { + "div.tsd-accordion-details": [ + { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Interfaces" + }, + "children": "Interfaces" + }, + { + "div": { + "tag": "a", + "props": { + "href": "#tmxdatanode" + }, + "children": { + "span": [ + "TMX", + { + "wbr": [] + }, + "Data", + { + "wbr": [] + }, + "Node" + ] + } + } + } + ] + }, + { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Type Aliases" + }, + "children": "Type Aliases" + }, + { + "div": { + "tag": "a", + "props": { + "href": "#tmxnode" + }, + "children": { + "span": [ + "TMX", + { + "wbr": [] + }, + "Node" + ] + } + } + } + ] + } + ] + } + ] + } + } + } + ] +} diff --git a/src/test/renderer/specs/modules/GH3007.json b/src/test/renderer/specs/modules/GH3007.json new file mode 100644 index 000000000..f409f158f --- /dev/null +++ b/src/test/renderer/specs/modules/GH3007.json @@ -0,0 +1,244 @@ +{ + "div.container.container-main": [ + { + "div.col-content": [ + { + "div.tsd-page-title": [ + { + "tag": "ul.tsd-breadcrumb", + "props": { + "aria-label": "Breadcrumb" + }, + "children": { + "li": { + "tag": "a", + "props": { + "href": "", + "aria-current": "page" + }, + "children": "GH3007" + } + } + }, + { + "h1": "Namespace GH3007" + } + ] + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Classes" + }, + "children": { + "h2": "Classes" + } + }, + { + "dl.tsd-member-summaries": [ + { + "dt.tsd-member-summary#dombase": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "../classes/GH3007.DOMBase.json" + }, + "children": "DOMBase" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#dombase", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + }, + { + "dt.tsd-member-summary#domclass": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "../classes/GH3007.DOMClass.json" + }, + "children": "DOMClass" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#domclass", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + } + ] + } + ] + }, + { + "tag": "details.tsd-panel-group.tsd-member-group.tsd-accordion", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Interfaces" + }, + "children": { + "h2": "Interfaces" + } + }, + { + "dl.tsd-member-summaries": [ + { + "dt.tsd-member-summary#domiterable": { + "span.tsd-member-summary-name": [ + { + "tag": "a", + "props": { + "href": "../interfaces/GH3007.DOMIterable.json" + }, + "children": "DOMIterable" + }, + { + "tag": "a.tsd-anchor-icon", + "props": { + "href": "#domiterable", + "aria-label": "Permalink" + } + } + ] + } + }, + { + "dd.tsd-member-summary": [] + } + ] + } + ] + } + ] + }, + { + "div.col-sidebar": { + "div.page-menu": { + "tag": "details.tsd-accordion.tsd-page-navigation", + "props": { + "open": true + }, + "children": [ + { + "summary.tsd-accordion-summary": { + "h3": "On This Page" + } + }, + { + "div.tsd-accordion-details": [ + { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Classes" + }, + "children": "Classes" + }, + { + "div": [ + { + "tag": "a", + "props": { + "href": "#dombase" + }, + "children": { + "span": [ + "DOM", + { + "wbr": [] + }, + "Base" + ] + } + }, + { + "tag": "a", + "props": { + "href": "#domclass" + }, + "children": { + "span": [ + "DOM", + { + "wbr": [] + }, + "Class" + ] + } + } + ] + } + ] + }, + { + "tag": "details.tsd-accordion.tsd-page-navigation-section", + "props": { + "open": true + }, + "children": [ + { + "tag": "summary.tsd-accordion-summary", + "props": { + "data-key": "section-Interfaces" + }, + "children": "Interfaces" + }, + { + "div": { + "tag": "a", + "props": { + "href": "#domiterable" + }, + "children": { + "span": [ + "DOM", + { + "wbr": [] + }, + "Iterable" + ] + } + } + } + ] + } + ] + } + ] + } + } + } + ] +} diff --git a/src/test/renderer/specs/types/ExpandType.AExpanded.json b/src/test/renderer/specs/types/ExpandType.AExpanded.json index 8b3b95b61..054638787 100644 --- a/src/test/renderer/specs/types/ExpandType.AExpanded.json +++ b/src/test/renderer/specs/types/ExpandType.AExpanded.json @@ -36,11 +36,6 @@ } ] }, - { - "section.tsd-panel.tsd-comment": { - "div.tsd-comment.tsd-typography": [] - } - }, { "div.tsd-signature": [ { @@ -61,7 +56,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -86,7 +81,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -111,7 +106,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -271,7 +266,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul.tsd-parameters": { @@ -290,10 +285,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "A
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "A" + } } ] } diff --git a/src/test/renderer/specs/types/ExpandType.BExpanded.json b/src/test/renderer/specs/types/ExpandType.BExpanded.json index e8eff5cf4..146e2c691 100644 --- a/src/test/renderer/specs/types/ExpandType.BExpanded.json +++ b/src/test/renderer/specs/types/ExpandType.BExpanded.json @@ -56,7 +56,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -81,7 +81,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -106,7 +106,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -318,7 +318,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul.tsd-parameters": { @@ -337,10 +337,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "B
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "B" + } } ] } diff --git a/src/test/renderer/specs/types/ExpandType.Expandable.json b/src/test/renderer/specs/types/ExpandType.Expandable.json index be39fc09a..9a12bb136 100644 --- a/src/test/renderer/specs/types/ExpandType.Expandable.json +++ b/src/test/renderer/specs/types/ExpandType.Expandable.json @@ -56,7 +56,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -185,10 +185,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "A
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "A" + } }, { "aside.tsd-sources": { diff --git a/src/test/renderer/specs/types/ExpandType.Expandable2.json b/src/test/renderer/specs/types/ExpandType.Expandable2.json index 1660b2262..5adbf8dbe 100644 --- a/src/test/renderer/specs/types/ExpandType.Expandable2.json +++ b/src/test/renderer/specs/types/ExpandType.Expandable2.json @@ -56,7 +56,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -185,10 +185,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "C
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "C" + } }, { "aside.tsd-sources": { diff --git a/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AExpanded.json b/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AExpanded.json index 678a54354..95b96b709 100644 --- a/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AExpanded.json +++ b/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AExpanded.json @@ -45,11 +45,6 @@ } ] }, - { - "section.tsd-panel.tsd-comment": { - "div.tsd-comment.tsd-typography": [] - } - }, { "div.tsd-signature": [ { @@ -70,7 +65,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -95,7 +90,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -120,7 +115,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -332,7 +327,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul.tsd-parameters": { @@ -351,10 +346,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "B
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "B" + } } ] } diff --git a/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AllExpanded.json b/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AllExpanded.json index 69dd59a7a..df4424c35 100644 --- a/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AllExpanded.json +++ b/src/test/renderer/specs/types/ExpandType.NestedBehavior1.AllExpanded.json @@ -65,7 +65,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -90,7 +90,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -115,7 +115,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -275,7 +275,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul.tsd-parameters": { @@ -294,10 +294,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "A
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "A" + } } ] } @@ -359,7 +358,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul.tsd-parameters": { @@ -378,10 +377,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "B
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "B" + } } ] } @@ -443,7 +441,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul.tsd-parameters": { @@ -462,10 +460,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "C
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "C" + } } ] } diff --git a/src/test/renderer/specs/types/GH2982.TMXNode.json b/src/test/renderer/specs/types/GH2982.TMXNode.json new file mode 100644 index 000000000..31febec59 --- /dev/null +++ b/src/test/renderer/specs/types/GH2982.TMXNode.json @@ -0,0 +1,120 @@ +{ + "div.container.container-main": [ + { + "div.col-content": [ + { + "div.tsd-page-title": [ + { + "tag": "ul.tsd-breadcrumb", + "props": { + "aria-label": "Breadcrumb" + }, + "children": [ + { + "li": { + "tag": "a", + "props": { + "href": "../modules/GH2982.json" + }, + "children": "GH2982" + } + }, + { + "li": { + "tag": "a", + "props": { + "href": "", + "aria-current": "page" + }, + "children": "TMXNode" + } + } + ] + }, + { + "h1": "Type Alias TMXNodeType alias with nested properties
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "section.tsd-panel.tsd-comment": { + "div.tsd-comment.tsd-typography": { + "p": "Type alias with nested properties" } - ] + } }, { "div.tsd-signature": [ @@ -55,7 +52,7 @@ { "br": [] }, - " ", + " ", { "tag": "a.tsd-kind-property", "props": { @@ -73,7 +70,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "anotherValue" }, @@ -90,7 +87,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "emptyObject" }, @@ -107,7 +104,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "moreOptions" }, @@ -139,7 +136,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "value" }, @@ -156,7 +153,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-signature-symbol": "}" }, @@ -181,7 +178,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:85" + "children": "index.ts:88" } ] } @@ -274,7 +271,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "anotherValue" }, @@ -291,7 +288,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "emptyObject" }, @@ -308,7 +305,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "moreOptions" }, @@ -340,7 +337,7 @@ { "br": [] }, - " ", + " ", { "span.tsd-kind-property": "value" }, @@ -365,7 +362,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul.tsd-parameters": [ @@ -388,10 +385,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "Another value
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "Another value" + } } ] }, @@ -444,10 +440,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "More options
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "More options" + } } ] }, @@ -470,10 +465,9 @@ ] }, { - "div.tsd-comment.tsd-typography": "Value
\n" - }, - { - "div.tsd-comment.tsd-typography": [] + "div.tsd-comment.tsd-typography": { + "p": "Value" + } } ] } @@ -491,7 +485,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:86" + "children": "index.ts:89" } ] } diff --git a/src/test/renderer/specs/types/UnionComments.json b/src/test/renderer/specs/types/UnionComments.json index 470df7d50..aabbcc333 100644 --- a/src/test/renderer/specs/types/UnionComments.json +++ b/src/test/renderer/specs/types/UnionComments.json @@ -50,7 +50,7 @@ { "div.tsd-type-declaration": [ { - "h4": "Type declaration" + "h4": "Type Declaration" }, { "ul": [ @@ -60,7 +60,9 @@ "span.tsd-signature-type": "\"abc\"" }, { - "div.tsd-comment.tsd-typography": "Commentary on abc
\n" + "div.tsd-comment.tsd-typography": { + "p": "Commentary on abc" + } } ] }, @@ -70,7 +72,9 @@ "span.tsd-signature-type": "\"def\"" }, { - "div.tsd-comment.tsd-typography": "Commentary on def
\n" + "div.tsd-comment.tsd-typography": { + "p": "Commentary on def" + } } ] } @@ -88,7 +92,7 @@ "props": { "href": "index.ts" }, - "children": "index.ts:99" + "children": "index.ts:102" } ] } diff --git a/src/test/renderer/testRendererUtils.ts b/src/test/renderer/testRendererUtils.ts index bb501f703..14632fd4b 100644 --- a/src/test/renderer/testRendererUtils.ts +++ b/src/test/renderer/testRendererUtils.ts @@ -1,10 +1,11 @@ import { type Reflection, resetReflectionID } from "#models"; -import { loadTestHighlighter } from "#node-utils"; +import { HtmlAttributeParser, loadTestHighlighter, ParserState } from "#node-utils"; import { rm } from "node:fs/promises"; import { DefaultTheme, KindRouter, PageEvent, PageKind, type RenderTemplate } from "../../lib/output/index.js"; import { type JsxChildren, type JsxElement, JsxFragment } from "../../lib/utils-common/jsx.elements.js"; import { Raw } from "../../lib/utils-common/jsx.js"; import { getConverter2App, getConverter2Project } from "../programs.js"; +import { assert } from "#utils"; function shouldIgnoreElement(el: JsxElement) { switch (el.tag) { @@ -46,13 +47,127 @@ function collapseStrings(data: any[]): unknown { return data; } +// This is a very hacky html parser only intended to handle output from markdown-it +// for inclusion in the renderer specs. Don't use it for anything that requires actual +// security. +function parseHtmlToJsxElement(html: string): JsxChildren[] { + const stack: JsxElement[] = []; + const output: JsxChildren[] = []; + let pos = 0; + let last = 0; + + function currentChildList() { + if (stack.length) { + return stack[stack.length - 1].children; + } + return output; + } + + function skipWs() { + while (pos < html.length && /\s/.test(html[pos])) ++pos; + } + + function takeWord() { + const start = pos; + while (pos < html.length && /[a-z0-9-]/i.test(html[pos])) ++pos; + return html.slice(start, pos); + } + + function startTag() { + assert(html[pos] === "<"); + + ++pos; + skipWs(); + + const tag = takeWord(); + + const parser = new HtmlAttributeParser(html, pos); + const props: Record
@@ -70,6 +74,9 @@ describe("JSX", () => {
it("Supports
), `
`); + }); + + it("Handles boolean children", () => { + equal(renderElement({true}{false}), ``); + }); + + it("Handles zero", () => { + equal(renderElement({0}), `0`); + }); +}); + +describe("JSX.renderElementToText", () => { + it("Handles null/undefined", () => { + equal(renderElementToText(null), ``); + equal(renderElementToText(undefined), ``); + }); + + it("Handles zero", () => { + equal(renderElementToText({0}), `0`); + }); + + it("Handles boolean children", () => { + equal(renderElementToText({true}{false}), ``); + }); + + it("Handles Raw elements", () => { + equal(renderElementToText((() => 123);
+
+ equal(map.get("a"), 123);
+ map.set("b", 5);
+ equal(map.get("b"), 5);
+ equal(map.getNoInsert("c"), undefined);
+ });
+});
+
+describe("StableKeyMap", () => {
+ interface StableKeyed {
+ getStableKey(): string;
+ }
+ const a = {
+ id: 1,
+ getStableKey() {
+ return "a";
+ },
+ };
+ const a2 = {
+ id: 2,
+ getStableKey() {
+ return "a";
+ },
+ };
+
+ it("Inserts objects via a stable key", () => {
+ const map = new StableKeyMap();
+
+ equal(map.size, 0);
+ map.set(a, 1);
+ equal(map.size, 1);
+ equal(map.get(a), 1);
+ equal(map.get(a2), 1);
+ });
+
+ it("Supports clear()", () => {
+ const map = new StableKeyMap();
+ map.set(a, 1);
+ map.clear();
+ equal(map.size, 0);
+ });
+
+ it("Supports delete()", () => {
+ const map = new StableKeyMap();
+ map.set(a, 1);
+ equal(map.delete(a2), true);
+ equal(map.size, 0);
+ });
+
+ it("Supports forEach()", () => {
+ const map = new StableKeyMap();
+ map.set(a, 1);
+ let called = false;
+ map.forEach((value, key, map2) => {
+ called = true;
+ equal(value, 1);
+ ok(key === a);
+ ok(map === map2);
+ });
+ ok(called);
+ });
+
+ it("Supports entries()", () => {
+ const map = new StableKeyMap();
+ map.set(a, 1);
+ let called = false;
+ for (const [key, value] of map.entries()) {
+ called = true;
+ equal(value, 1);
+ ok(key === a);
+ }
+ ok(called);
+ });
+
+ it("Supports keys()", () => {
+ const map = new StableKeyMap();
+ map.set(a, 1);
+ let called = false;
+ for (const key of map.keys()) {
+ called = true;
+ ok(key === a);
+ }
+ ok(called);
+ });
+
+ it("Supports values()", () => {
+ const map = new StableKeyMap();
+ map.set(a, 1);
+ let called = false;
+ for (const value of map.values()) {
+ called = true;
+ equal(value, 1);
+ }
+ ok(called);
+ });
+
+ it("Supports [Symbol.iterator]", () => {
+ const map = new StableKeyMap();
+ map.set(a, 1);
+ let called = false;
+ for (const [key, value] of map) {
+ called = true;
+ equal(value, 1);
+ ok(key === a);
+ }
+ ok(called);
+ });
+});
diff --git a/src/test/utils.ts b/src/test/utils.ts
index 409e65795..40b801487 100644
--- a/src/test/utils.ts
+++ b/src/test/utils.ts
@@ -60,7 +60,7 @@ export function querySig(
): SignatureReflection {
const decl = query(project, name);
ok(
- decl.signatures?.length ?? 0 > index,
+ (decl.signatures?.length ?? 0) > index,
`Reflection "${name}" does not contain signature`,
);
return decl.signatures![index];
@@ -108,7 +108,7 @@ export function equalKind(refl: Reflection, kind: ReflectionKind) {
equal(
refl.kind,
kind,
- `Expected ${ReflectionKind[kind]} but got ${ReflectionKind[refl.kind]}`,
+ `Expected ${ReflectionKind[kind]} but got ${ReflectionKind[refl.kind]} for ${refl.getFullName()}`,
);
}
diff --git a/src/test/utils/general.test.ts b/src/test/utils/general.test.ts
index 108ea73af..b9cbeaa06 100644
--- a/src/test/utils/general.test.ts
+++ b/src/test/utils/general.test.ts
@@ -1,27 +1,39 @@
-import { deepStrictEqual as equal } from "assert/strict";
-import { dedent } from "#utils";
+import { deepStrictEqual as equal, doesNotThrow, throws } from "assert/strict";
+import { assert, assertNever, dedent } from "#utils";
-describe("Dedent test helper", () => {
- it("Works on empty string", () => {
+describe("general.ts", () => {
+ it("dedent works on empty string", () => {
equal(dedent(""), "");
});
- it("Works with indented text", () => {
+ it("dedent works with indented text", () => {
equal(
dedent(`
- Text here
- `),
+ Text here
+ `),
"Text here",
);
});
- it("Works with multiple lines", () => {
+ it("dedent works with multiple lines", () => {
equal(
dedent(`
- Text here
- More indented
- `),
+ Text here
+ More indented
+ `),
"Text here\n More indented",
);
});
+
+ it("assertNever", () => {
+ throws(
+ () => assertNever("x" as never),
+ new Error(`Expected handling to cover all possible cases, but it didn't cover: "x"`),
+ );
+ });
+
+ it("assert", () => {
+ doesNotThrow(() => assert(true));
+ throws(() => assert(false), new Error("Assertion failed"));
+ });
});
diff --git a/src/test/utils/options/declaration.test.ts b/src/test/utils/options/declaration.test.ts
index c61ae72ce..ef0252fab 100644
--- a/src/test/utils/options/declaration.test.ts
+++ b/src/test/utils/options/declaration.test.ts
@@ -200,7 +200,10 @@ describe("Options - conversions", () => {
convert(["12,3"], optionWithType(ParameterType.Array), ""),
["12,3"],
);
- equal(convert(true, optionWithType(ParameterType.Array), ""), []);
+ throws(
+ () => convert(true, optionWithType(ParameterType.Array), ""),
+ new Error("The 'test' option must be set to an array of strings"),
+ );
equal(
convert("/,a", optionWithType(ParameterType.PathArray), ""),
@@ -214,9 +217,9 @@ describe("Options - conversions", () => {
),
[normalizePath(resolve("/foo"))],
);
- equal(
- convert(true, optionWithType(ParameterType.PathArray), ""),
- [],
+ throws(
+ () => convert(true, optionWithType(ParameterType.PathArray), ""),
+ new Error("The 'test' option must be set to an array of strings"),
);
equal(
@@ -231,9 +234,40 @@ describe("Options - conversions", () => {
),
["a,b"],
);
+ throws(
+ () => convert(true, optionWithType(ParameterType.ModuleArray), ""),
+ new Error("The 'test' option must be set to an array of strings"),
+ );
+
+ equal(
+ convert("a,b", optionWithType(ParameterType.PluginArray), ""),
+ ["a,b"],
+ );
equal(
- convert(true, optionWithType(ParameterType.ModuleArray), ""),
- [],
+ convert(
+ ["a,b"],
+ optionWithType(ParameterType.PluginArray),
+ "",
+ ),
+ ["a,b"],
+ );
+ const fn = () => {};
+ equal(
+ convert(
+ ["a", fn],
+ optionWithType(ParameterType.PluginArray),
+ "",
+ ),
+ ["a", fn],
+ );
+ throws(
+ () => convert(true, optionWithType(ParameterType.PluginArray), ""),
+ new Error("The 'test' option must be set to an array of strings/functions"),
+ );
+
+ throws(
+ () => convert(true, optionWithType(ParameterType.GlobArray), ""),
+ new Error("The 'test' option must be set to an array of strings"),
);
});
@@ -248,6 +282,17 @@ describe("Options - conversions", () => {
);
});
+ it("PluginArray is resolved if relative", () => {
+ equal(
+ convert(
+ ["./foo"],
+ optionWithType(ParameterType.PluginArray),
+ "",
+ ),
+ [normalizePath(join(process.cwd(), "foo"))],
+ );
+ });
+
it("Validates array options", () => {
const declaration: ArrayDeclarationOption = {
name: "test",
@@ -511,6 +556,21 @@ describe("Options - default values", () => {
);
});
+ it("PluginArray", () => {
+ equal(
+ getDefaultValue(getDeclaration(ParameterType.PluginArray, void 0)),
+ [],
+ );
+ equal(
+ getDefaultValue(getDeclaration(ParameterType.PluginArray, ["a"])),
+ ["a"],
+ );
+ equal(
+ getDefaultValue(getDeclaration(ParameterType.PluginArray, ["./a"])),
+ [normalizePath(resolve("./a"))],
+ );
+ });
+
it("GlobArray", () => {
equal(
getDefaultValue(getDeclaration(ParameterType.GlobArray, void 0)),
diff --git a/src/test/utils/options/default-options.test.ts b/src/test/utils/options/default-options.test.ts
index 88bf20f51..8b9ab552c 100644
--- a/src/test/utils/options/default-options.test.ts
+++ b/src/test/utils/options/default-options.test.ts
@@ -131,6 +131,172 @@ describe("Default Options", () => {
});
});
+ describe("locales", () => {
+ it("Should disallow non-objects", () => {
+ throws(() => opts.setValue("locales", null as never));
+ });
+
+ it("Should disallow objects containing non-objects", () => {
+ throws(() => opts.setValue("locales", { test: false } as never));
+ });
+
+ it("Should disallow locales containing non-strings", () => {
+ throws(() => opts.setValue("locales", { test: { key: false } } as never));
+ });
+
+ it("Should allow valid locale shapes", () => {
+ doesNotThrow(() => opts.setValue("locales", { test: { key: "hi" } }));
+ });
+ });
+
+ describe("packageOptions", () => {
+ it("Should disallow non-objects", () => {
+ throws(() => opts.setValue("packageOptions", null as never));
+ });
+
+ it("Should allow objects", () => {
+ doesNotThrow(() => opts.setValue("packageOptions", { test: false } as never));
+ });
+ });
+
+ describe("blockTags", () => {
+ it("Should disallow non-tags", () => {
+ throws(() => opts.setValue("blockTags", ["@bad_tag"]));
+ throws(() => opts.setValue("blockTags", ["@2bad"]));
+ });
+
+ it("Should allow tags", () => {
+ doesNotThrow(() => opts.setValue("blockTags", ["@good"]));
+ doesNotThrow(() => opts.setValue("blockTags", ["@good2"]));
+ doesNotThrow(() => opts.setValue("blockTags", ["@Good"]));
+ doesNotThrow(() => opts.setValue("blockTags", ["@good-tag"]));
+ });
+ });
+
+ describe("excludeNotDocumentedKinds", () => {
+ it("Should disallow invalid kind strings", () => {
+ throws(() => opts.setValue("excludeNotDocumentedKinds", ["InvalidKind"] as never));
+ });
+
+ it("Should disallow disallowed kind strings", () => {
+ throws(() => opts.setValue("excludeNotDocumentedKinds", ["Project"] as never));
+ });
+
+ it("Should kinds", () => {
+ doesNotThrow(() => opts.setValue("excludeNotDocumentedKinds", ["Variable"]));
+ });
+ });
+
+ describe("externalSymbolLinkMappings", () => {
+ it("Should disallow non-objects", () => {
+ throws(() => opts.setValue("externalSymbolLinkMappings", null as never));
+ });
+
+ it("Should disallow objects containing non-objects", () => {
+ throws(() => opts.setValue("externalSymbolLinkMappings", { test: false } as never));
+ });
+
+ it("Should disallow mappings containing non-strings", () => {
+ throws(() => opts.setValue("externalSymbolLinkMappings", { test: { key: false } } as never));
+ });
+
+ it("Should allow valid mapping shapes", () => {
+ doesNotThrow(() => opts.setValue("externalSymbolLinkMappings", { test: { key: "hi" } }));
+ });
+ });
+
+ describe("outputs", () => {
+ it("Should disallow non-arrays", () => {
+ throws(() => opts.setValue("outputs", null as never));
+ });
+
+ it("Should arrays of invalid shape", () => {
+ throws(() => opts.setValue("outputs", [{}] as never));
+ });
+
+ it("Should allow valid shapes", () => {
+ doesNotThrow(() => opts.setValue("outputs", [{ name: "html", path: "out" }]));
+ });
+ });
+
+ describe("highlightLanguages", () => {
+ it("Should disallow non-arrays", () => {
+ throws(() => opts.setValue("highlightLanguages", null as never));
+ });
+
+ it("Should disallow arrays containing unknown languages", () => {
+ throws(() => opts.setValue("highlightLanguages", ["notASupportedLanguage"] as never));
+ });
+
+ it("Should allow valid languages", () => {
+ doesNotThrow(() => opts.setValue("highlightLanguages", ["typescript"]));
+ });
+ });
+
+ describe("markdownItLoader", () => {
+ it("Should disallow non-functions", () => {
+ throws(() => opts.setValue("markdownItLoader", null as never));
+ });
+
+ it("Should allow functions", () => {
+ doesNotThrow(() => opts.setValue("markdownItLoader", () => {}));
+ });
+ });
+
+ describe("favicon", () => {
+ it("Should disallow paths with an unknown extension", () => {
+ throws(() => opts.setValue("favicon", "test.txt"));
+ });
+
+ it("Should allow remote paths with an unknown extension", () => {
+ doesNotThrow(() => opts.setValue("favicon", "https://example.com/test.txt"));
+ });
+
+ it("Should allow paths with a known extension", () => {
+ doesNotThrow(() => opts.setValue("favicon", "test.png"));
+ });
+ });
+
+ describe("hostedBaseurl", () => {
+ it("Should disallow non-http urls", () => {
+ throws(() => opts.setValue("hostedBaseUrl", "test"));
+ throws(() => opts.setValue("hostedBaseUrl", "ftp://test"));
+ });
+
+ it("Should allow http and https urls", () => {
+ doesNotThrow(() => opts.setValue("hostedBaseUrl", "http://example.com/"));
+ doesNotThrow(() => opts.setValue("hostedBaseUrl", "https://example.com/"));
+ });
+ });
+
+ describe("visibilityFilters", () => {
+ it("Should disallow non-objects", () => {
+ throws(() => opts.setValue("visibilityFilters", "test" as never));
+ });
+
+ it("Should disallow objects with an invalid key", () => {
+ throws(() => opts.setValue("visibilityFilters", { bad: true } as never));
+ });
+
+ it("Should disallow objects with a non-boolean values", () => {
+ throws(() => opts.setValue("visibilityFilters", { private: "bad" } as never));
+ });
+
+ it("Should allow objects with a valid shape", () => {
+ doesNotThrow(() => opts.setValue("visibilityFilters", { private: true }));
+ doesNotThrow(() => opts.setValue("visibilityFilters", { "@test": true }));
+ });
+ });
+
+ describe("kindSortOrder", () => {
+ it("Should disallow non-kind strings", () => {
+ throws(() => opts.setValue("kindSortOrder", ["Bad"] as never));
+ });
+ it("Should allow valid sort orders", () => {
+ doesNotThrow(() => opts.setValue("kindSortOrder", ["Accessor"]));
+ });
+ });
+
it("Package Options Documentation", () => {
const allOptions = opts
.getDeclarations()
diff --git a/src/test/utils/options/options.test.ts b/src/test/utils/options/options.test.ts
index f58134f57..3366d851d 100644
--- a/src/test/utils/options/options.test.ts
+++ b/src/test/utils/options/options.test.ts
@@ -3,6 +3,8 @@ import { type MapDeclarationOption, type NumberDeclarationOption, Option } from
import { deepStrictEqual as equal, throws } from "assert";
import type { DeclarationOption, EmitStrategy } from "../../../lib/utils/options/index.js";
import { LogLevel } from "#utils";
+import { TestLogger } from "../../TestLogger.js";
+import ts from "typescript";
describe("Options", () => {
let options: Options & {
@@ -180,6 +182,32 @@ describe("Options", () => {
throws(() => options.reset("thisOptionDoesNotExist" as never));
});
+
+ it("Handles tsconfig overrides which aren't strings, #3000", () => {
+ const logger = new TestLogger();
+ const options = new Options();
+
+ options.setValue("compilerOptions", {
+ moduleResolution: "bundler",
+ });
+
+ const compilerOptions = options.getCompilerOptions(logger);
+ equal(compilerOptions.moduleResolution, ts.ModuleResolutionKind.Bundler);
+ });
+
+ it("Handles tsconfig overrides which are invalid, #3000", () => {
+ const logger = new TestLogger();
+ const options = new Options();
+
+ options.setValue("compilerOptions", {
+ moduleResolution: "bad",
+ });
+
+ const compilerOptions = options.getCompilerOptions(logger);
+ equal(compilerOptions.moduleResolution, undefined);
+
+ logger.expectMessage("error: Failed to apply compilerOptions overrides: *");
+ });
});
describe("Option", () => {
diff --git a/src/test/utils/options/readers/tsconfig.test.ts b/src/test/utils/options/readers/tsconfig.test.ts
index 5bd666e81..f49cbe42d 100644
--- a/src/test/utils/options/readers/tsconfig.test.ts
+++ b/src/test/utils/options/readers/tsconfig.test.ts
@@ -162,7 +162,7 @@ describe("Options - TSConfigReader", () => {
compilerOptions: { strict: true },
});
await readWithProject(project);
- equal(options.getCompilerOptions().strict, true);
+ equal(options.getCompilerOptions(logger).strict, true);
});
async function testTsdoc(tsdoc: object, cb?: () => void, reset = true) {
diff --git a/src/test/utils/plugins.test.ts b/src/test/utils/plugins.test.ts
index 31f5962ba..0199d5ab6 100644
--- a/src/test/utils/plugins.test.ts
+++ b/src/test/utils/plugins.test.ts
@@ -1,8 +1,9 @@
import { tempdirProject } from "@typestrong/fs-fixture-builder";
-import type { Application } from "../../index.js";
+import { type Application, normalizePath } from "../../index.js";
import { loadPlugins } from "../../lib/utils/plugins.js";
import { TestLogger } from "../TestLogger.js";
import { join, resolve } from "path";
+import { deepStrictEqual as equal } from "assert/strict";
describe("loadPlugins", () => {
let logger: TestLogger;
@@ -20,7 +21,7 @@ describe("loadPlugins", () => {
project.addFile("index.js", "exports.load = function load() {}");
project.write();
- const plugin = resolve(project.cwd, "index.js");
+ const plugin = normalizePath(resolve(project.cwd, "index.js"));
await loadPlugins(fakeApp, [plugin]);
logger.expectMessage(`info: Loaded plugin ${plugin}`);
});
@@ -31,10 +32,12 @@ describe("loadPlugins", () => {
type: "commonjs",
main: "index.js",
});
- const plugin = project.addFile(
- "index.js",
- "exports.load = function load() {}",
- ).path;
+ const plugin = normalizePath(
+ project.addFile(
+ "index.js",
+ "exports.load = function load() {}",
+ ).path,
+ );
project.write();
await loadPlugins(fakeApp, [plugin]);
@@ -50,11 +53,21 @@ describe("loadPlugins", () => {
project.addFile("index.js", "export function load() {}");
project.write();
- const plugin = join(resolve(project.cwd), "index.js");
+ const plugin = normalizePath(join(resolve(project.cwd), "index.js"));
await loadPlugins(fakeApp, [plugin]);
logger.expectMessage(`info: Loaded plugin ${plugin}`);
});
+ it("Should support loading a function plugin", async () => {
+ let called = false as boolean;
+ function testFn() {
+ called = true;
+ }
+ await loadPlugins(fakeApp, [testFn]);
+ logger.expectMessage(`info: Loaded plugin testFn`);
+ equal(called, true);
+ });
+
it("Should handle errors when requiring plugins", async () => {
using project = tempdirProject();
project.addJsonFile("package.json", {
@@ -64,7 +77,7 @@ describe("loadPlugins", () => {
project.addFile("index.js", "throw Error('bad')");
project.write();
- const plugin = join(resolve(project.cwd), "index.js");
+ const plugin = normalizePath(join(resolve(project.cwd), "index.js"));
await loadPlugins(fakeApp, [plugin]);
logger.expectMessage(`error: The plugin ${plugin} could not be loaded`);
});
@@ -81,7 +94,7 @@ describe("loadPlugins", () => {
);
project.write();
- const plugin = join(resolve(project.cwd), "index.js");
+ const plugin = normalizePath(join(resolve(project.cwd), "index.js"));
await loadPlugins(fakeApp, [plugin]);
logger.expectMessage(`error: The plugin ${plugin} could not be loaded`);
});
@@ -95,7 +108,7 @@ describe("loadPlugins", () => {
project.addFile("index.js", "");
project.write();
- const plugin = join(resolve(project.cwd), "index.js");
+ const plugin = normalizePath(join(resolve(project.cwd), "index.js"));
await loadPlugins(fakeApp, [plugin]);
logger.expectMessage(
`error: Invalid structure in plugin ${plugin}, no load function found`,
diff --git a/src/test/validation.test.ts b/src/test/validation.test.ts
index cba32af1d..905672c25 100644
--- a/src/test/validation.test.ts
+++ b/src/test/validation.test.ts
@@ -2,73 +2,58 @@ import { ok } from "assert";
import { join } from "path";
import { validateDocumentation } from "../lib/validation/documentation.js";
import { validateExports } from "../lib/validation/exports.js";
-import { getConverter2App, getConverter2Program } from "./programs.js";
+import { getConverter2App, getConverter2Program, getConverter2Project } from "./programs.js";
import { TestLogger } from "./TestLogger.js";
import { fileURLToPath } from "url";
+import { validateMergeModuleWith } from "../lib/validation/unusedMergeModuleWith.js";
-function convertValidationFile(file: string) {
- const app = getConverter2App();
- const program = getConverter2Program();
- const sourceFile = program.getSourceFile(
- join(fileURLToPath(import.meta.url), "../converter2/validation", file),
- );
+function convertValidationFile(...files: [string, ...string[]]) {
+ return getConverter2Project(files, "validation");
+}
- ok(sourceFile, "Specified source file does not exist.");
+describe("validateExports", () => {
+ function expectWarning(
+ typeName: string,
+ file: string,
+ referencingName: string,
+ intentionallyNotExported: readonly string[] = [],
+ ) {
+ const project = convertValidationFile(file);
- const project = app.converter.convert([
- {
- displayName: "validation",
- program,
- sourceFile,
- },
- ]);
+ const logger = new TestLogger();
+ validateExports(project, logger, intentionallyNotExported);
- return project;
-}
+ logger.expectMessage(
+ `warn: ${typeName}, defined in */${file}, is referenced by ${referencingName} but not included in the documentation`,
+ );
+ }
-function expectWarning(
- typeName: string,
- file: string,
- referencingName: string,
- intentionallyNotExported: readonly string[] = [],
-) {
- const project = convertValidationFile(file);
+ function expectNoWarning(
+ file: string,
+ intentionallyNotExported: readonly string[] = [],
+ ) {
+ const app = getConverter2App();
+ const program = getConverter2Program();
+ const sourceFile = program.getSourceFile(
+ join(fileURLToPath(import.meta.url), "../converter2/validation", file),
+ );
- const logger = new TestLogger();
- validateExports(project, logger, intentionallyNotExported);
+ ok(sourceFile, "Specified source file does not exist.");
- logger.expectMessage(
- `warn: ${typeName}, defined in */${file}, is referenced by ${referencingName} but not included in the documentation`,
- );
-}
+ const project = app.converter.convert([
+ {
+ displayName: "validation",
+ program,
+ sourceFile,
+ },
+ ]);
-function expectNoWarning(
- file: string,
- intentionallyNotExported: readonly string[] = [],
-) {
- const app = getConverter2App();
- const program = getConverter2Program();
- const sourceFile = program.getSourceFile(
- join(fileURLToPath(import.meta.url), "../converter2/validation", file),
- );
-
- ok(sourceFile, "Specified source file does not exist.");
-
- const project = app.converter.convert([
- {
- displayName: "validation",
- program,
- sourceFile,
- },
- ]);
-
- const logger = new TestLogger();
-
- validateExports(project, logger, intentionallyNotExported);
- logger.expectNoOtherMessages();
-}
+ const logger = new TestLogger();
+
+ validateExports(project, logger, intentionallyNotExported);
+ logger.expectNoOtherMessages();
+ }
-describe("validateExports", () => {
it("Should warn if a variable type is missing", () => {
expectWarning("Foo", "variable.ts", "foo");
});
@@ -224,3 +209,27 @@ describe("validateDocumentation", () => {
logger.expectNoOtherMessages();
});
});
+
+describe("validateMergeModuleWith", () => {
+ it("Should warn if the project has a @mergeModuleWith tag", () => {
+ const project = convertValidationFile("unusedMergeModuleWith.ts");
+
+ const logger = new TestLogger();
+ validateMergeModuleWith(project, logger);
+
+ logger.expectMessage(
+ `warn: has a @mergeModuleWith tag which could not be resolved`,
+ );
+ });
+
+ it("Should warn if the project's module has a @mergeModuleWith tag", () => {
+ const project = convertValidationFile("unusedMergeModuleWith.ts", "return.ts");
+
+ const logger = new TestLogger();
+ validateMergeModuleWith(project, logger);
+
+ logger.expectMessage(
+ `warn: unusedMergeModuleWith has a @mergeModuleWith tag which could not be resolved`,
+ );
+ });
+});
diff --git a/static/style.css b/static/style.css
index 7c3fbdb90..5ba5a2a90 100644
--- a/static/style.css
+++ b/static/style.css
@@ -504,15 +504,8 @@
body {
background: var(--color-background);
font-family:
- -apple-system,
- BlinkMacSystemFont,
- "Segoe UI",
- "Noto Sans",
- Helvetica,
- Arial,
- sans-serif,
- "Apple Color Emoji",
- "Segoe UI Emoji";
+ -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans",
+ Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji";
font-size: 16px;
color: var(--color-text);
margin: 0;
diff --git a/tsdoc.json b/tsdoc.json
index 4fd1c034d..07d3e835c 100644
--- a/tsdoc.json
+++ b/tsdoc.json
@@ -146,6 +146,11 @@
"syntaxKind": "block",
"allowMultiple": true
},
+ {
+ "tagName": "@this",
+ "syntaxKind": "block",
+ "allowMultiple": false
+ },
{
"tagName": "@linkcode",
"syntaxKind": "inline",
@@ -237,6 +242,10 @@
{
"tagName": "@useDeclaredType",
"syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@sortStrategy",
+ "syntaxKind": "block"
}
]
}
), `
`); + }); + + it("Handles boolean children", () => { + equal(renderElement({true}{false}), ``); + }); + + it("Handles zero", () => { + equal(renderElement({0}), `0`); + }); +}); + +describe("JSX.renderElementToText", () => { + it("Handles null/undefined", () => { + equal(renderElementToText(null), ``); + equal(renderElementToText(undefined), ``); + }); + + it("Handles zero", () => { + equal(renderElementToText({0}), `0`); + }); + + it("Handles boolean children", () => { + equal(renderElementToText({true}{false}), ``); + }); + + it("Handles Raw elements", () => { + equal(renderElementToText(
- {name} - {anchorIcon(context, anchor)} -
-