,
+ context: DefaultThemeRenderContext,
+ parts: readonly CommentDisplayPart[],
+ ): string {
+ const useHtml = !!this.markdownItOptions["html"];
+ const result: string[] = [];
+
+ for (const part of parts) {
+ switch (part.kind) {
+ case "text":
+ case "code":
+ result.push(part.text);
+ break;
+ case "inline-tag":
+ switch (part.tag) {
+ case "@label":
+ case "@inheritdoc": // Shouldn't happen
+ break; // Not rendered.
+ case "@link":
+ case "@linkcode":
+ case "@linkplain": {
+ if (part.target) {
+ let url: string | undefined;
+ let kindClass: string | undefined;
+ if (typeof part.target === "string") {
+ url = part.target;
+ } else if ("id" in part.target) {
+ // No point in trying to resolve a ReflectionSymbolId at this point, we've already
+ // tried and failed during the resolution step.
+ url = context.urlTo(part.target);
+ kindClass = ReflectionKind.classString(part.target.kind);
+ }
+
+ if (useHtml) {
+ const text = part.tag === "@linkcode" ? `${part.text}` : part.text;
+ result.push(
+ url
+ ? `${text} `
+ : part.text,
+ );
+ } else {
+ const text = part.tag === "@linkcode" ? "`" + part.text + "`" : part.text;
+ result.push(url ? `[${text}](${url})` : text);
+ }
+ } else {
+ result.push(part.text);
+ }
+ break;
+ }
+ default:
+ // Hmm... probably want to be able to render these somehow, so custom inline tags can be given
+ // special rendering rules. Future capability. For now, just render their text.
+ result.push(`{${part.tag} ${part.text}}`);
+ break;
+ }
+ break;
+ case "relative-link":
+ switch (typeof part.target) {
+ case "number": {
+ const refl = page.project.files.resolve(part.target);
+ if (typeof refl === "object") {
+ result.push(context.urlTo(refl));
+ break;
+ }
+
+ const fileName = page.project.files.getName(part.target);
+ if (fileName) {
+ result.push(context.relativeURL(`media/${fileName}`));
+ break;
+ }
+ }
+ // fall through
+ case "undefined":
+ result.push(part.text);
+ break;
+ }
+ break;
+ default:
+ assertNever(part);
+ }
+ }
- this.owner.trigger(event);
- return event.parsedText;
+ return result.join("");
}
/**
@@ -131,27 +202,14 @@ output file :
*/
protected override onBeginRenderer(event: RendererEvent) {
super.onBeginRenderer(event);
+ this.setupParser();
+ }
- Marked.marked.setOptions(this.createMarkedOptions());
-
- delete this.includes;
- if (this.includeSource) {
- if (fs.existsSync(this.includeSource) && fs.statSync(this.includeSource).isDirectory()) {
- this.includes = this.includeSource;
- } else {
- this.application.logger.warn("Could not find provided includes directory: " + this.includeSource);
- }
- }
-
- if (this.mediaSource) {
- if (fs.existsSync(this.mediaSource) && fs.statSync(this.mediaSource).isDirectory()) {
- this.mediaDirectory = Path.join(event.outputDirectory, "media");
- copySync(this.mediaSource, this.mediaDirectory);
- } else {
- this.mediaDirectory = undefined;
- this.application.logger.warn("Could not find provided media directory: " + this.mediaSource);
- }
+ private getSlugger() {
+ if ("getSlugger" in this.owner.theme!) {
+ return (this.owner.theme as DefaultTheme).getSlugger(this.page!.model);
}
+ return getDefaultSlugger(this.application.logger);
}
/**
@@ -159,51 +217,56 @@ output file :
*
* @returns The options object for the markdown parser.
*/
- private createMarkedOptions(): Marked.marked.MarkedOptions {
- const markedOptions = (this.application.options.getValue("markedOptions") ?? {}) as Marked.marked.MarkedOptions;
-
- // Set some default values if they are not specified via the TypeDoc option
- markedOptions.highlight ??= (text, lang) => this.getHighlighted(text, lang);
-
- if (!markedOptions.renderer) {
- markedOptions.renderer = new Marked.Renderer();
-
- markedOptions.renderer.link = (href, title, text) => {
- // Prefix the #anchor links `#md:`.
- const target = href?.replace(/^#(?:md:)?(.+)/, "#md:$1") || undefined;
- return renderElement(
-
- ,
- );
- };
-
- markedOptions.renderer.heading = (text, level, _, slugger) => {
- const slug = slugger.slug(text);
- // Prefix the slug with an extra `md:` to prevent conflicts with TypeDoc's anchors.
- this.page!.pageHeadings.push({
- link: `#md:${slug}`,
- text: getTextContent(text),
- level,
- });
- const H = `h${level}`;
- return renderElement(
- <>
-
-
-
-
- ,
- );
- };
- markedOptions.renderer.code = renderCode;
- }
+ private setupParser() {
+ this.parser = markdown({
+ ...this.markdownItOptions,
+ highlight: (code, lang) => {
+ code = this.getHighlighted(code, lang || "ts");
+ code = code.replace(/\n$/, "") + "\n";
+
+ if (!lang) {
+ return `${code}${this.application.i18n.theme_copy()} ${code}${this.application.i18n.theme_copy()} ${escaped ? code : escapeHtml(code)}Copy ${
- escaped ? code : escapeHtml(code)
- }Copy ();
+
+ private serialize(value: string) {
+ // Extracted from marked@4.3.0
+ return (
+ value
+ .toLowerCase()
+ .trim()
+ // remove html tags
+ .replace(/<[!/a-z].*?>/gi, "")
+ // remove unwanted chars
+ .replace(/[\u2000-\u206F\u2E00-\u2E7F\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g, "")
+ .replace(/\s/g, "-")
+ );
+ }
+
+ slug(value: string) {
+ const originalSlug = this.serialize(value);
+ let slug = originalSlug;
+ let count = 0;
+ if (this.seen.has(slug)) {
+ count = this.seen.get(originalSlug)!;
+ do {
+ count++;
+ slug = `${originalSlug}-${count}`;
+ } while (this.seen.has(slug));
+ }
+ this.seen.set(originalSlug, count);
+ this.seen.set(slug, 0);
+ return slug;
+ }
+}
+
/**
* Default theme implementation of TypeDoc. If a theme does not provide a custom
* {@link Theme} implementation, this theme class will be used.
@@ -76,6 +114,9 @@ export class DefaultTheme extends Theme {
return new DefaultThemeRenderContext(this, pageEvent, this.application.options);
}
+ documentTemplate = (pageEvent: PageEvent) => {
+ return this.getRenderContext(pageEvent).documentTemplate(pageEvent);
+ };
reflectionTemplate = (pageEvent: PageEvent) => {
return this.getRenderContext(pageEvent).reflectionTemplate(pageEvent);
};
@@ -89,7 +130,7 @@ export class DefaultTheme extends Theme {
return this.getRenderContext(pageEvent).defaultLayout(template, pageEvent);
};
- getReflectionClasses(reflection: DeclarationReflection) {
+ getReflectionClasses(reflection: DeclarationReflection | DocumentReflection) {
const filters = this.application.options.getValue("visibilityFilters") as Record;
return getReflectionClasses(reflection, filters);
}
@@ -133,6 +174,11 @@ export class DefaultTheme extends Theme {
directory: "variables",
template: this.reflectionTemplate,
},
+ {
+ kind: [ReflectionKind.Document],
+ directory: "documents",
+ template: this.documentTemplate,
+ },
];
static URL_PREFIX = /^(http|ftp)s?:\/\//;
@@ -156,8 +202,9 @@ export class DefaultTheme extends Theme {
*/
getUrls(project: ProjectReflection): UrlMapping[] {
const urls: UrlMapping[] = [];
+ this.sluggers.set(project, new Slugger());
- if (false == hasReadme(this.application.options.getValue("readme"))) {
+ if (!hasReadme(this.application.options.getValue("readme"))) {
project.url = "index.html";
urls.push(new UrlMapping("index.html", project, this.reflectionTemplate));
} else if (project.children?.every((child) => child.kindOf(ReflectionKind.Module))) {
@@ -175,11 +222,7 @@ export class DefaultTheme extends Theme {
urls.push(new UrlMapping("hierarchy.html", project, this.hierarchyTemplate));
}
- project.children?.forEach((child: Reflection) => {
- if (child instanceof DeclarationReflection) {
- this.buildUrls(child, urls);
- }
- });
+ project.childrenIncludingDocuments?.forEach((child) => this.buildUrls(child, urls));
return urls;
}
@@ -208,7 +251,7 @@ export class DefaultTheme extends Theme {
* @param reflection The reflection whose mapping should be resolved.
* @returns The found mapping or undefined if no mapping could be found.
*/
- private getMapping(reflection: DeclarationReflection): TemplateMapping | undefined {
+ private getMapping(reflection: DeclarationReflection | DocumentReflection): TemplateMapping | undefined {
return this.mappings.find((mapping) => reflection.kindOf(mapping.kind));
}
@@ -219,19 +262,20 @@ export class DefaultTheme extends Theme {
* @param urls The array the url should be appended to.
* @returns The altered urls array.
*/
- buildUrls(reflection: DeclarationReflection, urls: UrlMapping[]): UrlMapping[] {
+ buildUrls(reflection: DeclarationReflection | DocumentReflection, urls: UrlMapping[]): UrlMapping[] {
const mapping = this.getMapping(reflection);
if (mapping) {
if (!reflection.url || !DefaultTheme.URL_PREFIX.test(reflection.url)) {
const url = [mapping.directory, DefaultTheme.getUrl(reflection) + ".html"].join("/");
urls.push(new UrlMapping(url, reflection, mapping.template));
+ this.sluggers.set(reflection, new Slugger());
reflection.url = url;
reflection.hasOwnDocument = true;
}
reflection.traverse((child) => {
- if (child instanceof DeclarationReflection) {
+ if (child.isDeclaration() || child.isDocument()) {
this.buildUrls(child, urls);
} else {
DefaultTheme.applyAnchorUrl(child, reflection);
@@ -271,16 +315,10 @@ export class DefaultTheme extends Theme {
const opts = this.application.options.getValue("navigation");
const leaves = this.application.options.getValue("navigationLeaves");
- if (opts.fullTree) {
- this.application.logger.warn(
- `The navigation.fullTree option no longer has any affect and will be removed in v0.26`,
- );
- }
-
return getNavigationElements(project) || [];
function toNavigation(
- element: ReflectionCategory | ReflectionGroup | DeclarationReflection,
+ element: ReflectionCategory | ReflectionGroup | DeclarationReflection | DocumentReflection,
): NavigationElement {
if (element instanceof ReflectionCategory || element instanceof ReflectionGroup) {
return {
@@ -299,7 +337,12 @@ export class DefaultTheme extends Theme {
}
function getNavigationElements(
- parent: ReflectionCategory | ReflectionGroup | DeclarationReflection | ProjectReflection,
+ parent:
+ | ReflectionCategory
+ | ReflectionGroup
+ | DeclarationReflection
+ | ProjectReflection
+ | DocumentReflection,
): undefined | NavigationElement[] {
if (parent instanceof ReflectionCategory) {
return parent.children.map(toNavigation);
@@ -316,10 +359,20 @@ export class DefaultTheme extends Theme {
return;
}
- if (!parent.kindOf(ReflectionKind.SomeModule | ReflectionKind.Project)) {
+ if (!parent.kindOf(ReflectionKind.MayContainDocuments)) {
return;
}
+ if (parent.isDocument()) {
+ return parent.children?.map(toNavigation);
+ }
+
+ if (!parent.kindOf(ReflectionKind.SomeModule | ReflectionKind.Project)) {
+ // Tricky: Non-module children don't show up in the navigation pane,
+ // but any documents added by them should.
+ return parent.documents?.map(toNavigation);
+ }
+
if (parent.categories && shouldShowCategories(parent, opts)) {
return parent.categories.map(toNavigation);
}
@@ -328,18 +381,14 @@ export class DefaultTheme extends Theme {
return parent.groups.map(toNavigation);
}
- if (
- opts.includeFolders &&
- parent.children?.every((child) => child.kindOf(ReflectionKind.Module)) &&
- parent.children.some((child) => child.name.includes("/"))
- ) {
- return deriveModuleFolders(parent.children);
+ if (opts.includeFolders && parent.childrenIncludingDocuments?.some((child) => child.name.includes("/"))) {
+ return deriveModuleFolders(parent.childrenIncludingDocuments);
}
- return parent.children?.map(toNavigation);
+ return parent.childrenIncludingDocuments?.map(toNavigation);
}
- function deriveModuleFolders(children: DeclarationReflection[]) {
+ function deriveModuleFolders(children: Array) {
const result: NavigationElement[] = [];
const resolveOrCreateParents = (
@@ -395,6 +444,16 @@ export class DefaultTheme extends Theme {
}
}
+ private sluggers = new Map();
+
+ getSlugger(reflection: Reflection): Slugger {
+ if (this.sluggers.has(reflection)) {
+ return this.sluggers.get(reflection)!;
+ }
+ // A slugger should always be defined at least for the project
+ return this.getSlugger(reflection.parent!);
+ }
+
/**
* Generate an anchor url for the given reflection and all of its children.
*
@@ -413,7 +472,7 @@ export class DefaultTheme extends Theme {
if (!reflection.url || !DefaultTheme.URL_PREFIX.test(reflection.url)) {
const anchor = DefaultTheme.getUrl(reflection, container, ".");
- reflection.url = container.url + "#" + anchor;
+ reflection.url = container.url! + "#" + anchor;
reflection.anchor = anchor;
reflection.hasOwnDocument = false;
}
@@ -429,14 +488,17 @@ function hasReadme(readme: string) {
return !readme.endsWith("none");
}
-function getReflectionClasses(reflection: DeclarationReflection, filters: Record) {
+function getReflectionClasses(
+ reflection: DeclarationReflection | DocumentReflection,
+ filters: Record,
+) {
const classes: string[] = [];
// Filter classes should match up with the settings function in
// partials/navigation.tsx.
for (const key of Object.keys(filters)) {
if (key === "inherited") {
- if (reflection.inheritedFrom) {
+ if (reflection.flags.isInherited) {
classes.push("tsd-is-inherited");
}
} else if (key === "protected") {
diff --git a/src/lib/output/themes/default/DefaultThemeRenderContext.ts b/src/lib/output/themes/default/DefaultThemeRenderContext.ts
index 0e663f377..2e0b423ff 100644
--- a/src/lib/output/themes/default/DefaultThemeRenderContext.ts
+++ b/src/lib/output/themes/default/DefaultThemeRenderContext.ts
@@ -1,15 +1,18 @@
-import type { PageEvent, RendererHooks } from "../..";
-import {
- Comment,
+import type { PageEvent, Renderer } from "../..";
+import type {
+ Internationalization,
+ TranslationProxy,
+} from "../../../internationalization/internationalization";
+import type {
+ DocumentReflection,
CommentDisplayPart,
DeclarationReflection,
Reflection,
} from "../../../models";
-import { JSX, NeverIfInternal, Options } from "../../../utils";
+import { type NeverIfInternal, type Options } from "../../../utils";
import type { DefaultTheme } from "./DefaultTheme";
import { defaultLayout } from "./layouts/default";
import { index } from "./partials";
-import { analytics } from "./partials/analytics";
import { breadcrumb } from "./partials/breadcrumb";
import {
commentSummary,
@@ -19,7 +22,7 @@ import {
import { footer } from "./partials/footer";
import { header } from "./partials/header";
import { hierarchy } from "./partials/hierarchy";
-import { buildRefIcons, icons } from "./partials/icon";
+import { buildRefIcons, type icons } from "./partials/icon";
import { member } from "./partials/member";
import { memberDeclaration } from "./partials/member.declaration";
import { memberGetterSetter } from "./partials/member.getterSetter";
@@ -29,7 +32,6 @@ import { memberSignatureTitle } from "./partials/member.signature.title";
import { memberSignatures } from "./partials/member.signatures";
import { memberSources } from "./partials/member.sources";
import { members } from "./partials/members";
-import { membersGroup } from "./partials/members.group";
import {
sidebar,
pageSidebar,
@@ -45,6 +47,7 @@ import { type } from "./partials/type";
import { typeAndParent } from "./partials/typeAndParent";
import { typeParameters } from "./partials/typeParameters";
import { indexTemplate } from "./templates";
+import { documentTemplate } from "./templates/document";
import { hierarchyTemplate } from "./templates/hierarchy";
import { reflectionTemplate } from "./templates/reflection";
@@ -55,21 +58,18 @@ function bind(fn: (f: F, ...a: L) => R, first: F) {
export class DefaultThemeRenderContext {
private _refIcons: typeof icons;
options: Options;
+ internationalization: Internationalization;
+ i18n: TranslationProxy;
constructor(
- private theme: DefaultTheme,
+ readonly theme: DefaultTheme,
public page: PageEvent,
options: Options,
) {
this.options = options;
- this._refIcons = buildRefIcons(icons, this);
- }
-
- /**
- * @deprecated Will be removed in 0.26, no longer required.
- */
- iconsCache(): JSX.Element {
- return JSX.createElement(JSX.Fragment, null);
+ this.internationalization = theme.application.internationalization;
+ this.i18n = this.internationalization.proxy;
+ this._refIcons = buildRefIcons(theme.icons, this);
}
/**
@@ -82,8 +82,9 @@ export class DefaultThemeRenderContext {
return this._refIcons;
}
- hook = (name: keyof RendererHooks) =>
- this.theme.owner.hooks.emit(name, this);
+ hook: Renderer["hooks"]["emit"] = (...params) => {
+ return this.theme.owner.hooks.emit(...params);
+ };
/** Avoid this in favor of urlTo if possible */
relativeURL = (url: string, cacheBust = false) => {
@@ -101,20 +102,15 @@ export class DefaultThemeRenderContext {
markdown = (
md: readonly CommentDisplayPart[] | NeverIfInternal,
) => {
- if (md instanceof Array) {
- return this.theme.markedPlugin.parseMarkdown(
- Comment.displayPartsToMarkdown(md, this.urlTo),
- this.page,
- );
- }
- return md ? this.theme.markedPlugin.parseMarkdown(md, this.page) : "";
+ return this.theme.markedPlugin.parseMarkdown(md || "", this.page, this);
};
getNavigation = () => this.theme.getNavigation(this.page.project);
- getReflectionClasses = (refl: DeclarationReflection) =>
+ getReflectionClasses = (refl: DeclarationReflection | DocumentReflection) =>
this.theme.getReflectionClasses(refl);
+ documentTemplate = bind(documentTemplate, this);
reflectionTemplate = bind(reflectionTemplate, this);
indexTemplate = bind(indexTemplate, this);
hierarchyTemplate = bind(hierarchyTemplate, this);
@@ -130,7 +126,6 @@ export class DefaultThemeRenderContext {
*/
reflectionPreview = bind(reflectionPreview, this);
- analytics = bind(analytics, this);
breadcrumb = bind(breadcrumb, this);
commentSummary = bind(commentSummary, this);
commentTags = bind(commentTags, this);
@@ -148,7 +143,8 @@ export class DefaultThemeRenderContext {
memberSignatures = bind(memberSignatures, this);
memberSources = bind(memberSources, this);
members = bind(members, this);
- membersGroup = bind(membersGroup, this);
+ /** @deprecated Since 0.26.3 members does group/category flattening internally */
+ membersGroup?: Function;
sidebar = bind(sidebar, this);
pageSidebar = bind(pageSidebar, this);
sidebarLinks = bind(sidebarLinks, this);
diff --git a/src/lib/output/themes/default/assets/bootstrap.ts b/src/lib/output/themes/default/assets/bootstrap.ts
index 5184eb086..a7168939d 100644
--- a/src/lib/output/themes/default/assets/bootstrap.ts
+++ b/src/lib/output/themes/default/assets/bootstrap.ts
@@ -7,7 +7,7 @@ import { initTheme } from "./typedoc/Theme";
import { initNav } from "./typedoc/Navigation";
registerComponent(Toggle, "a[data-toggle]");
-registerComponent(Accordion, ".tsd-index-accordion");
+registerComponent(Accordion, ".tsd-accordion");
registerComponent(Filter, ".tsd-filter-item input[type=checkbox]");
const themeChoice = document.getElementById("tsd-theme");
diff --git a/src/lib/output/themes/default/assets/typedoc/Application.ts b/src/lib/output/themes/default/assets/typedoc/Application.ts
index 0406e1d27..66fb784f8 100644
--- a/src/lib/output/themes/default/assets/typedoc/Application.ts
+++ b/src/lib/output/themes/default/assets/typedoc/Application.ts
@@ -1,5 +1,15 @@
import type { IComponentOptions } from "./Component";
+declare global {
+ interface Window {
+ translations: {
+ copy: string;
+ copied: string;
+ normally_hidden: string;
+ };
+ }
+}
+
/**
* Component definition.
*/
@@ -68,7 +78,6 @@ export class Application {
public showPage() {
if (!document.body.style.display) return;
- console.log("Show page");
document.body.style.removeProperty("display");
this.ensureFocusedElementVisible();
this.updateIndexVisibility();
@@ -79,7 +88,6 @@ export class Application {
// Because we hid the entire page until the navigation loaded or we hit a timeout,
// we have to manually resolve the url hash here.
if (location.hash) {
- console.log("Scorlling");
const reflAnchor = document.getElementById(
location.hash.substring(1),
);
@@ -161,6 +169,16 @@ export class Application {
return;
}
+ // Ensure the group this reflection is contained within is visible.
+ const wasHidden = reflContainer.offsetParent == null;
+ let sectionContainer = reflContainer;
+ while (sectionContainer !== document.body) {
+ if (sectionContainer instanceof HTMLDetailsElement) {
+ sectionContainer.open = true;
+ }
+ sectionContainer = sectionContainer.parentElement!;
+ }
+
if (reflContainer.offsetParent == null) {
this.alwaysVisibleMember = reflContainer;
@@ -168,11 +186,14 @@ export class Application {
const warning = document.createElement("p");
warning.classList.add("warning");
- warning.textContent =
- "This member is normally hidden due to your filter settings.";
+ warning.textContent = window.translations.normally_hidden;
reflContainer.prepend(warning);
}
+
+ if (wasHidden) {
+ reflAnchor.scrollIntoView();
+ }
}
private listenForCodeCopies() {
@@ -184,13 +205,13 @@ export class Application {
button.previousElementSibling.innerText.trim(),
);
}
- button.textContent = "Copied!";
+ button.textContent = window.translations.copied;
button.classList.add("visible");
clearTimeout(timeout);
timeout = setTimeout(() => {
button.classList.remove("visible");
timeout = setTimeout(() => {
- button.textContent = "Copy";
+ button.textContent = window.translations.copy;
}, 100);
}, 1000);
});
diff --git a/src/lib/output/themes/default/assets/typedoc/Navigation.ts b/src/lib/output/themes/default/assets/typedoc/Navigation.ts
index 87eae39df..0bd320e9b 100644
--- a/src/lib/output/themes/default/assets/typedoc/Navigation.ts
+++ b/src/lib/output/themes/default/assets/typedoc/Navigation.ts
@@ -34,7 +34,8 @@ async function buildNav() {
.pipeThrough(new DecompressionStream("gzip"));
const nav: NavigationElement[] = await new Response(json).json();
- BASE_URL = container.dataset.base + "/";
+ BASE_URL = container.dataset.base!;
+ if (!BASE_URL.endsWith("/")) BASE_URL += "/";
container.innerHTML = "";
for (const el of nav) {
buildNavElement(el, container, []);
@@ -56,12 +57,12 @@ function buildNavElement(
const fullPath = [...path, el.text];
const details = li.appendChild(document.createElement("details"));
details.className = el.class
- ? `${el.class} tsd-index-accordion`
- : "tsd-index-accordion";
- details.dataset.key = fullPath.join("$");
+ ? `${el.class} tsd-accordion`
+ : "tsd-accordion";
const summary = details.appendChild(document.createElement("summary"));
summary.className = "tsd-accordion-summary";
+ summary.dataset.key = fullPath.join("$");
// Would be nice to not hardcode this here, if someone overwrites the chevronDown icon with an >,
props: PageEvent,
) => (
-
+
-
{props.model.isProject()
@@ -32,10 +32,10 @@ export const defaultLayout = (
<script async src={context.relativeURL("assets/icons.js", true)} id="tsd-icons-script"></script>
<script async src={context.relativeURL("assets/search.js", true)} id="tsd-search-script"></script>
<script async src={context.relativeURL("assets/navigation.js", true)} id="tsd-nav-script"></script>
- {context.hook("head.end")}
+ {context.hook("head.end", context)}
</head>
<body>
- {context.hook("body.begin")}
+ {context.hook("body.begin", context)}
<script>
<Raw html='document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";' />
{/* Hide the entire page for up to 0.5 seconds so that if navigating between pages on a fast */}
@@ -50,21 +50,21 @@ export const defaultLayout = (
<div class="container container-main">
<div class="col-content">
- {context.hook("content.begin")}
+ {context.hook("content.begin", context)}
{context.header(props)}
{template(props)}
- {context.hook("content.end")}
+ {context.hook("content.end", context)}
</div>
<div class="col-sidebar">
<div class="page-menu">
- {context.hook("pageSidebar.begin")}
+ {context.hook("pageSidebar.begin", context)}
{context.pageSidebar(props)}
- {context.hook("pageSidebar.end")}
+ {context.hook("pageSidebar.end", context)}
</div>
<div class="site-menu">
- {context.hook("sidebar.begin")}
+ {context.hook("sidebar.begin", context)}
{context.sidebar(props)}
- {context.hook("sidebar.end")}
+ {context.hook("sidebar.end", context)}
</div>
</div>
</div>
@@ -73,8 +73,7 @@ export const defaultLayout = (
<div class="overlay"></div>
- {context.analytics()}
- {context.hook("body.end")}
+ {context.hook("body.end", context)}
</body>
</html>
);
diff --git a/src/lib/output/themes/default/partials/analytics.tsx b/src/lib/output/themes/default/partials/analytics.tsx
deleted file mode 100644
index afcf8fbbd..000000000
--- a/src/lib/output/themes/default/partials/analytics.tsx
+++ /dev/null
@@ -1,23 +0,0 @@
-import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
-
-export function analytics(context: DefaultThemeRenderContext) {
- const gaID = context.options.getValue("gaID");
- if (!gaID) return;
-
- const script = `
-window.dataLayer = window.dataLayer || [];
-function gtag(){dataLayer.push(arguments);}
-gtag('js', new Date());
-gtag('config', '${gaID}');
-`.trim();
-
- return (
- <>
- <script async src={"https://www.googletagmanager.com/gtag/js?id=" + gaID}></script>
- <script>
- <JSX.Raw html={script} />
- </script>
- </>
- );
-}
diff --git a/src/lib/output/themes/default/partials/anchor-icon.tsx b/src/lib/output/themes/default/partials/anchor-icon.tsx
index 0b376ce52..72a546925 100644
--- a/src/lib/output/themes/default/partials/anchor-icon.tsx
+++ b/src/lib/output/themes/default/partials/anchor-icon.tsx
@@ -5,7 +5,7 @@ export function anchorIcon(context: DefaultThemeRenderContext, anchor: string |
if (!anchor) return <></>;
return (
- <a href={`#${anchor}`} aria-label="Permalink" class="tsd-anchor-icon">
+ <a href={`#${anchor}`} aria-label={context.i18n.theme_permalink()} class="tsd-anchor-icon">
{context.icons.anchor()}
</a>
);
diff --git a/src/lib/output/themes/default/partials/comment.tsx b/src/lib/output/themes/default/partials/comment.tsx
index 768b70469..81259c049 100644
--- a/src/lib/output/themes/default/partials/comment.tsx
+++ b/src/lib/output/themes/default/partials/comment.tsx
@@ -1,7 +1,8 @@
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import { JSX, Raw } from "../../../../utils";
-import { Reflection, ReflectionKind } from "../../../../models";
-import { camelToTitleCase } from "../../lib";
+import { type Reflection, ReflectionKind } from "../../../../models";
+import { anchorIcon } from "./anchor-icon";
+import { join } from "../../lib";
// Note: Comment modifiers are handled in `renderFlags`
@@ -15,50 +16,55 @@ export function commentSummary({ markdown }: DefaultThemeRenderContext, props: R
);
}
-export function commentTags({ markdown }: DefaultThemeRenderContext, props: Reflection) {
+export function commentTags(context: DefaultThemeRenderContext, props: Reflection) {
if (!props.comment) return;
+ const beforeTags = context.hook("comment.beforeTags", context, props.comment, props);
+ const afterTags = context.hook("comment.afterTags", context, props.comment, props);
+
const tags = props.kindOf(ReflectionKind.SomeSignature)
- ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns")
- : props.comment.blockTags;
+ ? props.comment.blockTags.filter((tag) => tag.tag !== "@returns" && !tag.skipRendering)
+ : props.comment.blockTags.filter((tag) => !tag.skipRendering);
return (
- <div class="tsd-comment tsd-typography">
- {tags.map((item) => {
- const name = item.name
- ? `${camelToTitleCase(item.tag.substring(1))}: ${item.name}`
- : camelToTitleCase(item.tag.substring(1));
+ <>
+ {beforeTags}
+ <div class="tsd-comment tsd-typography">
+ {tags.map((item) => {
+ const name = item.name
+ ? `${context.internationalization.translateTagName(item.tag)}: ${item.name}`
+ : context.internationalization.translateTagName(item.tag);
- return (
- <>
- <h4>{name}</h4>
- <Raw html={markdown(item.content)} />
- </>
- );
- })}
- </div>
+ const anchor = props.getUniqueAliasInPage(name);
+
+ return (
+ <>
+ <h4 class="tsd-anchor-link">
+ <a id={anchor} class="tsd-anchor"></a>
+ {name}
+ {anchorIcon(context, anchor)}
+ </h4>
+ <Raw html={context.markdown(item.content)} />
+ </>
+ );
+ })}
+ </div>
+ {afterTags}
+ </>
);
}
const flagsNotRendered: `@${string}`[] = ["@showCategories", "@showGroups", "@hideCategories", "@hideGroups"];
-export function reflectionFlags(_context: DefaultThemeRenderContext, props: Reflection) {
- const allFlags = [...props.flags];
+export function reflectionFlags(context: DefaultThemeRenderContext, props: Reflection) {
+ const allFlags = props.flags.getFlagStrings(context.internationalization);
if (props.comment) {
for (const tag of props.comment.modifierTags) {
if (!flagsNotRendered.includes(tag)) {
- allFlags.push(camelToTitleCase(tag.substring(1)));
+ allFlags.push(context.internationalization.translateTagName(tag));
}
}
}
- return (
- <>
- {allFlags.map((item) => (
- <>
- <code class={"tsd-tag ts-flag" + item}>{item}</code>{" "}
- </>
- ))}
- </>
- );
+ return join(" ", allFlags, (item) => <code class="tsd-tag">{item}</code>);
}
diff --git a/src/lib/output/themes/default/partials/footer.tsx b/src/lib/output/themes/default/partials/footer.tsx
index 0bca03947..137c80c6c 100644
--- a/src/lib/output/themes/default/partials/footer.tsx
+++ b/src/lib/output/themes/default/partials/footer.tsx
@@ -3,18 +3,49 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
export function footer(context: DefaultThemeRenderContext) {
const hideGenerator = context.options.getValue("hideGenerator");
- return (
- <footer>
- {context.hook("footer.begin")}
- {hideGenerator || (
+ let generatorDisplay = <></>;
+ if (!hideGenerator) {
+ const message = context.i18n.theme_generated_using_typedoc();
+
+ // Only handles one occurrence, but that's all I expect...
+ const index = message.indexOf("TypeDoc");
+ if (index == -1) {
+ generatorDisplay = <p class="tsd-generator">{message}</p>;
+ } else {
+ const pre = message.substring(0, index);
+ const post = message.substring(index + "TypeDoc".length);
+ generatorDisplay = (
<p class="tsd-generator">
- {"Generated using "}
+ {pre}
<a href="https://typedoc.org/" target="_blank">
TypeDoc
</a>
+ {post}
+ </p>
+ );
+ }
+ }
+
+ const customFooterHtml = context.options.getValue("customFooterHtml");
+ let customFooterDisplay = <></>;
+ if (customFooterHtml) {
+ if (context.options.getValue("customFooterHtmlDisableWrapper")) {
+ customFooterDisplay = <JSX.Raw html={customFooterHtml} />;
+ } else {
+ customFooterDisplay = (
+ <p>
+ <JSX.Raw html={customFooterHtml} />
</p>
- )}
- {context.hook("footer.end")}
+ );
+ }
+ }
+
+ return (
+ <footer>
+ {context.hook("footer.begin", context)}
+ {generatorDisplay}
+ {customFooterDisplay}
+ {context.hook("footer.end", context)}
</footer>
);
}
diff --git a/src/lib/output/themes/default/partials/header.tsx b/src/lib/output/themes/default/partials/header.tsx
index 9e434b68c..87e3c5108 100644
--- a/src/lib/output/themes/default/partials/header.tsx
+++ b/src/lib/output/themes/default/partials/header.tsx
@@ -2,25 +2,28 @@ import { classNames, getDisplayName, hasTypeParameters, join } from "../../lib";
import { JSX } from "../../../../utils";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import type { PageEvent } from "../../../events";
-import { Reflection, ReflectionKind } from "../../../../models";
+import { type Reflection, ReflectionKind } from "../../../../models";
export const header = (context: DefaultThemeRenderContext, props: PageEvent<Reflection>) => {
const HeadingLevel = props.model.isProject() ? "h2" : "h1";
return (
<div class="tsd-page-title">
{!!props.model.parent && <ul class="tsd-breadcrumb">{context.breadcrumb(props.model)}</ul>}
- <HeadingLevel class={classNames({ deprecated: props.model.isDeprecated() })}>
- {props.model.kind !== ReflectionKind.Project && `${ReflectionKind.singularString(props.model.kind)} `}
- {getDisplayName(props.model)}
- {hasTypeParameters(props.model) && (
- <>
- {"<"}
- {join(", ", props.model.typeParameters, (item) => item.name)}
- {">"}
- </>
- )}
- {context.reflectionFlags(props.model)}
- </HeadingLevel>
+ {!props.model.isDocument() && (
+ <HeadingLevel class={classNames({ deprecated: props.model.isDeprecated() })}>
+ {props.model.kind !== ReflectionKind.Project &&
+ `${context.internationalization.kindSingularString(props.model.kind)} `}
+ {getDisplayName(props.model)}
+ {hasTypeParameters(props.model) && (
+ <>
+ {"<"}
+ {join(", ", props.model.typeParameters, (item) => item.name)}
+ {">"}
+ </>
+ )}
+ {context.reflectionFlags(props.model)}
+ </HeadingLevel>
+ )}
</div>
);
};
diff --git a/src/lib/output/themes/default/partials/hierarchy.tsx b/src/lib/output/themes/default/partials/hierarchy.tsx
index fa979eeb3..5d13d14fa 100644
--- a/src/lib/output/themes/default/partials/hierarchy.tsx
+++ b/src/lib/output/themes/default/partials/hierarchy.tsx
@@ -22,8 +22,8 @@ export function hierarchy(context: DefaultThemeRenderContext, props: Declaration
<>
{" "}
(
- <a class="link" href={context.relativeURL("hierarchy.html") + "#" + context.page.model.getFullName()}>
- view full
+ <a href={context.relativeURL("hierarchy.html") + "#" + context.page.model.getFullName()}>
+ {context.i18n.theme_hierarchy_view_full()}
</a>
)
</>
@@ -33,7 +33,10 @@ export function hierarchy(context: DefaultThemeRenderContext, props: Declaration
return (
<section class="tsd-panel tsd-hierarchy">
- <h4>Hierarchy{fullLink}</h4>
+ <h4>
+ {context.i18n.theme_hierarchy()}
+ {fullLink}
+ </h4>
{hierarchyList(context, props)}
</section>
);
diff --git a/src/lib/output/themes/default/partials/icon.tsx b/src/lib/output/themes/default/partials/icon.tsx
index c899cf5cb..b50eddeeb 100644
--- a/src/lib/output/themes/default/partials/icon.tsx
+++ b/src/lib/output/themes/default/partials/icon.tsx
@@ -184,6 +184,16 @@ export const icons: Record<
/>,
"var(--color-ts-variable)",
),
+ [ReflectionKind.Document]: () =>
+ kindIcon(
+ <g stroke="var(--color-text)" fill="var(--color-icon-background)">
+ <polygon points="6,5 6,19 18,19, 18,9 15,5" />
+ <line x1="9" y1="9" x2="14" y2="9" />
+ <line x1="9" y1="12" x2="15" y2="12" />
+ <line x1="9" y1="15" x2="15" y2="15" />
+ </g>,
+ "var(--color-document)",
+ ),
chevronDown: () => (
<svg width="20" height="20" viewBox="0 0 24 24" fill="none">
<path
diff --git a/src/lib/output/themes/default/partials/index.tsx b/src/lib/output/themes/default/partials/index.tsx
index a68058234..d35d0ba28 100644
--- a/src/lib/output/themes/default/partials/index.tsx
+++ b/src/lib/output/themes/default/partials/index.tsx
@@ -57,10 +57,10 @@ export function index(context: DefaultThemeRenderContext, props: ContainerReflec
)
) {
content = (
- <details class="tsd-index-content tsd-index-accordion" open={true}>
+ <details class="tsd-index-content tsd-accordion" open={true}>
<summary class="tsd-accordion-summary tsd-index-summary">
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex={0}>
- {context.icons.chevronSmall()} Index
+ {context.icons.chevronSmall()} {context.i18n.theme_index()}
</h5>
</summary>
<div class="tsd-accordion-details">{content}</div>
@@ -69,7 +69,7 @@ export function index(context: DefaultThemeRenderContext, props: ContainerReflec
} else {
content = (
<>
- <h3 class="tsd-index-heading uppercase">Index</h3>
+ <h3 class="tsd-index-heading uppercase">{context.i18n.theme_index()}</h3>
{content}
</>
);
diff --git a/src/lib/output/themes/default/partials/member.declaration.tsx b/src/lib/output/themes/default/partials/member.declaration.tsx
index 7ed7ce935..0dc770370 100644
--- a/src/lib/output/themes/default/partials/member.declaration.tsx
+++ b/src/lib/output/themes/default/partials/member.declaration.tsx
@@ -1,16 +1,30 @@
import type { DeclarationReflection, ReflectionType } from "../../../../models";
-import { JSX } from "../../../../utils";
+import { JSX, Raw } from "../../../../utils";
import { getKindClass, hasTypeParameters, renderTypeParametersSignature, wbr } from "../../lib";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
+function renderingTypeDeclarationIsUseful(declaration: DeclarationReflection): boolean {
+ if (declaration.hasComment()) return true;
+ if (declaration.children?.some(renderingTypeDeclarationIsUseful)) return true;
+ if (declaration.type?.type === "reflection" && renderingTypeDeclarationIsUseful(declaration.type.declaration)) {
+ return true;
+ }
+
+ return declaration.getAllSignatures().some((sig) => {
+ return sig.hasComment() || sig.parameters?.some((p) => p.hasComment());
+ });
+}
+
export function memberDeclaration(context: DefaultThemeRenderContext, props: DeclarationReflection) {
function renderTypeDeclaration(type: ReflectionType) {
- return (
- <div class="tsd-type-declaration">
- <h4>Type declaration</h4>
- {context.parameter(type.declaration)}
- </div>
- );
+ if (renderingTypeDeclarationIsUseful(type.declaration)) {
+ return (
+ <div class="tsd-type-declaration">
+ <h4>{context.i18n.theme_type_declaration()}</h4>
+ {context.parameter(type.declaration)}
+ </div>
+ );
+ }
}
const visitor = { reflection: renderTypeDeclaration };
@@ -44,7 +58,22 @@ export function memberDeclaration(context: DefaultThemeRenderContext, props: Dec
reflection: renderTypeDeclaration,
array: (arr) => arr.elementType.visit(visitor),
intersection: (int) => int.types.map((t) => t.visit(visitor)),
- union: (union) => union.types.map((t) => t.visit(visitor)),
+ union: (union) => {
+ if (union.elementSummaries) {
+ const result: JSX.Children = [];
+ for (let i = 0; i < union.types.length; ++i) {
+ result.push(
+ <li>
+ {context.type(union.types[i])}
+ <Raw html={context.markdown(union.elementSummaries[i])} />
+ {union.types[i].visit(visitor)}
+ </li>,
+ );
+ }
+ return <ul>{result}</ul>;
+ }
+ return union.types.map((t) => t.visit(visitor));
+ },
reference: (ref) => ref.typeArguments?.map((t) => t.visit(visitor)),
tuple: (ref) => ref.elements.map((t) => t.visit(visitor)),
})}
diff --git a/src/lib/output/themes/default/partials/member.reference.tsx b/src/lib/output/themes/default/partials/member.reference.tsx
index 77ea0e710..709ec1388 100644
--- a/src/lib/output/themes/default/partials/member.reference.tsx
+++ b/src/lib/output/themes/default/partials/member.reference.tsx
@@ -2,24 +2,28 @@ import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import { JSX } from "../../../../utils";
import type { ReferenceReflection } from "../../../../models";
-export const memberReference = ({ urlTo }: DefaultThemeRenderContext, props: ReferenceReflection) => {
+export const memberReference = ({ urlTo, i18n }: DefaultThemeRenderContext, props: ReferenceReflection) => {
const referenced = props.tryGetTargetReflectionDeep();
if (!referenced) {
- return <>Re-exports {props.name}</>;
+ return (
+ <>
+ {i18n.theme_re_exports()} {props.name}
+ </>
+ );
}
if (props.name === referenced.name) {
return (
<>
- Re-exports <a href={urlTo(referenced)}>{referenced.name}</a>
+ {i18n.theme_re_exports()} <a href={urlTo(referenced)}>{referenced.name}</a>
</>
);
}
return (
<>
- Renames and re-exports <a href={urlTo(referenced)}>{referenced.name}</a>
+ {i18n.theme_renames_and_re_exports()} <a href={urlTo(referenced)}>{referenced.name}</a>
</>
);
};
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 e62efeb72..f979c6d29 100644
--- a/src/lib/output/themes/default/partials/member.signature.body.tsx
+++ b/src/lib/output/themes/default/partials/member.signature.body.tsx
@@ -1,6 +1,6 @@
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import { JSX, Raw } from "../../../../utils";
-import { ReflectionType, SignatureReflection } from "../../../../models";
+import { ReflectionType, type SignatureReflection } from "../../../../models";
import { hasTypeParameters } from "../../lib";
export function memberSignatureBody(
@@ -19,7 +19,7 @@ export function memberSignatureBody(
{props.parameters && props.parameters.length > 0 && (
<div class="tsd-parameters">
- <h4 class="tsd-parameters-title">Parameters</h4>
+ <h4 class="tsd-parameters-title">{context.i18n.kind_plural_parameter()}</h4>
<ul class="tsd-parameter-list">
{props.parameters.map((item) => (
<li>
@@ -47,8 +47,7 @@ export function memberSignatureBody(
{props.type && (
<>
<h4 class="tsd-returns-title">
- {"Returns "}
- {context.type(props.type)}
+ {context.i18n.theme_returns()} {context.type(props.type)}
</h4>
{returnsTag && <Raw html={context.markdown(returnsTag.content)} />}
{props.type instanceof ReflectionType && context.parameter(props.type.declaration)}
diff --git a/src/lib/output/themes/default/partials/member.signature.title.tsx b/src/lib/output/themes/default/partials/member.signature.title.tsx
index 659e2f0fa..179a9acab 100644
--- a/src/lib/output/themes/default/partials/member.signature.title.tsx
+++ b/src/lib/output/themes/default/partials/member.signature.title.tsx
@@ -1,7 +1,7 @@
import { getKindClass, join, renderTypeParametersSignature, wbr } from "../../lib";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import { JSX } from "../../../../utils";
-import { ParameterReflection, ReflectionKind, SignatureReflection } from "../../../../models";
+import { type ParameterReflection, ReflectionKind, type SignatureReflection } from "../../../../models";
function renderParameterWithType(context: DefaultThemeRenderContext, item: ParameterReflection) {
return (
@@ -31,9 +31,12 @@ function renderParameterWithoutType(item: ParameterReflection) {
export function memberSignatureTitle(
context: DefaultThemeRenderContext,
props: SignatureReflection,
- { hideName = false, arrowStyle = false }: { hideName?: boolean; arrowStyle?: boolean } = {},
+ {
+ hideName = false,
+ arrowStyle = false,
+ hideParamTypes = context.options.getValue("hideParameterTypesInTitle"),
+ }: { hideName?: boolean; arrowStyle?: boolean; hideParamTypes?: boolean } = {},
) {
- const hideParamTypes = context.options.getValue("hideParameterTypesInTitle");
const renderParam = hideParamTypes ? renderParameterWithoutType : renderParameterWithType.bind(null, context);
return (
diff --git a/src/lib/output/themes/default/partials/member.sources.tsx b/src/lib/output/themes/default/partials/member.sources.tsx
index 27bdda522..cb842b098 100644
--- a/src/lib/output/themes/default/partials/member.sources.tsx
+++ b/src/lib/output/themes/default/partials/member.sources.tsx
@@ -6,7 +6,7 @@ function sourceLink(context: DefaultThemeRenderContext, item: SourceReference) {
if (!item.url) {
return (
<li>
- Defined in {item.fileName}:{item.line}
+ {context.i18n.theme_defined_in()} {item.fileName}:{item.line}
</li>
);
}
@@ -14,7 +14,7 @@ function sourceLink(context: DefaultThemeRenderContext, item: SourceReference) {
if (context.options.getValue("sourceLinkExternal")) {
return (
<li>
- {"Defined in "}
+ {context.i18n.theme_defined_in()}{" "}
<a href={item.url} class="external" target="_blank">
{item.fileName}:{item.line}
</a>
@@ -24,7 +24,7 @@ function sourceLink(context: DefaultThemeRenderContext, item: SourceReference) {
return (
<li>
- {"Defined in "}
+ {context.i18n.theme_defined_in()}{" "}
<a href={item.url}>
{item.fileName}:{item.line}
</a>
@@ -41,24 +41,21 @@ export const memberSources = (
if (props.implementationOf) {
sources.push(
<p>
- {"Implementation of "}
- {context.typeAndParent(props.implementationOf)}
+ {context.i18n.theme_implementation_of()} {context.typeAndParent(props.implementationOf)}
</p>,
);
}
if (props.inheritedFrom) {
sources.push(
<p>
- {"Inherited from "}
- {context.typeAndParent(props.inheritedFrom)}
+ {context.i18n.theme_inherited_from()} {context.typeAndParent(props.inheritedFrom)}
</p>,
);
}
if (props.overwrites) {
sources.push(
<p>
- {"Overrides "}
- {context.typeAndParent(props.overwrites)}
+ {context.i18n.theme_overrides()} {context.typeAndParent(props.overwrites)}
</p>,
);
}
diff --git a/src/lib/output/themes/default/partials/member.tsx b/src/lib/output/themes/default/partials/member.tsx
index 6e189d8a5..fd7e5e6ee 100644
--- a/src/lib/output/themes/default/partials/member.tsx
+++ b/src/lib/output/themes/default/partials/member.tsx
@@ -1,10 +1,10 @@
import { classNames, getDisplayName, wbr } from "../../lib";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
-import { DeclarationReflection, ReferenceReflection } from "../../../../models";
+import { JSX, Raw } from "../../../../utils";
+import { type DeclarationReflection, type DocumentReflection, ReferenceReflection } from "../../../../models";
import { anchorIcon } from "./anchor-icon";
-export function member(context: DefaultThemeRenderContext, props: DeclarationReflection) {
+export function member(context: DefaultThemeRenderContext, props: DeclarationReflection | DocumentReflection) {
context.page.pageHeadings.push({
link: `#${props.anchor}`,
text: getDisplayName(props),
@@ -12,6 +12,26 @@ export function member(context: DefaultThemeRenderContext, props: DeclarationRef
classes: context.getReflectionClasses(props),
});
+ // With the default url derivation, we'll never hit this case as documents are always placed into their
+ // own pages. Handle it here in case someone creates a custom url scheme which embeds guides within the page.
+ if (props.isDocument()) {
+ return (
+ <section class={classNames({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props))}>
+ <a id={props.anchor} class="tsd-anchor"></a>
+ {!!props.name && (
+ <h3 class="tsd-anchor-link">
+ {context.reflectionFlags(props)}
+ <span class={classNames({ deprecated: props.isDeprecated() })}>{wbr(props.name)}</span>
+ {anchorIcon(context, props.anchor)}
+ </h3>
+ )}
+ <div class="tsd-comment tsd-typography">
+ <Raw html={context.markdown(props.content)} />
+ </div>
+ </section>
+ );
+ }
+
return (
<section class={classNames({ "tsd-panel": true, "tsd-member": true }, context.getReflectionClasses(props))}>
<a id={props.anchor} class="tsd-anchor"></a>
@@ -25,10 +45,10 @@ export function member(context: DefaultThemeRenderContext, props: DeclarationRef
{props.signatures
? context.memberSignatures(props)
: props.hasGetterOrSetter()
- ? context.memberGetterSetter(props)
- : props instanceof ReferenceReflection
- ? context.memberReference(props)
- : context.memberDeclaration(props)}
+ ? context.memberGetterSetter(props)
+ : props instanceof ReferenceReflection
+ ? context.memberReference(props)
+ : context.memberDeclaration(props)}
{props.groups?.map((item) => item.children.map((item) => !item.hasOwnDocument && context.member(item)))}
</section>
diff --git a/src/lib/output/themes/default/partials/members.group.tsx b/src/lib/output/themes/default/partials/members.group.tsx
deleted file mode 100644
index cfbad3885..000000000
--- a/src/lib/output/themes/default/partials/members.group.tsx
+++ /dev/null
@@ -1,28 +0,0 @@
-import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
-import type { ReflectionGroup } from "../../../../models";
-
-export function membersGroup(context: DefaultThemeRenderContext, group: ReflectionGroup) {
- if (group.categories) {
- return (
- <>
- {group.categories.map((item) => (
- <section class="tsd-panel-group tsd-member-group">
- <h2>
- {group.title}
- {!!item.title && <> - {item.title}</>}
- </h2>
- {item.children.map((item) => !item.hasOwnDocument && context.member(item))}
- </section>
- ))}
- </>
- );
- }
-
- return (
- <section class="tsd-panel-group tsd-member-group">
- <h2>{group.title}</h2>
- {group.children.map((item) => !item.hasOwnDocument && context.member(item))}
- </section>
- );
-}
diff --git a/src/lib/output/themes/default/partials/members.tsx b/src/lib/output/themes/default/partials/members.tsx
index 9cb0f0f06..51fa596b9 100644
--- a/src/lib/output/themes/default/partials/members.tsx
+++ b/src/lib/output/themes/default/partials/members.tsx
@@ -1,29 +1,61 @@
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { JSX } from "../../../../utils";
-import { ContainerReflection, DeclarationReflection } from "../../../../models";
-import { classNames } from "../../lib";
+import { filterMap, JSX } from "../../../../utils";
+import type { ContainerReflection } from "../../../../models";
-export function members(context: DefaultThemeRenderContext, props: ContainerReflection) {
- if (props.categories && props.categories.length) {
- return (
- <>
- {props.categories.map(
- (item) =>
- !item.allChildrenHaveOwnDocument() && (
- <section
- class={classNames(
- { "tsd-panel-group": true, "tsd-member-group": true },
- props instanceof DeclarationReflection ? context.getReflectionClasses(props) : "",
- )}
- >
- <h2>{item.title}</h2>
- {item.children.map((item) => !item.hasOwnDocument && context.member(item))}
- </section>
- ),
- )}
- </>
- );
+function getMemberSections(parent: ContainerReflection) {
+ if (parent.categories?.length) {
+ return filterMap(parent.categories, (cat) => {
+ if (!cat.allChildrenHaveOwnDocument()) {
+ return {
+ title: cat.title,
+ children: cat.children.filter((child) => !child.hasOwnDocument),
+ };
+ }
+ });
}
- return <>{props.groups?.map((item) => !item.allChildrenHaveOwnDocument() && context.membersGroup(item))}</>;
+ if (parent.groups?.length) {
+ return parent.groups.flatMap((group) => {
+ if (group.categories?.length) {
+ return filterMap(group.categories, (cat) => {
+ if (!cat.allChildrenHaveOwnDocument()) {
+ return {
+ title: `${group.title} - ${cat.title}`,
+ children: cat.children.filter((child) => !child.hasOwnDocument),
+ };
+ }
+ });
+ }
+
+ return {
+ title: group.title,
+ children: group.children.filter((child) => !child.hasOwnDocument),
+ };
+ });
+ }
+
+ return [];
+}
+
+export function members(context: DefaultThemeRenderContext, props: ContainerReflection) {
+ const sections = getMemberSections(props).filter((sect) => sect.children.length);
+
+ return (
+ <>
+ {sections.map(({ title, children }) => {
+ context.page.startNewSection(title);
+
+ return (
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open>
+ <summary class="tsd-accordion-summary" data-key={"section-" + title}>
+ <h2>
+ {context.icons.chevronDown()} {title}
+ </h2>
+ </summary>
+ <section>{children.map((item) => context.member(item))}</section>
+ </details>
+ );
+ })}
+ </>
+ );
}
diff --git a/src/lib/output/themes/default/partials/navigation.tsx b/src/lib/output/themes/default/partials/navigation.tsx
index 6622fa70d..d14e86413 100644
--- a/src/lib/output/themes/default/partials/navigation.tsx
+++ b/src/lib/output/themes/default/partials/navigation.tsx
@@ -1,7 +1,7 @@
-import { Reflection, ReflectionKind } from "../../../../models";
+import { type Reflection, ReflectionFlag, ReflectionKind } from "../../../../models";
import { JSX } from "../../../../utils";
-import type { PageEvent } from "../../../events";
-import { camelToTitleCase, classNames, getDisplayName, wbr } from "../../lib";
+import type { PageEvent, PageHeading } from "../../../events";
+import { classNames, getDisplayName, wbr } from "../../lib";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
export function sidebar(context: DefaultThemeRenderContext, props: PageEvent<Reflection>) {
@@ -27,16 +27,30 @@ function buildFilterItem(context: DefaultThemeRenderContext, name: string, displ
export function sidebarLinks(context: DefaultThemeRenderContext) {
const links = Object.entries(context.options.getValue("sidebarLinks"));
- if (!links.length) return null;
+ const navLinks = Object.entries(context.options.getValue("navigationLinks"));
+
+ if (!links.length && !navLinks.length) return null;
return (
<nav id="tsd-sidebar-links" class="tsd-navigation">
{links.map(([label, url]) => (
<a href={url}>{label}</a>
))}
+ {navLinks.map(([label, url]) => (
+ <a href={url} class="tsd-nav-link">
+ {label}
+ </a>
+ ))}
</nav>
);
}
+const flagOptionNameToReflectionFlag = {
+ protected: ReflectionFlag.Protected,
+ private: ReflectionFlag.Private,
+ external: ReflectionFlag.External,
+ inherited: ReflectionFlag.Inherited,
+};
+
export function settings(context: DefaultThemeRenderContext) {
const defaultFilters = context.options.getValue("visibilityFilters") as Record<string, boolean>;
@@ -50,7 +64,12 @@ export function settings(context: DefaultThemeRenderContext) {
.toLowerCase();
visibilityOptions.push(
- buildFilterItem(context, filterName, camelToTitleCase(key.substring(1)), defaultFilters[key]),
+ buildFilterItem(
+ context,
+ filterName,
+ context.internationalization.translateTagName(key as `@${string}`),
+ defaultFilters[key],
+ ),
);
} else if (
(key === "protected" && !context.options.getValue("excludeProtected")) ||
@@ -58,7 +77,14 @@ export function settings(context: DefaultThemeRenderContext) {
(key === "external" && !context.options.getValue("excludeExternals")) ||
key === "inherited"
) {
- visibilityOptions.push(buildFilterItem(context, key, camelToTitleCase(key), defaultFilters[key]));
+ visibilityOptions.push(
+ buildFilterItem(
+ context,
+ key,
+ context.internationalization.flagString(flagOptionNameToReflectionFlag[key]),
+ defaultFilters[key],
+ ),
+ );
}
}
@@ -66,28 +92,28 @@ export function settings(context: DefaultThemeRenderContext) {
return (
<div class="tsd-navigation settings">
- <details class="tsd-index-accordion" open={false}>
+ <details class="tsd-accordion" open={false}>
<summary class="tsd-accordion-summary">
<h3>
{context.icons.chevronDown()}
- Settings
+ {context.i18n.theme_settings()}
</h3>
</summary>
<div class="tsd-accordion-details">
{visibilityOptions.length && (
<div class="tsd-filter-visibility">
- <h4 class="uppercase">Member Visibility</h4>
- <form>
- <ul id="tsd-filter-options">{...visibilityOptions}</ul>
- </form>
+ <span class="settings-label">{context.i18n.theme_member_visibility()}</span>
+ <ul id="tsd-filter-options">{...visibilityOptions}</ul>
</div>
)}
<div class="tsd-theme-toggle">
- <h4 class="uppercase">Theme</h4>
+ <label class="settings-label" for="tsd-theme">
+ {context.i18n.theme_theme()}
+ </label>
<select id="tsd-theme">
- <option value="os">OS</option>
- <option value="light">Light</option>
- <option value="dark">Dark</option>
+ <option value="os">{context.i18n.theme_os()}</option>
+ <option value="light">{context.i18n.theme_light()}</option>
+ <option value="dark">{context.i18n.theme_dark()}</option>
</select>
</div>
</div>
@@ -104,7 +130,7 @@ export const navigation = function navigation(context: DefaultThemeRenderContext
<span>{getDisplayName(props.project)}</span>
</a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base={context.relativeURL("./")}>
- <li>Loading...</li>
+ <li>{context.i18n.theme_loading()}</li>
</ul>
</nav>
);
@@ -119,7 +145,7 @@ export function pageSidebar(context: DefaultThemeRenderContext, props: PageEvent
);
}
-export function pageNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>) {
+function buildSectionNavigation(context: DefaultThemeRenderContext, headings: PageHeading[]) {
const levels: JSX.Element[][] = [[]];
function finalizeLevel(finishedHandlingHeadings: boolean) {
@@ -139,8 +165,12 @@ export function pageNavigation(context: DefaultThemeRenderContext, props: PageEv
levels[levels.length - 1].push(built);
}
- for (const heading of props.pageHeadings) {
- const inferredLevel = heading.level ? heading.level + 1 : 1;
+ for (const heading of headings) {
+ const inferredLevel = heading.level
+ ? heading.level + 2 // regular heading
+ : heading.kind
+ ? 2 // reflection
+ : 1; // group/category
while (inferredLevel < levels.length) {
finalizeLevel(false);
}
@@ -161,22 +191,43 @@ export function pageNavigation(context: DefaultThemeRenderContext, props: PageEv
finalizeLevel(true);
}
- if (!levels[0].length) {
+ levels.unshift([]);
+ finalizeLevel(true);
+ return levels[0];
+}
+
+export function pageNavigation(context: DefaultThemeRenderContext, props: PageEvent<Reflection>) {
+ if (!props.pageSections.some((sect) => sect.headings.length)) {
return <></>;
}
- levels.unshift([]);
- finalizeLevel(true);
+ const sections: JSX.Children = [];
+
+ for (const section of props.pageSections) {
+ if (section.title) {
+ sections.push(
+ <details open class="tsd-accordion tsd-page-navigation-section">
+ <summary class="tsd-accordion-summary" data-key={`tsd-otp-${section.title}`}>
+ {context.icons.chevronDown()}
+ {section.title}
+ </summary>
+ <div>{buildSectionNavigation(context, section.headings)}</div>
+ </details>,
+ );
+ } else {
+ sections.push(buildSectionNavigation(context, section.headings));
+ }
+ }
return (
- <details open={true} class="tsd-index-accordion tsd-page-navigation">
+ <details open={true} class="tsd-accordion tsd-page-navigation">
<summary class="tsd-accordion-summary">
<h3>
{context.icons.chevronDown()}
- On This Page
+ {context.i18n.theme_on_this_page()}
</h3>
</summary>
- <div class="tsd-accordion-details">{levels[0]}</div>
+ <div class="tsd-accordion-details">{sections}</div>
</details>
);
}
diff --git a/src/lib/output/themes/default/partials/parameter.tsx b/src/lib/output/themes/default/partials/parameter.tsx
index be633830a..7a6dd553b 100644
--- a/src/lib/output/themes/default/partials/parameter.tsx
+++ b/src/lib/output/themes/default/partials/parameter.tsx
@@ -1,7 +1,7 @@
import { classNames, getKindClass, wbr } from "../../lib";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import { JSX } from "../../../../utils";
-import { DeclarationReflection, ReflectionType } from "../../../../models";
+import { type DeclarationReflection, ReflectionType, type SignatureReflection } from "../../../../models";
export const parameter = (context: DefaultThemeRenderContext, props: DeclarationReflection) => (
<>
@@ -26,29 +26,7 @@ export const parameter = (context: DefaultThemeRenderContext, props: Declaration
</ul>
</li>
)}
- {!!props.indexSignature && (
- <>
- <li class="tsd-parameter-index-signature">
- <h5>
- <span class="tsd-signature-symbol">[</span>
- {props.indexSignature?.parameters?.map((item) => (
- <>
- {!!item.flags.isRest && <span class="tsd-signature-symbol">...</span>}
- <span class={getKindClass(item)}>{item.name}</span>
- {": "}
- {context.type(item.type)}
- </>
- ))}
- <span class="tsd-signature-symbol">{"]: "}</span>
- {context.type(props.indexSignature.type)}
- </h5>
- {context.commentSummary(props.indexSignature)}
- {context.commentTags(props.indexSignature)}
- {props.indexSignature.type instanceof ReflectionType &&
- context.parameter(props.indexSignature.type.declaration)}
- </li>
- </>
- )}
+ {props.indexSignatures?.map((index) => renderParamIndexSignature(context, index))}
{props.children?.map((item) => (
<>
{item.signatures ? (
@@ -134,3 +112,25 @@ export const parameter = (context: DefaultThemeRenderContext, props: Declaration
</ul>
</>
);
+
+function renderParamIndexSignature(context: DefaultThemeRenderContext, index: SignatureReflection) {
+ return (
+ <li class="tsd-parameter-index-signature">
+ <h5>
+ <span class="tsd-signature-symbol">[</span>
+ {index.parameters!.map((item) => (
+ <>
+ <span class={getKindClass(item)}>{item.name}</span>
+ {": "}
+ {context.type(item.type)}
+ </>
+ ))}
+ <span class="tsd-signature-symbol">{"]: "}</span>
+ {context.type(index.type)}
+ </h5>
+ {context.commentSummary(index)}
+ {context.commentTags(index)}
+ {index.type instanceof ReflectionType && context.parameter(index.type.declaration)}
+ </li>
+ );
+}
diff --git a/src/lib/output/themes/default/partials/reflectionPreview.tsx b/src/lib/output/themes/default/partials/reflectionPreview.tsx
index 95df3b4f6..ec1fb8bb5 100644
--- a/src/lib/output/themes/default/partials/reflectionPreview.tsx
+++ b/src/lib/output/themes/default/partials/reflectionPreview.tsx
@@ -7,8 +7,9 @@ export function reflectionPreview(context: DefaultThemeRenderContext, props: Ref
if (!(props instanceof DeclarationReflection)) return;
// Each property of the interface will have a member rendered later on the page describing it, so generate
- // a type-like object with links to each member.
- if (props.kindOf(ReflectionKind.Interface)) {
+ // a type-like object with links to each member. Don't do this if we don't have any children as it will
+ // generate a broken looking interface. (See TraverseCallback)
+ if (props.kindOf(ReflectionKind.Interface) && props.children) {
return (
<div class="tsd-signature">
<span class="tsd-signature-keyword">interface </span>
diff --git a/src/lib/output/themes/default/partials/toolbar.tsx b/src/lib/output/themes/default/partials/toolbar.tsx
index 42901e370..03240d323 100644
--- a/src/lib/output/themes/default/partials/toolbar.tsx
+++ b/src/lib/output/themes/default/partials/toolbar.tsx
@@ -12,7 +12,7 @@ export const toolbar = (context: DefaultThemeRenderContext, props: PageEvent<Ref
<label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption">
{context.icons.search()}
</label>
- <input type="text" id="tsd-search-field" aria-label="Search" />
+ <input type="text" id="tsd-search-field" aria-label={context.i18n.theme_search()} />
</div>
<div class="field">
@@ -24,8 +24,8 @@ export const toolbar = (context: DefaultThemeRenderContext, props: PageEvent<Ref
</div>
<ul class="results">
- <li class="state loading">Preparing search index...</li>
- <li class="state failure">The search index is not available</li>
+ <li class="state loading">{context.i18n.theme_preparing_search_index()}</li>
+ <li class="state failure">{context.i18n.theme_search_index_not_available()}</li>
</ul>
<a href={context.options.getValue("titleLink") || context.relativeURL("index.html")} class="title">
@@ -34,7 +34,12 @@ export const toolbar = (context: DefaultThemeRenderContext, props: PageEvent<Ref
</div>
<div class="table-cell" id="tsd-widgets">
- <a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu">
+ <a
+ href="#"
+ class="tsd-widget tsd-toolbar-icon menu no-caption"
+ data-toggle="menu"
+ aria-label={context.i18n.theme_menu()}
+ >
{context.icons.menu()}
</a>
</div>
diff --git a/src/lib/output/themes/default/partials/type.tsx b/src/lib/output/themes/default/partials/type.tsx
index c6b7d4fe5..3161332fb 100644
--- a/src/lib/output/themes/default/partials/type.tsx
+++ b/src/lib/output/themes/default/partials/type.tsx
@@ -1,14 +1,14 @@
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import {
- DeclarationReflection,
+ type DeclarationReflection,
LiteralType,
- ProjectReflection,
+ type ProjectReflection,
ReferenceType,
- Reflection,
+ type Reflection,
ReflectionKind,
- Type,
+ type Type,
TypeContext,
- TypeKindMap,
+ type TypeKindMap,
} from "../../../../models";
import { JSX } from "../../../../utils";
import { getKindClass, join, stringify } from "../../lib";
@@ -69,9 +69,10 @@ function renderUniquePath(context: DefaultThemeRenderContext, reflection: Reflec
));
}
+const indentSize = 4;
let indentationDepth = 0;
function includeIndentation(): JSX.Element {
- return indentationDepth > 0 ? <span>{"\u00A0".repeat(indentationDepth * 4)}</span> : <></>;
+ return indentationDepth > 0 ? <span>{"\u00A0".repeat(indentationDepth * indentSize)}</span> : <></>;
}
export function validateStateIsClean(page: string) {
@@ -378,6 +379,7 @@ const typeRenderers: {
{context.memberSignatureTitle(sig, {
hideName: true,
arrowStyle: false,
+ hideParamTypes: false,
})}
</>,
);
@@ -394,16 +396,17 @@ const typeRenderers: {
);
}
- if (type.declaration.indexSignature) {
- const index = type.declaration.indexSignature;
- members.push(
- <>
- [<span class={getKindClass(type.declaration.indexSignature)}>{index.parameters![0].name}</span>:{" "}
- {renderType(context, index.parameters![0].type, TypeContext.none)}]
- <span class="tsd-signature-symbol">: </span>
- {renderType(context, index.type, TypeContext.none)}
- </>,
- );
+ if (type.declaration.indexSignatures) {
+ for (const index of type.declaration.indexSignatures) {
+ members.push(
+ <>
+ [<span class={getKindClass(index)}>{index.parameters![0].name}</span>:{" "}
+ {renderType(context, index.parameters![0].type, TypeContext.none)}]
+ <span class="tsd-signature-symbol">: </span>
+ {renderType(context, index.type, TypeContext.none)}
+ </>,
+ );
+ }
}
if (!members.length && type.declaration.signatures?.length === 1) {
@@ -415,6 +418,7 @@ const typeRenderers: {
{context.memberSignatureTitle(type.declaration.signatures[0], {
hideName: true,
arrowStyle: true,
+ hideParamTypes: false,
})}
<span class="tsd-signature-symbol">)</span>
</>
@@ -422,7 +426,7 @@ const typeRenderers: {
}
for (const item of type.declaration.signatures || []) {
- members.push(context.memberSignatureTitle(item, { hideName: true }));
+ members.push(context.memberSignatureTitle(item, { hideName: true, hideParamTypes: false }));
}
if (members.length) {
@@ -495,6 +499,31 @@ const typeRenderers: {
);
},
union(context, type) {
+ // This could likely be improved with some print width based heuristic like
+ // how prettier works, but my initial investigation with it didn't consistently
+ // produce better results than this much simpler method as the print width
+ // method doesn't track how far into the current line we are, and I don't want
+ // to spend the time right now to properly track that here. PR welcome if someone
+ // wants to take the time to make that a real capability.
+ // https://gist.github.com/Gerrit0/5cebc127fd4b181e49e354b786d181d7
+ if (type.types.length > 3) {
+ ++indentationDepth;
+ const membersWithSeparators = type.types.flatMap((item) => [
+ includeIndentation(),
+ <span class="tsd-signature-symbol">| </span>,
+ renderType(context, item, TypeContext.unionElement),
+ <br></br>,
+ ]);
+ membersWithSeparators.pop();
+ --indentationDepth;
+
+ return (
+ <>
+ <br />
+ {membersWithSeparators}
+ </>
+ );
+ }
return join(<span class="tsd-signature-symbol"> | </span>, type.types, (item) =>
renderType(context, item, TypeContext.unionElement),
);
diff --git a/src/lib/output/themes/default/partials/typeAndParent.tsx b/src/lib/output/themes/default/partials/typeAndParent.tsx
index e776c3c04..6168240eb 100644
--- a/src/lib/output/themes/default/partials/typeAndParent.tsx
+++ b/src/lib/output/themes/default/partials/typeAndParent.tsx
@@ -1,10 +1,8 @@
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
-import { ArrayType, ReferenceType, SignatureReflection, Type } from "../../../../models";
+import { ArrayType, ReferenceType, SignatureReflection, type Type } from "../../../../models";
import { JSX } from "../../../../utils";
export const typeAndParent = (context: DefaultThemeRenderContext, props: Type): JSX.Element => {
- if (!props) return <>void</>;
-
if (props instanceof ArrayType) {
return (
<>
@@ -16,12 +14,12 @@ export const typeAndParent = (context: DefaultThemeRenderContext, props: Type):
if (props instanceof ReferenceType && props.reflection) {
const refl = props.reflection instanceof SignatureReflection ? props.reflection.parent : props.reflection;
- const parent = refl?.parent;
+ const parent = refl.parent;
return (
<>
{parent?.url ? <a href={context.urlTo(parent)}>{parent.name}</a> : parent?.name}.
- {refl?.url ? <a href={context.urlTo(refl)}>{refl.name}</a> : refl?.name}
+ {refl.url ? <a href={context.urlTo(refl)}>{refl.name}</a> : refl.name}
</>
);
}
diff --git a/src/lib/output/themes/default/partials/typeParameters.tsx b/src/lib/output/themes/default/partials/typeParameters.tsx
index 9617f1b39..da68da44e 100644
--- a/src/lib/output/themes/default/partials/typeParameters.tsx
+++ b/src/lib/output/themes/default/partials/typeParameters.tsx
@@ -6,9 +6,9 @@ export function typeParameters(context: DefaultThemeRenderContext, typeParameter
return (
<>
<section class="tsd-panel">
- <h4>Type Parameters</h4>
+ <h4>{context.i18n.kind_plural_type_parameter()}</h4>
<ul class="tsd-type-parameter-list">
- {typeParameters?.map((item) => (
+ {typeParameters.map((item) => (
<li>
<span>
<a id={item.anchor} class="tsd-anchor"></a>
diff --git a/src/lib/output/themes/default/templates/document.tsx b/src/lib/output/themes/default/templates/document.tsx
new file mode 100644
index 000000000..5ea74b5e9
--- /dev/null
+++ b/src/lib/output/themes/default/templates/document.tsx
@@ -0,0 +1,10 @@
+import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
+import type { DocumentReflection } from "../../../../models";
+import type { PageEvent } from "../../../events";
+import { JSX, Raw } from "../../../../utils";
+
+export const documentTemplate = ({ markdown }: DefaultThemeRenderContext, props: PageEvent<DocumentReflection>) => (
+ <div class="tsd-panel tsd-typography">
+ <Raw html={markdown(props.model.content)} />
+ </div>
+);
diff --git a/src/lib/output/themes/default/templates/hierarchy.tsx b/src/lib/output/themes/default/templates/hierarchy.tsx
index ee8fbcb1c..0a641acfc 100644
--- a/src/lib/output/themes/default/templates/hierarchy.tsx
+++ b/src/lib/output/themes/default/templates/hierarchy.tsx
@@ -37,7 +37,7 @@ function fullHierarchy(
export function hierarchyTemplate(context: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>) {
return (
<>
- <h2>Class Hierarchy</h2>
+ <h2>{context.i18n.theme_class_hierarchy_title()}</h2>
{getHierarchyRoots(props.project).map((root) => (
<ul class="tsd-full-hierarchy">{fullHierarchy(context, root)}</ul>
))}
diff --git a/src/lib/output/themes/default/templates/reflection.tsx b/src/lib/output/themes/default/templates/reflection.tsx
index 7c5a8f512..8e04c1ad7 100644
--- a/src/lib/output/themes/default/templates/reflection.tsx
+++ b/src/lib/output/themes/default/templates/reflection.tsx
@@ -1,7 +1,13 @@
-import { classNames, hasTypeParameters } from "../../lib";
+import { classNames, getKindClass, hasTypeParameters } from "../../lib";
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext";
import type { PageEvent } from "../../../events";
-import { ContainerReflection, DeclarationReflection, ReflectionKind, ReflectionType } from "../../../../models";
+import {
+ type ContainerReflection,
+ DeclarationReflection,
+ ReflectionKind,
+ ReflectionType,
+ type SignatureReflection,
+} from "../../../../models";
import { JSX, Raw } from "../../../../utils";
export function reflectionTemplate(context: DefaultThemeRenderContext, props: PageEvent<ContainerReflection>) {
@@ -37,7 +43,7 @@ export function reflectionTemplate(context: DefaultThemeRenderContext, props: Pa
{!!props.model.implementedTypes && (
<section class="tsd-panel">
- <h4>Implements</h4>
+ <h4>{context.i18n.theme_implements()}</h4>
<ul class="tsd-hierarchy">
{props.model.implementedTypes.map((item) => (
<li>{context.type(item)}</li>
@@ -47,7 +53,7 @@ export function reflectionTemplate(context: DefaultThemeRenderContext, props: Pa
)}
{!!props.model.implementedBy && (
<section class="tsd-panel">
- <h4>Implemented by</h4>
+ <h4>{context.i18n.theme_implemented_by()}</h4>
<ul class="tsd-hierarchy">
{props.model.implementedBy.map((item) => (
<li>{context.type(item)}</li>
@@ -55,26 +61,15 @@ export function reflectionTemplate(context: DefaultThemeRenderContext, props: Pa
</ul>
</section>
)}
- {!!props.model.signatures && (
+ {!!props.model.signatures?.length && (
<section class="tsd-panel">{context.memberSignatures(props.model)}</section>
)}
- {!!props.model.indexSignature && (
+ {!!props.model.indexSignatures?.length && (
<section class={classNames({ "tsd-panel": true }, context.getReflectionClasses(props.model))}>
- <h4 class="tsd-before-signature">Indexable</h4>
- <div class="tsd-signature">
- <span class="tsd-signature-symbol">[</span>
- {props.model.indexSignature.parameters!.map((item) => (
- <>
- {item.name}: {context.type(item.type)}
- </>
- ))}
- <span class="tsd-signature-symbol">]: </span>
- {context.type(props.model.indexSignature.type)}
- </div>
- {context.commentSummary(props.model.indexSignature)}
- {context.commentTags(props.model.indexSignature)}
- {props.model.indexSignature?.type instanceof ReflectionType &&
- context.parameter(props.model.indexSignature.type.declaration)}
+ <h4 class="tsd-before-signature">{context.i18n.theme_indexable()}</h4>
+ <ul class="tsd-signatures">
+ {props.model.indexSignatures.map((index) => renderIndexSignature(context, index))}
+ </ul>
</section>
)}
{!props.model.signatures && context.memberSources(props.model)}
@@ -85,3 +80,23 @@ export function reflectionTemplate(context: DefaultThemeRenderContext, props: Pa
</>
);
}
+
+function renderIndexSignature(context: DefaultThemeRenderContext, index: SignatureReflection) {
+ return (
+ <li class="tsd-index-signature">
+ <div class="tsd-signature">
+ <span class="tsd-signature-symbol">[</span>
+ {index.parameters!.map((item) => (
+ <>
+ <span class={getKindClass(item)}>{item.name}</span>: {context.type(item.type)}
+ </>
+ ))}
+ <span class="tsd-signature-symbol">]: </span>
+ {context.type(index.type)}
+ </div>
+ {context.commentSummary(index)}
+ {context.commentTags(index)}
+ {index.type instanceof ReflectionType && context.parameter(index.type.declaration)}
+ </li>
+ );
+}
diff --git a/src/lib/output/themes/lib.tsx b/src/lib/output/themes/lib.tsx
index 4c1605521..75e8f019e 100644
--- a/src/lib/output/themes/lib.tsx
+++ b/src/lib/output/themes/lib.tsx
@@ -3,10 +3,10 @@ import {
DeclarationReflection,
ProjectReflection,
ReferenceReflection,
- Reflection,
+ type Reflection,
ReflectionKind,
SignatureReflection,
- TypeParameterReflection,
+ type TypeParameterReflection,
} from "../../models";
import { JSX } from "../../utils";
@@ -27,7 +27,7 @@ export function getDisplayName(refl: Reflection): string {
}
export function toStyleClass(str: string): string {
- return str.replace(/(\w)([A-Z])/g, (_m, m1, m2) => m1 + "-" + m2).toLowerCase();
+ return str.replace(/(\w)([A-Z])/g, (_m, m1: string, m2: string) => m1 + "-" + m2).toLowerCase();
}
export function getKindClass(refl: Reflection): string {
@@ -139,18 +139,10 @@ export function renderTypeParametersSignature(
);
}
-export function camelToTitleCase(text: string) {
- return text.substring(0, 1).toUpperCase() + text.substring(1).replace(/[a-z][A-Z]/g, (x) => `${x[0]} ${x[1]}`);
-}
-
/**
* Renders the reflection name with an additional `?` if optional.
*/
export function renderName(refl: Reflection) {
- if (!refl.name) {
- return <em>{wbr(ReflectionKind.singularString(refl.kind))}</em>;
- }
-
if (refl.flags.isOptional) {
return <>{wbr(refl.name)}?</>;
}
diff --git a/src/lib/serialization/deserializer.ts b/src/lib/serialization/deserializer.ts
index 45f8e6cc0..4988e439a 100644
--- a/src/lib/serialization/deserializer.ts
+++ b/src/lib/serialization/deserializer.ts
@@ -4,6 +4,7 @@ import {
ArrayType,
ConditionalType,
DeclarationReflection,
+ DocumentReflection,
IndexedAccessType,
InferredType,
IntersectionType,
@@ -21,13 +22,13 @@ import {
Reflection,
ReflectionKind,
ReflectionType,
- ReflectionVariant,
+ type ReflectionVariant,
RestType,
SignatureReflection,
- SomeType,
+ type SomeType,
TemplateLiteralType,
TupleType,
- TypeKindMap,
+ type TypeKindMap,
TypeOperatorType,
TypeParameterReflection,
UnionType,
@@ -36,6 +37,7 @@ import {
import { insertPrioritySorted } from "../utils/array";
import type { Logger } from "../utils/loggers";
import type { JSONOutput } from "./index";
+import type { FileRegistry } from "../models/FileRegistry";
export interface DeserializerComponent {
priority: number;
@@ -51,10 +53,10 @@ export class Deserializer {
private deferred: Array<(project: ProjectReflection) => void> = [];
private deserializers: DeserializerComponent[] = [];
private activeReflection: Reflection[] = [];
- constructor(private app: Application) {}
+ constructor(readonly application: Application) {}
get logger(): Logger {
- return this.app.logger;
+ return this.application.logger;
}
reflectionBuilders: {
@@ -66,6 +68,9 @@ export class Deserializer {
declaration(parent, obj) {
return new DeclarationReflection(obj.name, obj.kind, parent);
},
+ document(parent, obj) {
+ return new DocumentReflection(obj.name, parent, [], {});
+ },
param(parent, obj) {
return new ParameterReflection(obj.name, obj.kind, parent);
},
@@ -203,7 +208,13 @@ export class Deserializer {
},
};
+ /**
+ * Only set when deserializing.
+ */
+ projectRoot!: string;
+
oldIdToNewId: Record<number, number | undefined> = {};
+ oldFileIdToNewFileId: Record<number, number | undefined> = {};
project: ProjectReflection | undefined;
addDeserializer(de: DeserializerComponent): void {
@@ -217,16 +228,23 @@ export class Deserializer {
*/
reviveProject(
projectObj: JSONOutput.ProjectReflection,
- name?: string,
+ name: string,
+ projectRoot: string,
+ registry: FileRegistry,
): ProjectReflection {
ok(
this.deferred.length === 0,
"Deserializer.defer was called when not deserializing",
);
- const project = new ProjectReflection(name || projectObj.name);
- project.registerReflection(project);
+ const project = new ProjectReflection(
+ name || projectObj.name,
+ registry,
+ );
+ project.registerReflection(project, undefined, undefined);
this.project = project;
+ this.projectRoot = projectRoot;
this.oldIdToNewId = { [projectObj.id]: project.id };
+ this.oldFileIdToNewFileId = {};
this.fromObject(project, projectObj);
const deferred = this.deferred;
@@ -246,21 +264,25 @@ export class Deserializer {
);
this.project = undefined;
+ this.projectRoot = undefined!;
this.oldIdToNewId = {};
+ this.oldFileIdToNewFileId = {};
return project;
}
reviveProjects(
name: string,
projects: readonly JSONOutput.ProjectReflection[],
+ projectRoot: string,
+ registry: FileRegistry,
): ProjectReflection {
if (projects.length === 1) {
- return this.reviveProject(projects[0], name);
+ return this.reviveProject(projects[0], name, projectRoot, registry);
}
- const project = new ProjectReflection(name);
- project.children = [];
+ const project = new ProjectReflection(name, registry);
this.project = project;
+ this.projectRoot = projectRoot;
for (const proj of projects) {
ok(
@@ -273,9 +295,10 @@ export class Deserializer {
ReflectionKind.Module,
project,
);
- project.registerReflection(projModule);
- project.children.push(projModule);
+ project.registerReflection(projModule, undefined, undefined);
+ project.addChild(projModule);
this.oldIdToNewId = { [proj.id]: projModule.id };
+ this.oldFileIdToNewFileId = {};
this.fromObject(projModule, proj);
const deferred = this.deferred;
@@ -295,7 +318,9 @@ export class Deserializer {
}
this.oldIdToNewId = {};
+ this.oldFileIdToNewFileId = {};
this.project = undefined;
+ this.projectRoot = undefined!;
return project;
}
@@ -356,7 +381,7 @@ export class Deserializer {
obj as never,
);
this.oldIdToNewId[obj.id] = result.id;
- this.project!.registerReflection(result);
+ this.project!.registerReflection(result, undefined, undefined);
return result as any;
}
diff --git a/src/lib/serialization/events.ts b/src/lib/serialization/events.ts
index d0090dcd5..b78912280 100644
--- a/src/lib/serialization/events.ts
+++ b/src/lib/serialization/events.ts
@@ -1,4 +1,3 @@
-import { Event } from "../utils/events";
import type { ProjectReflection } from "../models";
import type { ProjectReflection as JSONProjectReflection } from "./schema";
@@ -9,7 +8,7 @@ import type { ProjectReflection as JSONProjectReflection } from "./schema";
* @see {@link Serializer.EVENT_BEGIN}
* @see {@link Serializer.EVENT_END}
*/
-export class SerializeEvent extends Event {
+export class SerializeEvent {
/**
* The project the renderer is currently processing.
*/
@@ -17,12 +16,7 @@ export class SerializeEvent extends Event {
output: JSONProjectReflection | undefined;
- constructor(
- name: string,
- project: ProjectReflection,
- output?: JSONProjectReflection,
- ) {
- super(name);
+ constructor(project: ProjectReflection, output?: JSONProjectReflection) {
this.project = project;
this.output = output;
}
diff --git a/src/lib/serialization/index.ts b/src/lib/serialization/index.ts
index 6b91292ee..ffb55aa2f 100644
--- a/src/lib/serialization/index.ts
+++ b/src/lib/serialization/index.ts
@@ -6,4 +6,4 @@ export {
} from "./deserializer";
export { SerializeEvent } from "./events";
export * as JSONOutput from "./schema";
-export { Serializer } from "./serializer";
+export { Serializer, type SerializerEvents } from "./serializer";
diff --git a/src/lib/serialization/schema.ts b/src/lib/serialization/schema.ts
index 3709a6d49..f506702a8 100644
--- a/src/lib/serialization/schema.ts
+++ b/src/lib/serialization/schema.ts
@@ -29,13 +29,16 @@
*/
import type * as M from "../models";
+import type { IfInternal } from "../utils";
/**
* Describes the mapping from Model types to the corresponding JSON output type.
*/
-export type ModelToObject<T> = T extends Array<infer U>
- ? _ModelToObject<U>[]
- : _ModelToObject<T>;
+export type ModelToObject<T> = [T] extends [Array<infer U>]
+ ? ModelToObject<U>[]
+ : [M.SomeType] extends [T]
+ ? SomeType
+ : _ModelToObject<T>;
// Order matters here. Some types are subtypes of other types.
type _ModelToObject<T> =
@@ -43,40 +46,28 @@ type _ModelToObject<T> =
T extends Primitive
? T
: Required<T> extends Required<M.ReflectionGroup>
- ? ReflectionGroup
- : Required<T> extends Required<M.ReflectionCategory>
- ? ReflectionCategory
- : T extends M.SignatureReflection
- ? SignatureReflection
- : T extends M.ParameterReflection
- ? ParameterReflection
- : T extends M.DeclarationReflection
- ? DeclarationReflection
- : T extends M.TypeParameterReflection
- ? TypeParameterReflection
- : T extends M.ProjectReflection
- ? ProjectReflection
- : T extends M.ContainerReflection
- ? ContainerReflection
- : T extends M.ReferenceReflection
- ? ReferenceReflection
- : T extends M.Reflection
- ? Reflection
- : // Types
- T extends M.SomeType
- ? TypeKindMap[T["type"]]
- : T extends M.Type
- ? SomeType
- : // Miscellaneous
- T extends M.Comment
- ? Comment
- : T extends M.CommentTag
- ? CommentTag
- : T extends M.CommentDisplayPart
- ? CommentDisplayPart
- : T extends M.SourceReference
- ? SourceReference
- : never;
+ ? ReflectionGroup
+ : Required<T> extends Required<M.ReflectionCategory>
+ ? ReflectionCategory
+ : T extends M.ReflectionVariant[keyof M.ReflectionVariant]
+ ? ReflectionVariantMap[T["variant"]]
+ : // Types
+ T extends M.SomeType
+ ? TypeKindMap[T["type"]]
+ : T extends M.Type
+ ? SomeType
+ : // Miscellaneous
+ T extends M.Comment
+ ? Comment
+ : T extends M.CommentTag
+ ? CommentTag
+ : T extends M.CommentDisplayPart
+ ? CommentDisplayPart
+ : T extends M.SourceReference
+ ? SourceReference
+ : T extends M.FileRegistry
+ ? FileRegistry
+ : never;
type Primitive = string | number | undefined | null | boolean;
@@ -84,8 +75,8 @@ type Primitive = string | number | undefined | null | boolean;
type ToSerialized<T> = T extends Primitive
? T
: T extends bigint
- ? { value: string; negative: boolean }
- : ModelToObject<T>;
+ ? { value: string; negative: boolean }
+ : ModelToObject<T>;
/**
* Helper to describe a set of serialized properties. Primitive types are returned
@@ -115,9 +106,28 @@ export interface ReflectionCategory
// Reflections
/** @category Reflections */
-export type SomeReflection = {
- [K in keyof M.ReflectionVariant]: ModelToObject<M.ReflectionVariant[K]>;
-}[keyof M.ReflectionVariant];
+export interface ReflectionVariantMap {
+ declaration: DeclarationReflection;
+ param: ParameterReflection;
+ project: ProjectReflection;
+ reference: ReferenceReflection;
+ signature: SignatureReflection;
+ typeParam: TypeParameterReflection;
+ document: DocumentReflection;
+}
+
+/** @category Reflections */
+export type SomeReflection = ReflectionVariantMap[keyof ReflectionVariantMap];
+
+/** @category Reflections */
+export interface DocumentReflection
+ extends Omit<Reflection, "variant">,
+ S<
+ M.DocumentReflection,
+ "variant" | "content" | "relevanceBoost" | "children"
+ > {
+ frontmatter: Record<string, unknown>;
+}
/** @category Reflections */
export interface ReferenceReflection
@@ -138,13 +148,14 @@ export interface SignatureReflection
| "variant"
| "sources"
| "parameters"
+ | "typeParameters"
| "type"
| "overwrites"
| "inheritedFrom"
| "implementationOf"
> {
- // Weird not to call this typeParameters... preserving backwards compatibility for now.
- typeParameter?: ModelToObject<M.SignatureReflection["typeParameters"]>;
+ /** @deprecated in 0.26, replaced with {@link typeParameters} */
+ typeParameter?: ModelToObject<M.TypeParameterReflection[]>;
}
/** @category Reflections */
@@ -165,7 +176,7 @@ export interface DeclarationReflection
| "relevanceBoost"
| "type"
| "signatures"
- | "indexSignature"
+ | "indexSignatures"
| "defaultValue"
| "overwrites"
| "inheritedFrom"
@@ -178,7 +189,10 @@ export interface DeclarationReflection
| "setSignature"
| "typeParameters"
| "readme"
- > {}
+ > {
+ /** @deprecated moved to {@link indexSignatures} with 0.26. */
+ indexSignature?: SignatureReflection;
+}
/** @category Reflections */
export interface TypeParameterReflection
@@ -195,13 +209,21 @@ export interface ProjectReflection
M.ProjectReflection,
"variant" | "packageName" | "packageVersion" | "readme"
> {
- symbolIdMap: Record<number, ReflectionSymbolId>;
+ symbolIdMap:
+ | Record<number, ReflectionSymbolId>
+ | IfInternal<undefined, never>;
+ files: FileRegistry;
}
/** @category Reflections */
export interface ContainerReflection
extends Reflection,
- S<M.ContainerReflection, "children" | "groups" | "categories"> {}
+ S<
+ M.ContainerReflection,
+ "children" | "documents" | "groups" | "categories"
+ > {
+ childrenIncludingDocuments?: number[];
+}
/** @category Reflections */
export interface Reflection
@@ -212,7 +234,7 @@ export interface Reflection
// Types
/** @category Types */
-export type SomeType = ModelToObject<M.SomeType>;
+export type SomeType = TypeKindMap[keyof TypeKindMap];
/** @category Types */
export type TypeKindMap = {
@@ -345,7 +367,9 @@ export interface TypeOperatorType
S<M.TypeOperatorType, "type" | "operator" | "target"> {}
/** @category Types */
-export interface UnionType extends Type, S<M.UnionType, "type" | "types"> {}
+export interface UnionType
+ extends Type,
+ S<M.UnionType, "type" | "types" | "elementSummaries"> {}
/** @category Types */
export interface UnknownType extends Type, S<M.UnknownType, "type" | "name"> {}
@@ -373,11 +397,15 @@ export interface CommentTag extends S<M.CommentTag, "tag" | "name"> {
content: CommentDisplayPart[];
}
-/** @category Comments */
+/**
+ * @see {@link M.CommentDisplayPart}
+ * @category Comments
+ */
export type CommentDisplayPart =
| { kind: "text"; text: string }
| { kind: "code"; text: string }
- | InlineTagDisplayPart;
+ | InlineTagDisplayPart
+ | RelativeLinkDisplayPart;
/**
* If `target` is a number, it is a reflection ID. If a string, it is a URL.
@@ -392,5 +420,29 @@ export interface InlineTagDisplayPart {
tsLinkText?: string;
}
+/**
+ * This is used for relative links within comments/documents.
+ * It is used to mark pieces of text which need to be replaced
+ * to make links work properly.
+ */
+export interface RelativeLinkDisplayPart {
+ kind: "relative-link";
+ /**
+ * The original relative text from the parsed comment.
+ */
+ text: string;
+ /**
+ * File ID, if present
+ */
+ target?: number;
+}
+
export interface SourceReference
extends S<M.SourceReference, "fileName" | "line" | "character" | "url"> {}
+
+export interface FileRegistry {
+ /** Relative path according to the serialization root */
+ entries: Record<number, string>;
+ /** File ID to reflection ID */
+ reflections: Record<number, number>;
+}
diff --git a/src/lib/serialization/serializer.ts b/src/lib/serialization/serializer.ts
index 9b4998a0f..91fc46414 100644
--- a/src/lib/serialization/serializer.ts
+++ b/src/lib/serialization/serializer.ts
@@ -6,18 +6,23 @@ import type { ModelToObject } from "./schema";
import type { SerializerComponent } from "./components";
import { insertPrioritySorted } from "../utils/array";
-export class Serializer extends EventDispatcher {
+export interface SerializerEvents {
+ begin: [SerializeEvent];
+ end: [SerializeEvent];
+}
+
+export class Serializer extends EventDispatcher<SerializerEvents> {
/**
* Triggered when the {@link Serializer} begins transforming a project.
- * @event EVENT_BEGIN
+ * @event
*/
- static EVENT_BEGIN = "begin";
+ static readonly EVENT_BEGIN = "begin";
/**
* Triggered when the {@link Serializer} has finished transforming a project.
- * @event EVENT_END
+ * @event
*/
- static EVENT_END = "end";
+ static readonly EVENT_END = "end";
private serializers: SerializerComponent<any>[] = [];
@@ -26,7 +31,7 @@ export class Serializer extends EventDispatcher {
*/
projectRoot!: string;
- addSerializer(serializer: SerializerComponent<any>): void {
+ addSerializer<T extends {}>(serializer: SerializerComponent<T>): void {
insertPrioritySorted(this.serializers, serializer);
}
@@ -71,17 +76,13 @@ export class Serializer extends EventDispatcher {
): ModelToObject<ProjectReflection> {
this.projectRoot = projectRoot;
- const eventBegin = new SerializeEvent(Serializer.EVENT_BEGIN, value);
- this.trigger(eventBegin);
+ const eventBegin = new SerializeEvent(value);
+ this.trigger(Serializer.EVENT_BEGIN, eventBegin);
const project = this.toObject(value);
- const eventEnd = new SerializeEvent(
- Serializer.EVENT_END,
- value,
- project,
- );
- this.trigger(eventEnd);
+ const eventEnd = new SerializeEvent(value, project);
+ this.trigger(Serializer.EVENT_END, eventEnd);
return project;
}
diff --git a/src/lib/types/shiki/shiki.d.ts b/src/lib/types/shiki/shiki.d.ts
new file mode 100644
index 000000000..4034f072c
--- /dev/null
+++ b/src/lib/types/shiki/shiki.d.ts
@@ -0,0 +1,19 @@
+// Shiki 1.x declares a `loadWasm` function which takes these types as input.
+// They are declared in the DOM library, but since TypeDoc doesn't use that library,
+// we have to declare some shims, intentionally crafted to not be accidentally
+// constructed.
+
+declare namespace WebAssembly {
+ interface Instance {
+ __shikiHack: never;
+ exports: unknown;
+ }
+ interface WebAssemblyInstantiatedSource {
+ __shikiHack: never;
+ }
+ type ImportValue = unknown;
+}
+
+interface Response {
+ __shikiHack: never;
+}
diff --git a/src/lib/types/ts-internal/index.d.ts b/src/lib/types/ts-internal/index.d.ts
index 31b66c0c6..dfee92d49 100644
--- a/src/lib/types/ts-internal/index.d.ts
+++ b/src/lib/types/ts-internal/index.d.ts
@@ -28,6 +28,12 @@ declare module "typescript" {
noCache?: boolean,
): readonly (JSDoc | JSDocTag)[];
+ export function getInterfaceBaseTypeNodes(
+ node: InterfaceDeclaration,
+ ): NodeArray<ExpressionWithTypeArguments> | undefined;
+
+ export function getAllSuperTypeNodes(node: ts.Node): readonly ts.TypeNode[];
+
export interface Signature {
thisParameter?: ts.Symbol;
}
diff --git a/src/lib/utils/array.ts b/src/lib/utils/array.ts
index 051127206..ff79d13aa 100644
--- a/src/lib/utils/array.ts
+++ b/src/lib/utils/array.ts
@@ -1,3 +1,5 @@
+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 earlier in the array.
@@ -120,7 +122,7 @@ export function* zip<T extends Iterable<any>[]>(
): Iterable<{ [K in keyof T]: T[K] extends Iterable<infer U> ? U : T[K] }> {
const iterators = args.map((x) => x[Symbol.iterator]());
- while (true) {
+ for (;;) {
const next = iterators.map((i) => i.next());
if (next.some((v) => v.done)) {
break;
@@ -144,3 +146,27 @@ export function filterMap<T, U>(
return result;
}
+
+export function firstDefined<T, U>(
+ array: readonly T[] | undefined,
+ 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) {
+ return result;
+ }
+ }
+ return undefined;
+}
+
+export function filter<T>(
+ array: readonly T[] | undefined,
+ predicate: (value: T, index: number, array: readonly T[]) => boolean,
+): readonly T[] {
+ return array ? array.filter(predicate) : emptyArray;
+}
diff --git a/src/lib/utils/component.ts b/src/lib/utils/component.ts
index 4c84a55a3..c87d86944 100644
--- a/src/lib/utils/component.ts
+++ b/src/lib/utils/component.ts
@@ -1,5 +1,5 @@
import type { Application } from "../application";
-import { EventDispatcher, Event, EventMap } from "./events";
+import { EventDispatcher } from "./events";
/**
* Exposes a reference to the root Application component.
@@ -8,7 +8,8 @@ export interface ComponentHost {
readonly application: Application;
}
-export interface Component extends AbstractComponent<ComponentHost> {}
+export interface Component<E extends Record<keyof E, unknown[]> = {}>
+ extends AbstractComponent<ComponentHost, E> {}
export interface ComponentClass<
T extends Component,
@@ -28,7 +29,7 @@ export interface ComponentOptions {
}
const childMappings: {
- host: ChildableComponent<any, any>;
+ host: ChildableComponent<any, any, any>;
child: Function;
}[] = [];
@@ -82,34 +83,17 @@ export function Component(options: ComponentOptions) {
};
}
-export class ComponentEvent extends Event {
- owner: ComponentHost;
-
- component: AbstractComponent<ComponentHost>;
-
- static ADDED = "componentAdded";
-
- static REMOVED = "componentRemoved";
-
- constructor(
- name: string,
- owner: ComponentHost,
- component: AbstractComponent<ComponentHost>,
- ) {
- super(name);
- this.owner = owner;
- this.component = component;
- }
-}
-
/**
* Component base class. Has an owner (unless it's the application root component),
* can dispatch events to its children, and has access to the root Application component.
*
* @template O type of component's owner.
*/
-export abstract class AbstractComponent<O extends ComponentHost>
- extends EventDispatcher
+export abstract class AbstractComponent<
+ O extends ComponentHost,
+ E extends Record<keyof E, unknown[]>,
+ >
+ extends EventDispatcher<E>
implements ComponentHost
{
/**
@@ -138,19 +122,6 @@ export abstract class AbstractComponent<O extends ComponentHost>
// empty default implementation
}
- protected bubble(name: Event | EventMap | string, ...args: any[]) {
- super.trigger(name, ...args);
-
- if (
- this.owner instanceof AbstractComponent &&
- this._componentOwner !== null
- ) {
- this.owner.bubble(name, ...args);
- }
-
- return this;
- }
-
/**
* Return the application / root component instance.
*/
@@ -180,11 +151,9 @@ export abstract class AbstractComponent<O extends ComponentHost>
export abstract class ChildableComponent<
O extends ComponentHost,
C extends Component,
-> extends AbstractComponent<O> {
- /**
- *
- */
- private _componentChildren?: { [name: string]: C };
+ E extends Record<keyof E, unknown[]>,
+> extends AbstractComponent<O, E> {
+ private _componentChildren?: { [name: string]: C | undefined };
private _defaultComponents?: { [name: string]: ComponentClass<C> };
@@ -211,11 +180,7 @@ export abstract class ChildableComponent<
}
getComponents(): C[] {
- return Object.values(this._componentChildren || {});
- }
-
- hasComponent(name: string): boolean {
- return !!(this._componentChildren || {})[name];
+ return Object.values(this._componentChildren || {}) as C[];
}
addComponent<T extends C>(
@@ -236,36 +201,10 @@ export abstract class ChildableComponent<
typeof componentClass === "function"
? new (<ComponentClass<T>>componentClass)(this)
: componentClass;
- const event = new ComponentEvent(
- ComponentEvent.ADDED,
- this,
- component,
- );
- this.bubble(event);
this._componentChildren[name] = component;
return component;
}
}
-
- removeComponent(name: string): C | undefined {
- const component = (this._componentChildren || {})[name];
- if (component) {
- delete this._componentChildren![name];
- component.stopListening();
- this.bubble(
- new ComponentEvent(ComponentEvent.REMOVED, this, component),
- );
- return component;
- }
- }
-
- removeAllComponents() {
- for (const component of Object.values(this._componentChildren || {})) {
- component.stopListening();
- }
-
- this._componentChildren = {};
- }
}
diff --git a/src/lib/utils/entry-point.ts b/src/lib/utils/entry-point.ts
index 3d08865e9..064723d82 100644
--- a/src/lib/utils/entry-point.ts
+++ b/src/lib/utils/entry-point.ts
@@ -45,14 +45,17 @@ export interface DocumentationEntryPoint {
version?: string;
}
+export interface DocumentEntryPoint {
+ displayName: string;
+ path: string;
+}
+
export function getEntryPoints(
logger: Logger,
options: Options,
): DocumentationEntryPoint[] | undefined {
if (!options.isSet("entryPoints")) {
- logger.warn(
- "No entry points were provided, this is likely a misconfiguration.",
- );
+ logger.warn(logger.i18n.no_entry_points_provided());
return [];
}
@@ -93,14 +96,50 @@ export function getEntryPoints(
assertNever(strategy);
}
- if (result && result.length === 0) {
- logger.error("Unable to find any entry points. See previous warnings.");
+ if (result.length === 0) {
+ logger.error(logger.i18n.unable_to_find_any_entry_points());
return;
}
return result;
}
+/**
+ * Document entry points are markdown documents that the user has requested we include in the project with
+ * an option rather than a `@document` tag.
+ *
+ * @returns A list of `.md` files to include in the documentation as documents.
+ */
+export function getDocumentEntryPoints(
+ logger: Logger,
+ options: Options,
+): DocumentEntryPoint[] {
+ const docGlobs = options.getValue("projectDocuments");
+ if (docGlobs.length === 0) {
+ return [];
+ }
+
+ const docPaths = expandGlobs(docGlobs, [], logger);
+
+ // We might want to expand this in the future, there are quite a lot of extensions
+ // that have at some point or another been used for markdown: https://superuser.com/a/285878
+ const supportedFileRegex = /\.(md|markdown)$/;
+
+ const expanded = expandInputFiles(
+ logger,
+ docPaths,
+ options,
+ supportedFileRegex,
+ );
+ const baseDir = options.getValue("basePath") || deriveRootDir(expanded);
+ return expanded.map((path) => {
+ return {
+ displayName: relative(baseDir, path).replace(/\.[^.]+$/, ""),
+ path,
+ };
+ });
+}
+
export function getWatchEntryPoints(
logger: Logger,
options: Options,
@@ -132,15 +171,11 @@ export function getWatchEntryPoints(
break;
case EntryPointStrategy.Packages:
- logger.error(
- "Watch mode does not support 'packages' style entry points.",
- );
+ logger.error(logger.i18n.watch_does_not_support_packages_mode());
break;
case EntryPointStrategy.Merge:
- logger.error(
- "Watch mode does not support 'merge' style entry points.",
- );
+ logger.error(logger.i18n.watch_does_not_support_merge_mode());
break;
default:
@@ -148,7 +183,7 @@ export function getWatchEntryPoints(
}
if (result && result.length === 0) {
- logger.error("Unable to find any entry points.");
+ logger.error(logger.i18n.unable_to_find_any_entry_points());
return;
}
@@ -187,6 +222,7 @@ function getEntryPointsForPaths(
): DocumentationEntryPoint[] {
const baseDir = options.getValue("basePath") || deriveRootDir(inputFiles);
const entryPoints: DocumentationEntryPoint[] = [];
+ let expandSuggestion = true;
entryLoop: for (const fileOrDir of inputFiles.map(normalizePath)) {
const toCheck = [fileOrDir];
@@ -217,14 +253,13 @@ function getEntryPointsForPaths(
}
}
- const suggestion = isDir(fileOrDir)
- ? " If you wanted to include files inside this directory, set --entryPointStrategy to expand or specify a glob."
- : "";
logger.warn(
- `The entry point ${nicePath(
- fileOrDir,
- )} is not referenced by the 'files' or 'include' option in your tsconfig.${suggestion}`,
+ logger.i18n.entry_point_0_not_in_program(nicePath(fileOrDir)),
);
+ if (expandSuggestion && isDir(fileOrDir)) {
+ expandSuggestion = false;
+ logger.info(logger.i18n.use_expand_or_glob_for_files_in_dir());
+ }
}
return entryPoints;
@@ -236,9 +271,15 @@ export function getExpandedEntryPointsForPaths(
options: Options,
programs = getEntryPrograms(inputFiles, logger, options),
): DocumentationEntryPoint[] {
+ const compilerOptions = options.getCompilerOptions();
+ const supportedFileRegex =
+ compilerOptions.allowJs || compilerOptions.checkJs
+ ? /\.([cm][tj]s|[tj]sx?)$/
+ : /\.([cm]ts|tsx?)$/;
+
return getEntryPointsForPaths(
logger,
- expandInputFiles(logger, inputFiles, options),
+ expandInputFiles(logger, inputFiles, options, supportedFileRegex),
options,
programs,
);
@@ -260,15 +301,13 @@ function expandGlobs(inputFiles: string[], exclude: string[], logger: Logger) {
if (result.length === 0) {
logger.warn(
- `The entrypoint glob ${nicePath(
- entry,
- )} did not match any files.`,
+ logger.i18n.glob_0_did_not_match_any_files(nicePath(entry)),
);
} else if (filtered.length === 0) {
logger.warn(
- `The entrypoint glob ${nicePath(
- entry,
- )} did not match any files after applying exclude patterns.`,
+ logger.i18n.entry_point_0_did_not_match_any_files_after_exclude(
+ nicePath(entry),
+ ),
);
} else {
logger.verbose(
@@ -344,16 +383,12 @@ function expandInputFiles(
logger: Logger,
entryPoints: string[],
options: Options,
+ supportedFile: RegExp,
): string[] {
const files: string[] = [];
const exclude = createMinimatch(options.getValue("exclude"));
- const compilerOptions = options.getCompilerOptions();
- const supportedFileRegex =
- compilerOptions.allowJs || compilerOptions.checkJs
- ? /\.([cm][tj]s|[tj]sx?)$/
- : /\.([cm]ts|tsx?)$/;
function add(file: string, entryPoint: boolean) {
let stats: FS.Stats;
try {
@@ -371,7 +406,7 @@ function expandInputFiles(
FS.readdirSync(file).forEach((next) => {
add(join(file, next), false);
});
- } else if (supportedFileRegex.test(file)) {
+ } else if (supportedFile.test(file)) {
if (!entryPoint && matchesAny(exclude, file)) {
return;
}
@@ -382,9 +417,7 @@ function expandInputFiles(
entryPoints.forEach((file) => {
const resolved = resolve(file);
if (!FS.existsSync(resolved)) {
- logger.warn(
- `Provided entry point ${file} does not exist and will not be included in the docs.`,
- );
+ logger.warn(logger.i18n.entry_point_0_did_not_exist(file));
return;
}
diff --git a/src/lib/utils/enum.ts b/src/lib/utils/enum.ts
index 5b0ab7c94..798dffab5 100644
--- a/src/lib/utils/enum.ts
+++ b/src/lib/utils/enum.ts
@@ -34,6 +34,6 @@ export function getEnumKeys(Enum: {}): string[] {
return Object.keys(E).filter((k) => E[E[k]] === k);
}
-export type EnumKeys<E extends {}> = keyof {
- [K in keyof E as number extends E[K] ? K : never]: 1;
-};
+export type EnumKeys<E extends {}> = {
+ [K in keyof E]: number extends E[K] ? K : never;
+}[keyof E] & {};
diff --git a/src/lib/utils/events.ts b/src/lib/utils/events.ts
index 102785738..0dcce2fa8 100644
--- a/src/lib/utils/events.ts
+++ b/src/lib/utils/events.ts
@@ -1,672 +1,65 @@
-// Backbone.js 1.2.3
-// (c) 2010-2015 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
-// Backbone may be freely distributed under the MIT license.
-// For all details and documentation:
-// https://backbonejs.org
-//
-// The Events object is a typesafe conversion of Backbones Events object:
-// https://github.com/jashkenas/backbone/blob/05fde9e201f7e2137796663081105cd6dad12a98/backbone.js#L119-L374
-
-// Priority: Higher number makes the listener be called earlier.
-
-const uniqueId = (function () {
- const prefixes: Record<string, number | undefined> = Object.create(null);
- return function (prefix: string) {
- const unique = prefixes[prefix] || 1;
- prefixes[prefix] = unique + 1;
- return `${prefix}${unique}`;
- };
-})();
-
-function once<T extends (..._: any) => any>(cb: T): T {
- let hasRun = false;
- let result: ReturnType<T>;
- return function (this: any, ...args: any) {
- if (hasRun === false) {
- hasRun = true;
- result = cb.apply(this, args);
- }
- return result;
- } as T;
-}
-
-export interface EventCallback extends Function {
- _callback?: Function;
-}
-
-interface EventListener {
- obj: any;
- objId: string;
- id: string;
- listeningTo: EventListeners;
- count: number;
-}
-
-interface EventListeners {
- [id: string]: EventListener;
-}
-
-interface EventHandler {
- callback: EventCallback;
- context: any;
- ctx: any;
- listening: EventListener;
- priority: number;
-}
-
-interface EventHandlers {
- [name: string]: EventHandler[];
-}
-
-export interface EventMap {
- [name: string]: EventCallback;
-}
-
-interface EventIteratee<T, U> {
- (events: U, name: string, callback: Function | undefined, options: T): U;
-}
-
-interface EventTriggerer {
- (events: EventHandler[], args: any[]): void;
-}
-
-interface OnApiOptions {
- context: any;
- ctx: any;
- listening: any;
- priority: number;
-}
-
-interface OffApiOptions {
- context: any;
- listeners: any;
-}
-
-// Regular expression used to split event strings.
-const eventSplitter = /\s+/;
-
-/**
- * Iterates over the standard `event, callback` (as well as the fancy multiple
- * space-separated events `"change blur", callback` and jQuery-style event
- * maps `{event: callback}`).
- */
-function eventsApi<T extends {}, U>(
- iteratee: EventIteratee<T, U>,
- events: U,
- name: EventMap | string | undefined,
- callback: EventCallback | undefined,
- options: T,
-): U {
- let i = 0,
- names: string[];
-
- const anyOptions = options as any;
-
- if (name && typeof name === "object") {
- // Handle event maps.
- if (
- callback !== void 0 &&
- "context" in options &&
- anyOptions["context"] === void 0
- ) {
- anyOptions["context"] = callback;
- }
-
- for (names = Object.keys(name); i < names.length; i++) {
- events = eventsApi(
- iteratee,
- events,
- names[i],
- name[names[i]],
- options,
- );
- }
- } else if (name && typeof name === "string" && eventSplitter.test(name)) {
- // Handle space separated event names by delegating them individually.
- for (names = name.split(eventSplitter); i < names.length; i++) {
- events = iteratee(events, names[i], callback, options);
- }
- } else {
- // Finally, standard events.
- events = iteratee(events, <any>name, callback, options);
- }
-
- return events;
-}
-
-/**
- * The reducing API that adds a callback to the `events` object.
- */
-function onApi(
- events: EventHandlers,
- name: string,
- callback: EventCallback | undefined,
- options: OnApiOptions,
-): EventHandlers {
- if (callback) {
- const handlers = (events[name] ||= []);
- const context = options.context,
- ctx = options.ctx,
- listening = options.listening,
- priority = options.priority;
- if (listening) {
- listening.count++;
- }
-
- handlers.push({
- callback: callback,
- context: context,
- ctx: context || ctx,
- listening: listening,
- priority: priority,
- });
-
- handlers.sort((a, b) => b.priority - a.priority);
- }
-
- return events;
-}
+import { insertPrioritySorted } from "./array";
/**
- * The reducing API that removes a callback from the `events` object.
- */
-function offApi(
- events: EventHandlers | undefined,
- name: string,
- callback: EventCallback | undefined,
- options: OffApiOptions,
-): EventHandlers | undefined {
- if (!events) {
- return;
- }
-
- let i = 0,
- listening: EventListener;
- const context = options.context,
- listeners = options.listeners;
-
- // Delete all events listeners and "drop" events.
- if (!name && !callback && !context) {
- const ids = Object.keys(listeners || {});
- for (; i < ids.length; i++) {
- listening = listeners[ids[i]];
- delete listeners[listening.id];
- delete listening.listeningTo[listening.objId];
- }
- return;
- }
-
- const names = name ? [name] : Object.keys(events || {});
- for (; i < names.length; i++) {
- name = names[i];
- const handlers = events[name];
-
- // Bail out if there are no events stored.
- if (!handlers) {
- break;
- }
-
- // Replace events if there are any remaining. Otherwise, clean up.
- const remaining: EventHandler[] = [];
- for (let j = 0; j < handlers.length; j++) {
- const handler = handlers[j];
- if (
- (callback &&
- callback !== handler.callback &&
- callback !== handler.callback._callback) ||
- (context && context !== handler.context)
- ) {
- remaining.push(handler);
- } else {
- listening = handler.listening;
- if (listening && --listening.count === 0) {
- delete listeners[listening.id];
- delete listening.listeningTo[listening.objId];
- }
- }
- }
-
- // Update tail event if the list has any events. Otherwise, clean up.
- if (remaining.length) {
- events[name] = remaining;
- } else {
- delete events[name];
- }
- }
-
- if (Object.keys(events || {}).length !== 0) {
- return events;
- }
-}
-
-/**
- * Reduces the event callbacks into a map of `{event: onceWrapper`.}
- * `offer` unbinds the `onceWrapper` after it has been called.
- */
-function onceMap(
- map: EventMap,
- name: string,
- callback: EventCallback | undefined,
- offer: Function,
-): EventMap {
- if (callback) {
- const listener: EventCallback = (map[name] = once(function (
- this: any,
- ...args: any
- ) {
- offer(name, listener);
- callback.apply(this, args);
- }));
-
- listener._callback = callback;
- }
-
- return map;
-}
-
-/**
- * Handles triggering the appropriate event callbacks.
- */
-function triggerApi(
- objEvents: EventHandlers,
- name: string,
- _callback: Function | undefined,
- args: any[],
- triggerer: EventTriggerer = triggerEvents,
-): EventHandlers {
- if (objEvents) {
- const events = objEvents[name];
- let allEvents = objEvents["all"];
- if (events && allEvents) {
- allEvents = allEvents.slice();
- }
- if (events) {
- triggerer(events, args);
- }
- if (allEvents) {
- triggerer(allEvents, [name].concat(args));
- }
- }
-
- return objEvents;
-}
-
-/**
- * A difficult-to-believe, but optimized internal dispatch function for
- * triggering events. Tries to keep the usual cases speedy (most internal
- * Backbone events have 3 arguments).
- */
-function triggerEvents(events: EventHandler[], args: any[]) {
- let ev: EventHandler,
- i = -1;
- const l = events.length,
- a1 = args[0],
- a2 = args[1],
- a3 = args[2];
- switch (args.length) {
- case 0:
- while (++i < l) {
- (ev = events[i]).callback.call(ev.ctx);
- }
- return;
- case 1:
- while (++i < l) {
- (ev = events[i]).callback.call(ev.ctx, a1);
- }
- return;
- case 2:
- while (++i < l) {
- (ev = events[i]).callback.call(ev.ctx, a1, a2);
- }
- return;
- case 3:
- while (++i < l) {
- (ev = events[i]).callback.call(ev.ctx, a1, a2, a3);
- }
- return;
- default:
- while (++i < l) {
- (ev = events[i]).callback.apply(ev.ctx, args);
- }
- return;
- }
-}
-
-/**
- * An event object.
- */
-export class Event {
- /**
- * The name of the event.
- */
- private _name: string;
-
- /**
- * Has {@link Event.stopPropagation} been called?
- */
- private _isPropagationStopped = false;
-
- /**
- * Has {@link Event.preventDefault} been called?
- */
- private _isDefaultPrevented = false;
-
- /**
- * Create a new Event instance.
- */
- constructor(name: string) {
- this._name = name;
- }
-
- /**
- * Stop the propagation of this event. Remaining event handlers will not be executed.
- */
- stopPropagation() {
- this._isPropagationStopped = true;
- }
-
- /**
- * Prevent the default action associated with this event from being executed.
- */
- preventDefault() {
- this._isDefaultPrevented = true;
- }
-
- /**
- * Return the event name.
- */
- get name(): string {
- return this._name;
- }
-
- /**
- * Has {@link Event.stopPropagation} been called?
- */
- get isPropagationStopped(): boolean {
- return this._isPropagationStopped;
- }
-
- /**
- * Has {@link Event.preventDefault} been called?
- */
- get isDefaultPrevented(): boolean {
- return this._isDefaultPrevented;
- }
-}
-
-/**
- * A class that provides a custom event channel.
+ * Intentionally very simple event emitter.
*
- * You may bind a callback to an event with `on` or remove with `off`;
- * `trigger`-ing an event fires all callbacks in succession.
+ * @privateRemarks
+ * This is essentially a stripped down copy of EventHooks in hooks.ts.
*/
-export class EventDispatcher {
- /**
- * Map of all handlers registered with the "on" function.
- */
- private _events?: EventHandlers;
-
- /**
- * Map of all objects this instance is listening to.
- */
- private _listeningTo?: EventListeners;
-
- /**
- * Map of all objects that are listening to this instance.
- */
- private _listeners?: EventListeners;
-
- /**
- * A unique id that identifies this instance.
- */
- private get _listenId(): string {
- return this._savedListenId || (this._savedListenId = uniqueId("l"));
- }
- private _savedListenId?: string;
-
- /**
- * Bind an event to a `callback` function. Passing `"all"` will bind
- * the callback to all events fired.
- */
- on(eventMap: EventMap, context?: any): this;
- on(
- eventMap: EventMap,
- callback?: EventCallback,
- context?: any,
- priority?: number,
- ): this;
- on(
- name: string,
- callback: EventCallback,
- context?: any,
- priority?: number,
- ): this;
- on(
- nameOrMap: EventMap | string,
- callback: EventCallback,
- context?: any,
- priority?: number,
- ) {
- this.internalOn(nameOrMap, callback, context, priority);
- return this;
- }
-
- /**
- * Guard the `listening` argument from the public API.
- */
- private internalOn(
- name: EventMap | string,
- callback: EventCallback | undefined,
- context?: any,
+export class EventDispatcher<T extends Record<keyof T, unknown[]>> {
+ // Function is *usually* not a good type to use, but here it lets us specify stricter
+ // contracts in the methods while not casting everywhere this is used.
+ private _listeners = new Map<
+ keyof T,
+ {
+ listener: Function;
+ priority: number;
+ }[]
+ >();
+
+ /**
+ * Starts listening to an event.
+ * @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.
+ */
+ on<K extends keyof T>(
+ event: K,
+ listener: (this: undefined, ...args: T[K]) => void,
priority = 0,
- listening?: EventListener,
- ) {
- this._events = eventsApi(
- onApi,
- this._events || <EventHandlers>{},
- name,
- callback,
- {
- context: context,
- ctx: this,
- listening: listening,
- priority: priority,
- },
- );
-
- if (listening) {
- const listeners = this._listeners || (this._listeners = {});
- listeners[listening.id] = listening;
- }
- }
-
- /**
- * Bind an event to only be triggered a single time. After the first time
- * the callback is invoked, its listener will be removed. If multiple events
- * are passed in using the space-separated syntax, the handler will fire
- * once for each event, not once for a combination of all events.
- */
- once(eventMap: EventMap, context?: any): this;
- once(
- name: string,
- callback: EventCallback,
- context?: any,
- priority?: any,
- ): this;
- once(
- name: EventMap | string,
- callback?: EventCallback,
- context?: any,
- priority?: number,
- ) {
- // Map the event into a `{event: once}` object.
- const events = eventsApi(
- onceMap,
- <EventMap>{},
- name,
- callback,
- this.off.bind(this),
- );
- return this.on(events, void 0, context, priority);
- }
-
- /**
- * Remove one or many callbacks. If `context` is null, removes all
- * callbacks with that function. If `callback` is null, removes all
- * callbacks for the event. If `name` is null, removes all bound
- * callbacks for all events.
- */
- off(): this;
- off(eventMap: EventMap | undefined, context?: any): this;
- off(
- name: string | undefined,
- callback?: EventCallback,
- context?: any,
- ): this;
- off(name?: EventMap | string, callback?: EventCallback, context?: any) {
- if (!this._events) {
- return this;
- }
-
- this._events = eventsApi(offApi, this._events, name, callback, {
- context: context,
- listeners: this._listeners,
- });
-
- return this;
- }
-
- /**
- * Inversion-of-control versions of `on`. Tell *this* object to listen to
- * an event in another object... keeping track of what it's listening to
- * for easier unbinding later.
- */
- listenTo(
- obj: EventDispatcher,
- name: EventMap | string,
- callback?: EventCallback,
- priority?: number,
- ) {
- if (!obj) {
- return this;
- }
- const id = obj._listenId;
- const listeningTo = this._listeningTo || (this._listeningTo = {});
- let listening = listeningTo[id];
-
- // This object is not listening to any other events on `obj` yet.
- // Setup the necessary references to track the listening callbacks.
- if (!listening) {
- const thisId = this._listenId;
- listening = listeningTo[id] = {
- obj: obj,
- objId: id,
- id: thisId,
- listeningTo: listeningTo,
- count: 0,
- };
- }
-
- // Bind callbacks on obj, and keep track of them on listening.
- obj.internalOn(name, callback, this, priority, listening);
- return this;
- }
-
- /**
- * Inversion-of-control versions of `once`.
- */
- listenToOnce(obj: EventDispatcher, eventMap: EventMap): this;
- listenToOnce(
- obj: EventDispatcher,
- name: string,
- callback: EventCallback,
- priority?: number,
- ): this;
- listenToOnce(
- obj: EventDispatcher,
- name: EventMap | string,
- callback?: EventCallback,
- priority?: number,
- ) {
- // Map the event into a `{event: once}` object.
- const events = eventsApi(
- onceMap,
- <EventMap>{},
- name,
- callback,
- this.stopListening.bind(this, obj),
- );
- return this.listenTo(obj, events, void 0, priority);
- }
-
- /**
- * Tell this object to stop listening to either specific events ... or
- * to every object it's currently listening to.
- */
- stopListening(
- obj?: EventDispatcher,
- name?: EventMap | string,
- callback?: EventCallback,
- ) {
- const listeningTo = this._listeningTo;
- if (!listeningTo) {
- return this;
- }
-
- const ids = obj ? [obj._listenId] : Object.keys(listeningTo);
- for (let i = 0; i < ids.length; i++) {
- const listening = listeningTo[ids[i]];
-
- // If listening doesn't exist, this object is not currently
- // listening to obj. Break out early.
- if (!listening) {
- break;
+ ): void {
+ const list = (this._listeners.get(event) || []).slice();
+ insertPrioritySorted(list, { listener, priority });
+ this._listeners.set(event, list);
+ }
+
+ /**
+ * Stops listening to an event.
+ * @param event the event to stop listening to.
+ * @param listener the function to remove from the listener array.
+ */
+ off<K extends keyof T>(
+ event: K,
+ listener: (this: undefined, ...args: T[K]) => void,
+ ): void {
+ const listeners = this._listeners.get(event);
+ if (listeners) {
+ const index = listeners.findIndex((lo) => lo.listener === listener);
+ if (index > -1) {
+ listeners.splice(index, 1);
}
-
- listening.obj.off(name, callback, this);
}
-
- if (Object.keys(listeningTo).length === 0) {
- this._listeningTo = void 0;
- }
-
- return this;
}
/**
- * Trigger one or many events, firing all bound callbacks. Callbacks are
- * passed the same arguments as `trigger` is, apart from the event name
- * (unless you're listening on `"all"`, which will cause your callback to
- * receive the true name of the event as the first argument).
+ * Emits an event to all currently subscribed listeners.
+ * @param event the event to emit.
+ * @param args any arguments required for the event.
*/
- trigger(name: Event | EventMap | string, ...args: any[]) {
- if (!this._events) {
- return this;
+ trigger<K extends keyof T>(event: K, ...args: T[K]): void {
+ const listeners = this._listeners.get(event)?.slice() || [];
+ for (const { listener } of listeners) {
+ listener(...args);
}
-
- if (name instanceof Event) {
- triggerApi(
- this._events,
- name.name,
- void 0,
- [name],
- (events: EventHandler[], args: any[]) => {
- let ev: EventHandler,
- i = -1;
- const l = events.length;
- while (++i < l) {
- if (name.isPropagationStopped) {
- return;
- }
- ev = events[i];
- ev.callback.apply(ev.ctx, args);
- }
- },
- );
- } else {
- eventsApi(triggerApi, this._events, name, void 0, args);
- }
-
- return this;
}
}
diff --git a/src/lib/utils/general.ts b/src/lib/utils/general.ts
index 35949f119..7108a4cf1 100644
--- a/src/lib/utils/general.ts
+++ b/src/lib/utils/general.ts
@@ -10,7 +10,7 @@ import * as Util from "util";
type InternalOnly = true;
/**
- * Helper type to convert `T` to `F` if strict mode is on.
+ * Helper type to convert `T` to `F` if compiling TypeDoc with stricter types.
*
* Can be used in overloads to map a parameter type to `never`. For example, the
* following function will work with any string argument, but to improve the type safety
@@ -23,14 +23,15 @@ type InternalOnly = true;
*
* ```ts
* function over(flag: 'a' | 'b'): string
- * function over(flag: IfStrict<string, never>): string
+ * // deprecated
+ * function over(flag: IfInternal<never, string>): string
* function over(flag: string): string { return flag }
* ```
*/
export type IfInternal<T, F> = InternalOnly extends true ? T : F;
/**
- * Helper type to convert `T` to `never` if strict mode is on.
+ * Helper type to convert `T` to `never` if compiling TypeDoc with stricter types.
*
* See {@link IfInternal} for the rationale.
*/
@@ -54,6 +55,13 @@ export function assertNever(x: never): never {
);
}
+export function camelToTitleCase(text: string) {
+ return (
+ text.substring(0, 1).toUpperCase() +
+ text.substring(1).replace(/[a-z][A-Z]/g, (x) => `${x[0]} ${x[1]}`)
+ );
+}
+
export function NonEnumerable(
_cls: unknown,
context: ClassFieldDecoratorContext,
diff --git a/src/lib/utils/highlighter.tsx b/src/lib/utils/highlighter.tsx
index 5dda79043..663b50dcf 100644
--- a/src/lib/utils/highlighter.tsx
+++ b/src/lib/utils/highlighter.tsx
@@ -1,74 +1,69 @@
-import { ok as assert } from "assert";
-import { BUNDLED_LANGUAGES, getHighlighter, Highlighter, Theme } from "shiki";
-import { unique, zip } from "./array";
+import { ok as assert, ok } from "assert";
+import type {
+ BundledLanguage,
+ BundledTheme,
+ Highlighter,
+ TokenStyles,
+} from "shiki" with { "resolution-mode": "import" };
import * as JSX from "./jsx";
+import { unique } from "./array";
const aliases = new Map<string, string>();
-for (const lang of BUNDLED_LANGUAGES) {
- for (const alias of lang.aliases || []) {
- aliases.set(alias, lang.id);
+let supportedLanguagesWithoutAliases: string[] = [];
+let supportedLanguages: string[] = [];
+let supportedThemes: string[] = [];
+
+export async function loadShikiMetadata() {
+ if (aliases.size) return;
+
+ const shiki = await import("shiki");
+ for (const lang of shiki.bundledLanguagesInfo) {
+ for (const alias of lang.aliases || []) {
+ aliases.set(alias, lang.id);
+ }
}
-}
-const supportedLanguages = unique(["text", ...aliases.keys(), ...BUNDLED_LANGUAGES.map((lang) => lang.id)]).sort();
+ supportedLanguages = unique([
+ "text",
+ ...aliases.keys(),
+ ...shiki.bundledLanguagesInfo.map((lang) => lang.id),
+ ]).sort();
+
+ supportedLanguagesWithoutAliases = unique(["text", ...shiki.bundledLanguagesInfo.map((lang) => lang.id)]);
+
+ supportedThemes = Object.keys(shiki.bundledThemes);
+}
class DoubleHighlighter {
private schemes = new Map<string, string>();
constructor(
private highlighter: Highlighter,
- private light: Theme,
- private dark: Theme,
+ private light: BundledTheme,
+ private dark: BundledTheme,
) {}
- highlight(code: string, lang: string) {
- const lightTokens = this.highlighter.codeToThemedTokens(code, lang, this.light, { includeExplanation: false });
- const darkTokens = this.highlighter.codeToThemedTokens(code, lang, this.dark, { includeExplanation: false });
+ supports(lang: string) {
+ return this.highlighter.getLoadedLanguages().includes(lang);
+ }
- // If this fails... something went *very* wrong.
- assert(lightTokens.length === darkTokens.length);
+ highlight(code: string, lang: string) {
+ const tokens = this.highlighter.codeToTokensWithThemes(code, {
+ themes: { light: this.light, dark: this.dark },
+ lang: lang as BundledLanguage,
+ });
const docEls: JSX.Element[] = [];
- for (const [lightLine, darkLine] of zip(lightTokens, darkTokens)) {
- // Different themes can have different rules for when colors change... so unfortunately we have to deal with different
- // sets of tokens.Example: light_plus and dark_plus tokenize " = " differently in the `schemes`
- // declaration for this file.
-
- while (lightLine.length && darkLine.length) {
- // Simple case, same token.
- if (lightLine[0].content === darkLine[0].content) {
- docEls.push(
- <span class={this.getClass(lightLine[0].color, darkLine[0].color)}>
- {lightLine[0].content}
- </span>,
- );
- lightLine.shift();
- darkLine.shift();
- continue;
- }
-
- if (lightLine[0].content.length < darkLine[0].content.length) {
- docEls.push(
- <span class={this.getClass(lightLine[0].color, darkLine[0].color)}>
- {lightLine[0].content}
- </span>,
- );
- darkLine[0].content = darkLine[0].content.substring(lightLine[0].content.length);
- lightLine.shift();
- continue;
- }
-
- docEls.push(
- <span class={this.getClass(lightLine[0].color, darkLine[0].color)}>{darkLine[0].content}</span>,
- );
- lightLine[0].content = lightLine[0].content.substring(darkLine[0].content.length);
- darkLine.shift();
+ for (const line of tokens) {
+ for (const token of line) {
+ docEls.push(<span class={this.getClass(token.variants)}>{token.content}</span>);
}
docEls.push(<br />);
}
+ docEls.pop(); // Remove last <br>
docEls.pop(); // Remove last <br>
return JSX.renderElement(<>{docEls}</>);
@@ -121,8 +116,8 @@ class DoubleHighlighter {
return style.join("\n");
}
- private getClass(lightColor?: string, darkColor?: string): string {
- const key = `${lightColor} | ${darkColor}`;
+ private getClass(variants: Record<string, TokenStyles>): string {
+ const key = `${variants["light"].color} | ${variants["dark"].color}`;
let scheme = this.schemes.get(key);
if (scheme == null) {
scheme = `hl-${this.schemes.size}`;
@@ -134,9 +129,11 @@ class DoubleHighlighter {
let highlighter: DoubleHighlighter | undefined;
-export async function loadHighlighter(lightTheme: Theme, darkTheme: Theme) {
+export async function loadHighlighter(lightTheme: BundledTheme, darkTheme: BundledTheme, langs: BundledLanguage[]) {
if (highlighter) return;
- const hl = await getHighlighter({ themes: [lightTheme, darkTheme] });
+
+ const shiki = await import("shiki");
+ const hl = await shiki.createHighlighter({ themes: [lightTheme, darkTheme], langs });
highlighter = new DoubleHighlighter(hl, lightTheme, darkTheme);
}
@@ -145,14 +142,26 @@ export function isSupportedLanguage(lang: string) {
}
export function getSupportedLanguages(): string[] {
+ ok(supportedLanguages.length > 0, "loadShikiMetadata has not been called");
+ return supportedLanguages;
+}
+
+export function getSupportedLanguagesWithoutAliases(): string[] {
+ ok(supportedLanguagesWithoutAliases.length > 0, "loadShikiMetadata has not been called");
return supportedLanguages;
}
+export function getSupportedThemes(): string[] {
+ ok(supportedThemes.length > 0, "loadShikiMetadata has not been called");
+ return supportedThemes;
+}
+
+export function isLoadedLanguage(lang: string): boolean {
+ return lang === "text" || (highlighter?.supports(lang) ?? false);
+}
+
export function highlight(code: string, lang: string): string {
assert(highlighter, "Tried to highlight with an uninitialized highlighter");
- if (!isSupportedLanguage(lang)) {
- return code;
- }
if (lang === "text") {
return JSX.renderElement(<>{code}</>);
diff --git a/src/lib/utils/html-entities.json b/src/lib/utils/html-entities.json
index 4715c8fb4..de089ea6a 100644
--- a/src/lib/utils/html-entities.json
+++ b/src/lib/utils/html-entities.json
@@ -1,2233 +1,2326 @@
{
- "AElig": "\u00C6",
- "AElig;": "\u00C6",
- "AMP": "\u0026",
- "AMP;": "\u0026",
- "Aacute": "\u00C1",
- "Aacute;": "\u00C1",
- "Abreve;": "\u0102",
- "Acirc": "\u00C2",
- "Acirc;": "\u00C2",
- "Acy;": "\u0410",
- "Afr;": "\uD835\uDD04",
- "Agrave": "\u00C0",
- "Agrave;": "\u00C0",
- "Alpha;": "\u0391",
- "Amacr;": "\u0100",
- "And;": "\u2A53",
- "Aogon;": "\u0104",
- "Aopf;": "\uD835\uDD38",
- "ApplyFunction;": "\u2061",
- "Aring": "\u00C5",
- "Aring;": "\u00C5",
- "Ascr;": "\uD835\uDC9C",
- "Assign;": "\u2254",
- "Atilde": "\u00C3",
- "Atilde;": "\u00C3",
- "Auml": "\u00C4",
- "Auml;": "\u00C4",
- "Backslash;": "\u2216",
- "Barv;": "\u2AE7",
- "Barwed;": "\u2306",
- "Bcy;": "\u0411",
- "Because;": "\u2235",
- "Bernoullis;": "\u212C",
- "Beta;": "\u0392",
- "Bfr;": "\uD835\uDD05",
- "Bopf;": "\uD835\uDD39",
- "Breve;": "\u02D8",
- "Bscr;": "\u212C",
- "Bumpeq;": "\u224E",
- "CHcy;": "\u0427",
- "COPY": "\u00A9",
- "COPY;": "\u00A9",
- "Cacute;": "\u0106",
- "Cap;": "\u22D2",
- "CapitalDifferentialD;": "\u2145",
- "Cayleys;": "\u212D",
- "Ccaron;": "\u010C",
- "Ccedil": "\u00C7",
- "Ccedil;": "\u00C7",
- "Ccirc;": "\u0108",
- "Cconint;": "\u2230",
- "Cdot;": "\u010A",
- "Cedilla;": "\u00B8",
- "CenterDot;": "\u00B7",
- "Cfr;": "\u212D",
- "Chi;": "\u03A7",
- "CircleDot;": "\u2299",
- "CircleMinus;": "\u2296",
- "CirclePlus;": "\u2295",
- "CircleTimes;": "\u2297",
- "ClockwiseContourIntegral;": "\u2232",
- "CloseCurlyDoubleQuote;": "\u201D",
- "CloseCurlyQuote;": "\u2019",
- "Colon;": "\u2237",
- "Colone;": "\u2A74",
- "Congruent;": "\u2261",
- "Conint;": "\u222F",
- "ContourIntegral;": "\u222E",
- "Copf;": "\u2102",
- "Coproduct;": "\u2210",
- "CounterClockwiseContourIntegral;": "\u2233",
- "Cross;": "\u2A2F",
- "Cscr;": "\uD835\uDC9E",
- "Cup;": "\u22D3",
- "CupCap;": "\u224D",
- "DD;": "\u2145",
- "DDotrahd;": "\u2911",
- "DJcy;": "\u0402",
- "DScy;": "\u0405",
- "DZcy;": "\u040F",
- "Dagger;": "\u2021",
- "Darr;": "\u21A1",
- "Dashv;": "\u2AE4",
- "Dcaron;": "\u010E",
- "Dcy;": "\u0414",
- "Del;": "\u2207",
- "Delta;": "\u0394",
- "Dfr;": "\uD835\uDD07",
- "DiacriticalAcute;": "\u00B4",
- "DiacriticalDot;": "\u02D9",
- "DiacriticalDoubleAcute;": "\u02DD",
- "DiacriticalGrave;": "\u0060",
- "DiacriticalTilde;": "\u02DC",
- "Diamond;": "\u22C4",
- "DifferentialD;": "\u2146",
- "Dopf;": "\uD835\uDD3B",
- "Dot;": "\u00A8",
- "DotDot;": "\u20DC",
- "DotEqual;": "\u2250",
- "DoubleContourIntegral;": "\u222F",
- "DoubleDot;": "\u00A8",
- "DoubleDownArrow;": "\u21D3",
- "DoubleLeftArrow;": "\u21D0",
- "DoubleLeftRightArrow;": "\u21D4",
- "DoubleLeftTee;": "\u2AE4",
- "DoubleLongLeftArrow;": "\u27F8",
- "DoubleLongLeftRightArrow;": "\u27FA",
- "DoubleLongRightArrow;": "\u27F9",
- "DoubleRightArrow;": "\u21D2",
- "DoubleRightTee;": "\u22A8",
- "DoubleUpArrow;": "\u21D1",
- "DoubleUpDownArrow;": "\u21D5",
- "DoubleVerticalBar;": "\u2225",
- "DownArrow;": "\u2193",
- "DownArrowBar;": "\u2913",
- "DownArrowUpArrow;": "\u21F5",
- "DownBreve;": "\u0311",
- "DownLeftRightVector;": "\u2950",
- "DownLeftTeeVector;": "\u295E",
- "DownLeftVector;": "\u21BD",
- "DownLeftVectorBar;": "\u2956",
- "DownRightTeeVector;": "\u295F",
- "DownRightVector;": "\u21C1",
- "DownRightVectorBar;": "\u2957",
- "DownTee;": "\u22A4",
- "DownTeeArrow;": "\u21A7",
- "Downarrow;": "\u21D3",
- "Dscr;": "\uD835\uDC9F",
- "Dstrok;": "\u0110",
- "ENG;": "\u014A",
- "ETH": "\u00D0",
- "ETH;": "\u00D0",
- "Eacute": "\u00C9",
- "Eacute;": "\u00C9",
- "Ecaron;": "\u011A",
- "Ecirc": "\u00CA",
- "Ecirc;": "\u00CA",
- "Ecy;": "\u042D",
- "Edot;": "\u0116",
- "Efr;": "\uD835\uDD08",
- "Egrave": "\u00C8",
- "Egrave;": "\u00C8",
- "Element;": "\u2208",
- "Emacr;": "\u0112",
- "EmptySmallSquare;": "\u25FB",
- "EmptyVerySmallSquare;": "\u25AB",
- "Eogon;": "\u0118",
- "Eopf;": "\uD835\uDD3C",
- "Epsilon;": "\u0395",
- "Equal;": "\u2A75",
- "EqualTilde;": "\u2242",
- "Equilibrium;": "\u21CC",
- "Escr;": "\u2130",
- "Esim;": "\u2A73",
- "Eta;": "\u0397",
- "Euml": "\u00CB",
- "Euml;": "\u00CB",
- "Exists;": "\u2203",
- "ExponentialE;": "\u2147",
- "Fcy;": "\u0424",
- "Ffr;": "\uD835\uDD09",
- "FilledSmallSquare;": "\u25FC",
- "FilledVerySmallSquare;": "\u25AA",
- "Fopf;": "\uD835\uDD3D",
- "ForAll;": "\u2200",
- "Fouriertrf;": "\u2131",
- "Fscr;": "\u2131",
- "GJcy;": "\u0403",
- "GT": "\u003E",
- "GT;": "\u003E",
- "Gamma;": "\u0393",
- "Gammad;": "\u03DC",
- "Gbreve;": "\u011E",
- "Gcedil;": "\u0122",
- "Gcirc;": "\u011C",
- "Gcy;": "\u0413",
- "Gdot;": "\u0120",
- "Gfr;": "\uD835\uDD0A",
- "Gg;": "\u22D9",
- "Gopf;": "\uD835\uDD3E",
- "GreaterEqual;": "\u2265",
- "GreaterEqualLess;": "\u22DB",
- "GreaterFullEqual;": "\u2267",
- "GreaterGreater;": "\u2AA2",
- "GreaterLess;": "\u2277",
- "GreaterSlantEqual;": "\u2A7E",
- "GreaterTilde;": "\u2273",
- "Gscr;": "\uD835\uDCA2",
- "Gt;": "\u226B",
- "HARDcy;": "\u042A",
- "Hacek;": "\u02C7",
- "Hat;": "\u005E",
- "Hcirc;": "\u0124",
- "Hfr;": "\u210C",
- "HilbertSpace;": "\u210B",
- "Hopf;": "\u210D",
- "HorizontalLine;": "\u2500",
- "Hscr;": "\u210B",
- "Hstrok;": "\u0126",
- "HumpDownHump;": "\u224E",
- "HumpEqual;": "\u224F",
- "IEcy;": "\u0415",
- "IJlig;": "\u0132",
- "IOcy;": "\u0401",
- "Iacute": "\u00CD",
- "Iacute;": "\u00CD",
- "Icirc": "\u00CE",
- "Icirc;": "\u00CE",
- "Icy;": "\u0418",
- "Idot;": "\u0130",
- "Ifr;": "\u2111",
- "Igrave": "\u00CC",
- "Igrave;": "\u00CC",
- "Im;": "\u2111",
- "Imacr;": "\u012A",
- "ImaginaryI;": "\u2148",
- "Implies;": "\u21D2",
- "Int;": "\u222C",
- "Integral;": "\u222B",
- "Intersection;": "\u22C2",
- "InvisibleComma;": "\u2063",
- "InvisibleTimes;": "\u2062",
- "Iogon;": "\u012E",
- "Iopf;": "\uD835\uDD40",
- "Iota;": "\u0399",
- "Iscr;": "\u2110",
- "Itilde;": "\u0128",
- "Iukcy;": "\u0406",
- "Iuml": "\u00CF",
- "Iuml;": "\u00CF",
- "Jcirc;": "\u0134",
- "Jcy;": "\u0419",
- "Jfr;": "\uD835\uDD0D",
- "Jopf;": "\uD835\uDD41",
- "Jscr;": "\uD835\uDCA5",
- "Jsercy;": "\u0408",
- "Jukcy;": "\u0404",
- "KHcy;": "\u0425",
- "KJcy;": "\u040C",
- "Kappa;": "\u039A",
- "Kcedil;": "\u0136",
- "Kcy;": "\u041A",
- "Kfr;": "\uD835\uDD0E",
- "Kopf;": "\uD835\uDD42",
- "Kscr;": "\uD835\uDCA6",
- "LJcy;": "\u0409",
- "LT": "\u003C",
- "LT;": "\u003C",
- "Lacute;": "\u0139",
- "Lambda;": "\u039B",
- "Lang;": "\u27EA",
- "Laplacetrf;": "\u2112",
- "Larr;": "\u219E",
- "Lcaron;": "\u013D",
- "Lcedil;": "\u013B",
- "Lcy;": "\u041B",
- "LeftAngleBracket;": "\u27E8",
- "LeftArrow;": "\u2190",
- "LeftArrowBar;": "\u21E4",
- "LeftArrowRightArrow;": "\u21C6",
- "LeftCeiling;": "\u2308",
- "LeftDoubleBracket;": "\u27E6",
- "LeftDownTeeVector;": "\u2961",
- "LeftDownVector;": "\u21C3",
- "LeftDownVectorBar;": "\u2959",
- "LeftFloor;": "\u230A",
- "LeftRightArrow;": "\u2194",
- "LeftRightVector;": "\u294E",
- "LeftTee;": "\u22A3",
- "LeftTeeArrow;": "\u21A4",
- "LeftTeeVector;": "\u295A",
- "LeftTriangle;": "\u22B2",
- "LeftTriangleBar;": "\u29CF",
- "LeftTriangleEqual;": "\u22B4",
- "LeftUpDownVector;": "\u2951",
- "LeftUpTeeVector;": "\u2960",
- "LeftUpVector;": "\u21BF",
- "LeftUpVectorBar;": "\u2958",
- "LeftVector;": "\u21BC",
- "LeftVectorBar;": "\u2952",
- "Leftarrow;": "\u21D0",
- "Leftrightarrow;": "\u21D4",
- "LessEqualGreater;": "\u22DA",
- "LessFullEqual;": "\u2266",
- "LessGreater;": "\u2276",
- "LessLess;": "\u2AA1",
- "LessSlantEqual;": "\u2A7D",
- "LessTilde;": "\u2272",
- "Lfr;": "\uD835\uDD0F",
- "Ll;": "\u22D8",
- "Lleftarrow;": "\u21DA",
- "Lmidot;": "\u013F",
- "LongLeftArrow;": "\u27F5",
- "LongLeftRightArrow;": "\u27F7",
- "LongRightArrow;": "\u27F6",
- "Longleftarrow;": "\u27F8",
- "Longleftrightarrow;": "\u27FA",
- "Longrightarrow;": "\u27F9",
- "Lopf;": "\uD835\uDD43",
- "LowerLeftArrow;": "\u2199",
- "LowerRightArrow;": "\u2198",
- "Lscr;": "\u2112",
- "Lsh;": "\u21B0",
- "Lstrok;": "\u0141",
- "Lt;": "\u226A",
- "Map;": "\u2905",
- "Mcy;": "\u041C",
- "MediumSpace;": "\u205F",
- "Mellintrf;": "\u2133",
- "Mfr;": "\uD835\uDD10",
- "MinusPlus;": "\u2213",
- "Mopf;": "\uD835\uDD44",
- "Mscr;": "\u2133",
- "Mu;": "\u039C",
- "NJcy;": "\u040A",
- "Nacute;": "\u0143",
- "Ncaron;": "\u0147",
- "Ncedil;": "\u0145",
- "Ncy;": "\u041D",
- "NegativeMediumSpace;": "\u200B",
- "NegativeThickSpace;": "\u200B",
- "NegativeThinSpace;": "\u200B",
- "NegativeVeryThinSpace;": "\u200B",
- "NestedGreaterGreater;": "\u226B",
- "NestedLessLess;": "\u226A",
- "NewLine;": "\u000A",
- "Nfr;": "\uD835\uDD11",
- "NoBreak;": "\u2060",
- "NonBreakingSpace;": "\u00A0",
- "Nopf;": "\u2115",
- "Not;": "\u2AEC",
- "NotCongruent;": "\u2262",
- "NotCupCap;": "\u226D",
- "NotDoubleVerticalBar;": "\u2226",
- "NotElement;": "\u2209",
- "NotEqual;": "\u2260",
- "NotEqualTilde;": "\u2242\u0338",
- "NotExists;": "\u2204",
- "NotGreater;": "\u226F",
- "NotGreaterEqual;": "\u2271",
- "NotGreaterFullEqual;": "\u2267\u0338",
- "NotGreaterGreater;": "\u226B\u0338",
- "NotGreaterLess;": "\u2279",
- "NotGreaterSlantEqual;": "\u2A7E\u0338",
- "NotGreaterTilde;": "\u2275",
- "NotHumpDownHump;": "\u224E\u0338",
- "NotHumpEqual;": "\u224F\u0338",
- "NotLeftTriangle;": "\u22EA",
- "NotLeftTriangleBar;": "\u29CF\u0338",
- "NotLeftTriangleEqual;": "\u22EC",
- "NotLess;": "\u226E",
- "NotLessEqual;": "\u2270",
- "NotLessGreater;": "\u2278",
- "NotLessLess;": "\u226A\u0338",
- "NotLessSlantEqual;": "\u2A7D\u0338",
- "NotLessTilde;": "\u2274",
- "NotNestedGreaterGreater;": "\u2AA2\u0338",
- "NotNestedLessLess;": "\u2AA1\u0338",
- "NotPrecedes;": "\u2280",
- "NotPrecedesEqual;": "\u2AAF\u0338",
- "NotPrecedesSlantEqual;": "\u22E0",
- "NotReverseElement;": "\u220C",
- "NotRightTriangle;": "\u22EB",
- "NotRightTriangleBar;": "\u29D0\u0338",
- "NotRightTriangleEqual;": "\u22ED",
- "NotSquareSubset;": "\u228F\u0338",
- "NotSquareSubsetEqual;": "\u22E2",
- "NotSquareSuperset;": "\u2290\u0338",
- "NotSquareSupersetEqual;": "\u22E3",
- "NotSubset;": "\u2282\u20D2",
- "NotSubsetEqual;": "\u2288",
- "NotSucceeds;": "\u2281",
- "NotSucceedsEqual;": "\u2AB0\u0338",
- "NotSucceedsSlantEqual;": "\u22E1",
- "NotSucceedsTilde;": "\u227F\u0338",
- "NotSuperset;": "\u2283\u20D2",
- "NotSupersetEqual;": "\u2289",
- "NotTilde;": "\u2241",
- "NotTildeEqual;": "\u2244",
- "NotTildeFullEqual;": "\u2247",
- "NotTildeTilde;": "\u2249",
- "NotVerticalBar;": "\u2224",
- "Nscr;": "\uD835\uDCA9",
- "Ntilde": "\u00D1",
- "Ntilde;": "\u00D1",
- "Nu;": "\u039D",
- "OElig;": "\u0152",
- "Oacute": "\u00D3",
- "Oacute;": "\u00D3",
- "Ocirc": "\u00D4",
- "Ocirc;": "\u00D4",
- "Ocy;": "\u041E",
- "Odblac;": "\u0150",
- "Ofr;": "\uD835\uDD12",
- "Ograve": "\u00D2",
- "Ograve;": "\u00D2",
- "Omacr;": "\u014C",
- "Omega;": "\u03A9",
- "Omicron;": "\u039F",
- "Oopf;": "\uD835\uDD46",
- "OpenCurlyDoubleQuote;": "\u201C",
- "OpenCurlyQuote;": "\u2018",
- "Or;": "\u2A54",
- "Oscr;": "\uD835\uDCAA",
- "Oslash": "\u00D8",
- "Oslash;": "\u00D8",
- "Otilde": "\u00D5",
- "Otilde;": "\u00D5",
- "Otimes;": "\u2A37",
- "Ouml": "\u00D6",
- "Ouml;": "\u00D6",
- "OverBar;": "\u203E",
- "OverBrace;": "\u23DE",
- "OverBracket;": "\u23B4",
- "OverParenthesis;": "\u23DC",
- "PartialD;": "\u2202",
- "Pcy;": "\u041F",
- "Pfr;": "\uD835\uDD13",
- "Phi;": "\u03A6",
- "Pi;": "\u03A0",
- "PlusMinus;": "\u00B1",
- "Poincareplane;": "\u210C",
- "Popf;": "\u2119",
- "Pr;": "\u2ABB",
- "Precedes;": "\u227A",
- "PrecedesEqual;": "\u2AAF",
- "PrecedesSlantEqual;": "\u227C",
- "PrecedesTilde;": "\u227E",
- "Prime;": "\u2033",
- "Product;": "\u220F",
- "Proportion;": "\u2237",
- "Proportional;": "\u221D",
- "Pscr;": "\uD835\uDCAB",
- "Psi;": "\u03A8",
- "QUOT": "\u0022",
- "QUOT;": "\u0022",
- "Qfr;": "\uD835\uDD14",
- "Qopf;": "\u211A",
- "Qscr;": "\uD835\uDCAC",
- "RBarr;": "\u2910",
- "REG": "\u00AE",
- "REG;": "\u00AE",
- "Racute;": "\u0154",
- "Rang;": "\u27EB",
- "Rarr;": "\u21A0",
- "Rarrtl;": "\u2916",
- "Rcaron;": "\u0158",
- "Rcedil;": "\u0156",
- "Rcy;": "\u0420",
- "Re;": "\u211C",
- "ReverseElement;": "\u220B",
- "ReverseEquilibrium;": "\u21CB",
- "ReverseUpEquilibrium;": "\u296F",
- "Rfr;": "\u211C",
- "Rho;": "\u03A1",
- "RightAngleBracket;": "\u27E9",
- "RightArrow;": "\u2192",
- "RightArrowBar;": "\u21E5",
- "RightArrowLeftArrow;": "\u21C4",
- "RightCeiling;": "\u2309",
- "RightDoubleBracket;": "\u27E7",
- "RightDownTeeVector;": "\u295D",
- "RightDownVector;": "\u21C2",
- "RightDownVectorBar;": "\u2955",
- "RightFloor;": "\u230B",
- "RightTee;": "\u22A2",
- "RightTeeArrow;": "\u21A6",
- "RightTeeVector;": "\u295B",
- "RightTriangle;": "\u22B3",
- "RightTriangleBar;": "\u29D0",
- "RightTriangleEqual;": "\u22B5",
- "RightUpDownVector;": "\u294F",
- "RightUpTeeVector;": "\u295C",
- "RightUpVector;": "\u21BE",
- "RightUpVectorBar;": "\u2954",
- "RightVector;": "\u21C0",
- "RightVectorBar;": "\u2953",
- "Rightarrow;": "\u21D2",
- "Ropf;": "\u211D",
- "RoundImplies;": "\u2970",
- "Rrightarrow;": "\u21DB",
- "Rscr;": "\u211B",
- "Rsh;": "\u21B1",
- "RuleDelayed;": "\u29F4",
- "SHCHcy;": "\u0429",
- "SHcy;": "\u0428",
- "SOFTcy;": "\u042C",
- "Sacute;": "\u015A",
- "Sc;": "\u2ABC",
- "Scaron;": "\u0160",
- "Scedil;": "\u015E",
- "Scirc;": "\u015C",
- "Scy;": "\u0421",
- "Sfr;": "\uD835\uDD16",
- "ShortDownArrow;": "\u2193",
- "ShortLeftArrow;": "\u2190",
- "ShortRightArrow;": "\u2192",
- "ShortUpArrow;": "\u2191",
- "Sigma;": "\u03A3",
- "SmallCircle;": "\u2218",
- "Sopf;": "\uD835\uDD4A",
- "Sqrt;": "\u221A",
- "Square;": "\u25A1",
- "SquareIntersection;": "\u2293",
- "SquareSubset;": "\u228F",
- "SquareSubsetEqual;": "\u2291",
- "SquareSuperset;": "\u2290",
- "SquareSupersetEqual;": "\u2292",
- "SquareUnion;": "\u2294",
- "Sscr;": "\uD835\uDCAE",
- "Star;": "\u22C6",
- "Sub;": "\u22D0",
- "Subset;": "\u22D0",
- "SubsetEqual;": "\u2286",
- "Succeeds;": "\u227B",
- "SucceedsEqual;": "\u2AB0",
- "SucceedsSlantEqual;": "\u227D",
- "SucceedsTilde;": "\u227F",
- "SuchThat;": "\u220B",
- "Sum;": "\u2211",
- "Sup;": "\u22D1",
- "Superset;": "\u2283",
- "SupersetEqual;": "\u2287",
- "Supset;": "\u22D1",
- "THORN": "\u00DE",
- "THORN;": "\u00DE",
- "TRADE;": "\u2122",
- "TSHcy;": "\u040B",
- "TScy;": "\u0426",
- "Tab;": "\u0009",
- "Tau;": "\u03A4",
- "Tcaron;": "\u0164",
- "Tcedil;": "\u0162",
- "Tcy;": "\u0422",
- "Tfr;": "\uD835\uDD17",
- "Therefore;": "\u2234",
- "Theta;": "\u0398",
- "ThickSpace;": "\u205F\u200A",
- "ThinSpace;": "\u2009",
- "Tilde;": "\u223C",
- "TildeEqual;": "\u2243",
- "TildeFullEqual;": "\u2245",
- "TildeTilde;": "\u2248",
- "Topf;": "\uD835\uDD4B",
- "TripleDot;": "\u20DB",
- "Tscr;": "\uD835\uDCAF",
- "Tstrok;": "\u0166",
- "Uacute": "\u00DA",
- "Uacute;": "\u00DA",
- "Uarr;": "\u219F",
- "Uarrocir;": "\u2949",
- "Ubrcy;": "\u040E",
- "Ubreve;": "\u016C",
- "Ucirc": "\u00DB",
- "Ucirc;": "\u00DB",
- "Ucy;": "\u0423",
- "Udblac;": "\u0170",
- "Ufr;": "\uD835\uDD18",
- "Ugrave": "\u00D9",
- "Ugrave;": "\u00D9",
- "Umacr;": "\u016A",
- "UnderBar;": "\u005F",
- "UnderBrace;": "\u23DF",
- "UnderBracket;": "\u23B5",
- "UnderParenthesis;": "\u23DD",
- "Union;": "\u22C3",
- "UnionPlus;": "\u228E",
- "Uogon;": "\u0172",
- "Uopf;": "\uD835\uDD4C",
- "UpArrow;": "\u2191",
- "UpArrowBar;": "\u2912",
- "UpArrowDownArrow;": "\u21C5",
- "UpDownArrow;": "\u2195",
- "UpEquilibrium;": "\u296E",
- "UpTee;": "\u22A5",
- "UpTeeArrow;": "\u21A5",
- "Uparrow;": "\u21D1",
- "Updownarrow;": "\u21D5",
- "UpperLeftArrow;": "\u2196",
- "UpperRightArrow;": "\u2197",
- "Upsi;": "\u03D2",
- "Upsilon;": "\u03A5",
- "Uring;": "\u016E",
- "Uscr;": "\uD835\uDCB0",
- "Utilde;": "\u0168",
- "Uuml": "\u00DC",
- "Uuml;": "\u00DC",
- "VDash;": "\u22AB",
- "Vbar;": "\u2AEB",
- "Vcy;": "\u0412",
- "Vdash;": "\u22A9",
- "Vdashl;": "\u2AE6",
- "Vee;": "\u22C1",
- "Verbar;": "\u2016",
- "Vert;": "\u2016",
- "VerticalBar;": "\u2223",
- "VerticalLine;": "\u007C",
- "VerticalSeparator;": "\u2758",
- "VerticalTilde;": "\u2240",
- "VeryThinSpace;": "\u200A",
- "Vfr;": "\uD835\uDD19",
- "Vopf;": "\uD835\uDD4D",
- "Vscr;": "\uD835\uDCB1",
- "Vvdash;": "\u22AA",
- "Wcirc;": "\u0174",
- "Wedge;": "\u22C0",
- "Wfr;": "\uD835\uDD1A",
- "Wopf;": "\uD835\uDD4E",
- "Wscr;": "\uD835\uDCB2",
- "Xfr;": "\uD835\uDD1B",
- "Xi;": "\u039E",
- "Xopf;": "\uD835\uDD4F",
- "Xscr;": "\uD835\uDCB3",
- "YAcy;": "\u042F",
- "YIcy;": "\u0407",
- "YUcy;": "\u042E",
- "Yacute": "\u00DD",
- "Yacute;": "\u00DD",
- "Ycirc;": "\u0176",
- "Ycy;": "\u042B",
- "Yfr;": "\uD835\uDD1C",
- "Yopf;": "\uD835\uDD50",
- "Yscr;": "\uD835\uDCB4",
- "Yuml;": "\u0178",
- "ZHcy;": "\u0416",
- "Zacute;": "\u0179",
- "Zcaron;": "\u017D",
- "Zcy;": "\u0417",
- "Zdot;": "\u017B",
- "ZeroWidthSpace;": "\u200B",
- "Zeta;": "\u0396",
- "Zfr;": "\u2128",
- "Zopf;": "\u2124",
- "Zscr;": "\uD835\uDCB5",
- "aacute": "\u00E1",
- "aacute;": "\u00E1",
- "abreve;": "\u0103",
- "ac;": "\u223E",
- "acE;": "\u223E\u0333",
- "acd;": "\u223F",
- "acirc": "\u00E2",
- "acirc;": "\u00E2",
- "acute": "\u00B4",
- "acute;": "\u00B4",
- "acy;": "\u0430",
- "aelig": "\u00E6",
- "aelig;": "\u00E6",
- "af;": "\u2061",
- "afr;": "\uD835\uDD1E",
- "agrave": "\u00E0",
- "agrave;": "\u00E0",
- "alefsym;": "\u2135",
- "aleph;": "\u2135",
- "alpha;": "\u03B1",
- "amacr;": "\u0101",
- "amalg;": "\u2A3F",
- "amp": "\u0026",
- "amp;": "\u0026",
- "and;": "\u2227",
- "andand;": "\u2A55",
- "andd;": "\u2A5C",
- "andslope;": "\u2A58",
- "andv;": "\u2A5A",
- "ang;": "\u2220",
- "ange;": "\u29A4",
- "angle;": "\u2220",
- "angmsd;": "\u2221",
- "angmsdaa;": "\u29A8",
- "angmsdab;": "\u29A9",
- "angmsdac;": "\u29AA",
- "angmsdad;": "\u29AB",
- "angmsdae;": "\u29AC",
- "angmsdaf;": "\u29AD",
- "angmsdag;": "\u29AE",
- "angmsdah;": "\u29AF",
- "angrt;": "\u221F",
- "angrtvb;": "\u22BE",
- "angrtvbd;": "\u299D",
- "angsph;": "\u2222",
- "angst;": "\u00C5",
- "angzarr;": "\u237C",
- "aogon;": "\u0105",
- "aopf;": "\uD835\uDD52",
- "ap;": "\u2248",
- "apE;": "\u2A70",
- "apacir;": "\u2A6F",
- "ape;": "\u224A",
- "apid;": "\u224B",
- "apos;": "\u0027",
- "approx;": "\u2248",
- "approxeq;": "\u224A",
- "aring": "\u00E5",
- "aring;": "\u00E5",
- "ascr;": "\uD835\uDCB6",
- "ast;": "\u002A",
- "asymp;": "\u2248",
- "asympeq;": "\u224D",
- "atilde": "\u00E3",
- "atilde;": "\u00E3",
- "auml": "\u00E4",
- "auml;": "\u00E4",
- "awconint;": "\u2233",
- "awint;": "\u2A11",
- "bNot;": "\u2AED",
- "backcong;": "\u224C",
- "backepsilon;": "\u03F6",
- "backprime;": "\u2035",
- "backsim;": "\u223D",
- "backsimeq;": "\u22CD",
- "barvee;": "\u22BD",
- "barwed;": "\u2305",
- "barwedge;": "\u2305",
- "bbrk;": "\u23B5",
- "bbrktbrk;": "\u23B6",
- "bcong;": "\u224C",
- "bcy;": "\u0431",
- "bdquo;": "\u201E",
- "becaus;": "\u2235",
- "because;": "\u2235",
- "bemptyv;": "\u29B0",
- "bepsi;": "\u03F6",
- "bernou;": "\u212C",
- "beta;": "\u03B2",
- "beth;": "\u2136",
- "between;": "\u226C",
- "bfr;": "\uD835\uDD1F",
- "bigcap;": "\u22C2",
- "bigcirc;": "\u25EF",
- "bigcup;": "\u22C3",
- "bigodot;": "\u2A00",
- "bigoplus;": "\u2A01",
- "bigotimes;": "\u2A02",
- "bigsqcup;": "\u2A06",
- "bigstar;": "\u2605",
- "bigtriangledown;": "\u25BD",
- "bigtriangleup;": "\u25B3",
- "biguplus;": "\u2A04",
- "bigvee;": "\u22C1",
- "bigwedge;": "\u22C0",
- "bkarow;": "\u290D",
- "blacklozenge;": "\u29EB",
- "blacksquare;": "\u25AA",
- "blacktriangle;": "\u25B4",
- "blacktriangledown;": "\u25BE",
- "blacktriangleleft;": "\u25C2",
- "blacktriangleright;": "\u25B8",
- "blank;": "\u2423",
- "blk12;": "\u2592",
- "blk14;": "\u2591",
- "blk34;": "\u2593",
- "block;": "\u2588",
- "bne;": "\u003D\u20E5",
- "bnequiv;": "\u2261\u20E5",
- "bnot;": "\u2310",
- "bopf;": "\uD835\uDD53",
- "bot;": "\u22A5",
- "bottom;": "\u22A5",
- "bowtie;": "\u22C8",
- "boxDL;": "\u2557",
- "boxDR;": "\u2554",
- "boxDl;": "\u2556",
- "boxDr;": "\u2553",
- "boxH;": "\u2550",
- "boxHD;": "\u2566",
- "boxHU;": "\u2569",
- "boxHd;": "\u2564",
- "boxHu;": "\u2567",
- "boxUL;": "\u255D",
- "boxUR;": "\u255A",
- "boxUl;": "\u255C",
- "boxUr;": "\u2559",
- "boxV;": "\u2551",
- "boxVH;": "\u256C",
- "boxVL;": "\u2563",
- "boxVR;": "\u2560",
- "boxVh;": "\u256B",
- "boxVl;": "\u2562",
- "boxVr;": "\u255F",
- "boxbox;": "\u29C9",
- "boxdL;": "\u2555",
- "boxdR;": "\u2552",
- "boxdl;": "\u2510",
- "boxdr;": "\u250C",
- "boxh;": "\u2500",
- "boxhD;": "\u2565",
- "boxhU;": "\u2568",
- "boxhd;": "\u252C",
- "boxhu;": "\u2534",
- "boxminus;": "\u229F",
- "boxplus;": "\u229E",
- "boxtimes;": "\u22A0",
- "boxuL;": "\u255B",
- "boxuR;": "\u2558",
- "boxul;": "\u2518",
- "boxur;": "\u2514",
- "boxv;": "\u2502",
- "boxvH;": "\u256A",
- "boxvL;": "\u2561",
- "boxvR;": "\u255E",
- "boxvh;": "\u253C",
- "boxvl;": "\u2524",
- "boxvr;": "\u251C",
- "bprime;": "\u2035",
- "breve;": "\u02D8",
- "brvbar": "\u00A6",
- "brvbar;": "\u00A6",
- "bscr;": "\uD835\uDCB7",
- "bsemi;": "\u204F",
- "bsim;": "\u223D",
- "bsime;": "\u22CD",
- "bsol;": "\u005C",
- "bsolb;": "\u29C5",
- "bsolhsub;": "\u27C8",
- "bull;": "\u2022",
- "bullet;": "\u2022",
- "bump;": "\u224E",
- "bumpE;": "\u2AAE",
- "bumpe;": "\u224F",
- "bumpeq;": "\u224F",
- "cacute;": "\u0107",
- "cap;": "\u2229",
- "capand;": "\u2A44",
- "capbrcup;": "\u2A49",
- "capcap;": "\u2A4B",
- "capcup;": "\u2A47",
- "capdot;": "\u2A40",
- "caps;": "\u2229\uFE00",
- "caret;": "\u2041",
- "caron;": "\u02C7",
- "ccaps;": "\u2A4D",
- "ccaron;": "\u010D",
- "ccedil": "\u00E7",
- "ccedil;": "\u00E7",
- "ccirc;": "\u0109",
- "ccups;": "\u2A4C",
- "ccupssm;": "\u2A50",
- "cdot;": "\u010B",
- "cedil": "\u00B8",
- "cedil;": "\u00B8",
- "cemptyv;": "\u29B2",
- "cent": "\u00A2",
- "cent;": "\u00A2",
- "centerdot;": "\u00B7",
- "cfr;": "\uD835\uDD20",
- "chcy;": "\u0447",
- "check;": "\u2713",
- "checkmark;": "\u2713",
- "chi;": "\u03C7",
- "cir;": "\u25CB",
- "cirE;": "\u29C3",
- "circ;": "\u02C6",
- "circeq;": "\u2257",
- "circlearrowleft;": "\u21BA",
- "circlearrowright;": "\u21BB",
- "circledR;": "\u00AE",
- "circledS;": "\u24C8",
- "circledast;": "\u229B",
- "circledcirc;": "\u229A",
- "circleddash;": "\u229D",
- "cire;": "\u2257",
- "cirfnint;": "\u2A10",
- "cirmid;": "\u2AEF",
- "cirscir;": "\u29C2",
- "clubs;": "\u2663",
- "clubsuit;": "\u2663",
- "colon;": "\u003A",
- "colone;": "\u2254",
- "coloneq;": "\u2254",
- "comma;": "\u002C",
- "commat;": "\u0040",
- "comp;": "\u2201",
- "compfn;": "\u2218",
- "complement;": "\u2201",
- "complexes;": "\u2102",
- "cong;": "\u2245",
- "congdot;": "\u2A6D",
- "conint;": "\u222E",
- "copf;": "\uD835\uDD54",
- "coprod;": "\u2210",
- "copy": "\u00A9",
- "copy;": "\u00A9",
- "copysr;": "\u2117",
- "crarr;": "\u21B5",
- "cross;": "\u2717",
- "cscr;": "\uD835\uDCB8",
- "csub;": "\u2ACF",
- "csube;": "\u2AD1",
- "csup;": "\u2AD0",
- "csupe;": "\u2AD2",
- "ctdot;": "\u22EF",
- "cudarrl;": "\u2938",
- "cudarrr;": "\u2935",
- "cuepr;": "\u22DE",
- "cuesc;": "\u22DF",
- "cularr;": "\u21B6",
- "cularrp;": "\u293D",
- "cup;": "\u222A",
- "cupbrcap;": "\u2A48",
- "cupcap;": "\u2A46",
- "cupcup;": "\u2A4A",
- "cupdot;": "\u228D",
- "cupor;": "\u2A45",
- "cups;": "\u222A\uFE00",
- "curarr;": "\u21B7",
- "curarrm;": "\u293C",
- "curlyeqprec;": "\u22DE",
- "curlyeqsucc;": "\u22DF",
- "curlyvee;": "\u22CE",
- "curlywedge;": "\u22CF",
- "curren": "\u00A4",
- "curren;": "\u00A4",
- "curvearrowleft;": "\u21B6",
- "curvearrowright;": "\u21B7",
- "cuvee;": "\u22CE",
- "cuwed;": "\u22CF",
- "cwconint;": "\u2232",
- "cwint;": "\u2231",
- "cylcty;": "\u232D",
- "dArr;": "\u21D3",
- "dHar;": "\u2965",
- "dagger;": "\u2020",
- "daleth;": "\u2138",
- "darr;": "\u2193",
- "dash;": "\u2010",
- "dashv;": "\u22A3",
- "dbkarow;": "\u290F",
- "dblac;": "\u02DD",
- "dcaron;": "\u010F",
- "dcy;": "\u0434",
- "dd;": "\u2146",
- "ddagger;": "\u2021",
- "ddarr;": "\u21CA",
- "ddotseq;": "\u2A77",
- "deg": "\u00B0",
- "deg;": "\u00B0",
- "delta;": "\u03B4",
- "demptyv;": "\u29B1",
- "dfisht;": "\u297F",
- "dfr;": "\uD835\uDD21",
- "dharl;": "\u21C3",
- "dharr;": "\u21C2",
- "diam;": "\u22C4",
- "diamond;": "\u22C4",
- "diamondsuit;": "\u2666",
- "diams;": "\u2666",
- "die;": "\u00A8",
- "digamma;": "\u03DD",
- "disin;": "\u22F2",
- "div;": "\u00F7",
- "divide": "\u00F7",
- "divide;": "\u00F7",
- "divideontimes;": "\u22C7",
- "divonx;": "\u22C7",
- "djcy;": "\u0452",
- "dlcorn;": "\u231E",
- "dlcrop;": "\u230D",
- "dollar;": "\u0024",
- "dopf;": "\uD835\uDD55",
- "dot;": "\u02D9",
- "doteq;": "\u2250",
- "doteqdot;": "\u2251",
- "dotminus;": "\u2238",
- "dotplus;": "\u2214",
- "dotsquare;": "\u22A1",
- "doublebarwedge;": "\u2306",
- "downarrow;": "\u2193",
- "downdownarrows;": "\u21CA",
- "downharpoonleft;": "\u21C3",
- "downharpoonright;": "\u21C2",
- "drbkarow;": "\u2910",
- "drcorn;": "\u231F",
- "drcrop;": "\u230C",
- "dscr;": "\uD835\uDCB9",
- "dscy;": "\u0455",
- "dsol;": "\u29F6",
- "dstrok;": "\u0111",
- "dtdot;": "\u22F1",
- "dtri;": "\u25BF",
- "dtrif;": "\u25BE",
- "duarr;": "\u21F5",
- "duhar;": "\u296F",
- "dwangle;": "\u29A6",
- "dzcy;": "\u045F",
- "dzigrarr;": "\u27FF",
- "eDDot;": "\u2A77",
- "eDot;": "\u2251",
- "eacute": "\u00E9",
- "eacute;": "\u00E9",
- "easter;": "\u2A6E",
- "ecaron;": "\u011B",
- "ecir;": "\u2256",
- "ecirc": "\u00EA",
- "ecirc;": "\u00EA",
- "ecolon;": "\u2255",
- "ecy;": "\u044D",
- "edot;": "\u0117",
- "ee;": "\u2147",
- "efDot;": "\u2252",
- "efr;": "\uD835\uDD22",
- "eg;": "\u2A9A",
- "egrave": "\u00E8",
- "egrave;": "\u00E8",
- "egs;": "\u2A96",
- "egsdot;": "\u2A98",
- "el;": "\u2A99",
- "elinters;": "\u23E7",
- "ell;": "\u2113",
- "els;": "\u2A95",
- "elsdot;": "\u2A97",
- "emacr;": "\u0113",
- "empty;": "\u2205",
- "emptyset;": "\u2205",
- "emptyv;": "\u2205",
- "emsp13;": "\u2004",
- "emsp14;": "\u2005",
- "emsp;": "\u2003",
- "eng;": "\u014B",
- "ensp;": "\u2002",
- "eogon;": "\u0119",
- "eopf;": "\uD835\uDD56",
- "epar;": "\u22D5",
- "eparsl;": "\u29E3",
- "eplus;": "\u2A71",
- "epsi;": "\u03B5",
- "epsilon;": "\u03B5",
- "epsiv;": "\u03F5",
- "eqcirc;": "\u2256",
- "eqcolon;": "\u2255",
- "eqsim;": "\u2242",
- "eqslantgtr;": "\u2A96",
- "eqslantless;": "\u2A95",
- "equals;": "\u003D",
- "equest;": "\u225F",
- "equiv;": "\u2261",
- "equivDD;": "\u2A78",
- "eqvparsl;": "\u29E5",
- "erDot;": "\u2253",
- "erarr;": "\u2971",
- "escr;": "\u212F",
- "esdot;": "\u2250",
- "esim;": "\u2242",
- "eta;": "\u03B7",
- "eth": "\u00F0",
- "eth;": "\u00F0",
- "euml": "\u00EB",
- "euml;": "\u00EB",
- "euro;": "\u20AC",
- "excl;": "\u0021",
- "exist;": "\u2203",
- "expectation;": "\u2130",
- "exponentiale;": "\u2147",
- "fallingdotseq;": "\u2252",
- "fcy;": "\u0444",
- "female;": "\u2640",
- "ffilig;": "\uFB03",
- "fflig;": "\uFB00",
- "ffllig;": "\uFB04",
- "ffr;": "\uD835\uDD23",
- "filig;": "\uFB01",
- "fjlig;": "\u0066\u006A",
- "flat;": "\u266D",
- "fllig;": "\uFB02",
- "fltns;": "\u25B1",
- "fnof;": "\u0192",
- "fopf;": "\uD835\uDD57",
- "forall;": "\u2200",
- "fork;": "\u22D4",
- "forkv;": "\u2AD9",
- "fpartint;": "\u2A0D",
- "frac12": "\u00BD",
- "frac12;": "\u00BD",
- "frac13;": "\u2153",
- "frac14": "\u00BC",
- "frac14;": "\u00BC",
- "frac15;": "\u2155",
- "frac16;": "\u2159",
- "frac18;": "\u215B",
- "frac23;": "\u2154",
- "frac25;": "\u2156",
- "frac34": "\u00BE",
- "frac34;": "\u00BE",
- "frac35;": "\u2157",
- "frac38;": "\u215C",
- "frac45;": "\u2158",
- "frac56;": "\u215A",
- "frac58;": "\u215D",
- "frac78;": "\u215E",
- "frasl;": "\u2044",
- "frown;": "\u2322",
- "fscr;": "\uD835\uDCBB",
- "gE;": "\u2267",
- "gEl;": "\u2A8C",
- "gacute;": "\u01F5",
- "gamma;": "\u03B3",
- "gammad;": "\u03DD",
- "gap;": "\u2A86",
- "gbreve;": "\u011F",
- "gcirc;": "\u011D",
- "gcy;": "\u0433",
- "gdot;": "\u0121",
- "ge;": "\u2265",
- "gel;": "\u22DB",
- "geq;": "\u2265",
- "geqq;": "\u2267",
- "geqslant;": "\u2A7E",
- "ges;": "\u2A7E",
- "gescc;": "\u2AA9",
- "gesdot;": "\u2A80",
- "gesdoto;": "\u2A82",
- "gesdotol;": "\u2A84",
- "gesl;": "\u22DB\uFE00",
- "gesles;": "\u2A94",
- "gfr;": "\uD835\uDD24",
- "gg;": "\u226B",
- "ggg;": "\u22D9",
- "gimel;": "\u2137",
- "gjcy;": "\u0453",
- "gl;": "\u2277",
- "glE;": "\u2A92",
- "gla;": "\u2AA5",
- "glj;": "\u2AA4",
- "gnE;": "\u2269",
- "gnap;": "\u2A8A",
- "gnapprox;": "\u2A8A",
- "gne;": "\u2A88",
- "gneq;": "\u2A88",
- "gneqq;": "\u2269",
- "gnsim;": "\u22E7",
- "gopf;": "\uD835\uDD58",
- "grave;": "\u0060",
- "gscr;": "\u210A",
- "gsim;": "\u2273",
- "gsime;": "\u2A8E",
- "gsiml;": "\u2A90",
- "gt": "\u003E",
- "gt;": "\u003E",
- "gtcc;": "\u2AA7",
- "gtcir;": "\u2A7A",
- "gtdot;": "\u22D7",
- "gtlPar;": "\u2995",
- "gtquest;": "\u2A7C",
- "gtrapprox;": "\u2A86",
- "gtrarr;": "\u2978",
- "gtrdot;": "\u22D7",
- "gtreqless;": "\u22DB",
- "gtreqqless;": "\u2A8C",
- "gtrless;": "\u2277",
- "gtrsim;": "\u2273",
- "gvertneqq;": "\u2269\uFE00",
- "gvnE;": "\u2269\uFE00",
- "hArr;": "\u21D4",
- "hairsp;": "\u200A",
- "half;": "\u00BD",
- "hamilt;": "\u210B",
- "hardcy;": "\u044A",
- "harr;": "\u2194",
- "harrcir;": "\u2948",
- "harrw;": "\u21AD",
- "hbar;": "\u210F",
- "hcirc;": "\u0125",
- "hearts;": "\u2665",
- "heartsuit;": "\u2665",
- "hellip;": "\u2026",
- "hercon;": "\u22B9",
- "hfr;": "\uD835\uDD25",
- "hksearow;": "\u2925",
- "hkswarow;": "\u2926",
- "hoarr;": "\u21FF",
- "homtht;": "\u223B",
- "hookleftarrow;": "\u21A9",
- "hookrightarrow;": "\u21AA",
- "hopf;": "\uD835\uDD59",
- "horbar;": "\u2015",
- "hscr;": "\uD835\uDCBD",
- "hslash;": "\u210F",
- "hstrok;": "\u0127",
- "hybull;": "\u2043",
- "hyphen;": "\u2010",
- "iacute": "\u00ED",
- "iacute;": "\u00ED",
- "ic;": "\u2063",
- "icirc": "\u00EE",
- "icirc;": "\u00EE",
- "icy;": "\u0438",
- "iecy;": "\u0435",
- "iexcl": "\u00A1",
- "iexcl;": "\u00A1",
- "iff;": "\u21D4",
- "ifr;": "\uD835\uDD26",
- "igrave": "\u00EC",
- "igrave;": "\u00EC",
- "ii;": "\u2148",
- "iiiint;": "\u2A0C",
- "iiint;": "\u222D",
- "iinfin;": "\u29DC",
- "iiota;": "\u2129",
- "ijlig;": "\u0133",
- "imacr;": "\u012B",
- "image;": "\u2111",
- "imagline;": "\u2110",
- "imagpart;": "\u2111",
- "imath;": "\u0131",
- "imof;": "\u22B7",
- "imped;": "\u01B5",
- "in;": "\u2208",
- "incare;": "\u2105",
- "infin;": "\u221E",
- "infintie;": "\u29DD",
- "inodot;": "\u0131",
- "int;": "\u222B",
- "intcal;": "\u22BA",
- "integers;": "\u2124",
- "intercal;": "\u22BA",
- "intlarhk;": "\u2A17",
- "intprod;": "\u2A3C",
- "iocy;": "\u0451",
- "iogon;": "\u012F",
- "iopf;": "\uD835\uDD5A",
- "iota;": "\u03B9",
- "iprod;": "\u2A3C",
- "iquest": "\u00BF",
- "iquest;": "\u00BF",
- "iscr;": "\uD835\uDCBE",
- "isin;": "\u2208",
- "isinE;": "\u22F9",
- "isindot;": "\u22F5",
- "isins;": "\u22F4",
- "isinsv;": "\u22F3",
- "isinv;": "\u2208",
- "it;": "\u2062",
- "itilde;": "\u0129",
- "iukcy;": "\u0456",
- "iuml": "\u00EF",
- "iuml;": "\u00EF",
- "jcirc;": "\u0135",
- "jcy;": "\u0439",
- "jfr;": "\uD835\uDD27",
- "jmath;": "\u0237",
- "jopf;": "\uD835\uDD5B",
- "jscr;": "\uD835\uDCBF",
- "jsercy;": "\u0458",
- "jukcy;": "\u0454",
- "kappa;": "\u03BA",
- "kappav;": "\u03F0",
- "kcedil;": "\u0137",
- "kcy;": "\u043A",
- "kfr;": "\uD835\uDD28",
- "kgreen;": "\u0138",
- "khcy;": "\u0445",
- "kjcy;": "\u045C",
- "kopf;": "\uD835\uDD5C",
- "kscr;": "\uD835\uDCC0",
- "lAarr;": "\u21DA",
- "lArr;": "\u21D0",
- "lAtail;": "\u291B",
- "lBarr;": "\u290E",
- "lE;": "\u2266",
- "lEg;": "\u2A8B",
- "lHar;": "\u2962",
- "lacute;": "\u013A",
- "laemptyv;": "\u29B4",
- "lagran;": "\u2112",
- "lambda;": "\u03BB",
- "lang;": "\u27E8",
- "langd;": "\u2991",
- "langle;": "\u27E8",
- "lap;": "\u2A85",
- "laquo": "\u00AB",
- "laquo;": "\u00AB",
- "larr;": "\u2190",
- "larrb;": "\u21E4",
- "larrbfs;": "\u291F",
- "larrfs;": "\u291D",
- "larrhk;": "\u21A9",
- "larrlp;": "\u21AB",
- "larrpl;": "\u2939",
- "larrsim;": "\u2973",
- "larrtl;": "\u21A2",
- "lat;": "\u2AAB",
- "latail;": "\u2919",
- "late;": "\u2AAD",
- "lates;": "\u2AAD\uFE00",
- "lbarr;": "\u290C",
- "lbbrk;": "\u2772",
- "lbrace;": "\u007B",
- "lbrack;": "\u005B",
- "lbrke;": "\u298B",
- "lbrksld;": "\u298F",
- "lbrkslu;": "\u298D",
- "lcaron;": "\u013E",
- "lcedil;": "\u013C",
- "lceil;": "\u2308",
- "lcub;": "\u007B",
- "lcy;": "\u043B",
- "ldca;": "\u2936",
- "ldquo;": "\u201C",
- "ldquor;": "\u201E",
- "ldrdhar;": "\u2967",
- "ldrushar;": "\u294B",
- "ldsh;": "\u21B2",
- "le;": "\u2264",
- "leftarrow;": "\u2190",
- "leftarrowtail;": "\u21A2",
- "leftharpoondown;": "\u21BD",
- "leftharpoonup;": "\u21BC",
- "leftleftarrows;": "\u21C7",
- "leftrightarrow;": "\u2194",
- "leftrightarrows;": "\u21C6",
- "leftrightharpoons;": "\u21CB",
- "leftrightsquigarrow;": "\u21AD",
- "leftthreetimes;": "\u22CB",
- "leg;": "\u22DA",
- "leq;": "\u2264",
- "leqq;": "\u2266",
- "leqslant;": "\u2A7D",
- "les;": "\u2A7D",
- "lescc;": "\u2AA8",
- "lesdot;": "\u2A7F",
- "lesdoto;": "\u2A81",
- "lesdotor;": "\u2A83",
- "lesg;": "\u22DA\uFE00",
- "lesges;": "\u2A93",
- "lessapprox;": "\u2A85",
- "lessdot;": "\u22D6",
- "lesseqgtr;": "\u22DA",
- "lesseqqgtr;": "\u2A8B",
- "lessgtr;": "\u2276",
- "lesssim;": "\u2272",
- "lfisht;": "\u297C",
- "lfloor;": "\u230A",
- "lfr;": "\uD835\uDD29",
- "lg;": "\u2276",
- "lgE;": "\u2A91",
- "lhard;": "\u21BD",
- "lharu;": "\u21BC",
- "lharul;": "\u296A",
- "lhblk;": "\u2584",
- "ljcy;": "\u0459",
- "ll;": "\u226A",
- "llarr;": "\u21C7",
- "llcorner;": "\u231E",
- "llhard;": "\u296B",
- "lltri;": "\u25FA",
- "lmidot;": "\u0140",
- "lmoust;": "\u23B0",
- "lmoustache;": "\u23B0",
- "lnE;": "\u2268",
- "lnap;": "\u2A89",
- "lnapprox;": "\u2A89",
- "lne;": "\u2A87",
- "lneq;": "\u2A87",
- "lneqq;": "\u2268",
- "lnsim;": "\u22E6",
- "loang;": "\u27EC",
- "loarr;": "\u21FD",
- "lobrk;": "\u27E6",
- "longleftarrow;": "\u27F5",
- "longleftrightarrow;": "\u27F7",
- "longmapsto;": "\u27FC",
- "longrightarrow;": "\u27F6",
- "looparrowleft;": "\u21AB",
- "looparrowright;": "\u21AC",
- "lopar;": "\u2985",
- "lopf;": "\uD835\uDD5D",
- "loplus;": "\u2A2D",
- "lotimes;": "\u2A34",
- "lowast;": "\u2217",
- "lowbar;": "\u005F",
- "loz;": "\u25CA",
- "lozenge;": "\u25CA",
- "lozf;": "\u29EB",
- "lpar;": "\u0028",
- "lparlt;": "\u2993",
- "lrarr;": "\u21C6",
- "lrcorner;": "\u231F",
- "lrhar;": "\u21CB",
- "lrhard;": "\u296D",
- "lrm;": "\u200E",
- "lrtri;": "\u22BF",
- "lsaquo;": "\u2039",
- "lscr;": "\uD835\uDCC1",
- "lsh;": "\u21B0",
- "lsim;": "\u2272",
- "lsime;": "\u2A8D",
- "lsimg;": "\u2A8F",
- "lsqb;": "\u005B",
- "lsquo;": "\u2018",
- "lsquor;": "\u201A",
- "lstrok;": "\u0142",
- "lt": "\u003C",
- "lt;": "\u003C",
- "ltcc;": "\u2AA6",
- "ltcir;": "\u2A79",
- "ltdot;": "\u22D6",
- "lthree;": "\u22CB",
- "ltimes;": "\u22C9",
- "ltlarr;": "\u2976",
- "ltquest;": "\u2A7B",
- "ltrPar;": "\u2996",
- "ltri;": "\u25C3",
- "ltrie;": "\u22B4",
- "ltrif;": "\u25C2",
- "lurdshar;": "\u294A",
- "luruhar;": "\u2966",
- "lvertneqq;": "\u2268\uFE00",
- "lvnE;": "\u2268\uFE00",
- "mDDot;": "\u223A",
- "macr": "\u00AF",
- "macr;": "\u00AF",
- "male;": "\u2642",
- "malt;": "\u2720",
- "maltese;": "\u2720",
- "map;": "\u21A6",
- "mapsto;": "\u21A6",
- "mapstodown;": "\u21A7",
- "mapstoleft;": "\u21A4",
- "mapstoup;": "\u21A5",
- "marker;": "\u25AE",
- "mcomma;": "\u2A29",
- "mcy;": "\u043C",
- "mdash;": "\u2014",
- "measuredangle;": "\u2221",
- "mfr;": "\uD835\uDD2A",
- "mho;": "\u2127",
- "micro": "\u00B5",
- "micro;": "\u00B5",
- "mid;": "\u2223",
- "midast;": "\u002A",
- "midcir;": "\u2AF0",
- "middot": "\u00B7",
- "middot;": "\u00B7",
- "minus;": "\u2212",
- "minusb;": "\u229F",
- "minusd;": "\u2238",
- "minusdu;": "\u2A2A",
- "mlcp;": "\u2ADB",
- "mldr;": "\u2026",
- "mnplus;": "\u2213",
- "models;": "\u22A7",
- "mopf;": "\uD835\uDD5E",
- "mp;": "\u2213",
- "mscr;": "\uD835\uDCC2",
- "mstpos;": "\u223E",
- "mu;": "\u03BC",
- "multimap;": "\u22B8",
- "mumap;": "\u22B8",
- "nGg;": "\u22D9\u0338",
- "nGt;": "\u226B\u20D2",
- "nGtv;": "\u226B\u0338",
- "nLeftarrow;": "\u21CD",
- "nLeftrightarrow;": "\u21CE",
- "nLl;": "\u22D8\u0338",
- "nLt;": "\u226A\u20D2",
- "nLtv;": "\u226A\u0338",
- "nRightarrow;": "\u21CF",
- "nVDash;": "\u22AF",
- "nVdash;": "\u22AE",
- "nabla;": "\u2207",
- "nacute;": "\u0144",
- "nang;": "\u2220\u20D2",
- "nap;": "\u2249",
- "napE;": "\u2A70\u0338",
- "napid;": "\u224B\u0338",
- "napos;": "\u0149",
- "napprox;": "\u2249",
- "natur;": "\u266E",
- "natural;": "\u266E",
- "naturals;": "\u2115",
- "nbsp": "\u00A0",
- "nbsp;": "\u00A0",
- "nbump;": "\u224E\u0338",
- "nbumpe;": "\u224F\u0338",
- "ncap;": "\u2A43",
- "ncaron;": "\u0148",
- "ncedil;": "\u0146",
- "ncong;": "\u2247",
- "ncongdot;": "\u2A6D\u0338",
- "ncup;": "\u2A42",
- "ncy;": "\u043D",
- "ndash;": "\u2013",
- "ne;": "\u2260",
- "neArr;": "\u21D7",
- "nearhk;": "\u2924",
- "nearr;": "\u2197",
- "nearrow;": "\u2197",
- "nedot;": "\u2250\u0338",
- "nequiv;": "\u2262",
- "nesear;": "\u2928",
- "nesim;": "\u2242\u0338",
- "nexist;": "\u2204",
- "nexists;": "\u2204",
- "nfr;": "\uD835\uDD2B",
- "ngE;": "\u2267\u0338",
- "nge;": "\u2271",
- "ngeq;": "\u2271",
- "ngeqq;": "\u2267\u0338",
- "ngeqslant;": "\u2A7E\u0338",
- "nges;": "\u2A7E\u0338",
- "ngsim;": "\u2275",
- "ngt;": "\u226F",
- "ngtr;": "\u226F",
- "nhArr;": "\u21CE",
- "nharr;": "\u21AE",
- "nhpar;": "\u2AF2",
- "ni;": "\u220B",
- "nis;": "\u22FC",
- "nisd;": "\u22FA",
- "niv;": "\u220B",
- "njcy;": "\u045A",
- "nlArr;": "\u21CD",
- "nlE;": "\u2266\u0338",
- "nlarr;": "\u219A",
- "nldr;": "\u2025",
- "nle;": "\u2270",
- "nleftarrow;": "\u219A",
- "nleftrightarrow;": "\u21AE",
- "nleq;": "\u2270",
- "nleqq;": "\u2266\u0338",
- "nleqslant;": "\u2A7D\u0338",
- "nles;": "\u2A7D\u0338",
- "nless;": "\u226E",
- "nlsim;": "\u2274",
- "nlt;": "\u226E",
- "nltri;": "\u22EA",
- "nltrie;": "\u22EC",
- "nmid;": "\u2224",
- "nopf;": "\uD835\uDD5F",
- "not": "\u00AC",
- "not;": "\u00AC",
- "notin;": "\u2209",
- "notinE;": "\u22F9\u0338",
- "notindot;": "\u22F5\u0338",
- "notinva;": "\u2209",
- "notinvb;": "\u22F7",
- "notinvc;": "\u22F6",
- "notni;": "\u220C",
- "notniva;": "\u220C",
- "notnivb;": "\u22FE",
- "notnivc;": "\u22FD",
- "npar;": "\u2226",
- "nparallel;": "\u2226",
- "nparsl;": "\u2AFD\u20E5",
- "npart;": "\u2202\u0338",
- "npolint;": "\u2A14",
- "npr;": "\u2280",
- "nprcue;": "\u22E0",
- "npre;": "\u2AAF\u0338",
- "nprec;": "\u2280",
- "npreceq;": "\u2AAF\u0338",
- "nrArr;": "\u21CF",
- "nrarr;": "\u219B",
- "nrarrc;": "\u2933\u0338",
- "nrarrw;": "\u219D\u0338",
- "nrightarrow;": "\u219B",
- "nrtri;": "\u22EB",
- "nrtrie;": "\u22ED",
- "nsc;": "\u2281",
- "nsccue;": "\u22E1",
- "nsce;": "\u2AB0\u0338",
- "nscr;": "\uD835\uDCC3",
- "nshortmid;": "\u2224",
- "nshortparallel;": "\u2226",
- "nsim;": "\u2241",
- "nsime;": "\u2244",
- "nsimeq;": "\u2244",
- "nsmid;": "\u2224",
- "nspar;": "\u2226",
- "nsqsube;": "\u22E2",
- "nsqsupe;": "\u22E3",
- "nsub;": "\u2284",
- "nsubE;": "\u2AC5\u0338",
- "nsube;": "\u2288",
- "nsubset;": "\u2282\u20D2",
- "nsubseteq;": "\u2288",
- "nsubseteqq;": "\u2AC5\u0338",
- "nsucc;": "\u2281",
- "nsucceq;": "\u2AB0\u0338",
- "nsup;": "\u2285",
- "nsupE;": "\u2AC6\u0338",
- "nsupe;": "\u2289",
- "nsupset;": "\u2283\u20D2",
- "nsupseteq;": "\u2289",
- "nsupseteqq;": "\u2AC6\u0338",
- "ntgl;": "\u2279",
- "ntilde": "\u00F1",
- "ntilde;": "\u00F1",
- "ntlg;": "\u2278",
- "ntriangleleft;": "\u22EA",
- "ntrianglelefteq;": "\u22EC",
- "ntriangleright;": "\u22EB",
- "ntrianglerighteq;": "\u22ED",
- "nu;": "\u03BD",
- "num;": "\u0023",
- "numero;": "\u2116",
- "numsp;": "\u2007",
- "nvDash;": "\u22AD",
- "nvHarr;": "\u2904",
- "nvap;": "\u224D\u20D2",
- "nvdash;": "\u22AC",
- "nvge;": "\u2265\u20D2",
- "nvgt;": "\u003E\u20D2",
- "nvinfin;": "\u29DE",
- "nvlArr;": "\u2902",
- "nvle;": "\u2264\u20D2",
- "nvlt;": "\u003C\u20D2",
- "nvltrie;": "\u22B4\u20D2",
- "nvrArr;": "\u2903",
- "nvrtrie;": "\u22B5\u20D2",
- "nvsim;": "\u223C\u20D2",
- "nwArr;": "\u21D6",
- "nwarhk;": "\u2923",
- "nwarr;": "\u2196",
- "nwarrow;": "\u2196",
- "nwnear;": "\u2927",
- "oS;": "\u24C8",
- "oacute": "\u00F3",
- "oacute;": "\u00F3",
- "oast;": "\u229B",
- "ocir;": "\u229A",
- "ocirc": "\u00F4",
- "ocirc;": "\u00F4",
- "ocy;": "\u043E",
- "odash;": "\u229D",
- "odblac;": "\u0151",
- "odiv;": "\u2A38",
- "odot;": "\u2299",
- "odsold;": "\u29BC",
- "oelig;": "\u0153",
- "ofcir;": "\u29BF",
- "ofr;": "\uD835\uDD2C",
- "ogon;": "\u02DB",
- "ograve": "\u00F2",
- "ograve;": "\u00F2",
- "ogt;": "\u29C1",
- "ohbar;": "\u29B5",
- "ohm;": "\u03A9",
- "oint;": "\u222E",
- "olarr;": "\u21BA",
- "olcir;": "\u29BE",
- "olcross;": "\u29BB",
- "oline;": "\u203E",
- "olt;": "\u29C0",
- "omacr;": "\u014D",
- "omega;": "\u03C9",
- "omicron;": "\u03BF",
- "omid;": "\u29B6",
- "ominus;": "\u2296",
- "oopf;": "\uD835\uDD60",
- "opar;": "\u29B7",
- "operp;": "\u29B9",
- "oplus;": "\u2295",
- "or;": "\u2228",
- "orarr;": "\u21BB",
- "ord;": "\u2A5D",
- "order;": "\u2134",
- "orderof;": "\u2134",
- "ordf": "\u00AA",
- "ordf;": "\u00AA",
- "ordm": "\u00BA",
- "ordm;": "\u00BA",
- "origof;": "\u22B6",
- "oror;": "\u2A56",
- "orslope;": "\u2A57",
- "orv;": "\u2A5B",
- "oscr;": "\u2134",
- "oslash": "\u00F8",
- "oslash;": "\u00F8",
- "osol;": "\u2298",
- "otilde": "\u00F5",
- "otilde;": "\u00F5",
- "otimes;": "\u2297",
- "otimesas;": "\u2A36",
- "ouml": "\u00F6",
- "ouml;": "\u00F6",
- "ovbar;": "\u233D",
- "par;": "\u2225",
- "para": "\u00B6",
- "para;": "\u00B6",
- "parallel;": "\u2225",
- "parsim;": "\u2AF3",
- "parsl;": "\u2AFD",
- "part;": "\u2202",
- "pcy;": "\u043F",
- "percnt;": "\u0025",
- "period;": "\u002E",
- "permil;": "\u2030",
- "perp;": "\u22A5",
- "pertenk;": "\u2031",
- "pfr;": "\uD835\uDD2D",
- "phi;": "\u03C6",
- "phiv;": "\u03D5",
- "phmmat;": "\u2133",
- "phone;": "\u260E",
- "pi;": "\u03C0",
- "pitchfork;": "\u22D4",
- "piv;": "\u03D6",
- "planck;": "\u210F",
- "planckh;": "\u210E",
- "plankv;": "\u210F",
- "plus;": "\u002B",
- "plusacir;": "\u2A23",
- "plusb;": "\u229E",
- "pluscir;": "\u2A22",
- "plusdo;": "\u2214",
- "plusdu;": "\u2A25",
- "pluse;": "\u2A72",
- "plusmn": "\u00B1",
- "plusmn;": "\u00B1",
- "plussim;": "\u2A26",
- "plustwo;": "\u2A27",
- "pm;": "\u00B1",
- "pointint;": "\u2A15",
- "popf;": "\uD835\uDD61",
- "pound": "\u00A3",
- "pound;": "\u00A3",
- "pr;": "\u227A",
- "prE;": "\u2AB3",
- "prap;": "\u2AB7",
- "prcue;": "\u227C",
- "pre;": "\u2AAF",
- "prec;": "\u227A",
- "precapprox;": "\u2AB7",
- "preccurlyeq;": "\u227C",
- "preceq;": "\u2AAF",
- "precnapprox;": "\u2AB9",
- "precneqq;": "\u2AB5",
- "precnsim;": "\u22E8",
- "precsim;": "\u227E",
- "prime;": "\u2032",
- "primes;": "\u2119",
- "prnE;": "\u2AB5",
- "prnap;": "\u2AB9",
- "prnsim;": "\u22E8",
- "prod;": "\u220F",
- "profalar;": "\u232E",
- "profline;": "\u2312",
- "profsurf;": "\u2313",
- "prop;": "\u221D",
- "propto;": "\u221D",
- "prsim;": "\u227E",
- "prurel;": "\u22B0",
- "pscr;": "\uD835\uDCC5",
- "psi;": "\u03C8",
- "puncsp;": "\u2008",
- "qfr;": "\uD835\uDD2E",
- "qint;": "\u2A0C",
- "qopf;": "\uD835\uDD62",
- "qprime;": "\u2057",
- "qscr;": "\uD835\uDCC6",
- "quaternions;": "\u210D",
- "quatint;": "\u2A16",
- "quest;": "\u003F",
- "questeq;": "\u225F",
- "quot": "\u0022",
- "quot;": "\u0022",
- "rAarr;": "\u21DB",
- "rArr;": "\u21D2",
- "rAtail;": "\u291C",
- "rBarr;": "\u290F",
- "rHar;": "\u2964",
- "race;": "\u223D\u0331",
- "racute;": "\u0155",
- "radic;": "\u221A",
- "raemptyv;": "\u29B3",
- "rang;": "\u27E9",
- "rangd;": "\u2992",
- "range;": "\u29A5",
- "rangle;": "\u27E9",
- "raquo": "\u00BB",
- "raquo;": "\u00BB",
- "rarr;": "\u2192",
- "rarrap;": "\u2975",
- "rarrb;": "\u21E5",
- "rarrbfs;": "\u2920",
- "rarrc;": "\u2933",
- "rarrfs;": "\u291E",
- "rarrhk;": "\u21AA",
- "rarrlp;": "\u21AC",
- "rarrpl;": "\u2945",
- "rarrsim;": "\u2974",
- "rarrtl;": "\u21A3",
- "rarrw;": "\u219D",
- "ratail;": "\u291A",
- "ratio;": "\u2236",
- "rationals;": "\u211A",
- "rbarr;": "\u290D",
- "rbbrk;": "\u2773",
- "rbrace;": "\u007D",
- "rbrack;": "\u005D",
- "rbrke;": "\u298C",
- "rbrksld;": "\u298E",
- "rbrkslu;": "\u2990",
- "rcaron;": "\u0159",
- "rcedil;": "\u0157",
- "rceil;": "\u2309",
- "rcub;": "\u007D",
- "rcy;": "\u0440",
- "rdca;": "\u2937",
- "rdldhar;": "\u2969",
- "rdquo;": "\u201D",
- "rdquor;": "\u201D",
- "rdsh;": "\u21B3",
- "real;": "\u211C",
- "realine;": "\u211B",
- "realpart;": "\u211C",
- "reals;": "\u211D",
- "rect;": "\u25AD",
- "reg": "\u00AE",
- "reg;": "\u00AE",
- "rfisht;": "\u297D",
- "rfloor;": "\u230B",
- "rfr;": "\uD835\uDD2F",
- "rhard;": "\u21C1",
- "rharu;": "\u21C0",
- "rharul;": "\u296C",
- "rho;": "\u03C1",
- "rhov;": "\u03F1",
- "rightarrow;": "\u2192",
- "rightarrowtail;": "\u21A3",
- "rightharpoondown;": "\u21C1",
- "rightharpoonup;": "\u21C0",
- "rightleftarrows;": "\u21C4",
- "rightleftharpoons;": "\u21CC",
- "rightrightarrows;": "\u21C9",
- "rightsquigarrow;": "\u219D",
- "rightthreetimes;": "\u22CC",
- "ring;": "\u02DA",
- "risingdotseq;": "\u2253",
- "rlarr;": "\u21C4",
- "rlhar;": "\u21CC",
- "rlm;": "\u200F",
- "rmoust;": "\u23B1",
- "rmoustache;": "\u23B1",
- "rnmid;": "\u2AEE",
- "roang;": "\u27ED",
- "roarr;": "\u21FE",
- "robrk;": "\u27E7",
- "ropar;": "\u2986",
- "ropf;": "\uD835\uDD63",
- "roplus;": "\u2A2E",
- "rotimes;": "\u2A35",
- "rpar;": "\u0029",
- "rpargt;": "\u2994",
- "rppolint;": "\u2A12",
- "rrarr;": "\u21C9",
- "rsaquo;": "\u203A",
- "rscr;": "\uD835\uDCC7",
- "rsh;": "\u21B1",
- "rsqb;": "\u005D",
- "rsquo;": "\u2019",
- "rsquor;": "\u2019",
- "rthree;": "\u22CC",
- "rtimes;": "\u22CA",
- "rtri;": "\u25B9",
- "rtrie;": "\u22B5",
- "rtrif;": "\u25B8",
- "rtriltri;": "\u29CE",
- "ruluhar;": "\u2968",
- "rx;": "\u211E",
- "sacute;": "\u015B",
- "sbquo;": "\u201A",
- "sc;": "\u227B",
- "scE;": "\u2AB4",
- "scap;": "\u2AB8",
- "scaron;": "\u0161",
- "sccue;": "\u227D",
- "sce;": "\u2AB0",
- "scedil;": "\u015F",
- "scirc;": "\u015D",
- "scnE;": "\u2AB6",
- "scnap;": "\u2ABA",
- "scnsim;": "\u22E9",
- "scpolint;": "\u2A13",
- "scsim;": "\u227F",
- "scy;": "\u0441",
- "sdot;": "\u22C5",
- "sdotb;": "\u22A1",
- "sdote;": "\u2A66",
- "seArr;": "\u21D8",
- "searhk;": "\u2925",
- "searr;": "\u2198",
- "searrow;": "\u2198",
- "sect": "\u00A7",
- "sect;": "\u00A7",
- "semi;": "\u003B",
- "seswar;": "\u2929",
- "setminus;": "\u2216",
- "setmn;": "\u2216",
- "sext;": "\u2736",
- "sfr;": "\uD835\uDD30",
- "sfrown;": "\u2322",
- "sharp;": "\u266F",
- "shchcy;": "\u0449",
- "shcy;": "\u0448",
- "shortmid;": "\u2223",
- "shortparallel;": "\u2225",
- "shy": "\u00AD",
- "shy;": "\u00AD",
- "sigma;": "\u03C3",
- "sigmaf;": "\u03C2",
- "sigmav;": "\u03C2",
- "sim;": "\u223C",
- "simdot;": "\u2A6A",
- "sime;": "\u2243",
- "simeq;": "\u2243",
- "simg;": "\u2A9E",
- "simgE;": "\u2AA0",
- "siml;": "\u2A9D",
- "simlE;": "\u2A9F",
- "simne;": "\u2246",
- "simplus;": "\u2A24",
- "simrarr;": "\u2972",
- "slarr;": "\u2190",
- "smallsetminus;": "\u2216",
- "smashp;": "\u2A33",
- "smeparsl;": "\u29E4",
- "smid;": "\u2223",
- "smile;": "\u2323",
- "smt;": "\u2AAA",
- "smte;": "\u2AAC",
- "smtes;": "\u2AAC\uFE00",
- "softcy;": "\u044C",
- "sol;": "\u002F",
- "solb;": "\u29C4",
- "solbar;": "\u233F",
- "sopf;": "\uD835\uDD64",
- "spades;": "\u2660",
- "spadesuit;": "\u2660",
- "spar;": "\u2225",
- "sqcap;": "\u2293",
- "sqcaps;": "\u2293\uFE00",
- "sqcup;": "\u2294",
- "sqcups;": "\u2294\uFE00",
- "sqsub;": "\u228F",
- "sqsube;": "\u2291",
- "sqsubset;": "\u228F",
- "sqsubseteq;": "\u2291",
- "sqsup;": "\u2290",
- "sqsupe;": "\u2292",
- "sqsupset;": "\u2290",
- "sqsupseteq;": "\u2292",
- "squ;": "\u25A1",
- "square;": "\u25A1",
- "squarf;": "\u25AA",
- "squf;": "\u25AA",
- "srarr;": "\u2192",
- "sscr;": "\uD835\uDCC8",
- "ssetmn;": "\u2216",
- "ssmile;": "\u2323",
- "sstarf;": "\u22C6",
- "star;": "\u2606",
- "starf;": "\u2605",
- "straightepsilon;": "\u03F5",
- "straightphi;": "\u03D5",
- "strns;": "\u00AF",
- "sub;": "\u2282",
- "subE;": "\u2AC5",
- "subdot;": "\u2ABD",
- "sube;": "\u2286",
- "subedot;": "\u2AC3",
- "submult;": "\u2AC1",
- "subnE;": "\u2ACB",
- "subne;": "\u228A",
- "subplus;": "\u2ABF",
- "subrarr;": "\u2979",
- "subset;": "\u2282",
- "subseteq;": "\u2286",
- "subseteqq;": "\u2AC5",
- "subsetneq;": "\u228A",
- "subsetneqq;": "\u2ACB",
- "subsim;": "\u2AC7",
- "subsub;": "\u2AD5",
- "subsup;": "\u2AD3",
- "succ;": "\u227B",
- "succapprox;": "\u2AB8",
- "succcurlyeq;": "\u227D",
- "succeq;": "\u2AB0",
- "succnapprox;": "\u2ABA",
- "succneqq;": "\u2AB6",
- "succnsim;": "\u22E9",
- "succsim;": "\u227F",
- "sum;": "\u2211",
- "sung;": "\u266A",
- "sup1": "\u00B9",
- "sup1;": "\u00B9",
- "sup2": "\u00B2",
- "sup2;": "\u00B2",
- "sup3": "\u00B3",
- "sup3;": "\u00B3",
- "sup;": "\u2283",
- "supE;": "\u2AC6",
- "supdot;": "\u2ABE",
- "supdsub;": "\u2AD8",
- "supe;": "\u2287",
- "supedot;": "\u2AC4",
- "suphsol;": "\u27C9",
- "suphsub;": "\u2AD7",
- "suplarr;": "\u297B",
- "supmult;": "\u2AC2",
- "supnE;": "\u2ACC",
- "supne;": "\u228B",
- "supplus;": "\u2AC0",
- "supset;": "\u2283",
- "supseteq;": "\u2287",
- "supseteqq;": "\u2AC6",
- "supsetneq;": "\u228B",
- "supsetneqq;": "\u2ACC",
- "supsim;": "\u2AC8",
- "supsub;": "\u2AD4",
- "supsup;": "\u2AD6",
- "swArr;": "\u21D9",
- "swarhk;": "\u2926",
- "swarr;": "\u2199",
- "swarrow;": "\u2199",
- "swnwar;": "\u292A",
- "szlig": "\u00DF",
- "szlig;": "\u00DF",
- "target;": "\u2316",
- "tau;": "\u03C4",
- "tbrk;": "\u23B4",
- "tcaron;": "\u0165",
- "tcedil;": "\u0163",
- "tcy;": "\u0442",
- "tdot;": "\u20DB",
- "telrec;": "\u2315",
- "tfr;": "\uD835\uDD31",
- "there4;": "\u2234",
- "therefore;": "\u2234",
- "theta;": "\u03B8",
- "thetasym;": "\u03D1",
- "thetav;": "\u03D1",
- "thickapprox;": "\u2248",
- "thicksim;": "\u223C",
- "thinsp;": "\u2009",
- "thkap;": "\u2248",
- "thksim;": "\u223C",
- "thorn": "\u00FE",
- "thorn;": "\u00FE",
- "tilde;": "\u02DC",
- "times": "\u00D7",
- "times;": "\u00D7",
- "timesb;": "\u22A0",
- "timesbar;": "\u2A31",
- "timesd;": "\u2A30",
- "tint;": "\u222D",
- "toea;": "\u2928",
- "top;": "\u22A4",
- "topbot;": "\u2336",
- "topcir;": "\u2AF1",
- "topf;": "\uD835\uDD65",
- "topfork;": "\u2ADA",
- "tosa;": "\u2929",
- "tprime;": "\u2034",
- "trade;": "\u2122",
- "triangle;": "\u25B5",
- "triangledown;": "\u25BF",
- "triangleleft;": "\u25C3",
- "trianglelefteq;": "\u22B4",
- "triangleq;": "\u225C",
- "triangleright;": "\u25B9",
- "trianglerighteq;": "\u22B5",
- "tridot;": "\u25EC",
- "trie;": "\u225C",
- "triminus;": "\u2A3A",
- "triplus;": "\u2A39",
- "trisb;": "\u29CD",
- "tritime;": "\u2A3B",
- "trpezium;": "\u23E2",
- "tscr;": "\uD835\uDCC9",
- "tscy;": "\u0446",
- "tshcy;": "\u045B",
- "tstrok;": "\u0167",
- "twixt;": "\u226C",
- "twoheadleftarrow;": "\u219E",
- "twoheadrightarrow;": "\u21A0",
- "uArr;": "\u21D1",
- "uHar;": "\u2963",
- "uacute": "\u00FA",
- "uacute;": "\u00FA",
- "uarr;": "\u2191",
- "ubrcy;": "\u045E",
- "ubreve;": "\u016D",
- "ucirc": "\u00FB",
- "ucirc;": "\u00FB",
- "ucy;": "\u0443",
- "udarr;": "\u21C5",
- "udblac;": "\u0171",
- "udhar;": "\u296E",
- "ufisht;": "\u297E",
- "ufr;": "\uD835\uDD32",
- "ugrave": "\u00F9",
- "ugrave;": "\u00F9",
- "uharl;": "\u21BF",
- "uharr;": "\u21BE",
- "uhblk;": "\u2580",
- "ulcorn;": "\u231C",
- "ulcorner;": "\u231C",
- "ulcrop;": "\u230F",
- "ultri;": "\u25F8",
- "umacr;": "\u016B",
- "uml": "\u00A8",
- "uml;": "\u00A8",
- "uogon;": "\u0173",
- "uopf;": "\uD835\uDD66",
- "uparrow;": "\u2191",
- "updownarrow;": "\u2195",
- "upharpoonleft;": "\u21BF",
- "upharpoonright;": "\u21BE",
- "uplus;": "\u228E",
- "upsi;": "\u03C5",
- "upsih;": "\u03D2",
- "upsilon;": "\u03C5",
- "upuparrows;": "\u21C8",
- "urcorn;": "\u231D",
- "urcorner;": "\u231D",
- "urcrop;": "\u230E",
- "uring;": "\u016F",
- "urtri;": "\u25F9",
- "uscr;": "\uD835\uDCCA",
- "utdot;": "\u22F0",
- "utilde;": "\u0169",
- "utri;": "\u25B5",
- "utrif;": "\u25B4",
- "uuarr;": "\u21C8",
- "uuml": "\u00FC",
- "uuml;": "\u00FC",
- "uwangle;": "\u29A7",
- "vArr;": "\u21D5",
- "vBar;": "\u2AE8",
- "vBarv;": "\u2AE9",
- "vDash;": "\u22A8",
- "vangrt;": "\u299C",
- "varepsilon;": "\u03F5",
- "varkappa;": "\u03F0",
- "varnothing;": "\u2205",
- "varphi;": "\u03D5",
- "varpi;": "\u03D6",
- "varpropto;": "\u221D",
- "varr;": "\u2195",
- "varrho;": "\u03F1",
- "varsigma;": "\u03C2",
- "varsubsetneq;": "\u228A\uFE00",
- "varsubsetneqq;": "\u2ACB\uFE00",
- "varsupsetneq;": "\u228B\uFE00",
- "varsupsetneqq;": "\u2ACC\uFE00",
- "vartheta;": "\u03D1",
- "vartriangleleft;": "\u22B2",
- "vartriangleright;": "\u22B3",
- "vcy;": "\u0432",
- "vdash;": "\u22A2",
- "vee;": "\u2228",
- "veebar;": "\u22BB",
- "veeeq;": "\u225A",
- "vellip;": "\u22EE",
- "verbar;": "\u007C",
- "vert;": "\u007C",
- "vfr;": "\uD835\uDD33",
- "vltri;": "\u22B2",
- "vnsub;": "\u2282\u20D2",
- "vnsup;": "\u2283\u20D2",
- "vopf;": "\uD835\uDD67",
- "vprop;": "\u221D",
- "vrtri;": "\u22B3",
- "vscr;": "\uD835\uDCCB",
- "vsubnE;": "\u2ACB\uFE00",
- "vsubne;": "\u228A\uFE00",
- "vsupnE;": "\u2ACC\uFE00",
- "vsupne;": "\u228B\uFE00",
- "vzigzag;": "\u299A",
- "wcirc;": "\u0175",
- "wedbar;": "\u2A5F",
- "wedge;": "\u2227",
- "wedgeq;": "\u2259",
- "weierp;": "\u2118",
- "wfr;": "\uD835\uDD34",
- "wopf;": "\uD835\uDD68",
- "wp;": "\u2118",
- "wr;": "\u2240",
- "wreath;": "\u2240",
- "wscr;": "\uD835\uDCCC",
- "xcap;": "\u22C2",
- "xcirc;": "\u25EF",
- "xcup;": "\u22C3",
- "xdtri;": "\u25BD",
- "xfr;": "\uD835\uDD35",
- "xhArr;": "\u27FA",
- "xharr;": "\u27F7",
- "xi;": "\u03BE",
- "xlArr;": "\u27F8",
- "xlarr;": "\u27F5",
- "xmap;": "\u27FC",
- "xnis;": "\u22FB",
- "xodot;": "\u2A00",
- "xopf;": "\uD835\uDD69",
- "xoplus;": "\u2A01",
- "xotime;": "\u2A02",
- "xrArr;": "\u27F9",
- "xrarr;": "\u27F6",
- "xscr;": "\uD835\uDCCD",
- "xsqcup;": "\u2A06",
- "xuplus;": "\u2A04",
- "xutri;": "\u25B3",
- "xvee;": "\u22C1",
- "xwedge;": "\u22C0",
- "yacute": "\u00FD",
- "yacute;": "\u00FD",
- "yacy;": "\u044F",
- "ycirc;": "\u0177",
- "ycy;": "\u044B",
- "yen": "\u00A5",
- "yen;": "\u00A5",
- "yfr;": "\uD835\uDD36",
- "yicy;": "\u0457",
- "yopf;": "\uD835\uDD6A",
- "yscr;": "\uD835\uDCCE",
- "yucy;": "\u044E",
- "yuml": "\u00FF",
- "yuml;": "\u00FF",
- "zacute;": "\u017A",
- "zcaron;": "\u017E",
- "zcy;": "\u0437",
- "zdot;": "\u017C",
- "zeetrf;": "\u2128",
- "zeta;": "\u03B6",
- "zfr;": "\uD835\uDD37",
- "zhcy;": "\u0436",
- "zigrarr;": "\u21DD",
- "zopf;": "\uD835\uDD6B",
- "zscr;": "\uD835\uDCCF",
- "zwj;": "\u200D",
- "zwnj;": "\u200C"
+ "AElig": { "p": [198], "c": "\u00C6" },
+ "AElig;": { "p": [198], "c": "\u00C6" },
+ "AMP": { "p": [38], "c": "\u0026" },
+ "AMP;": { "p": [38], "c": "\u0026" },
+ "Aacute": { "p": [193], "c": "\u00C1" },
+ "Aacute;": { "p": [193], "c": "\u00C1" },
+ "Abreve;": { "p": [258], "c": "\u0102" },
+ "Acirc": { "p": [194], "c": "\u00C2" },
+ "Acirc;": { "p": [194], "c": "\u00C2" },
+ "Acy;": { "p": [1040], "c": "\u0410" },
+ "Afr;": { "p": [120068], "c": "\uD835\uDD04" },
+ "Agrave": { "p": [192], "c": "\u00C0" },
+ "Agrave;": { "p": [192], "c": "\u00C0" },
+ "Alpha;": { "p": [913], "c": "\u0391" },
+ "Amacr;": { "p": [256], "c": "\u0100" },
+ "And;": { "p": [10835], "c": "\u2A53" },
+ "Aogon;": { "p": [260], "c": "\u0104" },
+ "Aopf;": { "p": [120120], "c": "\uD835\uDD38" },
+ "ApplyFunction;": { "p": [8289], "c": "\u2061" },
+ "Aring": { "p": [197], "c": "\u00C5" },
+ "Aring;": { "p": [197], "c": "\u00C5" },
+ "Ascr;": { "p": [119964], "c": "\uD835\uDC9C" },
+ "Assign;": { "p": [8788], "c": "\u2254" },
+ "Atilde": { "p": [195], "c": "\u00C3" },
+ "Atilde;": { "p": [195], "c": "\u00C3" },
+ "Auml": { "p": [196], "c": "\u00C4" },
+ "Auml;": { "p": [196], "c": "\u00C4" },
+ "Backslash;": { "p": [8726], "c": "\u2216" },
+ "Barv;": { "p": [10983], "c": "\u2AE7" },
+ "Barwed;": { "p": [8966], "c": "\u2306" },
+ "Bcy;": { "p": [1041], "c": "\u0411" },
+ "Because;": { "p": [8757], "c": "\u2235" },
+ "Bernoullis;": { "p": [8492], "c": "\u212C" },
+ "Beta;": { "p": [914], "c": "\u0392" },
+ "Bfr;": { "p": [120069], "c": "\uD835\uDD05" },
+ "Bopf;": { "p": [120121], "c": "\uD835\uDD39" },
+ "Breve;": { "p": [728], "c": "\u02D8" },
+ "Bscr;": { "p": [8492], "c": "\u212C" },
+ "Bumpeq;": { "p": [8782], "c": "\u224E" },
+ "CHcy;": { "p": [1063], "c": "\u0427" },
+ "COPY": { "p": [169], "c": "\u00A9" },
+ "COPY;": { "p": [169], "c": "\u00A9" },
+ "Cacute;": { "p": [262], "c": "\u0106" },
+ "Cap;": { "p": [8914], "c": "\u22D2" },
+ "CapitalDifferentialD;": { "p": [8517], "c": "\u2145" },
+ "Cayleys;": { "p": [8493], "c": "\u212D" },
+ "Ccaron;": { "p": [268], "c": "\u010C" },
+ "Ccedil": { "p": [199], "c": "\u00C7" },
+ "Ccedil;": { "p": [199], "c": "\u00C7" },
+ "Ccirc;": { "p": [264], "c": "\u0108" },
+ "Cconint;": { "p": [8752], "c": "\u2230" },
+ "Cdot;": { "p": [266], "c": "\u010A" },
+ "Cedilla;": { "p": [184], "c": "\u00B8" },
+ "CenterDot;": { "p": [183], "c": "\u00B7" },
+ "Cfr;": { "p": [8493], "c": "\u212D" },
+ "Chi;": { "p": [935], "c": "\u03A7" },
+ "CircleDot;": { "p": [8857], "c": "\u2299" },
+ "CircleMinus;": { "p": [8854], "c": "\u2296" },
+ "CirclePlus;": { "p": [8853], "c": "\u2295" },
+ "CircleTimes;": { "p": [8855], "c": "\u2297" },
+ "ClockwiseContourIntegral;": {
+ "p": [8754],
+ "c": "\u2232"
+ },
+ "CloseCurlyDoubleQuote;": { "p": [8221], "c": "\u201D" },
+ "CloseCurlyQuote;": { "p": [8217], "c": "\u2019" },
+ "Colon;": { "p": [8759], "c": "\u2237" },
+ "Colone;": { "p": [10868], "c": "\u2A74" },
+ "Congruent;": { "p": [8801], "c": "\u2261" },
+ "Conint;": { "p": [8751], "c": "\u222F" },
+ "ContourIntegral;": { "p": [8750], "c": "\u222E" },
+ "Copf;": { "p": [8450], "c": "\u2102" },
+ "Coproduct;": { "p": [8720], "c": "\u2210" },
+ "CounterClockwiseContourIntegral;": {
+ "p": [8755],
+ "c": "\u2233"
+ },
+ "Cross;": { "p": [10799], "c": "\u2A2F" },
+ "Cscr;": { "p": [119966], "c": "\uD835\uDC9E" },
+ "Cup;": { "p": [8915], "c": "\u22D3" },
+ "CupCap;": { "p": [8781], "c": "\u224D" },
+ "DD;": { "p": [8517], "c": "\u2145" },
+ "DDotrahd;": { "p": [10513], "c": "\u2911" },
+ "DJcy;": { "p": [1026], "c": "\u0402" },
+ "DScy;": { "p": [1029], "c": "\u0405" },
+ "DZcy;": { "p": [1039], "c": "\u040F" },
+ "Dagger;": { "p": [8225], "c": "\u2021" },
+ "Darr;": { "p": [8609], "c": "\u21A1" },
+ "Dashv;": { "p": [10980], "c": "\u2AE4" },
+ "Dcaron;": { "p": [270], "c": "\u010E" },
+ "Dcy;": { "p": [1044], "c": "\u0414" },
+ "Del;": { "p": [8711], "c": "\u2207" },
+ "Delta;": { "p": [916], "c": "\u0394" },
+ "Dfr;": { "p": [120071], "c": "\uD835\uDD07" },
+ "DiacriticalAcute;": { "p": [180], "c": "\u00B4" },
+ "DiacriticalDot;": { "p": [729], "c": "\u02D9" },
+ "DiacriticalDoubleAcute;": { "p": [733], "c": "\u02DD" },
+ "DiacriticalGrave;": { "p": [96], "c": "\u0060" },
+ "DiacriticalTilde;": { "p": [732], "c": "\u02DC" },
+ "Diamond;": { "p": [8900], "c": "\u22C4" },
+ "DifferentialD;": { "p": [8518], "c": "\u2146" },
+ "Dopf;": { "p": [120123], "c": "\uD835\uDD3B" },
+ "Dot;": { "p": [168], "c": "\u00A8" },
+ "DotDot;": { "p": [8412], "c": "\u20DC" },
+ "DotEqual;": { "p": [8784], "c": "\u2250" },
+ "DoubleContourIntegral;": { "p": [8751], "c": "\u222F" },
+ "DoubleDot;": { "p": [168], "c": "\u00A8" },
+ "DoubleDownArrow;": { "p": [8659], "c": "\u21D3" },
+ "DoubleLeftArrow;": { "p": [8656], "c": "\u21D0" },
+ "DoubleLeftRightArrow;": { "p": [8660], "c": "\u21D4" },
+ "DoubleLeftTee;": { "p": [10980], "c": "\u2AE4" },
+ "DoubleLongLeftArrow;": { "p": [10232], "c": "\u27F8" },
+ "DoubleLongLeftRightArrow;": {
+ "p": [10234],
+ "c": "\u27FA"
+ },
+ "DoubleLongRightArrow;": { "p": [10233], "c": "\u27F9" },
+ "DoubleRightArrow;": { "p": [8658], "c": "\u21D2" },
+ "DoubleRightTee;": { "p": [8872], "c": "\u22A8" },
+ "DoubleUpArrow;": { "p": [8657], "c": "\u21D1" },
+ "DoubleUpDownArrow;": { "p": [8661], "c": "\u21D5" },
+ "DoubleVerticalBar;": { "p": [8741], "c": "\u2225" },
+ "DownArrow;": { "p": [8595], "c": "\u2193" },
+ "DownArrowBar;": { "p": [10515], "c": "\u2913" },
+ "DownArrowUpArrow;": { "p": [8693], "c": "\u21F5" },
+ "DownBreve;": { "p": [785], "c": "\u0311" },
+ "DownLeftRightVector;": { "p": [10576], "c": "\u2950" },
+ "DownLeftTeeVector;": { "p": [10590], "c": "\u295E" },
+ "DownLeftVector;": { "p": [8637], "c": "\u21BD" },
+ "DownLeftVectorBar;": { "p": [10582], "c": "\u2956" },
+ "DownRightTeeVector;": { "p": [10591], "c": "\u295F" },
+ "DownRightVector;": { "p": [8641], "c": "\u21C1" },
+ "DownRightVectorBar;": { "p": [10583], "c": "\u2957" },
+ "DownTee;": { "p": [8868], "c": "\u22A4" },
+ "DownTeeArrow;": { "p": [8615], "c": "\u21A7" },
+ "Downarrow;": { "p": [8659], "c": "\u21D3" },
+ "Dscr;": { "p": [119967], "c": "\uD835\uDC9F" },
+ "Dstrok;": { "p": [272], "c": "\u0110" },
+ "ENG;": { "p": [330], "c": "\u014A" },
+ "ETH": { "p": [208], "c": "\u00D0" },
+ "ETH;": { "p": [208], "c": "\u00D0" },
+ "Eacute": { "p": [201], "c": "\u00C9" },
+ "Eacute;": { "p": [201], "c": "\u00C9" },
+ "Ecaron;": { "p": [282], "c": "\u011A" },
+ "Ecirc": { "p": [202], "c": "\u00CA" },
+ "Ecirc;": { "p": [202], "c": "\u00CA" },
+ "Ecy;": { "p": [1069], "c": "\u042D" },
+ "Edot;": { "p": [278], "c": "\u0116" },
+ "Efr;": { "p": [120072], "c": "\uD835\uDD08" },
+ "Egrave": { "p": [200], "c": "\u00C8" },
+ "Egrave;": { "p": [200], "c": "\u00C8" },
+ "Element;": { "p": [8712], "c": "\u2208" },
+ "Emacr;": { "p": [274], "c": "\u0112" },
+ "EmptySmallSquare;": { "p": [9723], "c": "\u25FB" },
+ "EmptyVerySmallSquare;": { "p": [9643], "c": "\u25AB" },
+ "Eogon;": { "p": [280], "c": "\u0118" },
+ "Eopf;": { "p": [120124], "c": "\uD835\uDD3C" },
+ "Epsilon;": { "p": [917], "c": "\u0395" },
+ "Equal;": { "p": [10869], "c": "\u2A75" },
+ "EqualTilde;": { "p": [8770], "c": "\u2242" },
+ "Equilibrium;": { "p": [8652], "c": "\u21CC" },
+ "Escr;": { "p": [8496], "c": "\u2130" },
+ "Esim;": { "p": [10867], "c": "\u2A73" },
+ "Eta;": { "p": [919], "c": "\u0397" },
+ "Euml": { "p": [203], "c": "\u00CB" },
+ "Euml;": { "p": [203], "c": "\u00CB" },
+ "Exists;": { "p": [8707], "c": "\u2203" },
+ "ExponentialE;": { "p": [8519], "c": "\u2147" },
+ "Fcy;": { "p": [1060], "c": "\u0424" },
+ "Ffr;": { "p": [120073], "c": "\uD835\uDD09" },
+ "FilledSmallSquare;": { "p": [9724], "c": "\u25FC" },
+ "FilledVerySmallSquare;": { "p": [9642], "c": "\u25AA" },
+ "Fopf;": { "p": [120125], "c": "\uD835\uDD3D" },
+ "ForAll;": { "p": [8704], "c": "\u2200" },
+ "Fouriertrf;": { "p": [8497], "c": "\u2131" },
+ "Fscr;": { "p": [8497], "c": "\u2131" },
+ "GJcy;": { "p": [1027], "c": "\u0403" },
+ "GT": { "p": [62], "c": "\u003E" },
+ "GT;": { "p": [62], "c": "\u003E" },
+ "Gamma;": { "p": [915], "c": "\u0393" },
+ "Gammad;": { "p": [988], "c": "\u03DC" },
+ "Gbreve;": { "p": [286], "c": "\u011E" },
+ "Gcedil;": { "p": [290], "c": "\u0122" },
+ "Gcirc;": { "p": [284], "c": "\u011C" },
+ "Gcy;": { "p": [1043], "c": "\u0413" },
+ "Gdot;": { "p": [288], "c": "\u0120" },
+ "Gfr;": { "p": [120074], "c": "\uD835\uDD0A" },
+ "Gg;": { "p": [8921], "c": "\u22D9" },
+ "Gopf;": { "p": [120126], "c": "\uD835\uDD3E" },
+ "GreaterEqual;": { "p": [8805], "c": "\u2265" },
+ "GreaterEqualLess;": { "p": [8923], "c": "\u22DB" },
+ "GreaterFullEqual;": { "p": [8807], "c": "\u2267" },
+ "GreaterGreater;": { "p": [10914], "c": "\u2AA2" },
+ "GreaterLess;": { "p": [8823], "c": "\u2277" },
+ "GreaterSlantEqual;": { "p": [10878], "c": "\u2A7E" },
+ "GreaterTilde;": { "p": [8819], "c": "\u2273" },
+ "Gscr;": { "p": [119970], "c": "\uD835\uDCA2" },
+ "Gt;": { "p": [8811], "c": "\u226B" },
+ "HARDcy;": { "p": [1066], "c": "\u042A" },
+ "Hacek;": { "p": [711], "c": "\u02C7" },
+ "Hat;": { "p": [94], "c": "\u005E" },
+ "Hcirc;": { "p": [292], "c": "\u0124" },
+ "Hfr;": { "p": [8460], "c": "\u210C" },
+ "HilbertSpace;": { "p": [8459], "c": "\u210B" },
+ "Hopf;": { "p": [8461], "c": "\u210D" },
+ "HorizontalLine;": { "p": [9472], "c": "\u2500" },
+ "Hscr;": { "p": [8459], "c": "\u210B" },
+ "Hstrok;": { "p": [294], "c": "\u0126" },
+ "HumpDownHump;": { "p": [8782], "c": "\u224E" },
+ "HumpEqual;": { "p": [8783], "c": "\u224F" },
+ "IEcy;": { "p": [1045], "c": "\u0415" },
+ "IJlig;": { "p": [306], "c": "\u0132" },
+ "IOcy;": { "p": [1025], "c": "\u0401" },
+ "Iacute": { "p": [205], "c": "\u00CD" },
+ "Iacute;": { "p": [205], "c": "\u00CD" },
+ "Icirc": { "p": [206], "c": "\u00CE" },
+ "Icirc;": { "p": [206], "c": "\u00CE" },
+ "Icy;": { "p": [1048], "c": "\u0418" },
+ "Idot;": { "p": [304], "c": "\u0130" },
+ "Ifr;": { "p": [8465], "c": "\u2111" },
+ "Igrave": { "p": [204], "c": "\u00CC" },
+ "Igrave;": { "p": [204], "c": "\u00CC" },
+ "Im;": { "p": [8465], "c": "\u2111" },
+ "Imacr;": { "p": [298], "c": "\u012A" },
+ "ImaginaryI;": { "p": [8520], "c": "\u2148" },
+ "Implies;": { "p": [8658], "c": "\u21D2" },
+ "Int;": { "p": [8748], "c": "\u222C" },
+ "Integral;": { "p": [8747], "c": "\u222B" },
+ "Intersection;": { "p": [8898], "c": "\u22C2" },
+ "InvisibleComma;": { "p": [8291], "c": "\u2063" },
+ "InvisibleTimes;": { "p": [8290], "c": "\u2062" },
+ "Iogon;": { "p": [302], "c": "\u012E" },
+ "Iopf;": { "p": [120128], "c": "\uD835\uDD40" },
+ "Iota;": { "p": [921], "c": "\u0399" },
+ "Iscr;": { "p": [8464], "c": "\u2110" },
+ "Itilde;": { "p": [296], "c": "\u0128" },
+ "Iukcy;": { "p": [1030], "c": "\u0406" },
+ "Iuml": { "p": [207], "c": "\u00CF" },
+ "Iuml;": { "p": [207], "c": "\u00CF" },
+ "Jcirc;": { "p": [308], "c": "\u0134" },
+ "Jcy;": { "p": [1049], "c": "\u0419" },
+ "Jfr;": { "p": [120077], "c": "\uD835\uDD0D" },
+ "Jopf;": { "p": [120129], "c": "\uD835\uDD41" },
+ "Jscr;": { "p": [119973], "c": "\uD835\uDCA5" },
+ "Jsercy;": { "p": [1032], "c": "\u0408" },
+ "Jukcy;": { "p": [1028], "c": "\u0404" },
+ "KHcy;": { "p": [1061], "c": "\u0425" },
+ "KJcy;": { "p": [1036], "c": "\u040C" },
+ "Kappa;": { "p": [922], "c": "\u039A" },
+ "Kcedil;": { "p": [310], "c": "\u0136" },
+ "Kcy;": { "p": [1050], "c": "\u041A" },
+ "Kfr;": { "p": [120078], "c": "\uD835\uDD0E" },
+ "Kopf;": { "p": [120130], "c": "\uD835\uDD42" },
+ "Kscr;": { "p": [119974], "c": "\uD835\uDCA6" },
+ "LJcy;": { "p": [1033], "c": "\u0409" },
+ "LT": { "p": [60], "c": "\u003C" },
+ "LT;": { "p": [60], "c": "\u003C" },
+ "Lacute;": { "p": [313], "c": "\u0139" },
+ "Lambda;": { "p": [923], "c": "\u039B" },
+ "Lang;": { "p": [10218], "c": "\u27EA" },
+ "Laplacetrf;": { "p": [8466], "c": "\u2112" },
+ "Larr;": { "p": [8606], "c": "\u219E" },
+ "Lcaron;": { "p": [317], "c": "\u013D" },
+ "Lcedil;": { "p": [315], "c": "\u013B" },
+ "Lcy;": { "p": [1051], "c": "\u041B" },
+ "LeftAngleBracket;": { "p": [10216], "c": "\u27E8" },
+ "LeftArrow;": { "p": [8592], "c": "\u2190" },
+ "LeftArrowBar;": { "p": [8676], "c": "\u21E4" },
+ "LeftArrowRightArrow;": { "p": [8646], "c": "\u21C6" },
+ "LeftCeiling;": { "p": [8968], "c": "\u2308" },
+ "LeftDoubleBracket;": { "p": [10214], "c": "\u27E6" },
+ "LeftDownTeeVector;": { "p": [10593], "c": "\u2961" },
+ "LeftDownVector;": { "p": [8643], "c": "\u21C3" },
+ "LeftDownVectorBar;": { "p": [10585], "c": "\u2959" },
+ "LeftFloor;": { "p": [8970], "c": "\u230A" },
+ "LeftRightArrow;": { "p": [8596], "c": "\u2194" },
+ "LeftRightVector;": { "p": [10574], "c": "\u294E" },
+ "LeftTee;": { "p": [8867], "c": "\u22A3" },
+ "LeftTeeArrow;": { "p": [8612], "c": "\u21A4" },
+ "LeftTeeVector;": { "p": [10586], "c": "\u295A" },
+ "LeftTriangle;": { "p": [8882], "c": "\u22B2" },
+ "LeftTriangleBar;": { "p": [10703], "c": "\u29CF" },
+ "LeftTriangleEqual;": { "p": [8884], "c": "\u22B4" },
+ "LeftUpDownVector;": { "p": [10577], "c": "\u2951" },
+ "LeftUpTeeVector;": { "p": [10592], "c": "\u2960" },
+ "LeftUpVector;": { "p": [8639], "c": "\u21BF" },
+ "LeftUpVectorBar;": { "p": [10584], "c": "\u2958" },
+ "LeftVector;": { "p": [8636], "c": "\u21BC" },
+ "LeftVectorBar;": { "p": [10578], "c": "\u2952" },
+ "Leftarrow;": { "p": [8656], "c": "\u21D0" },
+ "Leftrightarrow;": { "p": [8660], "c": "\u21D4" },
+ "LessEqualGreater;": { "p": [8922], "c": "\u22DA" },
+ "LessFullEqual;": { "p": [8806], "c": "\u2266" },
+ "LessGreater;": { "p": [8822], "c": "\u2276" },
+ "LessLess;": { "p": [10913], "c": "\u2AA1" },
+ "LessSlantEqual;": { "p": [10877], "c": "\u2A7D" },
+ "LessTilde;": { "p": [8818], "c": "\u2272" },
+ "Lfr;": { "p": [120079], "c": "\uD835\uDD0F" },
+ "Ll;": { "p": [8920], "c": "\u22D8" },
+ "Lleftarrow;": { "p": [8666], "c": "\u21DA" },
+ "Lmidot;": { "p": [319], "c": "\u013F" },
+ "LongLeftArrow;": { "p": [10229], "c": "\u27F5" },
+ "LongLeftRightArrow;": { "p": [10231], "c": "\u27F7" },
+ "LongRightArrow;": { "p": [10230], "c": "\u27F6" },
+ "Longleftarrow;": { "p": [10232], "c": "\u27F8" },
+ "Longleftrightarrow;": { "p": [10234], "c": "\u27FA" },
+ "Longrightarrow;": { "p": [10233], "c": "\u27F9" },
+ "Lopf;": { "p": [120131], "c": "\uD835\uDD43" },
+ "LowerLeftArrow;": { "p": [8601], "c": "\u2199" },
+ "LowerRightArrow;": { "p": [8600], "c": "\u2198" },
+ "Lscr;": { "p": [8466], "c": "\u2112" },
+ "Lsh;": { "p": [8624], "c": "\u21B0" },
+ "Lstrok;": { "p": [321], "c": "\u0141" },
+ "Lt;": { "p": [8810], "c": "\u226A" },
+ "Map;": { "p": [10501], "c": "\u2905" },
+ "Mcy;": { "p": [1052], "c": "\u041C" },
+ "MediumSpace;": { "p": [8287], "c": "\u205F" },
+ "Mellintrf;": { "p": [8499], "c": "\u2133" },
+ "Mfr;": { "p": [120080], "c": "\uD835\uDD10" },
+ "MinusPlus;": { "p": [8723], "c": "\u2213" },
+ "Mopf;": { "p": [120132], "c": "\uD835\uDD44" },
+ "Mscr;": { "p": [8499], "c": "\u2133" },
+ "Mu;": { "p": [924], "c": "\u039C" },
+ "NJcy;": { "p": [1034], "c": "\u040A" },
+ "Nacute;": { "p": [323], "c": "\u0143" },
+ "Ncaron;": { "p": [327], "c": "\u0147" },
+ "Ncedil;": { "p": [325], "c": "\u0145" },
+ "Ncy;": { "p": [1053], "c": "\u041D" },
+ "NegativeMediumSpace;": { "p": [8203], "c": "\u200B" },
+ "NegativeThickSpace;": { "p": [8203], "c": "\u200B" },
+ "NegativeThinSpace;": { "p": [8203], "c": "\u200B" },
+ "NegativeVeryThinSpace;": { "p": [8203], "c": "\u200B" },
+ "NestedGreaterGreater;": { "p": [8811], "c": "\u226B" },
+ "NestedLessLess;": { "p": [8810], "c": "\u226A" },
+ "NewLine;": { "p": [10], "c": "\u000A" },
+ "Nfr;": { "p": [120081], "c": "\uD835\uDD11" },
+ "NoBreak;": { "p": [8288], "c": "\u2060" },
+ "NonBreakingSpace;": { "p": [160], "c": "\u00A0" },
+ "Nopf;": { "p": [8469], "c": "\u2115" },
+ "Not;": { "p": [10988], "c": "\u2AEC" },
+ "NotCongruent;": { "p": [8802], "c": "\u2262" },
+ "NotCupCap;": { "p": [8813], "c": "\u226D" },
+ "NotDoubleVerticalBar;": { "p": [8742], "c": "\u2226" },
+ "NotElement;": { "p": [8713], "c": "\u2209" },
+ "NotEqual;": { "p": [8800], "c": "\u2260" },
+ "NotEqualTilde;": {
+ "p": [8770, 824],
+ "c": "\u2242\u0338"
+ },
+ "NotExists;": { "p": [8708], "c": "\u2204" },
+ "NotGreater;": { "p": [8815], "c": "\u226F" },
+ "NotGreaterEqual;": { "p": [8817], "c": "\u2271" },
+ "NotGreaterFullEqual;": {
+ "p": [8807, 824],
+ "c": "\u2267\u0338"
+ },
+ "NotGreaterGreater;": {
+ "p": [8811, 824],
+ "c": "\u226B\u0338"
+ },
+ "NotGreaterLess;": { "p": [8825], "c": "\u2279" },
+ "NotGreaterSlantEqual;": {
+ "p": [10878, 824],
+ "c": "\u2A7E\u0338"
+ },
+ "NotGreaterTilde;": { "p": [8821], "c": "\u2275" },
+ "NotHumpDownHump;": {
+ "p": [8782, 824],
+ "c": "\u224E\u0338"
+ },
+ "NotHumpEqual;": {
+ "p": [8783, 824],
+ "c": "\u224F\u0338"
+ },
+ "NotLeftTriangle;": { "p": [8938], "c": "\u22EA" },
+ "NotLeftTriangleBar;": {
+ "p": [10703, 824],
+ "c": "\u29CF\u0338"
+ },
+ "NotLeftTriangleEqual;": { "p": [8940], "c": "\u22EC" },
+ "NotLess;": { "p": [8814], "c": "\u226E" },
+ "NotLessEqual;": { "p": [8816], "c": "\u2270" },
+ "NotLessGreater;": { "p": [8824], "c": "\u2278" },
+ "NotLessLess;": {
+ "p": [8810, 824],
+ "c": "\u226A\u0338"
+ },
+ "NotLessSlantEqual;": {
+ "p": [10877, 824],
+ "c": "\u2A7D\u0338"
+ },
+ "NotLessTilde;": { "p": [8820], "c": "\u2274" },
+ "NotNestedGreaterGreater;": {
+ "p": [10914, 824],
+ "c": "\u2AA2\u0338"
+ },
+ "NotNestedLessLess;": {
+ "p": [10913, 824],
+ "c": "\u2AA1\u0338"
+ },
+ "NotPrecedes;": { "p": [8832], "c": "\u2280" },
+ "NotPrecedesEqual;": {
+ "p": [10927, 824],
+ "c": "\u2AAF\u0338"
+ },
+ "NotPrecedesSlantEqual;": { "p": [8928], "c": "\u22E0" },
+ "NotReverseElement;": { "p": [8716], "c": "\u220C" },
+ "NotRightTriangle;": { "p": [8939], "c": "\u22EB" },
+ "NotRightTriangleBar;": {
+ "p": [10704, 824],
+ "c": "\u29D0\u0338"
+ },
+ "NotRightTriangleEqual;": { "p": [8941], "c": "\u22ED" },
+ "NotSquareSubset;": {
+ "p": [8847, 824],
+ "c": "\u228F\u0338"
+ },
+ "NotSquareSubsetEqual;": { "p": [8930], "c": "\u22E2" },
+ "NotSquareSuperset;": {
+ "p": [8848, 824],
+ "c": "\u2290\u0338"
+ },
+ "NotSquareSupersetEqual;": {
+ "p": [8931],
+ "c": "\u22E3"
+ },
+ "NotSubset;": { "p": [8834, 8402], "c": "\u2282\u20D2" },
+ "NotSubsetEqual;": { "p": [8840], "c": "\u2288" },
+ "NotSucceeds;": { "p": [8833], "c": "\u2281" },
+ "NotSucceedsEqual;": {
+ "p": [10928, 824],
+ "c": "\u2AB0\u0338"
+ },
+ "NotSucceedsSlantEqual;": { "p": [8929], "c": "\u22E1" },
+ "NotSucceedsTilde;": {
+ "p": [8831, 824],
+ "c": "\u227F\u0338"
+ },
+ "NotSuperset;": {
+ "p": [8835, 8402],
+ "c": "\u2283\u20D2"
+ },
+ "NotSupersetEqual;": { "p": [8841], "c": "\u2289" },
+ "NotTilde;": { "p": [8769], "c": "\u2241" },
+ "NotTildeEqual;": { "p": [8772], "c": "\u2244" },
+ "NotTildeFullEqual;": { "p": [8775], "c": "\u2247" },
+ "NotTildeTilde;": { "p": [8777], "c": "\u2249" },
+ "NotVerticalBar;": { "p": [8740], "c": "\u2224" },
+ "Nscr;": { "p": [119977], "c": "\uD835\uDCA9" },
+ "Ntilde": { "p": [209], "c": "\u00D1" },
+ "Ntilde;": { "p": [209], "c": "\u00D1" },
+ "Nu;": { "p": [925], "c": "\u039D" },
+ "OElig;": { "p": [338], "c": "\u0152" },
+ "Oacute": { "p": [211], "c": "\u00D3" },
+ "Oacute;": { "p": [211], "c": "\u00D3" },
+ "Ocirc": { "p": [212], "c": "\u00D4" },
+ "Ocirc;": { "p": [212], "c": "\u00D4" },
+ "Ocy;": { "p": [1054], "c": "\u041E" },
+ "Odblac;": { "p": [336], "c": "\u0150" },
+ "Ofr;": { "p": [120082], "c": "\uD835\uDD12" },
+ "Ograve": { "p": [210], "c": "\u00D2" },
+ "Ograve;": { "p": [210], "c": "\u00D2" },
+ "Omacr;": { "p": [332], "c": "\u014C" },
+ "Omega;": { "p": [937], "c": "\u03A9" },
+ "Omicron;": { "p": [927], "c": "\u039F" },
+ "Oopf;": { "p": [120134], "c": "\uD835\uDD46" },
+ "OpenCurlyDoubleQuote;": { "p": [8220], "c": "\u201C" },
+ "OpenCurlyQuote;": { "p": [8216], "c": "\u2018" },
+ "Or;": { "p": [10836], "c": "\u2A54" },
+ "Oscr;": { "p": [119978], "c": "\uD835\uDCAA" },
+ "Oslash": { "p": [216], "c": "\u00D8" },
+ "Oslash;": { "p": [216], "c": "\u00D8" },
+ "Otilde": { "p": [213], "c": "\u00D5" },
+ "Otilde;": { "p": [213], "c": "\u00D5" },
+ "Otimes;": { "p": [10807], "c": "\u2A37" },
+ "Ouml": { "p": [214], "c": "\u00D6" },
+ "Ouml;": { "p": [214], "c": "\u00D6" },
+ "OverBar;": { "p": [8254], "c": "\u203E" },
+ "OverBrace;": { "p": [9182], "c": "\u23DE" },
+ "OverBracket;": { "p": [9140], "c": "\u23B4" },
+ "OverParenthesis;": { "p": [9180], "c": "\u23DC" },
+ "PartialD;": { "p": [8706], "c": "\u2202" },
+ "Pcy;": { "p": [1055], "c": "\u041F" },
+ "Pfr;": { "p": [120083], "c": "\uD835\uDD13" },
+ "Phi;": { "p": [934], "c": "\u03A6" },
+ "Pi;": { "p": [928], "c": "\u03A0" },
+ "PlusMinus;": { "p": [177], "c": "\u00B1" },
+ "Poincareplane;": { "p": [8460], "c": "\u210C" },
+ "Popf;": { "p": [8473], "c": "\u2119" },
+ "Pr;": { "p": [10939], "c": "\u2ABB" },
+ "Precedes;": { "p": [8826], "c": "\u227A" },
+ "PrecedesEqual;": { "p": [10927], "c": "\u2AAF" },
+ "PrecedesSlantEqual;": { "p": [8828], "c": "\u227C" },
+ "PrecedesTilde;": { "p": [8830], "c": "\u227E" },
+ "Prime;": { "p": [8243], "c": "\u2033" },
+ "Product;": { "p": [8719], "c": "\u220F" },
+ "Proportion;": { "p": [8759], "c": "\u2237" },
+ "Proportional;": { "p": [8733], "c": "\u221D" },
+ "Pscr;": { "p": [119979], "c": "\uD835\uDCAB" },
+ "Psi;": { "p": [936], "c": "\u03A8" },
+ "QUOT": { "p": [34], "c": "\u0022" },
+ "QUOT;": { "p": [34], "c": "\u0022" },
+ "Qfr;": { "p": [120084], "c": "\uD835\uDD14" },
+ "Qopf;": { "p": [8474], "c": "\u211A" },
+ "Qscr;": { "p": [119980], "c": "\uD835\uDCAC" },
+ "RBarr;": { "p": [10512], "c": "\u2910" },
+ "REG": { "p": [174], "c": "\u00AE" },
+ "REG;": { "p": [174], "c": "\u00AE" },
+ "Racute;": { "p": [340], "c": "\u0154" },
+ "Rang;": { "p": [10219], "c": "\u27EB" },
+ "Rarr;": { "p": [8608], "c": "\u21A0" },
+ "Rarrtl;": { "p": [10518], "c": "\u2916" },
+ "Rcaron;": { "p": [344], "c": "\u0158" },
+ "Rcedil;": { "p": [342], "c": "\u0156" },
+ "Rcy;": { "p": [1056], "c": "\u0420" },
+ "Re;": { "p": [8476], "c": "\u211C" },
+ "ReverseElement;": { "p": [8715], "c": "\u220B" },
+ "ReverseEquilibrium;": { "p": [8651], "c": "\u21CB" },
+ "ReverseUpEquilibrium;": { "p": [10607], "c": "\u296F" },
+ "Rfr;": { "p": [8476], "c": "\u211C" },
+ "Rho;": { "p": [929], "c": "\u03A1" },
+ "RightAngleBracket;": { "p": [10217], "c": "\u27E9" },
+ "RightArrow;": { "p": [8594], "c": "\u2192" },
+ "RightArrowBar;": { "p": [8677], "c": "\u21E5" },
+ "RightArrowLeftArrow;": { "p": [8644], "c": "\u21C4" },
+ "RightCeiling;": { "p": [8969], "c": "\u2309" },
+ "RightDoubleBracket;": { "p": [10215], "c": "\u27E7" },
+ "RightDownTeeVector;": { "p": [10589], "c": "\u295D" },
+ "RightDownVector;": { "p": [8642], "c": "\u21C2" },
+ "RightDownVectorBar;": { "p": [10581], "c": "\u2955" },
+ "RightFloor;": { "p": [8971], "c": "\u230B" },
+ "RightTee;": { "p": [8866], "c": "\u22A2" },
+ "RightTeeArrow;": { "p": [8614], "c": "\u21A6" },
+ "RightTeeVector;": { "p": [10587], "c": "\u295B" },
+ "RightTriangle;": { "p": [8883], "c": "\u22B3" },
+ "RightTriangleBar;": { "p": [10704], "c": "\u29D0" },
+ "RightTriangleEqual;": { "p": [8885], "c": "\u22B5" },
+ "RightUpDownVector;": { "p": [10575], "c": "\u294F" },
+ "RightUpTeeVector;": { "p": [10588], "c": "\u295C" },
+ "RightUpVector;": { "p": [8638], "c": "\u21BE" },
+ "RightUpVectorBar;": { "p": [10580], "c": "\u2954" },
+ "RightVector;": { "p": [8640], "c": "\u21C0" },
+ "RightVectorBar;": { "p": [10579], "c": "\u2953" },
+ "Rightarrow;": { "p": [8658], "c": "\u21D2" },
+ "Ropf;": { "p": [8477], "c": "\u211D" },
+ "RoundImplies;": { "p": [10608], "c": "\u2970" },
+ "Rrightarrow;": { "p": [8667], "c": "\u21DB" },
+ "Rscr;": { "p": [8475], "c": "\u211B" },
+ "Rsh;": { "p": [8625], "c": "\u21B1" },
+ "RuleDelayed;": { "p": [10740], "c": "\u29F4" },
+ "SHCHcy;": { "p": [1065], "c": "\u0429" },
+ "SHcy;": { "p": [1064], "c": "\u0428" },
+ "SOFTcy;": { "p": [1068], "c": "\u042C" },
+ "Sacute;": { "p": [346], "c": "\u015A" },
+ "Sc;": { "p": [10940], "c": "\u2ABC" },
+ "Scaron;": { "p": [352], "c": "\u0160" },
+ "Scedil;": { "p": [350], "c": "\u015E" },
+ "Scirc;": { "p": [348], "c": "\u015C" },
+ "Scy;": { "p": [1057], "c": "\u0421" },
+ "Sfr;": { "p": [120086], "c": "\uD835\uDD16" },
+ "ShortDownArrow;": { "p": [8595], "c": "\u2193" },
+ "ShortLeftArrow;": { "p": [8592], "c": "\u2190" },
+ "ShortRightArrow;": { "p": [8594], "c": "\u2192" },
+ "ShortUpArrow;": { "p": [8593], "c": "\u2191" },
+ "Sigma;": { "p": [931], "c": "\u03A3" },
+ "SmallCircle;": { "p": [8728], "c": "\u2218" },
+ "Sopf;": { "p": [120138], "c": "\uD835\uDD4A" },
+ "Sqrt;": { "p": [8730], "c": "\u221A" },
+ "Square;": { "p": [9633], "c": "\u25A1" },
+ "SquareIntersection;": { "p": [8851], "c": "\u2293" },
+ "SquareSubset;": { "p": [8847], "c": "\u228F" },
+ "SquareSubsetEqual;": { "p": [8849], "c": "\u2291" },
+ "SquareSuperset;": { "p": [8848], "c": "\u2290" },
+ "SquareSupersetEqual;": { "p": [8850], "c": "\u2292" },
+ "SquareUnion;": { "p": [8852], "c": "\u2294" },
+ "Sscr;": { "p": [119982], "c": "\uD835\uDCAE" },
+ "Star;": { "p": [8902], "c": "\u22C6" },
+ "Sub;": { "p": [8912], "c": "\u22D0" },
+ "Subset;": { "p": [8912], "c": "\u22D0" },
+ "SubsetEqual;": { "p": [8838], "c": "\u2286" },
+ "Succeeds;": { "p": [8827], "c": "\u227B" },
+ "SucceedsEqual;": { "p": [10928], "c": "\u2AB0" },
+ "SucceedsSlantEqual;": { "p": [8829], "c": "\u227D" },
+ "SucceedsTilde;": { "p": [8831], "c": "\u227F" },
+ "SuchThat;": { "p": [8715], "c": "\u220B" },
+ "Sum;": { "p": [8721], "c": "\u2211" },
+ "Sup;": { "p": [8913], "c": "\u22D1" },
+ "Superset;": { "p": [8835], "c": "\u2283" },
+ "SupersetEqual;": { "p": [8839], "c": "\u2287" },
+ "Supset;": { "p": [8913], "c": "\u22D1" },
+ "THORN": { "p": [222], "c": "\u00DE" },
+ "THORN;": { "p": [222], "c": "\u00DE" },
+ "TRADE;": { "p": [8482], "c": "\u2122" },
+ "TSHcy;": { "p": [1035], "c": "\u040B" },
+ "TScy;": { "p": [1062], "c": "\u0426" },
+ "Tab;": { "p": [9], "c": "\u0009" },
+ "Tau;": { "p": [932], "c": "\u03A4" },
+ "Tcaron;": { "p": [356], "c": "\u0164" },
+ "Tcedil;": { "p": [354], "c": "\u0162" },
+ "Tcy;": { "p": [1058], "c": "\u0422" },
+ "Tfr;": { "p": [120087], "c": "\uD835\uDD17" },
+ "Therefore;": { "p": [8756], "c": "\u2234" },
+ "Theta;": { "p": [920], "c": "\u0398" },
+ "ThickSpace;": {
+ "p": [8287, 8202],
+ "c": "\u205F\u200A"
+ },
+ "ThinSpace;": { "p": [8201], "c": "\u2009" },
+ "Tilde;": { "p": [8764], "c": "\u223C" },
+ "TildeEqual;": { "p": [8771], "c": "\u2243" },
+ "TildeFullEqual;": { "p": [8773], "c": "\u2245" },
+ "TildeTilde;": { "p": [8776], "c": "\u2248" },
+ "Topf;": { "p": [120139], "c": "\uD835\uDD4B" },
+ "TripleDot;": { "p": [8411], "c": "\u20DB" },
+ "Tscr;": { "p": [119983], "c": "\uD835\uDCAF" },
+ "Tstrok;": { "p": [358], "c": "\u0166" },
+ "Uacute": { "p": [218], "c": "\u00DA" },
+ "Uacute;": { "p": [218], "c": "\u00DA" },
+ "Uarr;": { "p": [8607], "c": "\u219F" },
+ "Uarrocir;": { "p": [10569], "c": "\u2949" },
+ "Ubrcy;": { "p": [1038], "c": "\u040E" },
+ "Ubreve;": { "p": [364], "c": "\u016C" },
+ "Ucirc": { "p": [219], "c": "\u00DB" },
+ "Ucirc;": { "p": [219], "c": "\u00DB" },
+ "Ucy;": { "p": [1059], "c": "\u0423" },
+ "Udblac;": { "p": [368], "c": "\u0170" },
+ "Ufr;": { "p": [120088], "c": "\uD835\uDD18" },
+ "Ugrave": { "p": [217], "c": "\u00D9" },
+ "Ugrave;": { "p": [217], "c": "\u00D9" },
+ "Umacr;": { "p": [362], "c": "\u016A" },
+ "UnderBar;": { "p": [95], "c": "\u005F" },
+ "UnderBrace;": { "p": [9183], "c": "\u23DF" },
+ "UnderBracket;": { "p": [9141], "c": "\u23B5" },
+ "UnderParenthesis;": { "p": [9181], "c": "\u23DD" },
+ "Union;": { "p": [8899], "c": "\u22C3" },
+ "UnionPlus;": { "p": [8846], "c": "\u228E" },
+ "Uogon;": { "p": [370], "c": "\u0172" },
+ "Uopf;": { "p": [120140], "c": "\uD835\uDD4C" },
+ "UpArrow;": { "p": [8593], "c": "\u2191" },
+ "UpArrowBar;": { "p": [10514], "c": "\u2912" },
+ "UpArrowDownArrow;": { "p": [8645], "c": "\u21C5" },
+ "UpDownArrow;": { "p": [8597], "c": "\u2195" },
+ "UpEquilibrium;": { "p": [10606], "c": "\u296E" },
+ "UpTee;": { "p": [8869], "c": "\u22A5" },
+ "UpTeeArrow;": { "p": [8613], "c": "\u21A5" },
+ "Uparrow;": { "p": [8657], "c": "\u21D1" },
+ "Updownarrow;": { "p": [8661], "c": "\u21D5" },
+ "UpperLeftArrow;": { "p": [8598], "c": "\u2196" },
+ "UpperRightArrow;": { "p": [8599], "c": "\u2197" },
+ "Upsi;": { "p": [978], "c": "\u03D2" },
+ "Upsilon;": { "p": [933], "c": "\u03A5" },
+ "Uring;": { "p": [366], "c": "\u016E" },
+ "Uscr;": { "p": [119984], "c": "\uD835\uDCB0" },
+ "Utilde;": { "p": [360], "c": "\u0168" },
+ "Uuml": { "p": [220], "c": "\u00DC" },
+ "Uuml;": { "p": [220], "c": "\u00DC" },
+ "VDash;": { "p": [8875], "c": "\u22AB" },
+ "Vbar;": { "p": [10987], "c": "\u2AEB" },
+ "Vcy;": { "p": [1042], "c": "\u0412" },
+ "Vdash;": { "p": [8873], "c": "\u22A9" },
+ "Vdashl;": { "p": [10982], "c": "\u2AE6" },
+ "Vee;": { "p": [8897], "c": "\u22C1" },
+ "Verbar;": { "p": [8214], "c": "\u2016" },
+ "Vert;": { "p": [8214], "c": "\u2016" },
+ "VerticalBar;": { "p": [8739], "c": "\u2223" },
+ "VerticalLine;": { "p": [124], "c": "\u007C" },
+ "VerticalSeparator;": { "p": [10072], "c": "\u2758" },
+ "VerticalTilde;": { "p": [8768], "c": "\u2240" },
+ "VeryThinSpace;": { "p": [8202], "c": "\u200A" },
+ "Vfr;": { "p": [120089], "c": "\uD835\uDD19" },
+ "Vopf;": { "p": [120141], "c": "\uD835\uDD4D" },
+ "Vscr;": { "p": [119985], "c": "\uD835\uDCB1" },
+ "Vvdash;": { "p": [8874], "c": "\u22AA" },
+ "Wcirc;": { "p": [372], "c": "\u0174" },
+ "Wedge;": { "p": [8896], "c": "\u22C0" },
+ "Wfr;": { "p": [120090], "c": "\uD835\uDD1A" },
+ "Wopf;": { "p": [120142], "c": "\uD835\uDD4E" },
+ "Wscr;": { "p": [119986], "c": "\uD835\uDCB2" },
+ "Xfr;": { "p": [120091], "c": "\uD835\uDD1B" },
+ "Xi;": { "p": [926], "c": "\u039E" },
+ "Xopf;": { "p": [120143], "c": "\uD835\uDD4F" },
+ "Xscr;": { "p": [119987], "c": "\uD835\uDCB3" },
+ "YAcy;": { "p": [1071], "c": "\u042F" },
+ "YIcy;": { "p": [1031], "c": "\u0407" },
+ "YUcy;": { "p": [1070], "c": "\u042E" },
+ "Yacute": { "p": [221], "c": "\u00DD" },
+ "Yacute;": { "p": [221], "c": "\u00DD" },
+ "Ycirc;": { "p": [374], "c": "\u0176" },
+ "Ycy;": { "p": [1067], "c": "\u042B" },
+ "Yfr;": { "p": [120092], "c": "\uD835\uDD1C" },
+ "Yopf;": { "p": [120144], "c": "\uD835\uDD50" },
+ "Yscr;": { "p": [119988], "c": "\uD835\uDCB4" },
+ "Yuml;": { "p": [376], "c": "\u0178" },
+ "ZHcy;": { "p": [1046], "c": "\u0416" },
+ "Zacute;": { "p": [377], "c": "\u0179" },
+ "Zcaron;": { "p": [381], "c": "\u017D" },
+ "Zcy;": { "p": [1047], "c": "\u0417" },
+ "Zdot;": { "p": [379], "c": "\u017B" },
+ "ZeroWidthSpace;": { "p": [8203], "c": "\u200B" },
+ "Zeta;": { "p": [918], "c": "\u0396" },
+ "Zfr;": { "p": [8488], "c": "\u2128" },
+ "Zopf;": { "p": [8484], "c": "\u2124" },
+ "Zscr;": { "p": [119989], "c": "\uD835\uDCB5" },
+ "aacute": { "p": [225], "c": "\u00E1" },
+ "aacute;": { "p": [225], "c": "\u00E1" },
+ "abreve;": { "p": [259], "c": "\u0103" },
+ "ac;": { "p": [8766], "c": "\u223E" },
+ "acE;": { "p": [8766, 819], "c": "\u223E\u0333" },
+ "acd;": { "p": [8767], "c": "\u223F" },
+ "acirc": { "p": [226], "c": "\u00E2" },
+ "acirc;": { "p": [226], "c": "\u00E2" },
+ "acute": { "p": [180], "c": "\u00B4" },
+ "acute;": { "p": [180], "c": "\u00B4" },
+ "acy;": { "p": [1072], "c": "\u0430" },
+ "aelig": { "p": [230], "c": "\u00E6" },
+ "aelig;": { "p": [230], "c": "\u00E6" },
+ "af;": { "p": [8289], "c": "\u2061" },
+ "afr;": { "p": [120094], "c": "\uD835\uDD1E" },
+ "agrave": { "p": [224], "c": "\u00E0" },
+ "agrave;": { "p": [224], "c": "\u00E0" },
+ "alefsym;": { "p": [8501], "c": "\u2135" },
+ "aleph;": { "p": [8501], "c": "\u2135" },
+ "alpha;": { "p": [945], "c": "\u03B1" },
+ "amacr;": { "p": [257], "c": "\u0101" },
+ "amalg;": { "p": [10815], "c": "\u2A3F" },
+ "amp": { "p": [38], "c": "\u0026" },
+ "amp;": { "p": [38], "c": "\u0026" },
+ "and;": { "p": [8743], "c": "\u2227" },
+ "andand;": { "p": [10837], "c": "\u2A55" },
+ "andd;": { "p": [10844], "c": "\u2A5C" },
+ "andslope;": { "p": [10840], "c": "\u2A58" },
+ "andv;": { "p": [10842], "c": "\u2A5A" },
+ "ang;": { "p": [8736], "c": "\u2220" },
+ "ange;": { "p": [10660], "c": "\u29A4" },
+ "angle;": { "p": [8736], "c": "\u2220" },
+ "angmsd;": { "p": [8737], "c": "\u2221" },
+ "angmsdaa;": { "p": [10664], "c": "\u29A8" },
+ "angmsdab;": { "p": [10665], "c": "\u29A9" },
+ "angmsdac;": { "p": [10666], "c": "\u29AA" },
+ "angmsdad;": { "p": [10667], "c": "\u29AB" },
+ "angmsdae;": { "p": [10668], "c": "\u29AC" },
+ "angmsdaf;": { "p": [10669], "c": "\u29AD" },
+ "angmsdag;": { "p": [10670], "c": "\u29AE" },
+ "angmsdah;": { "p": [10671], "c": "\u29AF" },
+ "angrt;": { "p": [8735], "c": "\u221F" },
+ "angrtvb;": { "p": [8894], "c": "\u22BE" },
+ "angrtvbd;": { "p": [10653], "c": "\u299D" },
+ "angsph;": { "p": [8738], "c": "\u2222" },
+ "angst;": { "p": [197], "c": "\u00C5" },
+ "angzarr;": { "p": [9084], "c": "\u237C" },
+ "aogon;": { "p": [261], "c": "\u0105" },
+ "aopf;": { "p": [120146], "c": "\uD835\uDD52" },
+ "ap;": { "p": [8776], "c": "\u2248" },
+ "apE;": { "p": [10864], "c": "\u2A70" },
+ "apacir;": { "p": [10863], "c": "\u2A6F" },
+ "ape;": { "p": [8778], "c": "\u224A" },
+ "apid;": { "p": [8779], "c": "\u224B" },
+ "apos;": { "p": [39], "c": "\u0027" },
+ "approx;": { "p": [8776], "c": "\u2248" },
+ "approxeq;": { "p": [8778], "c": "\u224A" },
+ "aring": { "p": [229], "c": "\u00E5" },
+ "aring;": { "p": [229], "c": "\u00E5" },
+ "ascr;": { "p": [119990], "c": "\uD835\uDCB6" },
+ "ast;": { "p": [42], "c": "\u002A" },
+ "asymp;": { "p": [8776], "c": "\u2248" },
+ "asympeq;": { "p": [8781], "c": "\u224D" },
+ "atilde": { "p": [227], "c": "\u00E3" },
+ "atilde;": { "p": [227], "c": "\u00E3" },
+ "auml": { "p": [228], "c": "\u00E4" },
+ "auml;": { "p": [228], "c": "\u00E4" },
+ "awconint;": { "p": [8755], "c": "\u2233" },
+ "awint;": { "p": [10769], "c": "\u2A11" },
+ "bNot;": { "p": [10989], "c": "\u2AED" },
+ "backcong;": { "p": [8780], "c": "\u224C" },
+ "backepsilon;": { "p": [1014], "c": "\u03F6" },
+ "backprime;": { "p": [8245], "c": "\u2035" },
+ "backsim;": { "p": [8765], "c": "\u223D" },
+ "backsimeq;": { "p": [8909], "c": "\u22CD" },
+ "barvee;": { "p": [8893], "c": "\u22BD" },
+ "barwed;": { "p": [8965], "c": "\u2305" },
+ "barwedge;": { "p": [8965], "c": "\u2305" },
+ "bbrk;": { "p": [9141], "c": "\u23B5" },
+ "bbrktbrk;": { "p": [9142], "c": "\u23B6" },
+ "bcong;": { "p": [8780], "c": "\u224C" },
+ "bcy;": { "p": [1073], "c": "\u0431" },
+ "bdquo;": { "p": [8222], "c": "\u201E" },
+ "becaus;": { "p": [8757], "c": "\u2235" },
+ "because;": { "p": [8757], "c": "\u2235" },
+ "bemptyv;": { "p": [10672], "c": "\u29B0" },
+ "bepsi;": { "p": [1014], "c": "\u03F6" },
+ "bernou;": { "p": [8492], "c": "\u212C" },
+ "beta;": { "p": [946], "c": "\u03B2" },
+ "beth;": { "p": [8502], "c": "\u2136" },
+ "between;": { "p": [8812], "c": "\u226C" },
+ "bfr;": { "p": [120095], "c": "\uD835\uDD1F" },
+ "bigcap;": { "p": [8898], "c": "\u22C2" },
+ "bigcirc;": { "p": [9711], "c": "\u25EF" },
+ "bigcup;": { "p": [8899], "c": "\u22C3" },
+ "bigodot;": { "p": [10752], "c": "\u2A00" },
+ "bigoplus;": { "p": [10753], "c": "\u2A01" },
+ "bigotimes;": { "p": [10754], "c": "\u2A02" },
+ "bigsqcup;": { "p": [10758], "c": "\u2A06" },
+ "bigstar;": { "p": [9733], "c": "\u2605" },
+ "bigtriangledown;": { "p": [9661], "c": "\u25BD" },
+ "bigtriangleup;": { "p": [9651], "c": "\u25B3" },
+ "biguplus;": { "p": [10756], "c": "\u2A04" },
+ "bigvee;": { "p": [8897], "c": "\u22C1" },
+ "bigwedge;": { "p": [8896], "c": "\u22C0" },
+ "bkarow;": { "p": [10509], "c": "\u290D" },
+ "blacklozenge;": { "p": [10731], "c": "\u29EB" },
+ "blacksquare;": { "p": [9642], "c": "\u25AA" },
+ "blacktriangle;": { "p": [9652], "c": "\u25B4" },
+ "blacktriangledown;": { "p": [9662], "c": "\u25BE" },
+ "blacktriangleleft;": { "p": [9666], "c": "\u25C2" },
+ "blacktriangleright;": { "p": [9656], "c": "\u25B8" },
+ "blank;": { "p": [9251], "c": "\u2423" },
+ "blk12;": { "p": [9618], "c": "\u2592" },
+ "blk14;": { "p": [9617], "c": "\u2591" },
+ "blk34;": { "p": [9619], "c": "\u2593" },
+ "block;": { "p": [9608], "c": "\u2588" },
+ "bne;": { "p": [61, 8421], "c": "\u003D\u20E5" },
+ "bnequiv;": { "p": [8801, 8421], "c": "\u2261\u20E5" },
+ "bnot;": { "p": [8976], "c": "\u2310" },
+ "bopf;": { "p": [120147], "c": "\uD835\uDD53" },
+ "bot;": { "p": [8869], "c": "\u22A5" },
+ "bottom;": { "p": [8869], "c": "\u22A5" },
+ "bowtie;": { "p": [8904], "c": "\u22C8" },
+ "boxDL;": { "p": [9559], "c": "\u2557" },
+ "boxDR;": { "p": [9556], "c": "\u2554" },
+ "boxDl;": { "p": [9558], "c": "\u2556" },
+ "boxDr;": { "p": [9555], "c": "\u2553" },
+ "boxH;": { "p": [9552], "c": "\u2550" },
+ "boxHD;": { "p": [9574], "c": "\u2566" },
+ "boxHU;": { "p": [9577], "c": "\u2569" },
+ "boxHd;": { "p": [9572], "c": "\u2564" },
+ "boxHu;": { "p": [9575], "c": "\u2567" },
+ "boxUL;": { "p": [9565], "c": "\u255D" },
+ "boxUR;": { "p": [9562], "c": "\u255A" },
+ "boxUl;": { "p": [9564], "c": "\u255C" },
+ "boxUr;": { "p": [9561], "c": "\u2559" },
+ "boxV;": { "p": [9553], "c": "\u2551" },
+ "boxVH;": { "p": [9580], "c": "\u256C" },
+ "boxVL;": { "p": [9571], "c": "\u2563" },
+ "boxVR;": { "p": [9568], "c": "\u2560" },
+ "boxVh;": { "p": [9579], "c": "\u256B" },
+ "boxVl;": { "p": [9570], "c": "\u2562" },
+ "boxVr;": { "p": [9567], "c": "\u255F" },
+ "boxbox;": { "p": [10697], "c": "\u29C9" },
+ "boxdL;": { "p": [9557], "c": "\u2555" },
+ "boxdR;": { "p": [9554], "c": "\u2552" },
+ "boxdl;": { "p": [9488], "c": "\u2510" },
+ "boxdr;": { "p": [9484], "c": "\u250C" },
+ "boxh;": { "p": [9472], "c": "\u2500" },
+ "boxhD;": { "p": [9573], "c": "\u2565" },
+ "boxhU;": { "p": [9576], "c": "\u2568" },
+ "boxhd;": { "p": [9516], "c": "\u252C" },
+ "boxhu;": { "p": [9524], "c": "\u2534" },
+ "boxminus;": { "p": [8863], "c": "\u229F" },
+ "boxplus;": { "p": [8862], "c": "\u229E" },
+ "boxtimes;": { "p": [8864], "c": "\u22A0" },
+ "boxuL;": { "p": [9563], "c": "\u255B" },
+ "boxuR;": { "p": [9560], "c": "\u2558" },
+ "boxul;": { "p": [9496], "c": "\u2518" },
+ "boxur;": { "p": [9492], "c": "\u2514" },
+ "boxv;": { "p": [9474], "c": "\u2502" },
+ "boxvH;": { "p": [9578], "c": "\u256A" },
+ "boxvL;": { "p": [9569], "c": "\u2561" },
+ "boxvR;": { "p": [9566], "c": "\u255E" },
+ "boxvh;": { "p": [9532], "c": "\u253C" },
+ "boxvl;": { "p": [9508], "c": "\u2524" },
+ "boxvr;": { "p": [9500], "c": "\u251C" },
+ "bprime;": { "p": [8245], "c": "\u2035" },
+ "breve;": { "p": [728], "c": "\u02D8" },
+ "brvbar": { "p": [166], "c": "\u00A6" },
+ "brvbar;": { "p": [166], "c": "\u00A6" },
+ "bscr;": { "p": [119991], "c": "\uD835\uDCB7" },
+ "bsemi;": { "p": [8271], "c": "\u204F" },
+ "bsim;": { "p": [8765], "c": "\u223D" },
+ "bsime;": { "p": [8909], "c": "\u22CD" },
+ "bsol;": { "p": [92], "c": "\u005C" },
+ "bsolb;": { "p": [10693], "c": "\u29C5" },
+ "bsolhsub;": { "p": [10184], "c": "\u27C8" },
+ "bull;": { "p": [8226], "c": "\u2022" },
+ "bullet;": { "p": [8226], "c": "\u2022" },
+ "bump;": { "p": [8782], "c": "\u224E" },
+ "bumpE;": { "p": [10926], "c": "\u2AAE" },
+ "bumpe;": { "p": [8783], "c": "\u224F" },
+ "bumpeq;": { "p": [8783], "c": "\u224F" },
+ "cacute;": { "p": [263], "c": "\u0107" },
+ "cap;": { "p": [8745], "c": "\u2229" },
+ "capand;": { "p": [10820], "c": "\u2A44" },
+ "capbrcup;": { "p": [10825], "c": "\u2A49" },
+ "capcap;": { "p": [10827], "c": "\u2A4B" },
+ "capcup;": { "p": [10823], "c": "\u2A47" },
+ "capdot;": { "p": [10816], "c": "\u2A40" },
+ "caps;": { "p": [8745, 65024], "c": "\u2229\uFE00" },
+ "caret;": { "p": [8257], "c": "\u2041" },
+ "caron;": { "p": [711], "c": "\u02C7" },
+ "ccaps;": { "p": [10829], "c": "\u2A4D" },
+ "ccaron;": { "p": [269], "c": "\u010D" },
+ "ccedil": { "p": [231], "c": "\u00E7" },
+ "ccedil;": { "p": [231], "c": "\u00E7" },
+ "ccirc;": { "p": [265], "c": "\u0109" },
+ "ccups;": { "p": [10828], "c": "\u2A4C" },
+ "ccupssm;": { "p": [10832], "c": "\u2A50" },
+ "cdot;": { "p": [267], "c": "\u010B" },
+ "cedil": { "p": [184], "c": "\u00B8" },
+ "cedil;": { "p": [184], "c": "\u00B8" },
+ "cemptyv;": { "p": [10674], "c": "\u29B2" },
+ "cent": { "p": [162], "c": "\u00A2" },
+ "cent;": { "p": [162], "c": "\u00A2" },
+ "centerdot;": { "p": [183], "c": "\u00B7" },
+ "cfr;": { "p": [120096], "c": "\uD835\uDD20" },
+ "chcy;": { "p": [1095], "c": "\u0447" },
+ "check;": { "p": [10003], "c": "\u2713" },
+ "checkmark;": { "p": [10003], "c": "\u2713" },
+ "chi;": { "p": [967], "c": "\u03C7" },
+ "cir;": { "p": [9675], "c": "\u25CB" },
+ "cirE;": { "p": [10691], "c": "\u29C3" },
+ "circ;": { "p": [710], "c": "\u02C6" },
+ "circeq;": { "p": [8791], "c": "\u2257" },
+ "circlearrowleft;": { "p": [8634], "c": "\u21BA" },
+ "circlearrowright;": { "p": [8635], "c": "\u21BB" },
+ "circledR;": { "p": [174], "c": "\u00AE" },
+ "circledS;": { "p": [9416], "c": "\u24C8" },
+ "circledast;": { "p": [8859], "c": "\u229B" },
+ "circledcirc;": { "p": [8858], "c": "\u229A" },
+ "circleddash;": { "p": [8861], "c": "\u229D" },
+ "cire;": { "p": [8791], "c": "\u2257" },
+ "cirfnint;": { "p": [10768], "c": "\u2A10" },
+ "cirmid;": { "p": [10991], "c": "\u2AEF" },
+ "cirscir;": { "p": [10690], "c": "\u29C2" },
+ "clubs;": { "p": [9827], "c": "\u2663" },
+ "clubsuit;": { "p": [9827], "c": "\u2663" },
+ "colon;": { "p": [58], "c": "\u003A" },
+ "colone;": { "p": [8788], "c": "\u2254" },
+ "coloneq;": { "p": [8788], "c": "\u2254" },
+ "comma;": { "p": [44], "c": "\u002C" },
+ "commat;": { "p": [64], "c": "\u0040" },
+ "comp;": { "p": [8705], "c": "\u2201" },
+ "compfn;": { "p": [8728], "c": "\u2218" },
+ "complement;": { "p": [8705], "c": "\u2201" },
+ "complexes;": { "p": [8450], "c": "\u2102" },
+ "cong;": { "p": [8773], "c": "\u2245" },
+ "congdot;": { "p": [10861], "c": "\u2A6D" },
+ "conint;": { "p": [8750], "c": "\u222E" },
+ "copf;": { "p": [120148], "c": "\uD835\uDD54" },
+ "coprod;": { "p": [8720], "c": "\u2210" },
+ "copy": { "p": [169], "c": "\u00A9" },
+ "copy;": { "p": [169], "c": "\u00A9" },
+ "copysr;": { "p": [8471], "c": "\u2117" },
+ "crarr;": { "p": [8629], "c": "\u21B5" },
+ "cross;": { "p": [10007], "c": "\u2717" },
+ "cscr;": { "p": [119992], "c": "\uD835\uDCB8" },
+ "csub;": { "p": [10959], "c": "\u2ACF" },
+ "csube;": { "p": [10961], "c": "\u2AD1" },
+ "csup;": { "p": [10960], "c": "\u2AD0" },
+ "csupe;": { "p": [10962], "c": "\u2AD2" },
+ "ctdot;": { "p": [8943], "c": "\u22EF" },
+ "cudarrl;": { "p": [10552], "c": "\u2938" },
+ "cudarrr;": { "p": [10549], "c": "\u2935" },
+ "cuepr;": { "p": [8926], "c": "\u22DE" },
+ "cuesc;": { "p": [8927], "c": "\u22DF" },
+ "cularr;": { "p": [8630], "c": "\u21B6" },
+ "cularrp;": { "p": [10557], "c": "\u293D" },
+ "cup;": { "p": [8746], "c": "\u222A" },
+ "cupbrcap;": { "p": [10824], "c": "\u2A48" },
+ "cupcap;": { "p": [10822], "c": "\u2A46" },
+ "cupcup;": { "p": [10826], "c": "\u2A4A" },
+ "cupdot;": { "p": [8845], "c": "\u228D" },
+ "cupor;": { "p": [10821], "c": "\u2A45" },
+ "cups;": { "p": [8746, 65024], "c": "\u222A\uFE00" },
+ "curarr;": { "p": [8631], "c": "\u21B7" },
+ "curarrm;": { "p": [10556], "c": "\u293C" },
+ "curlyeqprec;": { "p": [8926], "c": "\u22DE" },
+ "curlyeqsucc;": { "p": [8927], "c": "\u22DF" },
+ "curlyvee;": { "p": [8910], "c": "\u22CE" },
+ "curlywedge;": { "p": [8911], "c": "\u22CF" },
+ "curren": { "p": [164], "c": "\u00A4" },
+ "curren;": { "p": [164], "c": "\u00A4" },
+ "curvearrowleft;": { "p": [8630], "c": "\u21B6" },
+ "curvearrowright;": { "p": [8631], "c": "\u21B7" },
+ "cuvee;": { "p": [8910], "c": "\u22CE" },
+ "cuwed;": { "p": [8911], "c": "\u22CF" },
+ "cwconint;": { "p": [8754], "c": "\u2232" },
+ "cwint;": { "p": [8753], "c": "\u2231" },
+ "cylcty;": { "p": [9005], "c": "\u232D" },
+ "dArr;": { "p": [8659], "c": "\u21D3" },
+ "dHar;": { "p": [10597], "c": "\u2965" },
+ "dagger;": { "p": [8224], "c": "\u2020" },
+ "daleth;": { "p": [8504], "c": "\u2138" },
+ "darr;": { "p": [8595], "c": "\u2193" },
+ "dash;": { "p": [8208], "c": "\u2010" },
+ "dashv;": { "p": [8867], "c": "\u22A3" },
+ "dbkarow;": { "p": [10511], "c": "\u290F" },
+ "dblac;": { "p": [733], "c": "\u02DD" },
+ "dcaron;": { "p": [271], "c": "\u010F" },
+ "dcy;": { "p": [1076], "c": "\u0434" },
+ "dd;": { "p": [8518], "c": "\u2146" },
+ "ddagger;": { "p": [8225], "c": "\u2021" },
+ "ddarr;": { "p": [8650], "c": "\u21CA" },
+ "ddotseq;": { "p": [10871], "c": "\u2A77" },
+ "deg": { "p": [176], "c": "\u00B0" },
+ "deg;": { "p": [176], "c": "\u00B0" },
+ "delta;": { "p": [948], "c": "\u03B4" },
+ "demptyv;": { "p": [10673], "c": "\u29B1" },
+ "dfisht;": { "p": [10623], "c": "\u297F" },
+ "dfr;": { "p": [120097], "c": "\uD835\uDD21" },
+ "dharl;": { "p": [8643], "c": "\u21C3" },
+ "dharr;": { "p": [8642], "c": "\u21C2" },
+ "diam;": { "p": [8900], "c": "\u22C4" },
+ "diamond;": { "p": [8900], "c": "\u22C4" },
+ "diamondsuit;": { "p": [9830], "c": "\u2666" },
+ "diams;": { "p": [9830], "c": "\u2666" },
+ "die;": { "p": [168], "c": "\u00A8" },
+ "digamma;": { "p": [989], "c": "\u03DD" },
+ "disin;": { "p": [8946], "c": "\u22F2" },
+ "div;": { "p": [247], "c": "\u00F7" },
+ "divide": { "p": [247], "c": "\u00F7" },
+ "divide;": { "p": [247], "c": "\u00F7" },
+ "divideontimes;": { "p": [8903], "c": "\u22C7" },
+ "divonx;": { "p": [8903], "c": "\u22C7" },
+ "djcy;": { "p": [1106], "c": "\u0452" },
+ "dlcorn;": { "p": [8990], "c": "\u231E" },
+ "dlcrop;": { "p": [8973], "c": "\u230D" },
+ "dollar;": { "p": [36], "c": "\u0024" },
+ "dopf;": { "p": [120149], "c": "\uD835\uDD55" },
+ "dot;": { "p": [729], "c": "\u02D9" },
+ "doteq;": { "p": [8784], "c": "\u2250" },
+ "doteqdot;": { "p": [8785], "c": "\u2251" },
+ "dotminus;": { "p": [8760], "c": "\u2238" },
+ "dotplus;": { "p": [8724], "c": "\u2214" },
+ "dotsquare;": { "p": [8865], "c": "\u22A1" },
+ "doublebarwedge;": { "p": [8966], "c": "\u2306" },
+ "downarrow;": { "p": [8595], "c": "\u2193" },
+ "downdownarrows;": { "p": [8650], "c": "\u21CA" },
+ "downharpoonleft;": { "p": [8643], "c": "\u21C3" },
+ "downharpoonright;": { "p": [8642], "c": "\u21C2" },
+ "drbkarow;": { "p": [10512], "c": "\u2910" },
+ "drcorn;": { "p": [8991], "c": "\u231F" },
+ "drcrop;": { "p": [8972], "c": "\u230C" },
+ "dscr;": { "p": [119993], "c": "\uD835\uDCB9" },
+ "dscy;": { "p": [1109], "c": "\u0455" },
+ "dsol;": { "p": [10742], "c": "\u29F6" },
+ "dstrok;": { "p": [273], "c": "\u0111" },
+ "dtdot;": { "p": [8945], "c": "\u22F1" },
+ "dtri;": { "p": [9663], "c": "\u25BF" },
+ "dtrif;": { "p": [9662], "c": "\u25BE" },
+ "duarr;": { "p": [8693], "c": "\u21F5" },
+ "duhar;": { "p": [10607], "c": "\u296F" },
+ "dwangle;": { "p": [10662], "c": "\u29A6" },
+ "dzcy;": { "p": [1119], "c": "\u045F" },
+ "dzigrarr;": { "p": [10239], "c": "\u27FF" },
+ "eDDot;": { "p": [10871], "c": "\u2A77" },
+ "eDot;": { "p": [8785], "c": "\u2251" },
+ "eacute": { "p": [233], "c": "\u00E9" },
+ "eacute;": { "p": [233], "c": "\u00E9" },
+ "easter;": { "p": [10862], "c": "\u2A6E" },
+ "ecaron;": { "p": [283], "c": "\u011B" },
+ "ecir;": { "p": [8790], "c": "\u2256" },
+ "ecirc": { "p": [234], "c": "\u00EA" },
+ "ecirc;": { "p": [234], "c": "\u00EA" },
+ "ecolon;": { "p": [8789], "c": "\u2255" },
+ "ecy;": { "p": [1101], "c": "\u044D" },
+ "edot;": { "p": [279], "c": "\u0117" },
+ "ee;": { "p": [8519], "c": "\u2147" },
+ "efDot;": { "p": [8786], "c": "\u2252" },
+ "efr;": { "p": [120098], "c": "\uD835\uDD22" },
+ "eg;": { "p": [10906], "c": "\u2A9A" },
+ "egrave": { "p": [232], "c": "\u00E8" },
+ "egrave;": { "p": [232], "c": "\u00E8" },
+ "egs;": { "p": [10902], "c": "\u2A96" },
+ "egsdot;": { "p": [10904], "c": "\u2A98" },
+ "el;": { "p": [10905], "c": "\u2A99" },
+ "elinters;": { "p": [9191], "c": "\u23E7" },
+ "ell;": { "p": [8467], "c": "\u2113" },
+ "els;": { "p": [10901], "c": "\u2A95" },
+ "elsdot;": { "p": [10903], "c": "\u2A97" },
+ "emacr;": { "p": [275], "c": "\u0113" },
+ "empty;": { "p": [8709], "c": "\u2205" },
+ "emptyset;": { "p": [8709], "c": "\u2205" },
+ "emptyv;": { "p": [8709], "c": "\u2205" },
+ "emsp13;": { "p": [8196], "c": "\u2004" },
+ "emsp14;": { "p": [8197], "c": "\u2005" },
+ "emsp;": { "p": [8195], "c": "\u2003" },
+ "eng;": { "p": [331], "c": "\u014B" },
+ "ensp;": { "p": [8194], "c": "\u2002" },
+ "eogon;": { "p": [281], "c": "\u0119" },
+ "eopf;": { "p": [120150], "c": "\uD835\uDD56" },
+ "epar;": { "p": [8917], "c": "\u22D5" },
+ "eparsl;": { "p": [10723], "c": "\u29E3" },
+ "eplus;": { "p": [10865], "c": "\u2A71" },
+ "epsi;": { "p": [949], "c": "\u03B5" },
+ "epsilon;": { "p": [949], "c": "\u03B5" },
+ "epsiv;": { "p": [1013], "c": "\u03F5" },
+ "eqcirc;": { "p": [8790], "c": "\u2256" },
+ "eqcolon;": { "p": [8789], "c": "\u2255" },
+ "eqsim;": { "p": [8770], "c": "\u2242" },
+ "eqslantgtr;": { "p": [10902], "c": "\u2A96" },
+ "eqslantless;": { "p": [10901], "c": "\u2A95" },
+ "equals;": { "p": [61], "c": "\u003D" },
+ "equest;": { "p": [8799], "c": "\u225F" },
+ "equiv;": { "p": [8801], "c": "\u2261" },
+ "equivDD;": { "p": [10872], "c": "\u2A78" },
+ "eqvparsl;": { "p": [10725], "c": "\u29E5" },
+ "erDot;": { "p": [8787], "c": "\u2253" },
+ "erarr;": { "p": [10609], "c": "\u2971" },
+ "escr;": { "p": [8495], "c": "\u212F" },
+ "esdot;": { "p": [8784], "c": "\u2250" },
+ "esim;": { "p": [8770], "c": "\u2242" },
+ "eta;": { "p": [951], "c": "\u03B7" },
+ "eth": { "p": [240], "c": "\u00F0" },
+ "eth;": { "p": [240], "c": "\u00F0" },
+ "euml": { "p": [235], "c": "\u00EB" },
+ "euml;": { "p": [235], "c": "\u00EB" },
+ "euro;": { "p": [8364], "c": "\u20AC" },
+ "excl;": { "p": [33], "c": "\u0021" },
+ "exist;": { "p": [8707], "c": "\u2203" },
+ "expectation;": { "p": [8496], "c": "\u2130" },
+ "exponentiale;": { "p": [8519], "c": "\u2147" },
+ "fallingdotseq;": { "p": [8786], "c": "\u2252" },
+ "fcy;": { "p": [1092], "c": "\u0444" },
+ "female;": { "p": [9792], "c": "\u2640" },
+ "ffilig;": { "p": [64259], "c": "\uFB03" },
+ "fflig;": { "p": [64256], "c": "\uFB00" },
+ "ffllig;": { "p": [64260], "c": "\uFB04" },
+ "ffr;": { "p": [120099], "c": "\uD835\uDD23" },
+ "filig;": { "p": [64257], "c": "\uFB01" },
+ "fjlig;": { "p": [102, 106], "c": "\u0066\u006A" },
+ "flat;": { "p": [9837], "c": "\u266D" },
+ "fllig;": { "p": [64258], "c": "\uFB02" },
+ "fltns;": { "p": [9649], "c": "\u25B1" },
+ "fnof;": { "p": [402], "c": "\u0192" },
+ "fopf;": { "p": [120151], "c": "\uD835\uDD57" },
+ "forall;": { "p": [8704], "c": "\u2200" },
+ "fork;": { "p": [8916], "c": "\u22D4" },
+ "forkv;": { "p": [10969], "c": "\u2AD9" },
+ "fpartint;": { "p": [10765], "c": "\u2A0D" },
+ "frac12": { "p": [189], "c": "\u00BD" },
+ "frac12;": { "p": [189], "c": "\u00BD" },
+ "frac13;": { "p": [8531], "c": "\u2153" },
+ "frac14": { "p": [188], "c": "\u00BC" },
+ "frac14;": { "p": [188], "c": "\u00BC" },
+ "frac15;": { "p": [8533], "c": "\u2155" },
+ "frac16;": { "p": [8537], "c": "\u2159" },
+ "frac18;": { "p": [8539], "c": "\u215B" },
+ "frac23;": { "p": [8532], "c": "\u2154" },
+ "frac25;": { "p": [8534], "c": "\u2156" },
+ "frac34": { "p": [190], "c": "\u00BE" },
+ "frac34;": { "p": [190], "c": "\u00BE" },
+ "frac35;": { "p": [8535], "c": "\u2157" },
+ "frac38;": { "p": [8540], "c": "\u215C" },
+ "frac45;": { "p": [8536], "c": "\u2158" },
+ "frac56;": { "p": [8538], "c": "\u215A" },
+ "frac58;": { "p": [8541], "c": "\u215D" },
+ "frac78;": { "p": [8542], "c": "\u215E" },
+ "frasl;": { "p": [8260], "c": "\u2044" },
+ "frown;": { "p": [8994], "c": "\u2322" },
+ "fscr;": { "p": [119995], "c": "\uD835\uDCBB" },
+ "gE;": { "p": [8807], "c": "\u2267" },
+ "gEl;": { "p": [10892], "c": "\u2A8C" },
+ "gacute;": { "p": [501], "c": "\u01F5" },
+ "gamma;": { "p": [947], "c": "\u03B3" },
+ "gammad;": { "p": [989], "c": "\u03DD" },
+ "gap;": { "p": [10886], "c": "\u2A86" },
+ "gbreve;": { "p": [287], "c": "\u011F" },
+ "gcirc;": { "p": [285], "c": "\u011D" },
+ "gcy;": { "p": [1075], "c": "\u0433" },
+ "gdot;": { "p": [289], "c": "\u0121" },
+ "ge;": { "p": [8805], "c": "\u2265" },
+ "gel;": { "p": [8923], "c": "\u22DB" },
+ "geq;": { "p": [8805], "c": "\u2265" },
+ "geqq;": { "p": [8807], "c": "\u2267" },
+ "geqslant;": { "p": [10878], "c": "\u2A7E" },
+ "ges;": { "p": [10878], "c": "\u2A7E" },
+ "gescc;": { "p": [10921], "c": "\u2AA9" },
+ "gesdot;": { "p": [10880], "c": "\u2A80" },
+ "gesdoto;": { "p": [10882], "c": "\u2A82" },
+ "gesdotol;": { "p": [10884], "c": "\u2A84" },
+ "gesl;": { "p": [8923, 65024], "c": "\u22DB\uFE00" },
+ "gesles;": { "p": [10900], "c": "\u2A94" },
+ "gfr;": { "p": [120100], "c": "\uD835\uDD24" },
+ "gg;": { "p": [8811], "c": "\u226B" },
+ "ggg;": { "p": [8921], "c": "\u22D9" },
+ "gimel;": { "p": [8503], "c": "\u2137" },
+ "gjcy;": { "p": [1107], "c": "\u0453" },
+ "gl;": { "p": [8823], "c": "\u2277" },
+ "glE;": { "p": [10898], "c": "\u2A92" },
+ "gla;": { "p": [10917], "c": "\u2AA5" },
+ "glj;": { "p": [10916], "c": "\u2AA4" },
+ "gnE;": { "p": [8809], "c": "\u2269" },
+ "gnap;": { "p": [10890], "c": "\u2A8A" },
+ "gnapprox;": { "p": [10890], "c": "\u2A8A" },
+ "gne;": { "p": [10888], "c": "\u2A88" },
+ "gneq;": { "p": [10888], "c": "\u2A88" },
+ "gneqq;": { "p": [8809], "c": "\u2269" },
+ "gnsim;": { "p": [8935], "c": "\u22E7" },
+ "gopf;": { "p": [120152], "c": "\uD835\uDD58" },
+ "grave;": { "p": [96], "c": "\u0060" },
+ "gscr;": { "p": [8458], "c": "\u210A" },
+ "gsim;": { "p": [8819], "c": "\u2273" },
+ "gsime;": { "p": [10894], "c": "\u2A8E" },
+ "gsiml;": { "p": [10896], "c": "\u2A90" },
+ "gt": { "p": [62], "c": "\u003E" },
+ "gt;": { "p": [62], "c": "\u003E" },
+ "gtcc;": { "p": [10919], "c": "\u2AA7" },
+ "gtcir;": { "p": [10874], "c": "\u2A7A" },
+ "gtdot;": { "p": [8919], "c": "\u22D7" },
+ "gtlPar;": { "p": [10645], "c": "\u2995" },
+ "gtquest;": { "p": [10876], "c": "\u2A7C" },
+ "gtrapprox;": { "p": [10886], "c": "\u2A86" },
+ "gtrarr;": { "p": [10616], "c": "\u2978" },
+ "gtrdot;": { "p": [8919], "c": "\u22D7" },
+ "gtreqless;": { "p": [8923], "c": "\u22DB" },
+ "gtreqqless;": { "p": [10892], "c": "\u2A8C" },
+ "gtrless;": { "p": [8823], "c": "\u2277" },
+ "gtrsim;": { "p": [8819], "c": "\u2273" },
+ "gvertneqq;": {
+ "p": [8809, 65024],
+ "c": "\u2269\uFE00"
+ },
+ "gvnE;": { "p": [8809, 65024], "c": "\u2269\uFE00" },
+ "hArr;": { "p": [8660], "c": "\u21D4" },
+ "hairsp;": { "p": [8202], "c": "\u200A" },
+ "half;": { "p": [189], "c": "\u00BD" },
+ "hamilt;": { "p": [8459], "c": "\u210B" },
+ "hardcy;": { "p": [1098], "c": "\u044A" },
+ "harr;": { "p": [8596], "c": "\u2194" },
+ "harrcir;": { "p": [10568], "c": "\u2948" },
+ "harrw;": { "p": [8621], "c": "\u21AD" },
+ "hbar;": { "p": [8463], "c": "\u210F" },
+ "hcirc;": { "p": [293], "c": "\u0125" },
+ "hearts;": { "p": [9829], "c": "\u2665" },
+ "heartsuit;": { "p": [9829], "c": "\u2665" },
+ "hellip;": { "p": [8230], "c": "\u2026" },
+ "hercon;": { "p": [8889], "c": "\u22B9" },
+ "hfr;": { "p": [120101], "c": "\uD835\uDD25" },
+ "hksearow;": { "p": [10533], "c": "\u2925" },
+ "hkswarow;": { "p": [10534], "c": "\u2926" },
+ "hoarr;": { "p": [8703], "c": "\u21FF" },
+ "homtht;": { "p": [8763], "c": "\u223B" },
+ "hookleftarrow;": { "p": [8617], "c": "\u21A9" },
+ "hookrightarrow;": { "p": [8618], "c": "\u21AA" },
+ "hopf;": { "p": [120153], "c": "\uD835\uDD59" },
+ "horbar;": { "p": [8213], "c": "\u2015" },
+ "hscr;": { "p": [119997], "c": "\uD835\uDCBD" },
+ "hslash;": { "p": [8463], "c": "\u210F" },
+ "hstrok;": { "p": [295], "c": "\u0127" },
+ "hybull;": { "p": [8259], "c": "\u2043" },
+ "hyphen;": { "p": [8208], "c": "\u2010" },
+ "iacute": { "p": [237], "c": "\u00ED" },
+ "iacute;": { "p": [237], "c": "\u00ED" },
+ "ic;": { "p": [8291], "c": "\u2063" },
+ "icirc": { "p": [238], "c": "\u00EE" },
+ "icirc;": { "p": [238], "c": "\u00EE" },
+ "icy;": { "p": [1080], "c": "\u0438" },
+ "iecy;": { "p": [1077], "c": "\u0435" },
+ "iexcl": { "p": [161], "c": "\u00A1" },
+ "iexcl;": { "p": [161], "c": "\u00A1" },
+ "iff;": { "p": [8660], "c": "\u21D4" },
+ "ifr;": { "p": [120102], "c": "\uD835\uDD26" },
+ "igrave": { "p": [236], "c": "\u00EC" },
+ "igrave;": { "p": [236], "c": "\u00EC" },
+ "ii;": { "p": [8520], "c": "\u2148" },
+ "iiiint;": { "p": [10764], "c": "\u2A0C" },
+ "iiint;": { "p": [8749], "c": "\u222D" },
+ "iinfin;": { "p": [10716], "c": "\u29DC" },
+ "iiota;": { "p": [8489], "c": "\u2129" },
+ "ijlig;": { "p": [307], "c": "\u0133" },
+ "imacr;": { "p": [299], "c": "\u012B" },
+ "image;": { "p": [8465], "c": "\u2111" },
+ "imagline;": { "p": [8464], "c": "\u2110" },
+ "imagpart;": { "p": [8465], "c": "\u2111" },
+ "imath;": { "p": [305], "c": "\u0131" },
+ "imof;": { "p": [8887], "c": "\u22B7" },
+ "imped;": { "p": [437], "c": "\u01B5" },
+ "in;": { "p": [8712], "c": "\u2208" },
+ "incare;": { "p": [8453], "c": "\u2105" },
+ "infin;": { "p": [8734], "c": "\u221E" },
+ "infintie;": { "p": [10717], "c": "\u29DD" },
+ "inodot;": { "p": [305], "c": "\u0131" },
+ "int;": { "p": [8747], "c": "\u222B" },
+ "intcal;": { "p": [8890], "c": "\u22BA" },
+ "integers;": { "p": [8484], "c": "\u2124" },
+ "intercal;": { "p": [8890], "c": "\u22BA" },
+ "intlarhk;": { "p": [10775], "c": "\u2A17" },
+ "intprod;": { "p": [10812], "c": "\u2A3C" },
+ "iocy;": { "p": [1105], "c": "\u0451" },
+ "iogon;": { "p": [303], "c": "\u012F" },
+ "iopf;": { "p": [120154], "c": "\uD835\uDD5A" },
+ "iota;": { "p": [953], "c": "\u03B9" },
+ "iprod;": { "p": [10812], "c": "\u2A3C" },
+ "iquest": { "p": [191], "c": "\u00BF" },
+ "iquest;": { "p": [191], "c": "\u00BF" },
+ "iscr;": { "p": [119998], "c": "\uD835\uDCBE" },
+ "isin;": { "p": [8712], "c": "\u2208" },
+ "isinE;": { "p": [8953], "c": "\u22F9" },
+ "isindot;": { "p": [8949], "c": "\u22F5" },
+ "isins;": { "p": [8948], "c": "\u22F4" },
+ "isinsv;": { "p": [8947], "c": "\u22F3" },
+ "isinv;": { "p": [8712], "c": "\u2208" },
+ "it;": { "p": [8290], "c": "\u2062" },
+ "itilde;": { "p": [297], "c": "\u0129" },
+ "iukcy;": { "p": [1110], "c": "\u0456" },
+ "iuml": { "p": [239], "c": "\u00EF" },
+ "iuml;": { "p": [239], "c": "\u00EF" },
+ "jcirc;": { "p": [309], "c": "\u0135" },
+ "jcy;": { "p": [1081], "c": "\u0439" },
+ "jfr;": { "p": [120103], "c": "\uD835\uDD27" },
+ "jmath;": { "p": [567], "c": "\u0237" },
+ "jopf;": { "p": [120155], "c": "\uD835\uDD5B" },
+ "jscr;": { "p": [119999], "c": "\uD835\uDCBF" },
+ "jsercy;": { "p": [1112], "c": "\u0458" },
+ "jukcy;": { "p": [1108], "c": "\u0454" },
+ "kappa;": { "p": [954], "c": "\u03BA" },
+ "kappav;": { "p": [1008], "c": "\u03F0" },
+ "kcedil;": { "p": [311], "c": "\u0137" },
+ "kcy;": { "p": [1082], "c": "\u043A" },
+ "kfr;": { "p": [120104], "c": "\uD835\uDD28" },
+ "kgreen;": { "p": [312], "c": "\u0138" },
+ "khcy;": { "p": [1093], "c": "\u0445" },
+ "kjcy;": { "p": [1116], "c": "\u045C" },
+ "kopf;": { "p": [120156], "c": "\uD835\uDD5C" },
+ "kscr;": { "p": [120000], "c": "\uD835\uDCC0" },
+ "lAarr;": { "p": [8666], "c": "\u21DA" },
+ "lArr;": { "p": [8656], "c": "\u21D0" },
+ "lAtail;": { "p": [10523], "c": "\u291B" },
+ "lBarr;": { "p": [10510], "c": "\u290E" },
+ "lE;": { "p": [8806], "c": "\u2266" },
+ "lEg;": { "p": [10891], "c": "\u2A8B" },
+ "lHar;": { "p": [10594], "c": "\u2962" },
+ "lacute;": { "p": [314], "c": "\u013A" },
+ "laemptyv;": { "p": [10676], "c": "\u29B4" },
+ "lagran;": { "p": [8466], "c": "\u2112" },
+ "lambda;": { "p": [955], "c": "\u03BB" },
+ "lang;": { "p": [10216], "c": "\u27E8" },
+ "langd;": { "p": [10641], "c": "\u2991" },
+ "langle;": { "p": [10216], "c": "\u27E8" },
+ "lap;": { "p": [10885], "c": "\u2A85" },
+ "laquo": { "p": [171], "c": "\u00AB" },
+ "laquo;": { "p": [171], "c": "\u00AB" },
+ "larr;": { "p": [8592], "c": "\u2190" },
+ "larrb;": { "p": [8676], "c": "\u21E4" },
+ "larrbfs;": { "p": [10527], "c": "\u291F" },
+ "larrfs;": { "p": [10525], "c": "\u291D" },
+ "larrhk;": { "p": [8617], "c": "\u21A9" },
+ "larrlp;": { "p": [8619], "c": "\u21AB" },
+ "larrpl;": { "p": [10553], "c": "\u2939" },
+ "larrsim;": { "p": [10611], "c": "\u2973" },
+ "larrtl;": { "p": [8610], "c": "\u21A2" },
+ "lat;": { "p": [10923], "c": "\u2AAB" },
+ "latail;": { "p": [10521], "c": "\u2919" },
+ "late;": { "p": [10925], "c": "\u2AAD" },
+ "lates;": { "p": [10925, 65024], "c": "\u2AAD\uFE00" },
+ "lbarr;": { "p": [10508], "c": "\u290C" },
+ "lbbrk;": { "p": [10098], "c": "\u2772" },
+ "lbrace;": { "p": [123], "c": "\u007B" },
+ "lbrack;": { "p": [91], "c": "\u005B" },
+ "lbrke;": { "p": [10635], "c": "\u298B" },
+ "lbrksld;": { "p": [10639], "c": "\u298F" },
+ "lbrkslu;": { "p": [10637], "c": "\u298D" },
+ "lcaron;": { "p": [318], "c": "\u013E" },
+ "lcedil;": { "p": [316], "c": "\u013C" },
+ "lceil;": { "p": [8968], "c": "\u2308" },
+ "lcub;": { "p": [123], "c": "\u007B" },
+ "lcy;": { "p": [1083], "c": "\u043B" },
+ "ldca;": { "p": [10550], "c": "\u2936" },
+ "ldquo;": { "p": [8220], "c": "\u201C" },
+ "ldquor;": { "p": [8222], "c": "\u201E" },
+ "ldrdhar;": { "p": [10599], "c": "\u2967" },
+ "ldrushar;": { "p": [10571], "c": "\u294B" },
+ "ldsh;": { "p": [8626], "c": "\u21B2" },
+ "le;": { "p": [8804], "c": "\u2264" },
+ "leftarrow;": { "p": [8592], "c": "\u2190" },
+ "leftarrowtail;": { "p": [8610], "c": "\u21A2" },
+ "leftharpoondown;": { "p": [8637], "c": "\u21BD" },
+ "leftharpoonup;": { "p": [8636], "c": "\u21BC" },
+ "leftleftarrows;": { "p": [8647], "c": "\u21C7" },
+ "leftrightarrow;": { "p": [8596], "c": "\u2194" },
+ "leftrightarrows;": { "p": [8646], "c": "\u21C6" },
+ "leftrightharpoons;": { "p": [8651], "c": "\u21CB" },
+ "leftrightsquigarrow;": { "p": [8621], "c": "\u21AD" },
+ "leftthreetimes;": { "p": [8907], "c": "\u22CB" },
+ "leg;": { "p": [8922], "c": "\u22DA" },
+ "leq;": { "p": [8804], "c": "\u2264" },
+ "leqq;": { "p": [8806], "c": "\u2266" },
+ "leqslant;": { "p": [10877], "c": "\u2A7D" },
+ "les;": { "p": [10877], "c": "\u2A7D" },
+ "lescc;": { "p": [10920], "c": "\u2AA8" },
+ "lesdot;": { "p": [10879], "c": "\u2A7F" },
+ "lesdoto;": { "p": [10881], "c": "\u2A81" },
+ "lesdotor;": { "p": [10883], "c": "\u2A83" },
+ "lesg;": { "p": [8922, 65024], "c": "\u22DA\uFE00" },
+ "lesges;": { "p": [10899], "c": "\u2A93" },
+ "lessapprox;": { "p": [10885], "c": "\u2A85" },
+ "lessdot;": { "p": [8918], "c": "\u22D6" },
+ "lesseqgtr;": { "p": [8922], "c": "\u22DA" },
+ "lesseqqgtr;": { "p": [10891], "c": "\u2A8B" },
+ "lessgtr;": { "p": [8822], "c": "\u2276" },
+ "lesssim;": { "p": [8818], "c": "\u2272" },
+ "lfisht;": { "p": [10620], "c": "\u297C" },
+ "lfloor;": { "p": [8970], "c": "\u230A" },
+ "lfr;": { "p": [120105], "c": "\uD835\uDD29" },
+ "lg;": { "p": [8822], "c": "\u2276" },
+ "lgE;": { "p": [10897], "c": "\u2A91" },
+ "lhard;": { "p": [8637], "c": "\u21BD" },
+ "lharu;": { "p": [8636], "c": "\u21BC" },
+ "lharul;": { "p": [10602], "c": "\u296A" },
+ "lhblk;": { "p": [9604], "c": "\u2584" },
+ "ljcy;": { "p": [1113], "c": "\u0459" },
+ "ll;": { "p": [8810], "c": "\u226A" },
+ "llarr;": { "p": [8647], "c": "\u21C7" },
+ "llcorner;": { "p": [8990], "c": "\u231E" },
+ "llhard;": { "p": [10603], "c": "\u296B" },
+ "lltri;": { "p": [9722], "c": "\u25FA" },
+ "lmidot;": { "p": [320], "c": "\u0140" },
+ "lmoust;": { "p": [9136], "c": "\u23B0" },
+ "lmoustache;": { "p": [9136], "c": "\u23B0" },
+ "lnE;": { "p": [8808], "c": "\u2268" },
+ "lnap;": { "p": [10889], "c": "\u2A89" },
+ "lnapprox;": { "p": [10889], "c": "\u2A89" },
+ "lne;": { "p": [10887], "c": "\u2A87" },
+ "lneq;": { "p": [10887], "c": "\u2A87" },
+ "lneqq;": { "p": [8808], "c": "\u2268" },
+ "lnsim;": { "p": [8934], "c": "\u22E6" },
+ "loang;": { "p": [10220], "c": "\u27EC" },
+ "loarr;": { "p": [8701], "c": "\u21FD" },
+ "lobrk;": { "p": [10214], "c": "\u27E6" },
+ "longleftarrow;": { "p": [10229], "c": "\u27F5" },
+ "longleftrightarrow;": { "p": [10231], "c": "\u27F7" },
+ "longmapsto;": { "p": [10236], "c": "\u27FC" },
+ "longrightarrow;": { "p": [10230], "c": "\u27F6" },
+ "looparrowleft;": { "p": [8619], "c": "\u21AB" },
+ "looparrowright;": { "p": [8620], "c": "\u21AC" },
+ "lopar;": { "p": [10629], "c": "\u2985" },
+ "lopf;": { "p": [120157], "c": "\uD835\uDD5D" },
+ "loplus;": { "p": [10797], "c": "\u2A2D" },
+ "lotimes;": { "p": [10804], "c": "\u2A34" },
+ "lowast;": { "p": [8727], "c": "\u2217" },
+ "lowbar;": { "p": [95], "c": "\u005F" },
+ "loz;": { "p": [9674], "c": "\u25CA" },
+ "lozenge;": { "p": [9674], "c": "\u25CA" },
+ "lozf;": { "p": [10731], "c": "\u29EB" },
+ "lpar;": { "p": [40], "c": "\u0028" },
+ "lparlt;": { "p": [10643], "c": "\u2993" },
+ "lrarr;": { "p": [8646], "c": "\u21C6" },
+ "lrcorner;": { "p": [8991], "c": "\u231F" },
+ "lrhar;": { "p": [8651], "c": "\u21CB" },
+ "lrhard;": { "p": [10605], "c": "\u296D" },
+ "lrm;": { "p": [8206], "c": "\u200E" },
+ "lrtri;": { "p": [8895], "c": "\u22BF" },
+ "lsaquo;": { "p": [8249], "c": "\u2039" },
+ "lscr;": { "p": [120001], "c": "\uD835\uDCC1" },
+ "lsh;": { "p": [8624], "c": "\u21B0" },
+ "lsim;": { "p": [8818], "c": "\u2272" },
+ "lsime;": { "p": [10893], "c": "\u2A8D" },
+ "lsimg;": { "p": [10895], "c": "\u2A8F" },
+ "lsqb;": { "p": [91], "c": "\u005B" },
+ "lsquo;": { "p": [8216], "c": "\u2018" },
+ "lsquor;": { "p": [8218], "c": "\u201A" },
+ "lstrok;": { "p": [322], "c": "\u0142" },
+ "lt": { "p": [60], "c": "\u003C" },
+ "lt;": { "p": [60], "c": "\u003C" },
+ "ltcc;": { "p": [10918], "c": "\u2AA6" },
+ "ltcir;": { "p": [10873], "c": "\u2A79" },
+ "ltdot;": { "p": [8918], "c": "\u22D6" },
+ "lthree;": { "p": [8907], "c": "\u22CB" },
+ "ltimes;": { "p": [8905], "c": "\u22C9" },
+ "ltlarr;": { "p": [10614], "c": "\u2976" },
+ "ltquest;": { "p": [10875], "c": "\u2A7B" },
+ "ltrPar;": { "p": [10646], "c": "\u2996" },
+ "ltri;": { "p": [9667], "c": "\u25C3" },
+ "ltrie;": { "p": [8884], "c": "\u22B4" },
+ "ltrif;": { "p": [9666], "c": "\u25C2" },
+ "lurdshar;": { "p": [10570], "c": "\u294A" },
+ "luruhar;": { "p": [10598], "c": "\u2966" },
+ "lvertneqq;": {
+ "p": [8808, 65024],
+ "c": "\u2268\uFE00"
+ },
+ "lvnE;": { "p": [8808, 65024], "c": "\u2268\uFE00" },
+ "mDDot;": { "p": [8762], "c": "\u223A" },
+ "macr": { "p": [175], "c": "\u00AF" },
+ "macr;": { "p": [175], "c": "\u00AF" },
+ "male;": { "p": [9794], "c": "\u2642" },
+ "malt;": { "p": [10016], "c": "\u2720" },
+ "maltese;": { "p": [10016], "c": "\u2720" },
+ "map;": { "p": [8614], "c": "\u21A6" },
+ "mapsto;": { "p": [8614], "c": "\u21A6" },
+ "mapstodown;": { "p": [8615], "c": "\u21A7" },
+ "mapstoleft;": { "p": [8612], "c": "\u21A4" },
+ "mapstoup;": { "p": [8613], "c": "\u21A5" },
+ "marker;": { "p": [9646], "c": "\u25AE" },
+ "mcomma;": { "p": [10793], "c": "\u2A29" },
+ "mcy;": { "p": [1084], "c": "\u043C" },
+ "mdash;": { "p": [8212], "c": "\u2014" },
+ "measuredangle;": { "p": [8737], "c": "\u2221" },
+ "mfr;": { "p": [120106], "c": "\uD835\uDD2A" },
+ "mho;": { "p": [8487], "c": "\u2127" },
+ "micro": { "p": [181], "c": "\u00B5" },
+ "micro;": { "p": [181], "c": "\u00B5" },
+ "mid;": { "p": [8739], "c": "\u2223" },
+ "midast;": { "p": [42], "c": "\u002A" },
+ "midcir;": { "p": [10992], "c": "\u2AF0" },
+ "middot": { "p": [183], "c": "\u00B7" },
+ "middot;": { "p": [183], "c": "\u00B7" },
+ "minus;": { "p": [8722], "c": "\u2212" },
+ "minusb;": { "p": [8863], "c": "\u229F" },
+ "minusd;": { "p": [8760], "c": "\u2238" },
+ "minusdu;": { "p": [10794], "c": "\u2A2A" },
+ "mlcp;": { "p": [10971], "c": "\u2ADB" },
+ "mldr;": { "p": [8230], "c": "\u2026" },
+ "mnplus;": { "p": [8723], "c": "\u2213" },
+ "models;": { "p": [8871], "c": "\u22A7" },
+ "mopf;": { "p": [120158], "c": "\uD835\uDD5E" },
+ "mp;": { "p": [8723], "c": "\u2213" },
+ "mscr;": { "p": [120002], "c": "\uD835\uDCC2" },
+ "mstpos;": { "p": [8766], "c": "\u223E" },
+ "mu;": { "p": [956], "c": "\u03BC" },
+ "multimap;": { "p": [8888], "c": "\u22B8" },
+ "mumap;": { "p": [8888], "c": "\u22B8" },
+ "nGg;": { "p": [8921, 824], "c": "\u22D9\u0338" },
+ "nGt;": { "p": [8811, 8402], "c": "\u226B\u20D2" },
+ "nGtv;": { "p": [8811, 824], "c": "\u226B\u0338" },
+ "nLeftarrow;": { "p": [8653], "c": "\u21CD" },
+ "nLeftrightarrow;": { "p": [8654], "c": "\u21CE" },
+ "nLl;": { "p": [8920, 824], "c": "\u22D8\u0338" },
+ "nLt;": { "p": [8810, 8402], "c": "\u226A\u20D2" },
+ "nLtv;": { "p": [8810, 824], "c": "\u226A\u0338" },
+ "nRightarrow;": { "p": [8655], "c": "\u21CF" },
+ "nVDash;": { "p": [8879], "c": "\u22AF" },
+ "nVdash;": { "p": [8878], "c": "\u22AE" },
+ "nabla;": { "p": [8711], "c": "\u2207" },
+ "nacute;": { "p": [324], "c": "\u0144" },
+ "nang;": { "p": [8736, 8402], "c": "\u2220\u20D2" },
+ "nap;": { "p": [8777], "c": "\u2249" },
+ "napE;": { "p": [10864, 824], "c": "\u2A70\u0338" },
+ "napid;": { "p": [8779, 824], "c": "\u224B\u0338" },
+ "napos;": { "p": [329], "c": "\u0149" },
+ "napprox;": { "p": [8777], "c": "\u2249" },
+ "natur;": { "p": [9838], "c": "\u266E" },
+ "natural;": { "p": [9838], "c": "\u266E" },
+ "naturals;": { "p": [8469], "c": "\u2115" },
+ "nbsp": { "p": [160], "c": "\u00A0" },
+ "nbsp;": { "p": [160], "c": "\u00A0" },
+ "nbump;": { "p": [8782, 824], "c": "\u224E\u0338" },
+ "nbumpe;": { "p": [8783, 824], "c": "\u224F\u0338" },
+ "ncap;": { "p": [10819], "c": "\u2A43" },
+ "ncaron;": { "p": [328], "c": "\u0148" },
+ "ncedil;": { "p": [326], "c": "\u0146" },
+ "ncong;": { "p": [8775], "c": "\u2247" },
+ "ncongdot;": { "p": [10861, 824], "c": "\u2A6D\u0338" },
+ "ncup;": { "p": [10818], "c": "\u2A42" },
+ "ncy;": { "p": [1085], "c": "\u043D" },
+ "ndash;": { "p": [8211], "c": "\u2013" },
+ "ne;": { "p": [8800], "c": "\u2260" },
+ "neArr;": { "p": [8663], "c": "\u21D7" },
+ "nearhk;": { "p": [10532], "c": "\u2924" },
+ "nearr;": { "p": [8599], "c": "\u2197" },
+ "nearrow;": { "p": [8599], "c": "\u2197" },
+ "nedot;": { "p": [8784, 824], "c": "\u2250\u0338" },
+ "nequiv;": { "p": [8802], "c": "\u2262" },
+ "nesear;": { "p": [10536], "c": "\u2928" },
+ "nesim;": { "p": [8770, 824], "c": "\u2242\u0338" },
+ "nexist;": { "p": [8708], "c": "\u2204" },
+ "nexists;": { "p": [8708], "c": "\u2204" },
+ "nfr;": { "p": [120107], "c": "\uD835\uDD2B" },
+ "ngE;": { "p": [8807, 824], "c": "\u2267\u0338" },
+ "nge;": { "p": [8817], "c": "\u2271" },
+ "ngeq;": { "p": [8817], "c": "\u2271" },
+ "ngeqq;": { "p": [8807, 824], "c": "\u2267\u0338" },
+ "ngeqslant;": { "p": [10878, 824], "c": "\u2A7E\u0338" },
+ "nges;": { "p": [10878, 824], "c": "\u2A7E\u0338" },
+ "ngsim;": { "p": [8821], "c": "\u2275" },
+ "ngt;": { "p": [8815], "c": "\u226F" },
+ "ngtr;": { "p": [8815], "c": "\u226F" },
+ "nhArr;": { "p": [8654], "c": "\u21CE" },
+ "nharr;": { "p": [8622], "c": "\u21AE" },
+ "nhpar;": { "p": [10994], "c": "\u2AF2" },
+ "ni;": { "p": [8715], "c": "\u220B" },
+ "nis;": { "p": [8956], "c": "\u22FC" },
+ "nisd;": { "p": [8954], "c": "\u22FA" },
+ "niv;": { "p": [8715], "c": "\u220B" },
+ "njcy;": { "p": [1114], "c": "\u045A" },
+ "nlArr;": { "p": [8653], "c": "\u21CD" },
+ "nlE;": { "p": [8806, 824], "c": "\u2266\u0338" },
+ "nlarr;": { "p": [8602], "c": "\u219A" },
+ "nldr;": { "p": [8229], "c": "\u2025" },
+ "nle;": { "p": [8816], "c": "\u2270" },
+ "nleftarrow;": { "p": [8602], "c": "\u219A" },
+ "nleftrightarrow;": { "p": [8622], "c": "\u21AE" },
+ "nleq;": { "p": [8816], "c": "\u2270" },
+ "nleqq;": { "p": [8806, 824], "c": "\u2266\u0338" },
+ "nleqslant;": { "p": [10877, 824], "c": "\u2A7D\u0338" },
+ "nles;": { "p": [10877, 824], "c": "\u2A7D\u0338" },
+ "nless;": { "p": [8814], "c": "\u226E" },
+ "nlsim;": { "p": [8820], "c": "\u2274" },
+ "nlt;": { "p": [8814], "c": "\u226E" },
+ "nltri;": { "p": [8938], "c": "\u22EA" },
+ "nltrie;": { "p": [8940], "c": "\u22EC" },
+ "nmid;": { "p": [8740], "c": "\u2224" },
+ "nopf;": { "p": [120159], "c": "\uD835\uDD5F" },
+ "not": { "p": [172], "c": "\u00AC" },
+ "not;": { "p": [172], "c": "\u00AC" },
+ "notin;": { "p": [8713], "c": "\u2209" },
+ "notinE;": { "p": [8953, 824], "c": "\u22F9\u0338" },
+ "notindot;": { "p": [8949, 824], "c": "\u22F5\u0338" },
+ "notinva;": { "p": [8713], "c": "\u2209" },
+ "notinvb;": { "p": [8951], "c": "\u22F7" },
+ "notinvc;": { "p": [8950], "c": "\u22F6" },
+ "notni;": { "p": [8716], "c": "\u220C" },
+ "notniva;": { "p": [8716], "c": "\u220C" },
+ "notnivb;": { "p": [8958], "c": "\u22FE" },
+ "notnivc;": { "p": [8957], "c": "\u22FD" },
+ "npar;": { "p": [8742], "c": "\u2226" },
+ "nparallel;": { "p": [8742], "c": "\u2226" },
+ "nparsl;": { "p": [11005, 8421], "c": "\u2AFD\u20E5" },
+ "npart;": { "p": [8706, 824], "c": "\u2202\u0338" },
+ "npolint;": { "p": [10772], "c": "\u2A14" },
+ "npr;": { "p": [8832], "c": "\u2280" },
+ "nprcue;": { "p": [8928], "c": "\u22E0" },
+ "npre;": { "p": [10927, 824], "c": "\u2AAF\u0338" },
+ "nprec;": { "p": [8832], "c": "\u2280" },
+ "npreceq;": { "p": [10927, 824], "c": "\u2AAF\u0338" },
+ "nrArr;": { "p": [8655], "c": "\u21CF" },
+ "nrarr;": { "p": [8603], "c": "\u219B" },
+ "nrarrc;": { "p": [10547, 824], "c": "\u2933\u0338" },
+ "nrarrw;": { "p": [8605, 824], "c": "\u219D\u0338" },
+ "nrightarrow;": { "p": [8603], "c": "\u219B" },
+ "nrtri;": { "p": [8939], "c": "\u22EB" },
+ "nrtrie;": { "p": [8941], "c": "\u22ED" },
+ "nsc;": { "p": [8833], "c": "\u2281" },
+ "nsccue;": { "p": [8929], "c": "\u22E1" },
+ "nsce;": { "p": [10928, 824], "c": "\u2AB0\u0338" },
+ "nscr;": { "p": [120003], "c": "\uD835\uDCC3" },
+ "nshortmid;": { "p": [8740], "c": "\u2224" },
+ "nshortparallel;": { "p": [8742], "c": "\u2226" },
+ "nsim;": { "p": [8769], "c": "\u2241" },
+ "nsime;": { "p": [8772], "c": "\u2244" },
+ "nsimeq;": { "p": [8772], "c": "\u2244" },
+ "nsmid;": { "p": [8740], "c": "\u2224" },
+ "nspar;": { "p": [8742], "c": "\u2226" },
+ "nsqsube;": { "p": [8930], "c": "\u22E2" },
+ "nsqsupe;": { "p": [8931], "c": "\u22E3" },
+ "nsub;": { "p": [8836], "c": "\u2284" },
+ "nsubE;": { "p": [10949, 824], "c": "\u2AC5\u0338" },
+ "nsube;": { "p": [8840], "c": "\u2288" },
+ "nsubset;": { "p": [8834, 8402], "c": "\u2282\u20D2" },
+ "nsubseteq;": { "p": [8840], "c": "\u2288" },
+ "nsubseteqq;": {
+ "p": [10949, 824],
+ "c": "\u2AC5\u0338"
+ },
+ "nsucc;": { "p": [8833], "c": "\u2281" },
+ "nsucceq;": { "p": [10928, 824], "c": "\u2AB0\u0338" },
+ "nsup;": { "p": [8837], "c": "\u2285" },
+ "nsupE;": { "p": [10950, 824], "c": "\u2AC6\u0338" },
+ "nsupe;": { "p": [8841], "c": "\u2289" },
+ "nsupset;": { "p": [8835, 8402], "c": "\u2283\u20D2" },
+ "nsupseteq;": { "p": [8841], "c": "\u2289" },
+ "nsupseteqq;": {
+ "p": [10950, 824],
+ "c": "\u2AC6\u0338"
+ },
+ "ntgl;": { "p": [8825], "c": "\u2279" },
+ "ntilde": { "p": [241], "c": "\u00F1" },
+ "ntilde;": { "p": [241], "c": "\u00F1" },
+ "ntlg;": { "p": [8824], "c": "\u2278" },
+ "ntriangleleft;": { "p": [8938], "c": "\u22EA" },
+ "ntrianglelefteq;": { "p": [8940], "c": "\u22EC" },
+ "ntriangleright;": { "p": [8939], "c": "\u22EB" },
+ "ntrianglerighteq;": { "p": [8941], "c": "\u22ED" },
+ "nu;": { "p": [957], "c": "\u03BD" },
+ "num;": { "p": [35], "c": "\u0023" },
+ "numero;": { "p": [8470], "c": "\u2116" },
+ "numsp;": { "p": [8199], "c": "\u2007" },
+ "nvDash;": { "p": [8877], "c": "\u22AD" },
+ "nvHarr;": { "p": [10500], "c": "\u2904" },
+ "nvap;": { "p": [8781, 8402], "c": "\u224D\u20D2" },
+ "nvdash;": { "p": [8876], "c": "\u22AC" },
+ "nvge;": { "p": [8805, 8402], "c": "\u2265\u20D2" },
+ "nvgt;": { "p": [62, 8402], "c": "\u003E\u20D2" },
+ "nvinfin;": { "p": [10718], "c": "\u29DE" },
+ "nvlArr;": { "p": [10498], "c": "\u2902" },
+ "nvle;": { "p": [8804, 8402], "c": "\u2264\u20D2" },
+ "nvlt;": { "p": [60, 8402], "c": "\u003C\u20D2" },
+ "nvltrie;": { "p": [8884, 8402], "c": "\u22B4\u20D2" },
+ "nvrArr;": { "p": [10499], "c": "\u2903" },
+ "nvrtrie;": { "p": [8885, 8402], "c": "\u22B5\u20D2" },
+ "nvsim;": { "p": [8764, 8402], "c": "\u223C\u20D2" },
+ "nwArr;": { "p": [8662], "c": "\u21D6" },
+ "nwarhk;": { "p": [10531], "c": "\u2923" },
+ "nwarr;": { "p": [8598], "c": "\u2196" },
+ "nwarrow;": { "p": [8598], "c": "\u2196" },
+ "nwnear;": { "p": [10535], "c": "\u2927" },
+ "oS;": { "p": [9416], "c": "\u24C8" },
+ "oacute": { "p": [243], "c": "\u00F3" },
+ "oacute;": { "p": [243], "c": "\u00F3" },
+ "oast;": { "p": [8859], "c": "\u229B" },
+ "ocir;": { "p": [8858], "c": "\u229A" },
+ "ocirc": { "p": [244], "c": "\u00F4" },
+ "ocirc;": { "p": [244], "c": "\u00F4" },
+ "ocy;": { "p": [1086], "c": "\u043E" },
+ "odash;": { "p": [8861], "c": "\u229D" },
+ "odblac;": { "p": [337], "c": "\u0151" },
+ "odiv;": { "p": [10808], "c": "\u2A38" },
+ "odot;": { "p": [8857], "c": "\u2299" },
+ "odsold;": { "p": [10684], "c": "\u29BC" },
+ "oelig;": { "p": [339], "c": "\u0153" },
+ "ofcir;": { "p": [10687], "c": "\u29BF" },
+ "ofr;": { "p": [120108], "c": "\uD835\uDD2C" },
+ "ogon;": { "p": [731], "c": "\u02DB" },
+ "ograve": { "p": [242], "c": "\u00F2" },
+ "ograve;": { "p": [242], "c": "\u00F2" },
+ "ogt;": { "p": [10689], "c": "\u29C1" },
+ "ohbar;": { "p": [10677], "c": "\u29B5" },
+ "ohm;": { "p": [937], "c": "\u03A9" },
+ "oint;": { "p": [8750], "c": "\u222E" },
+ "olarr;": { "p": [8634], "c": "\u21BA" },
+ "olcir;": { "p": [10686], "c": "\u29BE" },
+ "olcross;": { "p": [10683], "c": "\u29BB" },
+ "oline;": { "p": [8254], "c": "\u203E" },
+ "olt;": { "p": [10688], "c": "\u29C0" },
+ "omacr;": { "p": [333], "c": "\u014D" },
+ "omega;": { "p": [969], "c": "\u03C9" },
+ "omicron;": { "p": [959], "c": "\u03BF" },
+ "omid;": { "p": [10678], "c": "\u29B6" },
+ "ominus;": { "p": [8854], "c": "\u2296" },
+ "oopf;": { "p": [120160], "c": "\uD835\uDD60" },
+ "opar;": { "p": [10679], "c": "\u29B7" },
+ "operp;": { "p": [10681], "c": "\u29B9" },
+ "oplus;": { "p": [8853], "c": "\u2295" },
+ "or;": { "p": [8744], "c": "\u2228" },
+ "orarr;": { "p": [8635], "c": "\u21BB" },
+ "ord;": { "p": [10845], "c": "\u2A5D" },
+ "order;": { "p": [8500], "c": "\u2134" },
+ "orderof;": { "p": [8500], "c": "\u2134" },
+ "ordf": { "p": [170], "c": "\u00AA" },
+ "ordf;": { "p": [170], "c": "\u00AA" },
+ "ordm": { "p": [186], "c": "\u00BA" },
+ "ordm;": { "p": [186], "c": "\u00BA" },
+ "origof;": { "p": [8886], "c": "\u22B6" },
+ "oror;": { "p": [10838], "c": "\u2A56" },
+ "orslope;": { "p": [10839], "c": "\u2A57" },
+ "orv;": { "p": [10843], "c": "\u2A5B" },
+ "oscr;": { "p": [8500], "c": "\u2134" },
+ "oslash": { "p": [248], "c": "\u00F8" },
+ "oslash;": { "p": [248], "c": "\u00F8" },
+ "osol;": { "p": [8856], "c": "\u2298" },
+ "otilde": { "p": [245], "c": "\u00F5" },
+ "otilde;": { "p": [245], "c": "\u00F5" },
+ "otimes;": { "p": [8855], "c": "\u2297" },
+ "otimesas;": { "p": [10806], "c": "\u2A36" },
+ "ouml": { "p": [246], "c": "\u00F6" },
+ "ouml;": { "p": [246], "c": "\u00F6" },
+ "ovbar;": { "p": [9021], "c": "\u233D" },
+ "par;": { "p": [8741], "c": "\u2225" },
+ "para": { "p": [182], "c": "\u00B6" },
+ "para;": { "p": [182], "c": "\u00B6" },
+ "parallel;": { "p": [8741], "c": "\u2225" },
+ "parsim;": { "p": [10995], "c": "\u2AF3" },
+ "parsl;": { "p": [11005], "c": "\u2AFD" },
+ "part;": { "p": [8706], "c": "\u2202" },
+ "pcy;": { "p": [1087], "c": "\u043F" },
+ "percnt;": { "p": [37], "c": "\u0025" },
+ "period;": { "p": [46], "c": "\u002E" },
+ "permil;": { "p": [8240], "c": "\u2030" },
+ "perp;": { "p": [8869], "c": "\u22A5" },
+ "pertenk;": { "p": [8241], "c": "\u2031" },
+ "pfr;": { "p": [120109], "c": "\uD835\uDD2D" },
+ "phi;": { "p": [966], "c": "\u03C6" },
+ "phiv;": { "p": [981], "c": "\u03D5" },
+ "phmmat;": { "p": [8499], "c": "\u2133" },
+ "phone;": { "p": [9742], "c": "\u260E" },
+ "pi;": { "p": [960], "c": "\u03C0" },
+ "pitchfork;": { "p": [8916], "c": "\u22D4" },
+ "piv;": { "p": [982], "c": "\u03D6" },
+ "planck;": { "p": [8463], "c": "\u210F" },
+ "planckh;": { "p": [8462], "c": "\u210E" },
+ "plankv;": { "p": [8463], "c": "\u210F" },
+ "plus;": { "p": [43], "c": "\u002B" },
+ "plusacir;": { "p": [10787], "c": "\u2A23" },
+ "plusb;": { "p": [8862], "c": "\u229E" },
+ "pluscir;": { "p": [10786], "c": "\u2A22" },
+ "plusdo;": { "p": [8724], "c": "\u2214" },
+ "plusdu;": { "p": [10789], "c": "\u2A25" },
+ "pluse;": { "p": [10866], "c": "\u2A72" },
+ "plusmn": { "p": [177], "c": "\u00B1" },
+ "plusmn;": { "p": [177], "c": "\u00B1" },
+ "plussim;": { "p": [10790], "c": "\u2A26" },
+ "plustwo;": { "p": [10791], "c": "\u2A27" },
+ "pm;": { "p": [177], "c": "\u00B1" },
+ "pointint;": { "p": [10773], "c": "\u2A15" },
+ "popf;": { "p": [120161], "c": "\uD835\uDD61" },
+ "pound": { "p": [163], "c": "\u00A3" },
+ "pound;": { "p": [163], "c": "\u00A3" },
+ "pr;": { "p": [8826], "c": "\u227A" },
+ "prE;": { "p": [10931], "c": "\u2AB3" },
+ "prap;": { "p": [10935], "c": "\u2AB7" },
+ "prcue;": { "p": [8828], "c": "\u227C" },
+ "pre;": { "p": [10927], "c": "\u2AAF" },
+ "prec;": { "p": [8826], "c": "\u227A" },
+ "precapprox;": { "p": [10935], "c": "\u2AB7" },
+ "preccurlyeq;": { "p": [8828], "c": "\u227C" },
+ "preceq;": { "p": [10927], "c": "\u2AAF" },
+ "precnapprox;": { "p": [10937], "c": "\u2AB9" },
+ "precneqq;": { "p": [10933], "c": "\u2AB5" },
+ "precnsim;": { "p": [8936], "c": "\u22E8" },
+ "precsim;": { "p": [8830], "c": "\u227E" },
+ "prime;": { "p": [8242], "c": "\u2032" },
+ "primes;": { "p": [8473], "c": "\u2119" },
+ "prnE;": { "p": [10933], "c": "\u2AB5" },
+ "prnap;": { "p": [10937], "c": "\u2AB9" },
+ "prnsim;": { "p": [8936], "c": "\u22E8" },
+ "prod;": { "p": [8719], "c": "\u220F" },
+ "profalar;": { "p": [9006], "c": "\u232E" },
+ "profline;": { "p": [8978], "c": "\u2312" },
+ "profsurf;": { "p": [8979], "c": "\u2313" },
+ "prop;": { "p": [8733], "c": "\u221D" },
+ "propto;": { "p": [8733], "c": "\u221D" },
+ "prsim;": { "p": [8830], "c": "\u227E" },
+ "prurel;": { "p": [8880], "c": "\u22B0" },
+ "pscr;": { "p": [120005], "c": "\uD835\uDCC5" },
+ "psi;": { "p": [968], "c": "\u03C8" },
+ "puncsp;": { "p": [8200], "c": "\u2008" },
+ "qfr;": { "p": [120110], "c": "\uD835\uDD2E" },
+ "qint;": { "p": [10764], "c": "\u2A0C" },
+ "qopf;": { "p": [120162], "c": "\uD835\uDD62" },
+ "qprime;": { "p": [8279], "c": "\u2057" },
+ "qscr;": { "p": [120006], "c": "\uD835\uDCC6" },
+ "quaternions;": { "p": [8461], "c": "\u210D" },
+ "quatint;": { "p": [10774], "c": "\u2A16" },
+ "quest;": { "p": [63], "c": "\u003F" },
+ "questeq;": { "p": [8799], "c": "\u225F" },
+ "quot": { "p": [34], "c": "\u0022" },
+ "quot;": { "p": [34], "c": "\u0022" },
+ "rAarr;": { "p": [8667], "c": "\u21DB" },
+ "rArr;": { "p": [8658], "c": "\u21D2" },
+ "rAtail;": { "p": [10524], "c": "\u291C" },
+ "rBarr;": { "p": [10511], "c": "\u290F" },
+ "rHar;": { "p": [10596], "c": "\u2964" },
+ "race;": { "p": [8765, 817], "c": "\u223D\u0331" },
+ "racute;": { "p": [341], "c": "\u0155" },
+ "radic;": { "p": [8730], "c": "\u221A" },
+ "raemptyv;": { "p": [10675], "c": "\u29B3" },
+ "rang;": { "p": [10217], "c": "\u27E9" },
+ "rangd;": { "p": [10642], "c": "\u2992" },
+ "range;": { "p": [10661], "c": "\u29A5" },
+ "rangle;": { "p": [10217], "c": "\u27E9" },
+ "raquo": { "p": [187], "c": "\u00BB" },
+ "raquo;": { "p": [187], "c": "\u00BB" },
+ "rarr;": { "p": [8594], "c": "\u2192" },
+ "rarrap;": { "p": [10613], "c": "\u2975" },
+ "rarrb;": { "p": [8677], "c": "\u21E5" },
+ "rarrbfs;": { "p": [10528], "c": "\u2920" },
+ "rarrc;": { "p": [10547], "c": "\u2933" },
+ "rarrfs;": { "p": [10526], "c": "\u291E" },
+ "rarrhk;": { "p": [8618], "c": "\u21AA" },
+ "rarrlp;": { "p": [8620], "c": "\u21AC" },
+ "rarrpl;": { "p": [10565], "c": "\u2945" },
+ "rarrsim;": { "p": [10612], "c": "\u2974" },
+ "rarrtl;": { "p": [8611], "c": "\u21A3" },
+ "rarrw;": { "p": [8605], "c": "\u219D" },
+ "ratail;": { "p": [10522], "c": "\u291A" },
+ "ratio;": { "p": [8758], "c": "\u2236" },
+ "rationals;": { "p": [8474], "c": "\u211A" },
+ "rbarr;": { "p": [10509], "c": "\u290D" },
+ "rbbrk;": { "p": [10099], "c": "\u2773" },
+ "rbrace;": { "p": [125], "c": "\u007D" },
+ "rbrack;": { "p": [93], "c": "\u005D" },
+ "rbrke;": { "p": [10636], "c": "\u298C" },
+ "rbrksld;": { "p": [10638], "c": "\u298E" },
+ "rbrkslu;": { "p": [10640], "c": "\u2990" },
+ "rcaron;": { "p": [345], "c": "\u0159" },
+ "rcedil;": { "p": [343], "c": "\u0157" },
+ "rceil;": { "p": [8969], "c": "\u2309" },
+ "rcub;": { "p": [125], "c": "\u007D" },
+ "rcy;": { "p": [1088], "c": "\u0440" },
+ "rdca;": { "p": [10551], "c": "\u2937" },
+ "rdldhar;": { "p": [10601], "c": "\u2969" },
+ "rdquo;": { "p": [8221], "c": "\u201D" },
+ "rdquor;": { "p": [8221], "c": "\u201D" },
+ "rdsh;": { "p": [8627], "c": "\u21B3" },
+ "real;": { "p": [8476], "c": "\u211C" },
+ "realine;": { "p": [8475], "c": "\u211B" },
+ "realpart;": { "p": [8476], "c": "\u211C" },
+ "reals;": { "p": [8477], "c": "\u211D" },
+ "rect;": { "p": [9645], "c": "\u25AD" },
+ "reg": { "p": [174], "c": "\u00AE" },
+ "reg;": { "p": [174], "c": "\u00AE" },
+ "rfisht;": { "p": [10621], "c": "\u297D" },
+ "rfloor;": { "p": [8971], "c": "\u230B" },
+ "rfr;": { "p": [120111], "c": "\uD835\uDD2F" },
+ "rhard;": { "p": [8641], "c": "\u21C1" },
+ "rharu;": { "p": [8640], "c": "\u21C0" },
+ "rharul;": { "p": [10604], "c": "\u296C" },
+ "rho;": { "p": [961], "c": "\u03C1" },
+ "rhov;": { "p": [1009], "c": "\u03F1" },
+ "rightarrow;": { "p": [8594], "c": "\u2192" },
+ "rightarrowtail;": { "p": [8611], "c": "\u21A3" },
+ "rightharpoondown;": { "p": [8641], "c": "\u21C1" },
+ "rightharpoonup;": { "p": [8640], "c": "\u21C0" },
+ "rightleftarrows;": { "p": [8644], "c": "\u21C4" },
+ "rightleftharpoons;": { "p": [8652], "c": "\u21CC" },
+ "rightrightarrows;": { "p": [8649], "c": "\u21C9" },
+ "rightsquigarrow;": { "p": [8605], "c": "\u219D" },
+ "rightthreetimes;": { "p": [8908], "c": "\u22CC" },
+ "ring;": { "p": [730], "c": "\u02DA" },
+ "risingdotseq;": { "p": [8787], "c": "\u2253" },
+ "rlarr;": { "p": [8644], "c": "\u21C4" },
+ "rlhar;": { "p": [8652], "c": "\u21CC" },
+ "rlm;": { "p": [8207], "c": "\u200F" },
+ "rmoust;": { "p": [9137], "c": "\u23B1" },
+ "rmoustache;": { "p": [9137], "c": "\u23B1" },
+ "rnmid;": { "p": [10990], "c": "\u2AEE" },
+ "roang;": { "p": [10221], "c": "\u27ED" },
+ "roarr;": { "p": [8702], "c": "\u21FE" },
+ "robrk;": { "p": [10215], "c": "\u27E7" },
+ "ropar;": { "p": [10630], "c": "\u2986" },
+ "ropf;": { "p": [120163], "c": "\uD835\uDD63" },
+ "roplus;": { "p": [10798], "c": "\u2A2E" },
+ "rotimes;": { "p": [10805], "c": "\u2A35" },
+ "rpar;": { "p": [41], "c": "\u0029" },
+ "rpargt;": { "p": [10644], "c": "\u2994" },
+ "rppolint;": { "p": [10770], "c": "\u2A12" },
+ "rrarr;": { "p": [8649], "c": "\u21C9" },
+ "rsaquo;": { "p": [8250], "c": "\u203A" },
+ "rscr;": { "p": [120007], "c": "\uD835\uDCC7" },
+ "rsh;": { "p": [8625], "c": "\u21B1" },
+ "rsqb;": { "p": [93], "c": "\u005D" },
+ "rsquo;": { "p": [8217], "c": "\u2019" },
+ "rsquor;": { "p": [8217], "c": "\u2019" },
+ "rthree;": { "p": [8908], "c": "\u22CC" },
+ "rtimes;": { "p": [8906], "c": "\u22CA" },
+ "rtri;": { "p": [9657], "c": "\u25B9" },
+ "rtrie;": { "p": [8885], "c": "\u22B5" },
+ "rtrif;": { "p": [9656], "c": "\u25B8" },
+ "rtriltri;": { "p": [10702], "c": "\u29CE" },
+ "ruluhar;": { "p": [10600], "c": "\u2968" },
+ "rx;": { "p": [8478], "c": "\u211E" },
+ "sacute;": { "p": [347], "c": "\u015B" },
+ "sbquo;": { "p": [8218], "c": "\u201A" },
+ "sc;": { "p": [8827], "c": "\u227B" },
+ "scE;": { "p": [10932], "c": "\u2AB4" },
+ "scap;": { "p": [10936], "c": "\u2AB8" },
+ "scaron;": { "p": [353], "c": "\u0161" },
+ "sccue;": { "p": [8829], "c": "\u227D" },
+ "sce;": { "p": [10928], "c": "\u2AB0" },
+ "scedil;": { "p": [351], "c": "\u015F" },
+ "scirc;": { "p": [349], "c": "\u015D" },
+ "scnE;": { "p": [10934], "c": "\u2AB6" },
+ "scnap;": { "p": [10938], "c": "\u2ABA" },
+ "scnsim;": { "p": [8937], "c": "\u22E9" },
+ "scpolint;": { "p": [10771], "c": "\u2A13" },
+ "scsim;": { "p": [8831], "c": "\u227F" },
+ "scy;": { "p": [1089], "c": "\u0441" },
+ "sdot;": { "p": [8901], "c": "\u22C5" },
+ "sdotb;": { "p": [8865], "c": "\u22A1" },
+ "sdote;": { "p": [10854], "c": "\u2A66" },
+ "seArr;": { "p": [8664], "c": "\u21D8" },
+ "searhk;": { "p": [10533], "c": "\u2925" },
+ "searr;": { "p": [8600], "c": "\u2198" },
+ "searrow;": { "p": [8600], "c": "\u2198" },
+ "sect": { "p": [167], "c": "\u00A7" },
+ "sect;": { "p": [167], "c": "\u00A7" },
+ "semi;": { "p": [59], "c": "\u003B" },
+ "seswar;": { "p": [10537], "c": "\u2929" },
+ "setminus;": { "p": [8726], "c": "\u2216" },
+ "setmn;": { "p": [8726], "c": "\u2216" },
+ "sext;": { "p": [10038], "c": "\u2736" },
+ "sfr;": { "p": [120112], "c": "\uD835\uDD30" },
+ "sfrown;": { "p": [8994], "c": "\u2322" },
+ "sharp;": { "p": [9839], "c": "\u266F" },
+ "shchcy;": { "p": [1097], "c": "\u0449" },
+ "shcy;": { "p": [1096], "c": "\u0448" },
+ "shortmid;": { "p": [8739], "c": "\u2223" },
+ "shortparallel;": { "p": [8741], "c": "\u2225" },
+ "shy": { "p": [173], "c": "\u00AD" },
+ "shy;": { "p": [173], "c": "\u00AD" },
+ "sigma;": { "p": [963], "c": "\u03C3" },
+ "sigmaf;": { "p": [962], "c": "\u03C2" },
+ "sigmav;": { "p": [962], "c": "\u03C2" },
+ "sim;": { "p": [8764], "c": "\u223C" },
+ "simdot;": { "p": [10858], "c": "\u2A6A" },
+ "sime;": { "p": [8771], "c": "\u2243" },
+ "simeq;": { "p": [8771], "c": "\u2243" },
+ "simg;": { "p": [10910], "c": "\u2A9E" },
+ "simgE;": { "p": [10912], "c": "\u2AA0" },
+ "siml;": { "p": [10909], "c": "\u2A9D" },
+ "simlE;": { "p": [10911], "c": "\u2A9F" },
+ "simne;": { "p": [8774], "c": "\u2246" },
+ "simplus;": { "p": [10788], "c": "\u2A24" },
+ "simrarr;": { "p": [10610], "c": "\u2972" },
+ "slarr;": { "p": [8592], "c": "\u2190" },
+ "smallsetminus;": { "p": [8726], "c": "\u2216" },
+ "smashp;": { "p": [10803], "c": "\u2A33" },
+ "smeparsl;": { "p": [10724], "c": "\u29E4" },
+ "smid;": { "p": [8739], "c": "\u2223" },
+ "smile;": { "p": [8995], "c": "\u2323" },
+ "smt;": { "p": [10922], "c": "\u2AAA" },
+ "smte;": { "p": [10924], "c": "\u2AAC" },
+ "smtes;": { "p": [10924, 65024], "c": "\u2AAC\uFE00" },
+ "softcy;": { "p": [1100], "c": "\u044C" },
+ "sol;": { "p": [47], "c": "\u002F" },
+ "solb;": { "p": [10692], "c": "\u29C4" },
+ "solbar;": { "p": [9023], "c": "\u233F" },
+ "sopf;": { "p": [120164], "c": "\uD835\uDD64" },
+ "spades;": { "p": [9824], "c": "\u2660" },
+ "spadesuit;": { "p": [9824], "c": "\u2660" },
+ "spar;": { "p": [8741], "c": "\u2225" },
+ "sqcap;": { "p": [8851], "c": "\u2293" },
+ "sqcaps;": { "p": [8851, 65024], "c": "\u2293\uFE00" },
+ "sqcup;": { "p": [8852], "c": "\u2294" },
+ "sqcups;": { "p": [8852, 65024], "c": "\u2294\uFE00" },
+ "sqsub;": { "p": [8847], "c": "\u228F" },
+ "sqsube;": { "p": [8849], "c": "\u2291" },
+ "sqsubset;": { "p": [8847], "c": "\u228F" },
+ "sqsubseteq;": { "p": [8849], "c": "\u2291" },
+ "sqsup;": { "p": [8848], "c": "\u2290" },
+ "sqsupe;": { "p": [8850], "c": "\u2292" },
+ "sqsupset;": { "p": [8848], "c": "\u2290" },
+ "sqsupseteq;": { "p": [8850], "c": "\u2292" },
+ "squ;": { "p": [9633], "c": "\u25A1" },
+ "square;": { "p": [9633], "c": "\u25A1" },
+ "squarf;": { "p": [9642], "c": "\u25AA" },
+ "squf;": { "p": [9642], "c": "\u25AA" },
+ "srarr;": { "p": [8594], "c": "\u2192" },
+ "sscr;": { "p": [120008], "c": "\uD835\uDCC8" },
+ "ssetmn;": { "p": [8726], "c": "\u2216" },
+ "ssmile;": { "p": [8995], "c": "\u2323" },
+ "sstarf;": { "p": [8902], "c": "\u22C6" },
+ "star;": { "p": [9734], "c": "\u2606" },
+ "starf;": { "p": [9733], "c": "\u2605" },
+ "straightepsilon;": { "p": [1013], "c": "\u03F5" },
+ "straightphi;": { "p": [981], "c": "\u03D5" },
+ "strns;": { "p": [175], "c": "\u00AF" },
+ "sub;": { "p": [8834], "c": "\u2282" },
+ "subE;": { "p": [10949], "c": "\u2AC5" },
+ "subdot;": { "p": [10941], "c": "\u2ABD" },
+ "sube;": { "p": [8838], "c": "\u2286" },
+ "subedot;": { "p": [10947], "c": "\u2AC3" },
+ "submult;": { "p": [10945], "c": "\u2AC1" },
+ "subnE;": { "p": [10955], "c": "\u2ACB" },
+ "subne;": { "p": [8842], "c": "\u228A" },
+ "subplus;": { "p": [10943], "c": "\u2ABF" },
+ "subrarr;": { "p": [10617], "c": "\u2979" },
+ "subset;": { "p": [8834], "c": "\u2282" },
+ "subseteq;": { "p": [8838], "c": "\u2286" },
+ "subseteqq;": { "p": [10949], "c": "\u2AC5" },
+ "subsetneq;": { "p": [8842], "c": "\u228A" },
+ "subsetneqq;": { "p": [10955], "c": "\u2ACB" },
+ "subsim;": { "p": [10951], "c": "\u2AC7" },
+ "subsub;": { "p": [10965], "c": "\u2AD5" },
+ "subsup;": { "p": [10963], "c": "\u2AD3" },
+ "succ;": { "p": [8827], "c": "\u227B" },
+ "succapprox;": { "p": [10936], "c": "\u2AB8" },
+ "succcurlyeq;": { "p": [8829], "c": "\u227D" },
+ "succeq;": { "p": [10928], "c": "\u2AB0" },
+ "succnapprox;": { "p": [10938], "c": "\u2ABA" },
+ "succneqq;": { "p": [10934], "c": "\u2AB6" },
+ "succnsim;": { "p": [8937], "c": "\u22E9" },
+ "succsim;": { "p": [8831], "c": "\u227F" },
+ "sum;": { "p": [8721], "c": "\u2211" },
+ "sung;": { "p": [9834], "c": "\u266A" },
+ "sup1": { "p": [185], "c": "\u00B9" },
+ "sup1;": { "p": [185], "c": "\u00B9" },
+ "sup2": { "p": [178], "c": "\u00B2" },
+ "sup2;": { "p": [178], "c": "\u00B2" },
+ "sup3": { "p": [179], "c": "\u00B3" },
+ "sup3;": { "p": [179], "c": "\u00B3" },
+ "sup;": { "p": [8835], "c": "\u2283" },
+ "supE;": { "p": [10950], "c": "\u2AC6" },
+ "supdot;": { "p": [10942], "c": "\u2ABE" },
+ "supdsub;": { "p": [10968], "c": "\u2AD8" },
+ "supe;": { "p": [8839], "c": "\u2287" },
+ "supedot;": { "p": [10948], "c": "\u2AC4" },
+ "suphsol;": { "p": [10185], "c": "\u27C9" },
+ "suphsub;": { "p": [10967], "c": "\u2AD7" },
+ "suplarr;": { "p": [10619], "c": "\u297B" },
+ "supmult;": { "p": [10946], "c": "\u2AC2" },
+ "supnE;": { "p": [10956], "c": "\u2ACC" },
+ "supne;": { "p": [8843], "c": "\u228B" },
+ "supplus;": { "p": [10944], "c": "\u2AC0" },
+ "supset;": { "p": [8835], "c": "\u2283" },
+ "supseteq;": { "p": [8839], "c": "\u2287" },
+ "supseteqq;": { "p": [10950], "c": "\u2AC6" },
+ "supsetneq;": { "p": [8843], "c": "\u228B" },
+ "supsetneqq;": { "p": [10956], "c": "\u2ACC" },
+ "supsim;": { "p": [10952], "c": "\u2AC8" },
+ "supsub;": { "p": [10964], "c": "\u2AD4" },
+ "supsup;": { "p": [10966], "c": "\u2AD6" },
+ "swArr;": { "p": [8665], "c": "\u21D9" },
+ "swarhk;": { "p": [10534], "c": "\u2926" },
+ "swarr;": { "p": [8601], "c": "\u2199" },
+ "swarrow;": { "p": [8601], "c": "\u2199" },
+ "swnwar;": { "p": [10538], "c": "\u292A" },
+ "szlig": { "p": [223], "c": "\u00DF" },
+ "szlig;": { "p": [223], "c": "\u00DF" },
+ "target;": { "p": [8982], "c": "\u2316" },
+ "tau;": { "p": [964], "c": "\u03C4" },
+ "tbrk;": { "p": [9140], "c": "\u23B4" },
+ "tcaron;": { "p": [357], "c": "\u0165" },
+ "tcedil;": { "p": [355], "c": "\u0163" },
+ "tcy;": { "p": [1090], "c": "\u0442" },
+ "tdot;": { "p": [8411], "c": "\u20DB" },
+ "telrec;": { "p": [8981], "c": "\u2315" },
+ "tfr;": { "p": [120113], "c": "\uD835\uDD31" },
+ "there4;": { "p": [8756], "c": "\u2234" },
+ "therefore;": { "p": [8756], "c": "\u2234" },
+ "theta;": { "p": [952], "c": "\u03B8" },
+ "thetasym;": { "p": [977], "c": "\u03D1" },
+ "thetav;": { "p": [977], "c": "\u03D1" },
+ "thickapprox;": { "p": [8776], "c": "\u2248" },
+ "thicksim;": { "p": [8764], "c": "\u223C" },
+ "thinsp;": { "p": [8201], "c": "\u2009" },
+ "thkap;": { "p": [8776], "c": "\u2248" },
+ "thksim;": { "p": [8764], "c": "\u223C" },
+ "thorn": { "p": [254], "c": "\u00FE" },
+ "thorn;": { "p": [254], "c": "\u00FE" },
+ "tilde;": { "p": [732], "c": "\u02DC" },
+ "times": { "p": [215], "c": "\u00D7" },
+ "times;": { "p": [215], "c": "\u00D7" },
+ "timesb;": { "p": [8864], "c": "\u22A0" },
+ "timesbar;": { "p": [10801], "c": "\u2A31" },
+ "timesd;": { "p": [10800], "c": "\u2A30" },
+ "tint;": { "p": [8749], "c": "\u222D" },
+ "toea;": { "p": [10536], "c": "\u2928" },
+ "top;": { "p": [8868], "c": "\u22A4" },
+ "topbot;": { "p": [9014], "c": "\u2336" },
+ "topcir;": { "p": [10993], "c": "\u2AF1" },
+ "topf;": { "p": [120165], "c": "\uD835\uDD65" },
+ "topfork;": { "p": [10970], "c": "\u2ADA" },
+ "tosa;": { "p": [10537], "c": "\u2929" },
+ "tprime;": { "p": [8244], "c": "\u2034" },
+ "trade;": { "p": [8482], "c": "\u2122" },
+ "triangle;": { "p": [9653], "c": "\u25B5" },
+ "triangledown;": { "p": [9663], "c": "\u25BF" },
+ "triangleleft;": { "p": [9667], "c": "\u25C3" },
+ "trianglelefteq;": { "p": [8884], "c": "\u22B4" },
+ "triangleq;": { "p": [8796], "c": "\u225C" },
+ "triangleright;": { "p": [9657], "c": "\u25B9" },
+ "trianglerighteq;": { "p": [8885], "c": "\u22B5" },
+ "tridot;": { "p": [9708], "c": "\u25EC" },
+ "trie;": { "p": [8796], "c": "\u225C" },
+ "triminus;": { "p": [10810], "c": "\u2A3A" },
+ "triplus;": { "p": [10809], "c": "\u2A39" },
+ "trisb;": { "p": [10701], "c": "\u29CD" },
+ "tritime;": { "p": [10811], "c": "\u2A3B" },
+ "trpezium;": { "p": [9186], "c": "\u23E2" },
+ "tscr;": { "p": [120009], "c": "\uD835\uDCC9" },
+ "tscy;": { "p": [1094], "c": "\u0446" },
+ "tshcy;": { "p": [1115], "c": "\u045B" },
+ "tstrok;": { "p": [359], "c": "\u0167" },
+ "twixt;": { "p": [8812], "c": "\u226C" },
+ "twoheadleftarrow;": { "p": [8606], "c": "\u219E" },
+ "twoheadrightarrow;": { "p": [8608], "c": "\u21A0" },
+ "uArr;": { "p": [8657], "c": "\u21D1" },
+ "uHar;": { "p": [10595], "c": "\u2963" },
+ "uacute": { "p": [250], "c": "\u00FA" },
+ "uacute;": { "p": [250], "c": "\u00FA" },
+ "uarr;": { "p": [8593], "c": "\u2191" },
+ "ubrcy;": { "p": [1118], "c": "\u045E" },
+ "ubreve;": { "p": [365], "c": "\u016D" },
+ "ucirc": { "p": [251], "c": "\u00FB" },
+ "ucirc;": { "p": [251], "c": "\u00FB" },
+ "ucy;": { "p": [1091], "c": "\u0443" },
+ "udarr;": { "p": [8645], "c": "\u21C5" },
+ "udblac;": { "p": [369], "c": "\u0171" },
+ "udhar;": { "p": [10606], "c": "\u296E" },
+ "ufisht;": { "p": [10622], "c": "\u297E" },
+ "ufr;": { "p": [120114], "c": "\uD835\uDD32" },
+ "ugrave": { "p": [249], "c": "\u00F9" },
+ "ugrave;": { "p": [249], "c": "\u00F9" },
+ "uharl;": { "p": [8639], "c": "\u21BF" },
+ "uharr;": { "p": [8638], "c": "\u21BE" },
+ "uhblk;": { "p": [9600], "c": "\u2580" },
+ "ulcorn;": { "p": [8988], "c": "\u231C" },
+ "ulcorner;": { "p": [8988], "c": "\u231C" },
+ "ulcrop;": { "p": [8975], "c": "\u230F" },
+ "ultri;": { "p": [9720], "c": "\u25F8" },
+ "umacr;": { "p": [363], "c": "\u016B" },
+ "uml": { "p": [168], "c": "\u00A8" },
+ "uml;": { "p": [168], "c": "\u00A8" },
+ "uogon;": { "p": [371], "c": "\u0173" },
+ "uopf;": { "p": [120166], "c": "\uD835\uDD66" },
+ "uparrow;": { "p": [8593], "c": "\u2191" },
+ "updownarrow;": { "p": [8597], "c": "\u2195" },
+ "upharpoonleft;": { "p": [8639], "c": "\u21BF" },
+ "upharpoonright;": { "p": [8638], "c": "\u21BE" },
+ "uplus;": { "p": [8846], "c": "\u228E" },
+ "upsi;": { "p": [965], "c": "\u03C5" },
+ "upsih;": { "p": [978], "c": "\u03D2" },
+ "upsilon;": { "p": [965], "c": "\u03C5" },
+ "upuparrows;": { "p": [8648], "c": "\u21C8" },
+ "urcorn;": { "p": [8989], "c": "\u231D" },
+ "urcorner;": { "p": [8989], "c": "\u231D" },
+ "urcrop;": { "p": [8974], "c": "\u230E" },
+ "uring;": { "p": [367], "c": "\u016F" },
+ "urtri;": { "p": [9721], "c": "\u25F9" },
+ "uscr;": { "p": [120010], "c": "\uD835\uDCCA" },
+ "utdot;": { "p": [8944], "c": "\u22F0" },
+ "utilde;": { "p": [361], "c": "\u0169" },
+ "utri;": { "p": [9653], "c": "\u25B5" },
+ "utrif;": { "p": [9652], "c": "\u25B4" },
+ "uuarr;": { "p": [8648], "c": "\u21C8" },
+ "uuml": { "p": [252], "c": "\u00FC" },
+ "uuml;": { "p": [252], "c": "\u00FC" },
+ "uwangle;": { "p": [10663], "c": "\u29A7" },
+ "vArr;": { "p": [8661], "c": "\u21D5" },
+ "vBar;": { "p": [10984], "c": "\u2AE8" },
+ "vBarv;": { "p": [10985], "c": "\u2AE9" },
+ "vDash;": { "p": [8872], "c": "\u22A8" },
+ "vangrt;": { "p": [10652], "c": "\u299C" },
+ "varepsilon;": { "p": [1013], "c": "\u03F5" },
+ "varkappa;": { "p": [1008], "c": "\u03F0" },
+ "varnothing;": { "p": [8709], "c": "\u2205" },
+ "varphi;": { "p": [981], "c": "\u03D5" },
+ "varpi;": { "p": [982], "c": "\u03D6" },
+ "varpropto;": { "p": [8733], "c": "\u221D" },
+ "varr;": { "p": [8597], "c": "\u2195" },
+ "varrho;": { "p": [1009], "c": "\u03F1" },
+ "varsigma;": { "p": [962], "c": "\u03C2" },
+ "varsubsetneq;": {
+ "p": [8842, 65024],
+ "c": "\u228A\uFE00"
+ },
+ "varsubsetneqq;": {
+ "p": [10955, 65024],
+ "c": "\u2ACB\uFE00"
+ },
+ "varsupsetneq;": {
+ "p": [8843, 65024],
+ "c": "\u228B\uFE00"
+ },
+ "varsupsetneqq;": {
+ "p": [10956, 65024],
+ "c": "\u2ACC\uFE00"
+ },
+ "vartheta;": { "p": [977], "c": "\u03D1" },
+ "vartriangleleft;": { "p": [8882], "c": "\u22B2" },
+ "vartriangleright;": { "p": [8883], "c": "\u22B3" },
+ "vcy;": { "p": [1074], "c": "\u0432" },
+ "vdash;": { "p": [8866], "c": "\u22A2" },
+ "vee;": { "p": [8744], "c": "\u2228" },
+ "veebar;": { "p": [8891], "c": "\u22BB" },
+ "veeeq;": { "p": [8794], "c": "\u225A" },
+ "vellip;": { "p": [8942], "c": "\u22EE" },
+ "verbar;": { "p": [124], "c": "\u007C" },
+ "vert;": { "p": [124], "c": "\u007C" },
+ "vfr;": { "p": [120115], "c": "\uD835\uDD33" },
+ "vltri;": { "p": [8882], "c": "\u22B2" },
+ "vnsub;": { "p": [8834, 8402], "c": "\u2282\u20D2" },
+ "vnsup;": { "p": [8835, 8402], "c": "\u2283\u20D2" },
+ "vopf;": { "p": [120167], "c": "\uD835\uDD67" },
+ "vprop;": { "p": [8733], "c": "\u221D" },
+ "vrtri;": { "p": [8883], "c": "\u22B3" },
+ "vscr;": { "p": [120011], "c": "\uD835\uDCCB" },
+ "vsubnE;": { "p": [10955, 65024], "c": "\u2ACB\uFE00" },
+ "vsubne;": { "p": [8842, 65024], "c": "\u228A\uFE00" },
+ "vsupnE;": { "p": [10956, 65024], "c": "\u2ACC\uFE00" },
+ "vsupne;": { "p": [8843, 65024], "c": "\u228B\uFE00" },
+ "vzigzag;": { "p": [10650], "c": "\u299A" },
+ "wcirc;": { "p": [373], "c": "\u0175" },
+ "wedbar;": { "p": [10847], "c": "\u2A5F" },
+ "wedge;": { "p": [8743], "c": "\u2227" },
+ "wedgeq;": { "p": [8793], "c": "\u2259" },
+ "weierp;": { "p": [8472], "c": "\u2118" },
+ "wfr;": { "p": [120116], "c": "\uD835\uDD34" },
+ "wopf;": { "p": [120168], "c": "\uD835\uDD68" },
+ "wp;": { "p": [8472], "c": "\u2118" },
+ "wr;": { "p": [8768], "c": "\u2240" },
+ "wreath;": { "p": [8768], "c": "\u2240" },
+ "wscr;": { "p": [120012], "c": "\uD835\uDCCC" },
+ "xcap;": { "p": [8898], "c": "\u22C2" },
+ "xcirc;": { "p": [9711], "c": "\u25EF" },
+ "xcup;": { "p": [8899], "c": "\u22C3" },
+ "xdtri;": { "p": [9661], "c": "\u25BD" },
+ "xfr;": { "p": [120117], "c": "\uD835\uDD35" },
+ "xhArr;": { "p": [10234], "c": "\u27FA" },
+ "xharr;": { "p": [10231], "c": "\u27F7" },
+ "xi;": { "p": [958], "c": "\u03BE" },
+ "xlArr;": { "p": [10232], "c": "\u27F8" },
+ "xlarr;": { "p": [10229], "c": "\u27F5" },
+ "xmap;": { "p": [10236], "c": "\u27FC" },
+ "xnis;": { "p": [8955], "c": "\u22FB" },
+ "xodot;": { "p": [10752], "c": "\u2A00" },
+ "xopf;": { "p": [120169], "c": "\uD835\uDD69" },
+ "xoplus;": { "p": [10753], "c": "\u2A01" },
+ "xotime;": { "p": [10754], "c": "\u2A02" },
+ "xrArr;": { "p": [10233], "c": "\u27F9" },
+ "xrarr;": { "p": [10230], "c": "\u27F6" },
+ "xscr;": { "p": [120013], "c": "\uD835\uDCCD" },
+ "xsqcup;": { "p": [10758], "c": "\u2A06" },
+ "xuplus;": { "p": [10756], "c": "\u2A04" },
+ "xutri;": { "p": [9651], "c": "\u25B3" },
+ "xvee;": { "p": [8897], "c": "\u22C1" },
+ "xwedge;": { "p": [8896], "c": "\u22C0" },
+ "yacute": { "p": [253], "c": "\u00FD" },
+ "yacute;": { "p": [253], "c": "\u00FD" },
+ "yacy;": { "p": [1103], "c": "\u044F" },
+ "ycirc;": { "p": [375], "c": "\u0177" },
+ "ycy;": { "p": [1099], "c": "\u044B" },
+ "yen": { "p": [165], "c": "\u00A5" },
+ "yen;": { "p": [165], "c": "\u00A5" },
+ "yfr;": { "p": [120118], "c": "\uD835\uDD36" },
+ "yicy;": { "p": [1111], "c": "\u0457" },
+ "yopf;": { "p": [120170], "c": "\uD835\uDD6A" },
+ "yscr;": { "p": [120014], "c": "\uD835\uDCCE" },
+ "yucy;": { "p": [1102], "c": "\u044E" },
+ "yuml": { "p": [255], "c": "\u00FF" },
+ "yuml;": { "p": [255], "c": "\u00FF" },
+ "zacute;": { "p": [378], "c": "\u017A" },
+ "zcaron;": { "p": [382], "c": "\u017E" },
+ "zcy;": { "p": [1079], "c": "\u0437" },
+ "zdot;": { "p": [380], "c": "\u017C" },
+ "zeetrf;": { "p": [8488], "c": "\u2128" },
+ "zeta;": { "p": [950], "c": "\u03B6" },
+ "zfr;": { "p": [120119], "c": "\uD835\uDD37" },
+ "zhcy;": { "p": [1078], "c": "\u0436" },
+ "zigrarr;": { "p": [8669], "c": "\u21DD" },
+ "zopf;": { "p": [120171], "c": "\uD835\uDD6B" },
+ "zscr;": { "p": [120015], "c": "\uD835\uDCCF" },
+ "zwj;": { "p": [8205], "c": "\u200D" },
+ "zwnj;": { "p": [8204], "c": "\u200C" }
}
diff --git a/src/lib/utils/html.ts b/src/lib/utils/html.ts
index 42582524e..ed983a8c2 100644
--- a/src/lib/utils/html.ts
+++ b/src/lib/utils/html.ts
@@ -1,30 +1,29 @@
// There is a fixed list of named character references which will not be expanded in the future.
// This json file is based on https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references
-// with some modifications to reduce the file size of the original JSON since we just need.
+// with some modifications to reduce the file size of the original JSON.
+import { assertNever } from "./general";
import htmlEntities from "./html-entities.json";
-// Three cases:
-// { - numeric escape
-// - hex escape
-// & - named escape
-function unescapeEntities(html: string) {
- return html.replace(
- /&(#(?:\d+);?|(?:#[xX][0-9A-Fa-f]+);?|(?:\w+);?)/g,
- (_, n) => {
- if (n[0] === "#") {
- return String.fromCharCode(
- n[1] === "x" || n[1] === "X"
- ? parseInt(n.substring(2), 16)
- : parseInt(n.substring(1), 10),
- );
- }
- return htmlEntities[n as never] || "";
- },
- );
+interface EntityData {
+ /** code points associated with this escape */
+ p: number[];
+ /** String representing this escape when rendered */
+ c: string;
}
-export function getTextContent(text: string) {
- return unescapeEntities(text.replace(/<.*?(?:>|$)/g, ""));
+// https://en.wikipedia.org/wiki/Trie
+interface Trie {
+ data?: EntityData;
+ children?: Record<number, Trie | undefined>;
+}
+const htmlEntitiesTrie: Trie = {};
+for (const [name, data] of Object.entries(htmlEntities)) {
+ let current = htmlEntitiesTrie;
+ for (let i = 0; i < name.length; ++i) {
+ current.children ||= {};
+ current = current.children[name.charCodeAt(i)] ||= {};
+ }
+ current.data = data;
}
const htmlEscapes: Record<string, string> = {
@@ -38,3 +37,604 @@ const htmlEscapes: Record<string, string> = {
export function escapeHtml(html: string) {
return html.replace(/[&<>'"]/g, (c) => htmlEscapes[c as never]);
}
+
+/* eslint-disable @typescript-eslint/no-unsafe-enum-comparison */
+const enum Chars {
+ EOF = -1,
+ NULL = 0,
+ TAB = 0x9,
+ LF = 0xa,
+ FF = 0xc,
+ SPACE = 0x20,
+ NUMBER_SIGN = 0x23,
+ SOLIDUS = 0x2f,
+ QUOTATION_MARK = 0x22,
+ AMPERSAND = 0x26,
+ APOTROPHE = 0x27,
+ SEMICOLON = 0x3b,
+ ZERO = 0x30,
+ NINE = 0x39,
+ LESS_THAN = 0x3c,
+ EQUALS = 0x3d,
+ GREATER_THAN = 0x3e,
+ UPPERCASE_A = 0x41,
+ UPPERCASE_F = 0x46,
+ UPPERCASE_X = 0x58,
+ UPPERCASE_Z = 0x5a,
+ GRAVE_ACCENT = 0x60,
+ LOWERCASE_A = 0x61,
+ LOWERCASE_F = 0x66,
+ LOWERCASE_X = 0x78,
+ LOWERCASE_Z = 0x7a,
+}
+
+function isalpha(ch: number) {
+ return Chars.LOWERCASE_A <= (ch | 0x20) && (ch | 0x20) <= Chars.LOWERCASE_Z;
+}
+
+function isdigit(ch: number) {
+ return Chars.ZERO <= ch && ch <= Chars.NINE;
+}
+
+function isalnum(ch: number) {
+ return isalpha(ch) || isdigit(ch);
+}
+
+function isxdigit(ch: number) {
+ return (
+ isdigit(ch) ||
+ (Chars.LOWERCASE_A <= (ch | 0x20) && (ch | 0x20) <= Chars.LOWERCASE_F)
+ );
+}
+
+export const enum ParserState {
+ BeforeAttributeName,
+ AfterAttributeName,
+ BeforeAttributeValue,
+ END,
+}
+
+/**
+ * Parser for HTML attributes, each call to {@link step} will
+ * pause the parser at key points used to extract relative links from markdown
+ *
+ * The parser will pause at the points marked with `^`:
+ *
+ * ```text
+ * attr="value" attr='value' attr=value attr attr2 />
+ * ^ ^ ^ ^ ^ ^ ^ ^^
+ * BeforeValue | | | | | ||
+ * BeforeName | | | | ||
+ * BeforeValue | | | ||
+ * BeforeName | | ||
+ * BeforeValue| ||
+ * BeforeName ||
+ * AfterName
+ * AfterName
+ * END
+ * ```
+ */
+export class HtmlAttributeParser {
+ state = ParserState.BeforeAttributeName;
+ currentAttributeName: string = "";
+ currentAttributeValueStart = -1;
+ currentAttributeValueEnd = -1;
+ currentAttributeValue: string = "";
+ private temporaryBuffer: number[] = [];
+ private characterReferenceCode = 0;
+
+ constructor(
+ readonly text: string,
+ public pos: number = 0,
+ ) {}
+
+ step() {
+ switch (this.state) {
+ case ParserState.BeforeAttributeName:
+ this.beforeAttributeName();
+ return;
+ case ParserState.AfterAttributeName:
+ this.afterAttributeName();
+ return;
+ case ParserState.BeforeAttributeValue:
+ this.beforeAttributeValue();
+ return;
+
+ case ParserState.END:
+ return; // Do nothing
+ }
+
+ /* c8 ignore next */
+ assertNever(this.state);
+ }
+
+ private peek() {
+ const ch = this.text.charCodeAt(this.pos);
+ return isNaN(ch) ? Chars.EOF : ch;
+ }
+ private consume() {
+ const ch = this.peek();
+ ++this.pos;
+ return ch;
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#before-attribute-name-state
+ beforeAttributeName() {
+ this.currentAttributeName = "";
+ this.currentAttributeValue = "";
+
+ loop: for (;;) {
+ switch (this.consume()) {
+ case Chars.TAB:
+ case Chars.LF:
+ case Chars.FF:
+ case Chars.SPACE:
+ break;
+ case Chars.SOLIDUS:
+ case Chars.GREATER_THAN:
+ case Chars.EOF:
+ --this.pos;
+ this.afterAttributeName();
+ break loop;
+ case Chars.EQUALS:
+ // Unexpected equals sign before attribute name parse error.
+ // fall through
+ default:
+ --this.pos;
+ this.attributeName();
+ break loop;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#attribute-name-state
+ attributeName() {
+ const startPos = this.pos;
+ loop: for (;;) {
+ const ch = this.consume();
+ switch (ch) {
+ case Chars.TAB:
+ case Chars.LF:
+ case Chars.FF:
+ case Chars.SPACE:
+ case Chars.SOLIDUS:
+ case Chars.GREATER_THAN:
+ case Chars.EOF:
+ --this.pos;
+ this.state = ParserState.AfterAttributeName;
+ break loop;
+ case Chars.EQUALS:
+ this.state = ParserState.BeforeAttributeValue;
+ break loop;
+ case Chars.QUOTATION_MARK:
+ case Chars.APOTROPHE:
+ case Chars.LESS_THAN:
+ // This is an unexpected-character-in-attribute-name parse error. Treat it as per the "anything else" entry below.
+ // fall through
+ default:
+ // Do nothing, we collect the attribute name after the loop
+ break;
+ }
+ }
+
+ if (this.state === ParserState.BeforeAttributeValue) {
+ this.currentAttributeName = this.text
+ .substring(startPos, this.pos - 1)
+ .toLowerCase();
+ } else {
+ this.currentAttributeName = this.text
+ .substring(startPos, this.pos)
+ .toLowerCase();
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#after-attribute-name-state
+ afterAttributeName() {
+ loop: for (;;) {
+ switch (this.consume()) {
+ case Chars.TAB:
+ case Chars.LF:
+ case Chars.FF:
+ case Chars.SPACE:
+ break; // Ignore the character
+ case Chars.SOLIDUS:
+ this.state = ParserState.END; // self-closing start tag state
+ break loop;
+ case Chars.EQUALS:
+ this.state = ParserState.BeforeAttributeValue;
+ break loop;
+ case Chars.GREATER_THAN:
+ this.state = ParserState.END; // data state
+ break loop;
+ case Chars.EOF:
+ this.state = ParserState.END; // eof-in-tag parse error
+ break loop;
+ default:
+ --this.pos;
+ this.attributeName();
+ break loop;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#before-attribute-value-state
+ beforeAttributeValue() {
+ loop: for (;;) {
+ switch (this.consume()) {
+ case Chars.TAB:
+ case Chars.LF:
+ case Chars.FF:
+ case Chars.SPACE:
+ break; // Ignore the character
+ case Chars.QUOTATION_MARK:
+ this.attributeValueDoubleQuoted();
+ break loop;
+ case Chars.APOTROPHE:
+ this.attributeValueSingleQuoted();
+ break loop;
+ case Chars.GREATER_THAN:
+ this.state = ParserState.END; // missing-attribute-value parse error
+ break loop;
+ default:
+ --this.pos;
+ this.attributeValueUnquoted();
+ break loop;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#attribute-value-(double-quoted)-state
+ attributeValueDoubleQuoted() {
+ this.currentAttributeValueStart = this.pos;
+ loop: for (;;) {
+ switch (this.consume()) {
+ case Chars.QUOTATION_MARK:
+ this.currentAttributeValueEnd = this.pos - 1;
+ this.afterAttributeValueQuoted();
+ break loop;
+ case Chars.AMPERSAND:
+ this.characterReference();
+ break;
+ case Chars.NULL:
+ this.currentAttributeValue += String.fromCharCode(0xfffd);
+ break;
+ case Chars.EOF:
+ this.currentAttributeValueEnd = this.pos;
+ this.state = ParserState.END; // eof-in-tag parse error
+ break loop;
+ default:
+ this.currentAttributeValue += this.text[this.pos - 1];
+ break;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#attribute-value-(single-quoted)-state
+ attributeValueSingleQuoted() {
+ this.currentAttributeValueStart = this.pos;
+ loop: for (;;) {
+ switch (this.consume()) {
+ case Chars.APOTROPHE:
+ this.currentAttributeValueEnd = this.pos - 1;
+ this.afterAttributeValueQuoted();
+ break loop;
+ case Chars.AMPERSAND:
+ this.characterReference();
+ break;
+ case Chars.NULL:
+ this.currentAttributeValue += String.fromCharCode(0xfffd);
+ break;
+ case Chars.EOF:
+ this.currentAttributeValueEnd = this.pos;
+ this.state = ParserState.END; // eof-in-tag parse error
+ break loop;
+ default:
+ this.currentAttributeValue += this.text[this.pos - 1];
+ break;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#attribute-value-(unquoted)-state
+ attributeValueUnquoted() {
+ this.currentAttributeValueStart = this.pos;
+ loop: for (;;) {
+ switch (this.consume()) {
+ case Chars.TAB:
+ case Chars.LF:
+ case Chars.FF:
+ case Chars.SPACE:
+ this.currentAttributeValueEnd = this.pos - 1;
+ this.state = ParserState.BeforeAttributeName;
+ break loop;
+ case Chars.AMPERSAND:
+ this.characterReference();
+ break;
+ case Chars.GREATER_THAN:
+ this.currentAttributeValueEnd = this.pos;
+ this.state = ParserState.END;
+ break loop;
+ case Chars.NULL:
+ this.currentAttributeValue += String.fromCharCode(0xfffd);
+ break;
+ case Chars.EOF:
+ this.currentAttributeValueEnd = this.pos;
+ this.state = ParserState.END; // eof-in-tag parse error
+ break loop;
+ case Chars.QUOTATION_MARK:
+ case Chars.APOTROPHE:
+ case Chars.LESS_THAN:
+ case Chars.EQUALS:
+ case Chars.GRAVE_ACCENT:
+ // This is an unexpected-character-in-unquoted-attribute-value parse error. Treat it as per the "anything else" entry below.
+ // fall through
+ default:
+ this.currentAttributeValue += this.text[this.pos - 1];
+ break;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#after-attribute-value-(quoted)-state
+ afterAttributeValueQuoted() {
+ switch (this.consume()) {
+ case Chars.TAB:
+ case Chars.LF:
+ case Chars.FF:
+ case Chars.SPACE:
+ this.state = ParserState.BeforeAttributeName;
+ break;
+ case Chars.SOLIDUS:
+ case Chars.GREATER_THAN:
+ case Chars.EOF:
+ this.state = ParserState.END;
+ break;
+ default:
+ // This is a missing-whitespace-between-attributes parse error. Reconsume in the before attribute name state.
+ --this.pos;
+ this.state = ParserState.BeforeAttributeName;
+ break;
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#character-reference-state
+ characterReference() {
+ this.temporaryBuffer = [Chars.AMPERSAND];
+ const next = this.consume();
+ if (isalnum(next)) {
+ --this.pos;
+ this.namedCharacterReference();
+ } else if (next == Chars.NUMBER_SIGN) {
+ this.temporaryBuffer.push(next);
+ this.numericCharacterReference();
+ } else {
+ --this.pos;
+ this.flushTemporaryBuffer();
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#named-character-reference-state
+ // Intentionally only handling part of an attribute
+ namedCharacterReference() {
+ // Consume the maximum number of characters possible, where the consumed
+ // characters are one of the identifiers in the first column of the named
+ // character references table. Append each character to the temporary buffer
+ // when it's consumed.
+ let currentTrie = htmlEntitiesTrie;
+ for (;;) {
+ const ch = this.consume();
+ this.temporaryBuffer.push(ch);
+
+ if (currentTrie.children && ch in currentTrie.children) {
+ currentTrie = currentTrie.children[ch]!;
+ } else {
+ --this.pos;
+ this.temporaryBuffer.pop();
+ const lastChar =
+ this.temporaryBuffer[this.temporaryBuffer.length - 1];
+
+ // If there is a match
+ if (currentTrie.data) {
+ // If the character reference was consumed as part of an attribute,
+ // and the last character matched is not a U+003B SEMICOLON character (;),
+ // and the next input character is either a U+003D EQUALS SIGN character (=)
+ // or an ASCII alphanumeric, then, for historical reasons, flush code points
+ // consumed as a character reference and switch to the return state.
+ if (
+ lastChar != Chars.SEMICOLON &&
+ (this.peek() == Chars.EQUALS || isalpha(this.peek()))
+ ) {
+ this.flushTemporaryBuffer();
+ return;
+ } else {
+ // missing-semicolon-after-character-reference parse error
+ this.temporaryBuffer = currentTrie.data.p;
+ this.flushTemporaryBuffer();
+ return;
+ }
+ } else {
+ this.flushTemporaryBuffer();
+ this.ambiguousAmpersand();
+ return;
+ }
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#ambiguous-ampersand-state
+ ambiguousAmpersand() {
+ const ch = this.consume();
+ if (isalnum(ch)) {
+ this.currentAttributeValue += String.fromCharCode(ch);
+ } else {
+ --this.pos;
+ return;
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#numeric-character-reference-state
+ numericCharacterReference() {
+ this.characterReferenceCode = 0;
+ const ch = this.consume();
+ switch (ch) {
+ case Chars.LOWERCASE_X:
+ case Chars.UPPERCASE_X:
+ this.temporaryBuffer.push(ch);
+ this.hexadecimalCharacterReferenceStart();
+ break;
+ default:
+ --this.pos;
+ this.decimalCharacterReferenceStart();
+ break;
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#hexadecimal-character-reference-start-state
+ hexadecimalCharacterReferenceStart() {
+ const ch = this.consume();
+
+ if (isxdigit(ch)) {
+ --this.pos;
+ this.hexadecimalCharacterReference();
+ } else {
+ --this.pos;
+ this.flushTemporaryBuffer();
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#decimal-character-reference-start-state
+ decimalCharacterReferenceStart() {
+ const ch = this.consume();
+ if (isdigit(ch)) {
+ --this.pos;
+ this.decimalCharacterReference();
+ } else {
+ --this.pos;
+ this.flushTemporaryBuffer();
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#hexadecimal-character-reference-state
+ hexadecimalCharacterReference() {
+ for (;;) {
+ const ch = this.consume();
+ if (isdigit(ch)) {
+ this.characterReferenceCode *= 16;
+ this.characterReferenceCode += ch - 0x30;
+ } else if (Chars.UPPERCASE_A <= ch && ch <= Chars.UPPERCASE_F) {
+ this.characterReferenceCode *= 16;
+ this.characterReferenceCode += ch - 0x37;
+ } else if (Chars.LOWERCASE_A <= ch && ch <= Chars.LOWERCASE_F) {
+ this.characterReferenceCode *= 16;
+ this.characterReferenceCode += ch - 0x57;
+ } else if (ch === Chars.SEMICOLON) {
+ this.numericCharacterReferenceEndState();
+ return;
+ } else {
+ --this.pos;
+ this.numericCharacterReferenceEndState();
+ return;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#decimal-character-reference-state
+ decimalCharacterReference() {
+ for (;;) {
+ const ch = this.consume();
+ if (isdigit(ch)) {
+ this.characterReferenceCode *= 10;
+ this.characterReferenceCode += ch - 0x30;
+ } else if (ch === Chars.SEMICOLON) {
+ this.numericCharacterReferenceEndState();
+ return;
+ } else {
+ --this.pos;
+ this.numericCharacterReferenceEndState();
+ return;
+ }
+ }
+ }
+
+ // https://html.spec.whatwg.org/multipage/parsing.html#numeric-character-reference-end-state
+ numericCharacterReferenceEndState() {
+ if (this.characterReferenceCode == 0) {
+ // null-character-reference parse error
+ this.characterReferenceCode = 0xfffd;
+ }
+
+ if (this.characterReferenceCode > 0x10ffff) {
+ // character-reference-outside-unicode-range parse error
+ this.characterReferenceCode = 0xfffd;
+ }
+
+ if (isSurrogate(this.characterReferenceCode)) {
+ // surrogate-character-reference parse error
+ this.characterReferenceCode = 0xfffd;
+ }
+
+ // If the number is a noncharacter, then this is a noncharacter-character-reference parse error.
+ // ... and do nothing, so don't bother checking.
+
+ // Handle replacements
+ this.characterReferenceCode =
+ characterReferenceCodePointReplacements.get(
+ this.characterReferenceCode,
+ ) ?? this.characterReferenceCode;
+
+ this.temporaryBuffer = [this.characterReferenceCode];
+ this.flushTemporaryBuffer();
+ }
+
+ private flushTemporaryBuffer() {
+ this.currentAttributeValue += String.fromCodePoint(
+ ...this.temporaryBuffer,
+ );
+ this.temporaryBuffer = [];
+ }
+}
+
+// https://infra.spec.whatwg.org/#leading-surrogate
+function isLeadingSurrogate(ch: number) {
+ return 0xd800 <= ch && ch <= 0xdbff;
+}
+
+// https://infra.spec.whatwg.org/#trailing-surrogate
+function isTrailingSurrogate(ch: number) {
+ return 0xdc00 <= ch && ch <= 0xdfff;
+}
+
+// https://infra.spec.whatwg.org/#surrogate
+function isSurrogate(ch: number) {
+ return isLeadingSurrogate(ch) || isTrailingSurrogate(ch);
+}
+
+const characterReferenceCodePointReplacements = new Map([
+ [0x80, 0x20ac], // EURO SIGN (€)
+ [0x82, 0x201a], // SINGLE LOW-9 QUOTATION MARK (‚)
+ [0x83, 0x0192], // LATIN SMALL LETTER F WITH HOOK (ƒ)
+ [0x84, 0x201e], // DOUBLE LOW-9 QUOTATION MARK („)
+ [0x85, 0x2026], // HORIZONTAL ELLIPSIS (…)
+ [0x86, 0x2020], // DAGGER (†)
+ [0x87, 0x2021], // DOUBLE DAGGER (‡)
+ [0x88, 0x02c6], // MODIFIER LETTER CIRCUMFLEX ACCENT (ˆ)
+ [0x89, 0x2030], // PER MILLE SIGN (‰)
+ [0x8a, 0x0160], // LATIN CAPITAL LETTER S WITH CARON (Š)
+ [0x8b, 0x2039], // SINGLE LEFT-POINTING ANGLE QUOTATION MARK (‹)
+ [0x8c, 0x0152], // LATIN CAPITAL LIGATURE OE (Œ)
+ [0x8e, 0x017d], // LATIN CAPITAL LETTER Z WITH CARON (Ž)
+ [0x91, 0x2018], // LEFT SINGLE QUOTATION MARK (‘)
+ [0x92, 0x2019], // RIGHT SINGLE QUOTATION MARK (’)
+ [0x93, 0x201c], // LEFT DOUBLE QUOTATION MARK (“)
+ [0x94, 0x201d], // RIGHT DOUBLE QUOTATION MARK (”)
+ [0x95, 0x2022], // BULLET (•)
+ [0x96, 0x2013], // EN DASH (–)
+ [0x97, 0x2014], // EM DASH (—)
+ [0x98, 0x02dc], // SMALL TILDE (˜)
+ [0x99, 0x2122], // TRADE MARK SIGN (™)
+ [0x9a, 0x0161], // LATIN SMALL LETTER S WITH CARON (š)
+ [0x9b, 0x203a], // SINGLE RIGHT-POINTING ANGLE QUOTATION MARK (›)
+ [0x9c, 0x0153], // LATIN SMALL LIGATURE OE (œ)
+ [0x9e, 0x017e], // LATIN SMALL LETTER Z WITH CARON (ž)
+ [0x9f, 0x0178], // LATIN CAPITAL LETTER Y WITH DIAERESIS (Ÿ)
+]);
diff --git a/src/lib/utils/index.ts b/src/lib/utils/index.ts
index 650c89df2..318b68f7c 100644
--- a/src/lib/utils/index.ts
+++ b/src/lib/utils/index.ts
@@ -8,7 +8,7 @@ export {
} from "./array";
export { AbstractComponent, ChildableComponent, Component } from "./component";
export * from "./enum";
-export { Event, EventDispatcher } from "./events";
+export { EventDispatcher } from "./events";
export {
isFile,
copy,
@@ -28,7 +28,6 @@ export { DefaultMap } from "./map";
export {
ArgumentsReader,
Option,
- BindOption,
CommentStyle,
Options,
PackageJsonReader,
diff --git a/src/lib/utils/jsx.elements.ts b/src/lib/utils/jsx.elements.ts
index f858080e7..7893b1bc2 100644
--- a/src/lib/utils/jsx.elements.ts
+++ b/src/lib/utils/jsx.elements.ts
@@ -122,6 +122,7 @@ export interface IntrinsicElements {
ellipse: JsxEllipseElementProps;
polygon: JsxPolygonElementProps;
polyline: JsxPolylineElementProps;
+ line: JsxLineElementProps;
use: JsxUseElementProps;
}
@@ -591,7 +592,7 @@ export interface JsxMetaElementProps extends JsxHtmlGlobalProps {
| "default-style"
| "x-ua-compatible"
| "refresh";
- charSet?: "utf-8";
+ charset?: "utf-8";
content?: string;
name?: string;
}
@@ -1136,6 +1137,22 @@ export interface JsxPolylineElementProps
pathLength?: number;
}
+/** Properties permitted on the `<line>` element.
+ *
+ * Reference: https://developer.mozilla.org/en-US/docs/Web/SVG/Element/line
+ */
+export interface JsxLineElementProps
+ extends JsxSvgCoreProps,
+ JsxSvgStyleProps,
+ JsxSvgConditionalProcessingProps,
+ JsxSvgPresentationProps {
+ x1?: string | number;
+ y1?: string | number;
+ x2?: string | number;
+ y2?: string | number;
+ pathLength?: number;
+}
+
/**
* Properties permitted on the `<use>` element.
*
diff --git a/src/lib/utils/loggers.ts b/src/lib/utils/loggers.ts
index 9a6cabfea..8ee2bc812 100644
--- a/src/lib/utils/loggers.ts
+++ b/src/lib/utils/loggers.ts
@@ -3,6 +3,11 @@ import { url } from "inspector";
import { resolve } from "path";
import { nicePath } from "./paths";
import type { MinimalSourceFile } from "./minimalSourceFile";
+import type {
+ TranslatedString,
+ TranslationProxy,
+} from "../internationalization/internationalization";
+import type { IfInternal } from ".";
const isDebugging = () => !!url();
@@ -27,7 +32,7 @@ const Colors = {
};
function color(text: string, color: keyof typeof Colors) {
- if ("NO_COLOR" in process.env) return `${text}`;
+ if ("NO_COLOR" in process.env) return text;
return `${Colors[color]}${text}${Colors.reset}`;
}
@@ -39,6 +44,18 @@ const messagePrefixes = {
[LogLevel.Verbose]: color("[debug]", "gray"),
};
+const dummyTranslationProxy: TranslationProxy = new Proxy(
+ {} as TranslationProxy,
+ {
+ get: (_target, key) => {
+ return (...args: string[]) =>
+ String(key).replace(/\{(\d+)\}/g, (_, index) => {
+ return args[+index] ?? "(no placeholder)";
+ });
+ },
+ },
+);
+
type FormatArgs = [ts.Node?] | [number, MinimalSourceFile];
/**
@@ -48,6 +65,13 @@ type FormatArgs = [ts.Node?] | [number, MinimalSourceFile];
* all the required utility functions.
*/
export class Logger {
+ /**
+ * Translation utility for internationalization.
+ * @privateRemarks
+ * This is fully initialized by the application during bootstrapping.
+ */
+ i18n: TranslationProxy = dummyTranslationProxy;
+
/**
* How many error messages have been logged?
*/
@@ -106,7 +130,7 @@ export class Logger {
}
/** Log the given info message. */
- info(text: string) {
+ info(text: IfInternal<TranslatedString, string>) {
this.log(this.addContext(text, LogLevel.Info), LogLevel.Info);
}
@@ -115,8 +139,12 @@ export class Logger {
*
* @param text The warning that should be logged.
*/
- warn(text: string, node?: ts.Node): void;
- warn(text: string, pos: number, file: MinimalSourceFile): void;
+ warn(text: IfInternal<TranslatedString, string>, node?: ts.Node): void;
+ warn(
+ text: IfInternal<TranslatedString, string>,
+ pos: number,
+ file: MinimalSourceFile,
+ ): void;
warn(text: string, ...args: FormatArgs): void {
const text2 = this.addContext(text, LogLevel.Warn, ...args);
if (this.seenWarnings.has(text2) && !isDebugging()) return;
@@ -129,8 +157,12 @@ export class Logger {
*
* @param text The error that should be logged.
*/
- error(text: string, node?: ts.Node): void;
- error(text: string, pos: number, file: MinimalSourceFile): void;
+ error(text: IfInternal<TranslatedString, string>, node?: ts.Node): void;
+ error(
+ text: IfInternal<TranslatedString, string>,
+ pos: number,
+ file: MinimalSourceFile,
+ ): void;
error(text: string, ...args: FormatArgs) {
const text2 = this.addContext(text, LogLevel.Error, ...args);
if (this.seenErrors.has(text2) && !isDebugging()) return;
@@ -138,17 +170,6 @@ export class Logger {
this.log(text2, LogLevel.Error);
}
- /** @internal */
- deprecated(text: string, addStack = true) {
- if (addStack) {
- const stack = new Error().stack?.split("\n");
- if (stack && stack.length >= 4) {
- text = text + "\n" + stack[3];
- }
- }
- this.warn(text);
- }
-
/**
* Print a log message.
*
@@ -212,13 +233,6 @@ export class Logger {
* A logger that outputs all messages to the console.
*/
export class ConsoleLogger extends Logger {
- /**
- * Create a new ConsoleLogger instance.
- */
- constructor() {
- super();
- }
-
/**
* Print a log message.
*
diff --git a/src/lib/utils/map.ts b/src/lib/utils/map.ts
index aa6b22475..bc7a8b1de 100644
--- a/src/lib/utils/map.ts
+++ b/src/lib/utils/map.ts
@@ -1,5 +1,5 @@
export class DefaultMap<K, V> extends Map<K, V> {
- constructor(private creator: () => V) {
+ constructor(private creator: (key: K) => V) {
super();
}
@@ -9,7 +9,7 @@ export class DefaultMap<K, V> extends Map<K, V> {
return saved;
}
- const created = this.creator();
+ const created = this.creator(key);
this.set(key, created);
return created;
}
diff --git a/src/lib/utils/minimalSourceFile.ts b/src/lib/utils/minimalSourceFile.ts
index 18d821f19..f597b96b8 100644
--- a/src/lib/utils/minimalSourceFile.ts
+++ b/src/lib/utils/minimalSourceFile.ts
@@ -23,7 +23,7 @@ export class MinimalSourceFile implements SourceFileLike {
while (pos >= starts[starts.length - 1]) {
const nextStart = this.text.indexOf(
"\n",
- starts[starts.length - 1] + 1,
+ starts[starts.length - 1],
);
if (nextStart === -1) {
diff --git a/src/lib/utils/options/declaration.ts b/src/lib/utils/options/declaration.ts
index 2a9b4861b..1b967b543 100644
--- a/src/lib/utils/options/declaration.ts
+++ b/src/lib/utils/options/declaration.ts
@@ -1,9 +1,14 @@
-import type { Theme as ShikiTheme } from "shiki";
+import type { BundledTheme as ShikiTheme } from "shiki" with { "resolution-mode": "import" };
import type { LogLevel } from "../loggers";
import type { SortStrategy } from "../sort";
import { isAbsolute, join, resolve } from "path";
import type { EntryPointStrategy } from "../entry-point";
import type { ReflectionKind } from "../../models/reflections/kind";
+import type { NeverIfInternal } from "..";
+import type {
+ TranslatedString,
+ TranslationProxy,
+} from "../../internationalization/internationalization";
/** @enum */
export const EmitStrategy = {
@@ -36,16 +41,16 @@ export type TypeDocOptions = {
[K in keyof TypeDocOptionMap]: unknown extends TypeDocOptionMap[K]
? unknown
: TypeDocOptionMap[K] extends ManuallyValidatedOption<
- infer ManuallyValidated
- >
- ? ManuallyValidated
- : TypeDocOptionMap[K] extends string | string[] | number | boolean
- ? TypeDocOptionMap[K]
- : TypeDocOptionMap[K] extends Record<string, boolean>
- ? Partial<TypeDocOptionMap[K]> | boolean
- :
- | keyof TypeDocOptionMap[K]
- | TypeDocOptionMap[K][keyof TypeDocOptionMap[K]];
+ infer ManuallyValidated
+ >
+ ? ManuallyValidated
+ : TypeDocOptionMap[K] extends string | string[] | number | boolean
+ ? TypeDocOptionMap[K]
+ : TypeDocOptionMap[K] extends Record<string, boolean>
+ ? Partial<TypeDocOptionMap[K]> | boolean
+ :
+ | keyof TypeDocOptionMap[K]
+ | TypeDocOptionMap[K][keyof TypeDocOptionMap[K]];
};
/**
@@ -58,17 +63,17 @@ export type TypeDocOptionValues = {
[K in keyof TypeDocOptionMap]: unknown extends TypeDocOptionMap[K]
? unknown
: TypeDocOptionMap[K] extends ManuallyValidatedOption<
- infer ManuallyValidated
- >
- ? ManuallyValidated
- : TypeDocOptionMap[K] extends
- | string
- | string[]
- | number
- | boolean
- | Record<string, boolean>
- ? TypeDocOptionMap[K]
- : TypeDocOptionMap[K][keyof TypeDocOptionMap[K]];
+ infer ManuallyValidated
+ >
+ ? ManuallyValidated
+ : TypeDocOptionMap[K] extends
+ | string
+ | string[]
+ | number
+ | boolean
+ | Record<string, boolean>
+ ? TypeDocOptionMap[K]
+ : TypeDocOptionMap[K][keyof TypeDocOptionMap[K]];
};
/**
@@ -92,15 +97,20 @@ export interface TypeDocOptionMap {
tsconfig: string;
compilerOptions: unknown;
plugin: string[];
+ lang: string;
+ locales: ManuallyValidatedOption<Record<string, Record<string, string>>>;
+ packageOptions: ManuallyValidatedOption<TypeDocOptions>;
// Input
entryPoints: string[];
entryPointStrategy: typeof EntryPointStrategy;
+ alwaysCreateEntryPointModule: boolean;
+ projectDocuments: string[];
exclude: string[];
externalPattern: string[];
excludeExternals: boolean;
excludeNotDocumented: boolean;
- excludeNotDocumentedKinds: Array<keyof typeof ReflectionKind>;
+ excludeNotDocumentedKinds: ReflectionKind.KindString[];
excludeInternal: boolean;
excludePrivate: boolean;
excludeProtected: boolean;
@@ -116,7 +126,6 @@ export interface TypeDocOptionMap {
gitRevision: string;
gitRemote: string;
readme: string;
- stripYamlFrontmatter: boolean;
// Output
out: string;
@@ -126,18 +135,42 @@ export interface TypeDocOptionMap {
theme: string;
lightHighlightTheme: ShikiTheme;
darkHighlightTheme: ShikiTheme;
+ highlightLanguages: string[];
customCss: string;
- markedOptions: unknown;
+ markdownItOptions: ManuallyValidatedOption<Record<string, unknown>>;
+ /**
+ * Will be called when TypeDoc is setting up the markdown parser to use to render markdown.
+ * Can be used to add markdown-it plugins to the parser with code like this:
+ *
+ * ```ts
+ * // typedoc.config.mjs
+ * import iterator from "markdown-it-for-inline";
+ * export default {
+ * /** @param {MarkdownIt} parser *\/
+ * markdownItLoader(parser) {
+ * parser.use(iterator, "foo_replace", "text", function(tokens, idx) {
+ * tokens[idx].content = tokens[idx].content.replace(/foo/g, 'bar');
+ * });
+ * }
+ * }
+ * ```
+ *
+ * Note: Unfortunately, markdown-it doesn't ship its own types, so `parser` isn't
+ * strictly typed here.
+ */
+ markdownItLoader: ManuallyValidatedOption<(parser: any) => void>;
basePath: string;
cname: string;
- htmlLang: string;
githubPages: boolean;
- sitemapBaseUrl: string;
+ hostedBaseUrl: string;
+ useHostedBaseUrlForAbsoluteLinks: boolean;
cacheBust: boolean;
- gaID: string;
hideGenerator: boolean;
+ customFooterHtml: string;
+ customFooterHtmlDisableWrapper: boolean;
hideParameterTypesInTitle: boolean;
searchInComments: boolean;
+ searchInDocuments: boolean;
cleanOutputDir: boolean;
titleLink: string;
navigationLinks: ManuallyValidatedOption<Record<string, string>>;
@@ -147,7 +180,6 @@ export interface TypeDocOptionMap {
includeCategories: boolean;
includeGroups: boolean;
includeFolders: boolean;
- fullTree: boolean;
};
visibilityFilters: ManuallyValidatedOption<{
protected?: boolean;
@@ -164,6 +196,7 @@ export interface TypeDocOptionMap {
useTsLinkResolution: boolean;
preserveLinkText: boolean;
jsDocCompatibility: JsDocCompatibility;
+ suppressCommentWarningsInDeclarationFiles: boolean;
blockTags: `@${string}`[];
inlineTags: `@${string}`[];
modifierTags: `@${string}`[];
@@ -171,8 +204,7 @@ export interface TypeDocOptionMap {
externalSymbolLinkMappings: ManuallyValidatedOption<
Record<string, Record<string, string>>
>;
- media: string;
- includes: string;
+ cascadedModifierTags: `@${string}`[];
// Organization
categorizeByGroup: boolean;
@@ -252,26 +284,35 @@ export type KeyToDeclaration<K extends keyof TypeDocOptionMap> =
TypeDocOptionMap[K] extends boolean
? BooleanDeclarationOption
: TypeDocOptionMap[K] extends string
- ? StringDeclarationOption
- : TypeDocOptionMap[K] extends number
- ? NumberDeclarationOption
- : TypeDocOptionMap[K] extends string[]
- ? ArrayDeclarationOption
- : unknown extends TypeDocOptionMap[K]
- ? MixedDeclarationOption | ObjectDeclarationOption
- : TypeDocOptionMap[K] extends ManuallyValidatedOption<unknown>
- ?
- | (MixedDeclarationOption & {
- validate(value: unknown): void;
- })
- | (ObjectDeclarationOption & {
- validate(value: unknown): void;
- })
- : TypeDocOptionMap[K] extends Record<string, boolean>
- ? FlagsDeclarationOption<TypeDocOptionMap[K]>
- : TypeDocOptionMap[K] extends Record<string | number, infer U>
- ? MapDeclarationOption<U>
- : never;
+ ? StringDeclarationOption
+ : TypeDocOptionMap[K] extends number
+ ? NumberDeclarationOption
+ : TypeDocOptionMap[K] extends string[]
+ ? ArrayDeclarationOption
+ : unknown extends TypeDocOptionMap[K]
+ ? MixedDeclarationOption | ObjectDeclarationOption
+ : TypeDocOptionMap[K] extends ManuallyValidatedOption<unknown>
+ ?
+ | (MixedDeclarationOption & {
+ validate(
+ value: unknown,
+ i18n: TranslationProxy,
+ ): void;
+ })
+ | (ObjectDeclarationOption & {
+ validate(
+ value: unknown,
+ i18n: TranslationProxy,
+ ): void;
+ })
+ : TypeDocOptionMap[K] extends Record<string, boolean>
+ ? FlagsDeclarationOption<TypeDocOptionMap[K]>
+ : TypeDocOptionMap[K] extends Record<
+ string | number,
+ infer U
+ >
+ ? MapDeclarationOption<U>
+ : never;
export enum ParameterHint {
File,
@@ -319,8 +360,12 @@ export interface DeclarationOptionBase {
/**
* The help text to be displayed to the user when --help is passed.
+ *
+ * This may be a string, which will be presented directly, or a function,
+ * which will be called with an {@link TranslationProxy} so that option help
+ * can be translated into the user specified locale.
*/
- help: string;
+ help: NeverIfInternal<string> | ((i18n: TranslationProxy) => string);
/**
* The parameter type, used to convert user configuration values into the expected type.
@@ -356,7 +401,7 @@ export interface StringDeclarationOption extends DeclarationOptionBase {
* An optional validation function that validates a potential value of this option.
* The function must throw an Error if the validation fails and should do nothing otherwise.
*/
- validate?: (value: string) => void;
+ validate?: (value: string, i18n: TranslationProxy) => void;
}
export interface NumberDeclarationOption extends DeclarationOptionBase {
@@ -381,7 +426,7 @@ export interface NumberDeclarationOption extends DeclarationOptionBase {
* An optional validation function that validates a potential value of this option.
* The function must throw an Error if the validation fails and should do nothing otherwise.
*/
- validate?: (value: number) => void;
+ validate?: (value: number, i18n: TranslationProxy) => void;
}
export interface BooleanDeclarationOption extends DeclarationOptionBase {
@@ -409,7 +454,7 @@ export interface ArrayDeclarationOption extends DeclarationOptionBase {
* An optional validation function that validates a potential value of this option.
* The function must throw an Error if the validation fails and should do nothing otherwise.
*/
- validate?: (value: string[]) => void;
+ validate?: (value: string[], i18n: TranslationProxy) => void;
}
export interface MixedDeclarationOption extends DeclarationOptionBase {
@@ -424,7 +469,7 @@ export interface MixedDeclarationOption extends DeclarationOptionBase {
* An optional validation function that validates a potential value of this option.
* The function must throw an Error if the validation fails and should do nothing otherwise.
*/
- validate?: (value: unknown) => void;
+ validate?: (value: unknown, i18n: TranslationProxy) => void;
}
export interface ObjectDeclarationOption extends DeclarationOptionBase {
@@ -439,7 +484,7 @@ export interface ObjectDeclarationOption extends DeclarationOptionBase {
* An optional validation function that validates a potential value of this option.
* The function must throw an Error if the validation fails and should do nothing otherwise.
*/
- validate?: (value: unknown) => void;
+ validate?: (value: unknown, i18n: TranslationProxy) => void;
}
export interface MapDeclarationOption<T> extends DeclarationOptionBase {
type: ParameterType.Map;
@@ -456,11 +501,6 @@ export interface MapDeclarationOption<T> extends DeclarationOptionBase {
* The default value for a mapped type must be specified.
*/
defaultValue: T;
-
- /**
- * Optional override for the error reported when an invalid key is provided.
- */
- mapError?: string;
}
export interface FlagsDeclarationOption<T extends Record<string, boolean>>
@@ -504,52 +544,58 @@ export type DeclarationOptionToOptionType<T extends DeclarationOption> =
T extends MapDeclarationOption<infer U>
? U
: T extends FlagsDeclarationOption<infer U>
- ? U
- : ParameterTypeToOptionTypeMap[Exclude<T["type"], undefined>];
+ ? U
+ : ParameterTypeToOptionTypeMap[Exclude<T["type"], undefined>];
const converters: {
[K in ParameterType]: (
value: unknown,
option: DeclarationOption & { type: K },
+ i18n: TranslationProxy,
configPath: string,
oldValue: unknown,
) => ParameterTypeToOptionTypeMap[K];
} = {
- [ParameterType.String](value, option) {
+ [ParameterType.String](value, option, i18n) {
const stringValue = value == null ? "" : String(value);
- option.validate?.(stringValue);
+ option.validate?.(stringValue, i18n);
return stringValue;
},
- [ParameterType.Path](value, option, configPath) {
+ [ParameterType.Path](value, option, i18n, configPath) {
const stringValue =
value == null ? "" : resolve(configPath, String(value));
- option.validate?.(stringValue);
+ option.validate?.(stringValue, i18n);
return stringValue;
},
- [ParameterType.Number](value, option) {
+ [ParameterType.Number](value, option, i18n) {
const numValue = parseInt(String(value), 10) || 0;
if (!valueIsWithinBounds(numValue, option.minValue, option.maxValue)) {
throw new Error(
- getBoundsError(option.name, option.minValue, option.maxValue),
+ getBoundsError(
+ option.name,
+ i18n,
+ option.minValue,
+ option.maxValue,
+ ),
);
}
- option.validate?.(numValue);
+ option.validate?.(numValue, i18n);
return numValue;
},
[ParameterType.Boolean](value) {
return !!value;
},
- [ParameterType.Array](value, option) {
+ [ParameterType.Array](value, option, i18n) {
let strArrValue = new Array<string>();
if (Array.isArray(value)) {
strArrValue = value.map(String);
} else if (typeof value === "string") {
strArrValue = [value];
}
- option.validate?.(strArrValue);
+ option.validate?.(strArrValue, i18n);
return strArrValue;
},
- [ParameterType.PathArray](value, option, configPath) {
+ [ParameterType.PathArray](value, option, i18n, configPath) {
let strArrValue = new Array<string>();
if (Array.isArray(value)) {
strArrValue = value.map(String);
@@ -557,10 +603,10 @@ const converters: {
strArrValue = [value];
}
strArrValue = strArrValue.map((path) => resolve(configPath, path));
- option.validate?.(strArrValue);
+ option.validate?.(strArrValue, i18n);
return strArrValue;
},
- [ParameterType.ModuleArray](value, option, configPath) {
+ [ParameterType.ModuleArray](value, option, i18n, configPath) {
let strArrValue = new Array<string>();
if (Array.isArray(value)) {
strArrValue = value.map(String);
@@ -568,10 +614,10 @@ const converters: {
strArrValue = [value];
}
strArrValue = resolveModulePaths(strArrValue, configPath);
- option.validate?.(strArrValue);
+ option.validate?.(strArrValue, i18n);
return strArrValue;
},
- [ParameterType.GlobArray](value, option, configPath) {
+ [ParameterType.GlobArray](value, option, i18n, configPath) {
let strArrValue = new Array<string>();
if (Array.isArray(value)) {
strArrValue = value.map(String);
@@ -579,10 +625,10 @@ const converters: {
strArrValue = [value];
}
strArrValue = resolveGlobPaths(strArrValue, configPath);
- option.validate?.(strArrValue);
+ option.validate?.(strArrValue, i18n);
return strArrValue;
},
- [ParameterType.Map](value, option) {
+ [ParameterType.Map](value, option, i18n) {
const key = String(value);
if (option.map instanceof Map) {
if (option.map.has(key)) {
@@ -598,21 +644,19 @@ const converters: {
} else if (Object.values(option.map).includes(value)) {
return value;
}
- throw new Error(
- option.mapError ?? getMapError(option.map, option.name),
- );
+ throw new Error(getMapError(option.map, i18n, option.name));
},
- [ParameterType.Mixed](value, option) {
- option.validate?.(value);
+ [ParameterType.Mixed](value, option, i18n) {
+ option.validate?.(value, i18n);
return value;
},
- [ParameterType.Object](value, option, _configPath, oldValue) {
- option.validate?.(value);
+ [ParameterType.Object](value, option, i18n, _configPath, oldValue) {
+ option.validate?.(value, i18n);
if (typeof oldValue !== "undefined")
value = { ...(oldValue as {}), ...(value as {}) };
return value;
},
- [ParameterType.Flags](value, option) {
+ [ParameterType.Flags](value, option, i18n) {
if (typeof value === "boolean") {
value = Object.fromEntries(
Object.keys(option.defaults).map((key) => [key, value]),
@@ -621,7 +665,7 @@ const converters: {
if (typeof value !== "object" || value == null) {
throw new Error(
- `Expected an object with flag values for ${option.name} or true/false`,
+ i18n.expected_object_with_flag_values_for_0(option.name),
);
}
const obj = { ...value } as Record<string, unknown>;
@@ -629,11 +673,11 @@ const converters: {
for (const key of Object.keys(obj)) {
if (!Object.prototype.hasOwnProperty.call(option.defaults, key)) {
throw new Error(
- `The flag '${key}' is not valid for ${
- option.name
- }, expected one of: ${Object.keys(option.defaults).join(
- ", ",
- )}`,
+ i18n.flag_0_is_not_valid_for_1_expected_2(
+ key,
+ option.name,
+ Object.keys(option.defaults).join(", "),
+ ),
);
}
@@ -643,7 +687,7 @@ const converters: {
obj[key] = option.defaults[key];
} else {
throw new Error(
- `Flag values for ${option.name} must be a boolean.`,
+ i18n.flag_values_for_0_must_be_booleans(option.name),
);
}
}
@@ -663,16 +707,24 @@ const converters: {
export function convert(
value: unknown,
option: DeclarationOption,
+ i18n: TranslationProxy,
configPath: string,
oldValue?: unknown,
): unknown {
const _converters = converters as Record<
ParameterType,
- (v: unknown, o: DeclarationOption, c: string, ov: unknown) => unknown
+ (
+ v: unknown,
+ o: DeclarationOption,
+ i18n: TranslationProxy,
+ c: string,
+ ov: unknown,
+ ) => unknown
>;
return _converters[option.type ?? ParameterType.String](
value,
option,
+ i18n,
configPath,
oldValue,
);
@@ -775,8 +827,9 @@ function isTsNumericEnum(map: Record<string, any>) {
*/
function getMapError(
map: MapDeclarationOption<unknown>["map"],
+ i18n: TranslationProxy,
name: string,
-): string {
+): TranslatedString {
let keys = map instanceof Map ? [...map.keys()] : Object.keys(map);
// If the map is a TS numeric enum we need to filter out the numeric keys.
@@ -786,7 +839,7 @@ function getMapError(
keys = keys.filter((key) => Number.isNaN(parseInt(key, 10)));
}
- return `${name} must be one of ${keys.join(", ")}`;
+ return i18n.option_0_must_be_one_of_1(name, keys.join(", "));
}
/**
@@ -798,15 +851,26 @@ function getMapError(
*/
function getBoundsError(
name: string,
+ i18n: TranslationProxy,
minValue?: number,
maxValue?: number,
-): string {
+): TranslatedString {
if (isFiniteNumber(minValue) && isFiniteNumber(maxValue)) {
- return `${name} must be between ${minValue} and ${maxValue}`;
+ return i18n.option_0_must_be_between_1_and_2(
+ name,
+ String(minValue),
+ String(maxValue),
+ );
} else if (isFiniteNumber(minValue)) {
- return `${name} must be >= ${minValue}`;
+ return i18n.option_0_must_be_equal_to_or_greater_than_1(
+ name,
+ String(minValue),
+ );
} else {
- return `${name} must be <= ${maxValue}`;
+ return i18n.option_0_must_be_less_than_or_equal_to_1(
+ name,
+ String(maxValue),
+ );
}
}
diff --git a/src/lib/utils/options/help.ts b/src/lib/utils/options/help.ts
index 85eba1042..79d0849c8 100644
--- a/src/lib/utils/options/help.ts
+++ b/src/lib/utils/options/help.ts
@@ -1,12 +1,15 @@
import type { Options } from "./options";
import {
ParameterHint,
- StringDeclarationOption,
+ type StringDeclarationOption,
ParameterType,
- DeclarationOption,
+ type DeclarationOption,
} from "./declaration";
-import { getSupportedLanguages } from "../highlighter";
-import { BUNDLED_THEMES } from "shiki";
+import {
+ getSupportedLanguagesWithoutAliases,
+ getSupportedThemes,
+} from "../highlighter";
+import type { TranslationProxy } from "../../internationalization/internationalization";
export interface ParameterHelp {
names: string[];
@@ -29,7 +32,10 @@ function hasHint(
* @param scope The scope of the parameters whose help should be returned.
* @returns The columns and lines for the help of the requested parameters.
*/
-function getParameterHelp(options: Options): ParameterHelp {
+function getParameterHelp(
+ options: Options,
+ i18n: TranslationProxy,
+): ParameterHelp {
const parameters = options.getDeclarations();
parameters.sort((a, b) =>
a.name.localeCompare(b.name, undefined, { sensitivity: "base" }),
@@ -50,7 +56,11 @@ function getParameterHelp(options: Options): ParameterHelp {
}
names.push(name);
- helps.push(parameter.help);
+ helps.push(
+ typeof parameter.help === "string"
+ ? parameter.help
+ : parameter.help(i18n),
+ );
margin = Math.max(name.length, margin);
}
@@ -61,7 +71,7 @@ function toEvenColumns(values: string[], maxLineWidth: number) {
const columnWidth =
values.reduce((acc, val) => Math.max(acc, val.length), 0) + 2;
- const numColumns = Math.max(1, Math.min(maxLineWidth / columnWidth));
+ const numColumns = Math.max(1, Math.floor(maxLineWidth / columnWidth));
let line = "";
const out: string[] = [];
@@ -79,10 +89,13 @@ function toEvenColumns(values: string[], maxLineWidth: number) {
return out;
}
-export function getOptionsHelp(options: Options): string {
- const output = ["Usage:", " typedoc path/to/entry.ts", "", "Options:"];
+export function getOptionsHelp(
+ options: Options,
+ i18n: TranslationProxy,
+): string {
+ const output = ["typedoc path/to/entry.ts", "", "Options:"];
- const columns = getParameterHelp(options);
+ const columns = getParameterHelp(options, i18n);
for (let i = 0; i < columns.names.length; i++) {
const usage = columns.names[i];
const description = columns.helps[i];
@@ -92,13 +105,13 @@ export function getOptionsHelp(options: Options): string {
output.push(
"",
"Supported highlighting languages:",
- ...toEvenColumns(getSupportedLanguages(), 80),
+ ...toEvenColumns(getSupportedLanguagesWithoutAliases(), 80),
);
output.push(
"",
"Supported highlighting themes:",
- ...toEvenColumns(BUNDLED_THEMES, 80),
+ ...toEvenColumns(getSupportedThemes(), 80),
);
return output.join("\n");
diff --git a/src/lib/utils/options/index.ts b/src/lib/utils/options/index.ts
index 770fa44a6..8f5308f5d 100644
--- a/src/lib/utils/options/index.ts
+++ b/src/lib/utils/options/index.ts
@@ -1,4 +1,4 @@
-export { Options, Option, BindOption } from "./options";
+export { Options, Option } from "./options";
export type { OptionsReader } from "./options";
export {
ArgumentsReader,
diff --git a/src/lib/utils/options/options.ts b/src/lib/utils/options/options.ts
index 212bd86dd..e186f1d09 100644
--- a/src/lib/utils/options/options.ts
+++ b/src/lib/utils/options/options.ts
@@ -1,20 +1,22 @@
import type * as ts from "typescript";
import { ParameterType } from "./declaration";
import type { NeverIfInternal } from "..";
+import { DefaultMap } from "../map";
import type { Application } from "../../..";
import { insertOrderSorted, unique } from "../array";
import type { Logger } from "../loggers";
import {
convert,
- DeclarationOption,
+ type DeclarationOption,
getDefaultValue,
- KeyToDeclaration,
- TypeDocOptionMap,
- TypeDocOptions,
- TypeDocOptionValues,
+ type KeyToDeclaration,
+ type TypeDocOptionMap,
+ type TypeDocOptions,
+ type TypeDocOptionValues,
} from "./declaration";
import { addTypeDocOptions } from "./sources";
import { getOptionsHelp } from "./help";
+import type { TranslationProxy } from "../../internationalization/internationalization";
/**
* Describes an option reader that discovers user configuration and converts it to the
@@ -60,7 +62,7 @@ export interface OptionsReader {
const optionSnapshots = new WeakMap<
{ __optionSnapshot: never },
{
- values: string;
+ values: Record<string, unknown>;
set: Set<string>;
}
>();
@@ -93,13 +95,15 @@ export class Options {
private _compilerOptions: ts.CompilerOptions = {};
private _fileNames: readonly string[] = [];
private _projectReferences: readonly ts.ProjectReference[] = [];
+ private _i18n: TranslationProxy;
/**
* In packages mode, the directory of the package being converted.
*/
packageDir?: string;
- constructor() {
+ constructor(i18n: TranslationProxy) {
+ this._i18n = i18n;
addTypeDocOptions(this);
}
@@ -107,7 +111,7 @@ export class Options {
* Clones the options, intended for use in packages mode.
*/
copyForPackage(packageDir: string): Options {
- const options = new Options();
+ const options = new Options(this._i18n);
options.packageDir = packageDir;
options._readers = this._readers.filter(
@@ -116,6 +120,12 @@ export class Options {
options._declarations = new Map(this._declarations);
options.reset();
+ for (const [key, val] of Object.entries(
+ this.getValue("packageOptions"),
+ )) {
+ options.setValue(key as any, val, packageDir);
+ }
+
return options;
}
@@ -141,7 +151,7 @@ export class Options {
const key = {} as { __optionSnapshot: never };
optionSnapshots.set(key, {
- values: JSON.stringify(this._values),
+ values: { ...this._values },
set: new Set(this._setOptions),
});
@@ -154,7 +164,7 @@ export class Options {
*/
restore(snapshot: { __optionSnapshot: never }) {
const data = optionSnapshots.get(snapshot)!;
- this._values = JSON.parse(data.values);
+ this._values = { ...data.values };
this._setOptions = new Set(data.set);
}
@@ -277,9 +287,10 @@ export class Options {
if (!declaration) {
const nearNames = this.getSimilarOptions(name);
throw new Error(
- `Unknown option '${name}', you may have meant:\n\t${nearNames.join(
- "\n\t",
- )}`,
+ this._i18n.unknown_option_0_you_may_have_meant_1(
+ name,
+ nearNames.join("\n\t"),
+ ),
);
}
@@ -313,9 +324,10 @@ export class Options {
if (!declaration) {
const nearNames = this.getSimilarOptions(name);
throw new Error(
- `Tried to set an option (${name}) that was not declared. You may have meant:\n\t${nearNames.join(
- "\n\t",
- )}`,
+ this._i18n.unknown_option_0_you_may_have_meant_1(
+ name,
+ nearNames.join("\n\t"),
+ ),
);
}
@@ -326,12 +338,17 @@ export class Options {
const converted = convert(
value,
declaration,
+ this._i18n,
configPath ?? process.cwd(),
oldValue,
);
if (declaration.type === ParameterType.Flags) {
- Object.assign(this._values[declaration.name] as any, converted);
+ this._values[declaration.name] = Object.assign(
+ {},
+ this._values[declaration.name],
+ converted,
+ );
} else {
this._values[declaration.name] = converted;
}
@@ -409,28 +426,26 @@ export class Options {
* Discover similar option names to the given name, for use in error reporting.
*/
getSimilarOptions(missingName: string): string[] {
- const results: Record<number, string[]> = {};
+ const results = new DefaultMap<number, string[]>(() => []);
let lowest = Infinity;
for (const name of this._declarations.keys()) {
const distance = editDistance(missingName, name);
lowest = Math.min(lowest, distance);
- results[distance] ||= [];
- results[distance].push(name);
+ results.get(distance).push(name);
}
// Experimenting a bit, it seems an edit distance of 3 is roughly the
// right metric for relevant "similar" results without showing obviously wrong suggestions
- return results[lowest].concat(
- results[lowest + 1] || [],
- results[lowest + 2] || [],
- );
+ return results
+ .get(lowest)
+ .concat(results.get(lowest + 1), results.get(lowest + 2));
}
/**
* Get the help message to be displayed to the user if `--help` is passed.
*/
- getHelp() {
- return getOptionsHelp(this);
+ getHelp(i18n: TranslationProxy) {
+ return getOptionsHelp(this, i18n);
}
}
@@ -451,9 +466,7 @@ export function Option<K extends keyof TypeDocOptionMap>(name: K) {
get(this: { application: Application } | { options: Options }) {
const options =
"options" in this ? this.options : this.application.options;
- const value = options.getValue(name as keyof TypeDocOptions);
-
- return value as TypeDocOptionValues[K];
+ return options.getValue(name);
},
set(_value: never) {
throw new Error(
@@ -464,60 +477,6 @@ export function Option<K extends keyof TypeDocOptionMap>(name: K) {
};
}
-/**
- * Binds an option to the given property. Does not register the option.
- *
- * Note: This is a legacy experimental decorator, and will not work with TS 5.0 decorators
- *
- * @since v0.16.3
- * @deprecated Will be removed in 0.26, use {@link Option | `@Option`} instead.
- */
-export function BindOption<K extends keyof TypeDocOptionMap>(
- name: K,
-): <IK extends PropertyKey>(
- target: ({ application: Application } | { options: Options }) & {
- [K2 in IK]: TypeDocOptionValues[K];
- },
- key: IK,
-) => void;
-
-/**
- * Binds an option to the given property. Does not register the option.
- *
- * Note: This is a legacy experimental decorator, and will not work with TS 5.0 decorators
- *
- * @since v0.16.3
- * @deprecated Will be removed in 0.26, use {@link Option | `@Option`} instead
- *
- * @privateRemarks
- * This overload is intended for plugin use only with looser type checks. Do not use internally.
- */
-export function BindOption(
- name: NeverIfInternal<string>,
-): (
- target: { application: Application } | { options: Options },
- key: PropertyKey,
-) => void;
-
-export function BindOption(name: string) {
- return function (
- target: { application: Application } | { options: Options },
- key: PropertyKey,
- ) {
- Object.defineProperty(target, key, {
- get(this: { application: Application } | { options: Options }) {
- const options =
- "options" in this ? this.options : this.application.options;
- const value = options.getValue(name as keyof TypeDocOptions);
-
- return value;
- },
- enumerable: true,
- configurable: true,
- });
- };
-}
-
// Based on https://en.wikipedia.org/wiki/Levenshtein_distance#Iterative_with_two_matrix_rows
// Slightly modified for improved match results for options
function editDistance(s: string, t: string): number {
diff --git a/src/lib/utils/options/readers/arguments.ts b/src/lib/utils/options/readers/arguments.ts
index 63e8b6dbd..dc5845a45 100644
--- a/src/lib/utils/options/readers/arguments.ts
+++ b/src/lib/utils/options/readers/arguments.ts
@@ -2,6 +2,7 @@ import { ok } from "assert";
import type { OptionsReader, Options } from "..";
import type { Logger } from "../../loggers";
import { ParameterType } from "../declaration";
+import type { TranslatedString } from "../../../internationalization/internationalization";
const ARRAY_OPTION_TYPES = new Set<ParameterType | undefined>([
ParameterType.Array,
@@ -38,7 +39,7 @@ export class ArgumentsReader implements OptionsReader {
options.setValue(name, value);
} catch (err) {
ok(err instanceof Error);
- logger.error(err.message);
+ logger.error(err.message as TranslatedString);
}
};
@@ -51,7 +52,9 @@ export class ArgumentsReader implements OptionsReader {
if (decl) {
if (decl.configFileOnly) {
logger.error(
- `The '${decl.name}' option can only be specified via a config file.`,
+ logger.i18n.option_0_can_only_be_specified_by_config_file(
+ decl.name,
+ ),
);
continue;
}
@@ -80,7 +83,9 @@ export class ArgumentsReader implements OptionsReader {
if (index === this.args.length) {
// Only boolean values have optional values.
logger.warn(
- `--${decl.name} expected a value, but none was given as an argument`,
+ logger.i18n.option_0_expected_a_value_but_none_provided(
+ decl.name,
+ ),
);
}
trySet(decl.name, this.args[index]);
@@ -112,9 +117,10 @@ export class ArgumentsReader implements OptionsReader {
}
logger.error(
- `Unknown option: ${name}, you may have meant:\n\t${options
- .getSimilarOptions(name)
- .join("\n\t")}`,
+ logger.i18n.unknown_option_0_may_have_meant_1(
+ name,
+ options.getSimilarOptions(name).join("\n\t"),
+ ),
);
index++;
}
diff --git a/src/lib/utils/options/readers/package-json.ts b/src/lib/utils/options/readers/package-json.ts
index 570230a4f..b4d5c2296 100644
--- a/src/lib/utils/options/readers/package-json.ts
+++ b/src/lib/utils/options/readers/package-json.ts
@@ -5,6 +5,7 @@ import { ok } from "assert";
import { nicePath } from "../../paths";
import { discoverPackageJson } from "../../fs";
import { dirname } from "path";
+import type { TranslatedString } from "../../../internationalization/internationalization";
export class PackageJsonReader implements OptionsReader {
// Should run after the TypeDoc config reader but before the TS config
@@ -25,11 +26,7 @@ export class PackageJsonReader implements OptionsReader {
const { file, content } = result;
if ("typedoc" in content) {
- logger.warn(
- `The 'typedoc' key in ${nicePath(
- file,
- )} was used by the legacy-packages entryPointStrategy and will be ignored.`,
- );
+ logger.warn(logger.i18n.typedoc_key_in_0_ignored(nicePath(file)));
}
const optsKey = "typedocOptions";
@@ -40,9 +37,7 @@ export class PackageJsonReader implements OptionsReader {
const opts = content[optsKey];
if (opts === null || typeof opts !== "object") {
logger.error(
- `Failed to parse the "typedocOptions" field in ${nicePath(
- file,
- )}, ensure it exists and contains an object.`,
+ logger.i18n.typedoc_options_must_be_object_in_0(nicePath(file)),
);
return;
}
@@ -52,7 +47,7 @@ export class PackageJsonReader implements OptionsReader {
container.setValue(opt as never, val as never, dirname(file));
} catch (err) {
ok(err instanceof Error);
- logger.error(err.message);
+ logger.error(err.message as TranslatedString);
}
}
}
diff --git a/src/lib/utils/options/readers/tsconfig.ts b/src/lib/utils/options/readers/tsconfig.ts
index a3e19a036..7f179049f 100644
--- a/src/lib/utils/options/readers/tsconfig.ts
+++ b/src/lib/utils/options/readers/tsconfig.ts
@@ -8,7 +8,7 @@ import { isFile } from "../../fs";
import { ok } from "assert";
import {
additionalProperties,
- Infer,
+ type Infer,
isTagString,
optional,
validate,
@@ -26,6 +26,7 @@ import {
getTypeDocOptionsFromTsConfig,
readTsConfig,
} from "../../tsconfig";
+import type { TranslatedString } from "../../../internationalization/internationalization";
function isSupportForTags(obj: unknown): obj is Record<`@${string}`, boolean> {
return (
@@ -83,7 +84,7 @@ export class TSConfigReader implements OptionsReader {
// If the user didn't give us this option, we shouldn't complain about not being able to find it.
if (container.isSet("tsconfig")) {
logger.error(
- `The tsconfig file ${nicePath(file)} does not exist`,
+ logger.i18n.tsconfig_file_0_does_not_exist(nicePath(file)),
);
}
return;
@@ -105,18 +106,11 @@ export class TSConfigReader implements OptionsReader {
const typedocOptions = getTypeDocOptionsFromTsConfig(fileToRead);
if (typedocOptions.options) {
- logger.error(
- [
- "typedocOptions in tsconfig file specifies an option file to read but the option",
- "file has already been read. This is likely a misconfiguration.",
- ].join(" "),
- );
+ logger.error(logger.i18n.tsconfig_file_specifies_options_file());
delete typedocOptions.options;
}
if (typedocOptions.tsconfig) {
- logger.error(
- "typedocOptions in tsconfig file may not specify a tsconfig file to read",
- );
+ logger.error(logger.i18n.tsconfig_file_specifies_tsconfig_file());
delete typedocOptions.tsconfig;
}
@@ -135,7 +129,7 @@ export class TSConfigReader implements OptionsReader {
);
} catch (error) {
ok(error instanceof Error);
- logger.error(error.message);
+ logger.error(error.message as TranslatedString);
}
}
}
@@ -156,8 +150,9 @@ export class TSConfigReader implements OptionsReader {
).filter((opt) => container.isSet(opt));
if (overwritten.length) {
logger.warn(
- `The ${overwritten.join(", ")} defined in typedoc.json will ` +
- "be overwritten by configuration in tsdoc.json.",
+ logger.i18n.tags_0_defined_in_typedoc_json_overwritten_by_tsdoc_json(
+ overwritten.join(", "),
+ ),
);
}
@@ -199,9 +194,7 @@ export class TSConfigReader implements OptionsReader {
private readTsDoc(logger: Logger, path: string): TsDocSchema | undefined {
if (this.seenTsdocPaths.has(path)) {
logger.error(
- `Circular reference encountered for "extends" field of ${nicePath(
- path,
- )}`,
+ logger.i18n.circular_reference_extends_0(nicePath(path)),
);
return;
}
@@ -213,16 +206,12 @@ export class TSConfigReader implements OptionsReader {
);
if (error) {
- logger.error(
- `Failed to read tsdoc.json file at ${nicePath(path)}.`,
- );
+ logger.error(logger.i18n.failed_read_tsdoc_json_0(nicePath(path)));
return;
}
if (!validate(tsDocSchema, config)) {
- logger.error(
- `The file ${nicePath(path)} is not a valid tsdoc.json file.`,
- );
+ logger.error(logger.i18n.invalid_tsdoc_json_0(nicePath(path)));
return;
}
@@ -236,9 +225,10 @@ export class TSConfigReader implements OptionsReader {
resolvedPath = resolver.resolve(extendedPath);
} catch {
logger.error(
- `Failed to resolve ${extendedPath} to a file in ${nicePath(
- path,
- )}`,
+ logger.i18n.failed_resolve_0_to_file_in_1(
+ extendedPath,
+ nicePath(path),
+ ),
);
return;
}
diff --git a/src/lib/utils/options/readers/typedoc.ts b/src/lib/utils/options/readers/typedoc.ts
index 6344ca81a..75b5faa6e 100644
--- a/src/lib/utils/options/readers/typedoc.ts
+++ b/src/lib/utils/options/readers/typedoc.ts
@@ -10,6 +10,7 @@ import { nicePath, normalizePath } from "../../paths";
import { isFile } from "../../fs";
import { createRequire } from "module";
import { pathToFileURL } from "url";
+import type { TranslatedString } from "../../../internationalization/internationalization";
/**
* Obtains option values from typedoc.json
@@ -37,7 +38,7 @@ export class TypeDocReader implements OptionsReader {
if (!file) {
if (container.isSet("options")) {
logger.error(
- `The options file ${nicePath(path)} does not exist.`,
+ logger.i18n.options_file_0_does_not_exist(nicePath(path)),
);
}
return;
@@ -61,25 +62,21 @@ export class TypeDocReader implements OptionsReader {
) {
if (seen.has(file)) {
logger.error(
- `Tried to load the options file ${nicePath(
- file,
- )} multiple times.`,
+ logger.i18n.circular_reference_extends_0(nicePath(file)),
);
return;
}
seen.add(file);
let fileContent: any;
- if (file.endsWith(".json")) {
+ if (file.endsWith(".json") || file.endsWith(".jsonc")) {
const readResult = ts.readConfigFile(normalizePath(file), (path) =>
FS.readFileSync(path, "utf-8"),
);
if (readResult.error) {
logger.error(
- `Failed to parse ${nicePath(
- file,
- )}, ensure it exists and contains an object.`,
+ logger.i18n.failed_read_options_file_0(nicePath(file)),
);
return;
} else {
@@ -88,7 +85,6 @@ export class TypeDocReader implements OptionsReader {
} else {
try {
try {
- // eslint-disable-next-line @typescript-eslint/no-var-requires
fileContent = await require(file);
} catch (error: any) {
if (error?.code === "ERR_REQUIRE_ESM") {
@@ -102,9 +98,12 @@ export class TypeDocReader implements OptionsReader {
}
} catch (error) {
logger.error(
- `Failed to read ${nicePath(file)}: ${
- error instanceof Error ? error.message : error
- }`,
+ logger.i18n.failed_read_options_file_0(nicePath(file)),
+ );
+ logger.error(
+ String(
+ error instanceof Error ? error.message : error,
+ ) as TranslatedString,
);
return;
}
@@ -112,7 +111,7 @@ export class TypeDocReader implements OptionsReader {
if (typeof fileContent !== "object" || !fileContent) {
logger.error(
- `The root value of ${nicePath(file)} is not an object.`,
+ logger.i18n.failed_read_options_file_0(nicePath(file)),
);
return;
}
@@ -130,9 +129,10 @@ export class TypeDocReader implements OptionsReader {
resolvedParent = resolver.resolve(extendedFile);
} catch {
logger.error(
- `Failed to resolve ${extendedFile} to a file in ${nicePath(
- file,
- )}`,
+ logger.i18n.failed_resolve_0_to_file_in_1(
+ extendedFile,
+ nicePath(file),
+ ),
);
continue;
}
@@ -150,7 +150,7 @@ export class TypeDocReader implements OptionsReader {
);
} catch (error) {
ok(error instanceof Error);
- logger.error(error.message);
+ logger.error(error.message as TranslatedString);
}
}
}
@@ -160,7 +160,7 @@ export class TypeDocReader implements OptionsReader {
*
* @param path Path to the typedoc.(js|json) file. If path is a directory
* typedoc file will be attempted to be found at the root of this path
- * @return the typedoc.(js|json) file path or undefined
+ * @returns the typedoc.(js|json) file path or undefined
*/
private findTypedocFile(path: string): string | undefined {
path = resolve(path);
diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
index 261d5402a..2f6d02e8f 100644
--- a/src/lib/utils/options/sources/typedoc.ts
+++ b/src/lib/utils/options/sources/typedoc.ts
@@ -6,13 +6,21 @@ import {
EmitStrategy,
CommentStyle,
} from "../declaration";
-import { BUNDLED_THEMES, Theme } from "shiki";
import { SORT_STRATEGIES } from "../../sort";
import { EntryPointStrategy } from "../../entry-point";
import { ReflectionKind } from "../../../models/reflections/kind";
import * as Validation from "../../validation";
import { blockTags, inlineTags, modifierTags } from "../tsdoc-defaults";
import { getEnumKeys } from "../../enum";
+import type {
+ BundledLanguage,
+ BundledTheme,
+} from "shiki" with { "resolution-mode": "import" };
+import {
+ getSupportedLanguagesWithoutAliases,
+ getSupportedThemes,
+} from "../../highlighter";
+import { setDifference } from "../../set";
// For convenience, added in the same order as they are documented on the website.
export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
@@ -23,26 +31,70 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
type: ParameterType.Path,
name: "options",
- help: "Specify a json option file that should be loaded. If not specified TypeDoc will look for 'typedoc.json' in the current directory.",
+ help: (i18n) => i18n.help_options(),
hint: ParameterHint.File,
defaultValue: "",
});
options.addDeclaration({
type: ParameterType.Path,
name: "tsconfig",
- help: "Specify a TypeScript config file that should be loaded. If not specified TypeDoc will look for 'tsconfig.json' in the current directory.",
+ help: (i18n) => i18n.help_tsconfig(),
hint: ParameterHint.File,
defaultValue: "",
});
options.addDeclaration({
name: "compilerOptions",
- help: "Selectively override the TypeScript compiler options used by TypeDoc.",
+ help: (i18n) => i18n.help_compilerOptions(),
+ type: ParameterType.Mixed,
+ configFileOnly: true,
+ validate(value, i18n) {
+ if (!Validation.validate({}, value)) {
+ throw new Error(
+ i18n.option_0_must_be_an_object("compilerOptions"),
+ );
+ }
+ },
+ });
+ options.addDeclaration({
+ name: "lang",
+ help: (i18n) => i18n.help_lang(),
+ type: ParameterType.String,
+ defaultValue: "en",
+ });
+ options.addDeclaration({
+ name: "locales",
+ help: (i18n) => i18n.help_locales(),
+ type: ParameterType.Mixed,
+ configFileOnly: true,
+ defaultValue: {},
+ validate(value, i18n) {
+ if (typeof value !== "object" || !value) {
+ throw new Error(i18n.locales_must_be_an_object());
+ }
+
+ for (const val of Object.values(value)) {
+ if (typeof val !== "object" || !val) {
+ throw new Error(i18n.locales_must_be_an_object());
+ }
+
+ for (const val2 of Object.values(val)) {
+ if (typeof val2 !== "string") {
+ throw new Error(i18n.locales_must_be_an_object());
+ }
+ }
+ }
+ },
+ });
+ options.addDeclaration({
+ name: "packageOptions",
+ help: (i18n) => i18n.help_packageOptions(),
type: ParameterType.Mixed,
configFileOnly: true,
- validate(value) {
+ defaultValue: {},
+ validate(value, i18n) {
if (!Validation.validate({}, value)) {
throw new Error(
- "The 'compilerOptions' option must be a non-array object.",
+ i18n.option_0_must_be_an_object("packageOptions"),
);
}
},
@@ -54,43 +106,53 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "entryPoints",
- help: "The entry points of your documentation.",
+ help: (i18n) => i18n.help_entryPoints(),
type: ParameterType.GlobArray,
});
options.addDeclaration({
name: "entryPointStrategy",
- help: "The strategy to be used to convert entry points into documentation modules.",
+ help: (i18n) => i18n.help_entryPointStrategy(),
type: ParameterType.Map,
map: EntryPointStrategy,
defaultValue: EntryPointStrategy.Resolve,
});
+ options.addDeclaration({
+ name: "alwaysCreateEntryPointModule",
+ help: (i18n) => i18n.help_alwaysCreateEntryPointModule(),
+ type: ParameterType.Boolean,
+ });
+ options.addDeclaration({
+ name: "projectDocuments",
+ help: (i18n) => i18n.help_projectDocuments(),
+ type: ParameterType.GlobArray,
+ });
options.addDeclaration({
name: "exclude",
- help: "Define patterns to be excluded when expanding a directory that was specified as an entry point.",
+ help: (i18n) => i18n.help_exclude(),
type: ParameterType.GlobArray,
});
options.addDeclaration({
name: "externalPattern",
- help: "Define patterns for files that should be considered being external.",
+ help: (i18n) => i18n.help_externalPattern(),
type: ParameterType.GlobArray,
defaultValue: ["**/node_modules/**"],
});
options.addDeclaration({
name: "excludeExternals",
- help: "Prevent externally resolved symbols from being documented.",
+ help: (i18n) => i18n.help_excludeExternals(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "excludeNotDocumented",
- help: "Prevent symbols that are not explicitly documented from appearing in the results.",
+ help: (i18n) => i18n.help_excludeNotDocumented(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "excludeNotDocumentedKinds",
- help: "Specify the type of reflections that can be removed by excludeNotDocumented.",
+ help: (i18n) => i18n.help_excludeNotDocumentedKinds(),
type: ParameterType.Array,
- validate(value) {
+ validate(value, i18n) {
const invalid = new Set(value);
const valid = new Set(getEnumKeys(ReflectionKind));
for (const notPermitted of [
@@ -107,11 +169,10 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
if (invalid.size !== 0) {
throw new Error(
- `excludeNotDocumentedKinds may only specify known values, and invalid values were provided (${Array.from(
- invalid,
- ).join(", ")}). The valid kinds are:\n${Array.from(
- valid,
- ).join(", ")}`,
+ i18n.exclude_not_documented_specified_0_valid_values_are_1(
+ Array.from(invalid).join(", "),
+ Array.from(valid).join(", "),
+ ),
);
}
},
@@ -139,68 +200,60 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
});
options.addDeclaration({
name: "excludeInternal",
- help: "Prevent symbols that are marked with @internal from being documented.",
+ help: (i18n) => i18n.help_excludeInternal(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "excludeCategories",
- help: "Exclude symbols within this category from the documentation.",
+ help: (i18n) => i18n.help_excludeCategories(),
type: ParameterType.Array,
defaultValue: [],
});
options.addDeclaration({
name: "excludePrivate",
- help: "Ignore private variables and methods.",
+ help: (i18n) => i18n.help_excludePrivate(),
type: ParameterType.Boolean,
+ defaultValue: true,
});
options.addDeclaration({
name: "excludeProtected",
- help: "Ignore protected variables and methods.",
+ help: (i18n) => i18n.help_excludeProtected(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "excludeReferences",
- help: "If a symbol is exported multiple times, ignore all but the first export.",
+ help: (i18n) => i18n.help_excludeReferences(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "externalSymbolLinkMappings",
- help: "Define custom links for symbols not included in the documentation.",
+ help: (i18n) => i18n.help_externalSymbolLinkMappings(),
type: ParameterType.Mixed,
defaultValue: {},
- validate(value) {
- const error =
- "externalSymbolLinkMappings must be a Record<package name, Record<symbol name, link>>";
-
+ validate(value, i18n) {
if (!Validation.validate({}, value)) {
- throw new Error(error);
+ throw new Error(
+ i18n.external_symbol_link_mappings_must_be_object(),
+ );
}
for (const mappings of Object.values(value)) {
if (!Validation.validate({}, mappings)) {
- throw new Error(error);
+ throw new Error(
+ i18n.external_symbol_link_mappings_must_be_object(),
+ );
}
for (const link of Object.values(mappings)) {
if (typeof link !== "string") {
- throw new Error(error);
+ throw new Error(
+ i18n.external_symbol_link_mappings_must_be_object(),
+ );
}
}
}
},
});
- options.addDeclaration({
- name: "media",
- help: "Specify the location with media files that should be copied to the output directory.",
- type: ParameterType.Path,
- hint: ParameterHint.Directory,
- });
- options.addDeclaration({
- name: "includes",
- help: "Specify the location to look for included documents (use [[include:FILENAME]] in comments).",
- type: ParameterType.Path,
- hint: ParameterHint.Directory,
- });
///////////////////////////
///// Output Options //////
@@ -208,66 +261,98 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "out",
- help: "Specify the location the documentation should be written to.",
+ help: (i18n) => i18n.help_out(),
type: ParameterType.Path,
hint: ParameterHint.Directory,
defaultValue: "./docs",
});
options.addDeclaration({
name: "json",
- help: "Specify the location and filename a JSON file describing the project is written to.",
+ help: (i18n) => i18n.help_json(),
type: ParameterType.Path,
hint: ParameterHint.File,
});
options.addDeclaration({
name: "pretty",
- help: "Specify whether the output JSON should be formatted with tabs.",
+ help: (i18n) => i18n.help_pretty(),
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
name: "emit",
- help: "Specify what TypeDoc should emit, 'docs', 'both', or 'none'.",
+ help: (i18n) => i18n.help_emit(),
type: ParameterType.Map,
map: EmitStrategy,
defaultValue: "docs",
});
options.addDeclaration({
name: "theme",
- help: "Specify the theme name to render the documentation with",
+ help: (i18n) => i18n.help_theme(),
type: ParameterType.String,
defaultValue: "default",
});
- const defaultLightTheme: Theme = "light-plus";
- const defaultDarkTheme: Theme = "dark-plus";
+ const defaultLightTheme: BundledTheme = "light-plus";
+ const defaultDarkTheme: BundledTheme = "dark-plus";
options.addDeclaration({
name: "lightHighlightTheme",
- help: "Specify the code highlighting theme in light mode.",
+ help: (i18n) => i18n.help_lightHighlightTheme(),
type: ParameterType.String,
defaultValue: defaultLightTheme,
- validate(value) {
- if (!(BUNDLED_THEMES as readonly string[]).includes(value)) {
+ validate(value, i18n) {
+ if (!getSupportedThemes().includes(value)) {
throw new Error(
- `lightHighlightTheme must be one of the following: ${BUNDLED_THEMES.join(
- ", ",
- )}`,
+ i18n.highlight_theme_0_must_be_one_of_1(
+ "lightHighlightTheme",
+ getSupportedThemes().join(", "),
+ ),
);
}
},
});
options.addDeclaration({
name: "darkHighlightTheme",
- help: "Specify the code highlighting theme in dark mode.",
+ help: (i18n) => i18n.help_darkHighlightTheme(),
type: ParameterType.String,
defaultValue: defaultDarkTheme,
- validate(value) {
- if (!(BUNDLED_THEMES as readonly string[]).includes(value)) {
+ validate(value, i18n) {
+ if (!getSupportedThemes().includes(value)) {
+ throw new Error(
+ i18n.highlight_theme_0_must_be_one_of_1(
+ "darkHighlightTheme",
+ getSupportedThemes().join(", "),
+ ),
+ );
+ }
+ },
+ });
+ options.addDeclaration({
+ name: "highlightLanguages",
+ help: (i18n) => i18n.help_highlightLanguages(),
+ type: ParameterType.Array,
+ defaultValue: [
+ "bash",
+ "console",
+ "css",
+ "html",
+ "javascript",
+ "json",
+ "jsonc",
+ "json5",
+ "tsx",
+ "typescript",
+ ] satisfies BundledLanguage[],
+ validate(value, i18n) {
+ const invalid = setDifference(
+ value,
+ getSupportedLanguagesWithoutAliases(),
+ );
+ if (invalid.size) {
throw new Error(
- `darkHighlightTheme must be one of the following: ${BUNDLED_THEMES.join(
- ", ",
- )}`,
+ i18n.highlightLanguages_contains_invalid_languages_0(
+ Array.from(invalid).join(", "),
+ ),
);
}
},
@@ -275,68 +360,86 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "customCss",
- help: "Path to a custom CSS file to for the theme to import.",
+ help: (i18n) => i18n.help_customCss(),
type: ParameterType.Path,
});
options.addDeclaration({
- name: "markedOptions",
- help: "Specify the options passed to Marked, the Markdown parser used by TypeDoc.",
+ name: "markdownItOptions",
+ help: (i18n) => i18n.help_markdownItOptions(),
type: ParameterType.Mixed,
configFileOnly: true,
- validate(value) {
+ defaultValue: {
+ html: true,
+ linkify: true,
+ },
+ validate(value, i18n) {
if (!Validation.validate({}, value)) {
throw new Error(
- "The 'markedOptions' option must be a non-array object.",
+ i18n.option_0_must_be_an_object("markdownItOptions"),
+ );
+ }
+ },
+ });
+ options.addDeclaration({
+ name: "markdownItLoader",
+ help: (i18n) => i18n.help_markdownItLoader(),
+ type: ParameterType.Mixed,
+ configFileOnly: true,
+ defaultValue: () => {},
+ validate(value, i18n) {
+ if (typeof value !== "function") {
+ throw new Error(
+ i18n.option_0_must_be_a_function("markdownItLoader"),
);
}
},
});
options.addDeclaration({
name: "maxTypeConversionDepth",
- help: "Set the maximum depth of types to be converted.",
+ help: (i18n) => i18n.help_maxTypeConversionDepth(),
defaultValue: 10,
type: ParameterType.Number,
});
options.addDeclaration({
name: "name",
- help: "Set the name of the project that will be used in the header of the template.",
+ help: (i18n) => i18n.help_name(),
});
options.addDeclaration({
name: "includeVersion",
- help: "Add the package version to the project name.",
+ help: (i18n) => i18n.help_includeVersion(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "disableSources",
- help: "Disable setting the source of a reflection when documenting it.",
+ help: (i18n) => i18n.help_disableSources(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "sourceLinkTemplate",
- help: "Specify a link template to be used when generating source urls. If not set, will be automatically created using the git remote. Supports {path}, {line}, {gitRevision} placeholders.",
+ help: (i18n) => i18n.help_sourceLinkTemplate(),
});
options.addDeclaration({
name: "gitRevision",
- help: "Use specified revision instead of the last revision for linking to GitHub/Bitbucket source files. Has no effect if disableSources is set.",
+ help: (i18n) => i18n.help_gitRevision(),
});
options.addDeclaration({
name: "gitRemote",
- help: "Use the specified remote for linking to GitHub/Bitbucket source files. Has no effect if disableGit or disableSources is set.",
+ help: (i18n) => i18n.help_gitRemote(),
defaultValue: "origin",
});
options.addDeclaration({
name: "disableGit",
- help: "Assume that all can be linked to with the sourceLinkTemplate, sourceLinkTemplate must be set if this is enabled. {path} will be rooted at basePath",
+ help: (i18n) => i18n.help_disableGit(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "basePath",
- help: "Specifies the base path to be used when displaying file paths.",
+ help: (i18n) => i18n.help_basePath(),
type: ParameterType.Path,
});
options.addDeclaration({
name: "excludeTags",
- help: "Remove the listed block/modifier tags from doc comments.",
+ help: (i18n) => i18n.help_excludeTags(),
type: ParameterType.Array,
defaultValue: [
"@override",
@@ -345,150 +448,152 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
"@satisfies",
"@overload",
],
- validate(value) {
+ validate(value, i18n) {
if (!Validation.validate([Array, Validation.isTagString], value)) {
throw new Error(
- `excludeTags must be an array of valid tag names.`,
+ i18n.option_0_values_must_be_array_of_tags("excludeTags"),
);
}
},
});
options.addDeclaration({
name: "readme",
- help: "Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page and start the documentation on the globals page.",
+ help: (i18n) => i18n.help_readme(),
type: ParameterType.Path,
});
- options.addDeclaration({
- name: "stripYamlFrontmatter",
- help: "Strip YAML frontmatter from markdown files.",
- type: ParameterType.Boolean,
- });
options.addDeclaration({
name: "cname",
- help: "Set the CNAME file text, it's useful for custom domains on GitHub Pages.",
+ help: (i18n) => i18n.help_cname(),
});
options.addDeclaration({
name: "sourceLinkExternal",
- help: "Specifies that source links should be treated as external links to be opened in a new tab.",
+ help: (i18n) => i18n.help_sourceLinkExternal(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "githubPages",
- help: "Generate a .nojekyll file to prevent 404 errors in GitHub Pages. Defaults to `true`.",
+ help: (i18n) => i18n.help_githubPages(),
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
- name: "sitemapBaseUrl",
- help: "Specify a base URL to be used in generating a sitemap.xml in our output folder. If not specified, no sitemap will be generated.",
- validate(value) {
+ name: "hostedBaseUrl",
+ help: (i18n) => i18n.help_hostedBaseUrl(),
+ validate(value, i18n) {
if (!/https?:\/\//.test(value)) {
- throw new Error(
- "sitemapBaseUrl must start with http:// or https://",
- );
+ throw new Error(i18n.hostedBaseUrl_must_start_with_http());
}
},
});
options.addDeclaration({
- name: "htmlLang",
- help: "Sets the lang attribute in the generated html tag.",
- type: ParameterType.String,
- defaultValue: "en",
+ name: "useHostedBaseUrlForAbsoluteLinks",
+ help: (i18n) => i18n.help_useHostedBaseUrlForAbsoluteLinks(),
+ type: ParameterType.Boolean,
+ });
+ options.addDeclaration({
+ name: "hideGenerator",
+ help: (i18n) => i18n.help_hideGenerator(),
+ type: ParameterType.Boolean,
});
options.addDeclaration({
- name: "gaID",
- help: "Set the Google Analytics tracking ID and activate tracking code.",
+ name: "customFooterHtml",
+ help: (i18n) => i18n.help_customFooterHtml(),
+ type: ParameterType.String,
});
options.addDeclaration({
- name: "hideGenerator",
- help: "Do not print the TypeDoc link at the end of the page.",
+ name: "customFooterHtmlDisableWrapper",
+ help: (i18n) => i18n.help_customFooterHtmlDisableWrapper(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "hideParameterTypesInTitle",
- help: "Hides parameter types in signature titles for easier scanning.",
+ help: (i18n) => i18n.help_hideParameterTypesInTitle(),
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
name: "cacheBust",
- help: "Include the generation time in links to static assets.",
+ help: (i18n) => i18n.help_cacheBust(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "searchInComments",
- help: "If set, the search index will also include comments. This will greatly increase the size of the search index.",
+ help: (i18n) => i18n.help_searchInComments(),
+ type: ParameterType.Boolean,
+ });
+ options.addDeclaration({
+ name: "searchInDocuments",
+ help: (i18n) => i18n.help_searchInDocuments(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "cleanOutputDir",
- help: "If set, TypeDoc will remove the output directory before writing output.",
+ help: (i18n) => i18n.help_cleanOutputDir(),
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
name: "titleLink",
- help: "Set the link the title in the header points to. Defaults to the documentation homepage.",
+ help: (i18n) => i18n.help_titleLink(),
type: ParameterType.String,
});
options.addDeclaration({
name: "navigationLinks",
- help: "Defines links to be included in the header.",
+ help: (i18n) => i18n.help_navigationLinks(),
type: ParameterType.Mixed,
defaultValue: {},
- validate(value) {
+ validate(value, i18n) {
if (!isObject(value)) {
throw new Error(
- `navigationLinks must be an object with string labels as keys and URL values.`,
+ i18n.option_0_must_be_object_with_urls("navigationLinks"),
);
}
if (Object.values(value).some((x) => typeof x !== "string")) {
throw new Error(
- `All values of navigationLinks must be string URLs.`,
+ i18n.option_0_must_be_object_with_urls("navigationLinks"),
);
}
},
});
options.addDeclaration({
name: "sidebarLinks",
- help: "Defines links to be included in the sidebar.",
+ help: (i18n) => i18n.help_sidebarLinks(),
type: ParameterType.Mixed,
defaultValue: {},
- validate(value) {
+ validate(value, i18n) {
if (!isObject(value)) {
throw new Error(
- `sidebarLinks must be an object with string labels as keys and URL values.`,
+ i18n.option_0_must_be_object_with_urls("sidebarLinks"),
);
}
if (Object.values(value).some((x) => typeof x !== "string")) {
throw new Error(
- `All values of sidebarLinks must be string URLs.`,
+ i18n.option_0_must_be_object_with_urls("sidebarLinks"),
);
}
},
});
options.addDeclaration({
name: "navigationLeaves",
- help: "Branches of the navigation tree which should not be expanded.",
+ help: (i18n) => i18n.help_navigationLeaves(),
type: ParameterType.Array,
});
options.addDeclaration({
name: "navigation",
- help: "Determines how the navigation sidebar is organized.",
+ help: (i18n) => i18n.help_navigation(),
type: ParameterType.Flags,
defaults: {
includeCategories: false,
includeGroups: false,
includeFolders: true,
- fullTree: false,
},
});
options.addDeclaration({
name: "visibilityFilters",
- help: "Specify the default visibility for builtin filters and additional filters according to modifier tags.",
+ help: (i18n) => i18n.help_visibilityFilters(),
type: ParameterType.Mixed,
configFileOnly: true,
defaultValue: {
@@ -497,25 +602,25 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
inherited: true,
external: false,
},
- validate(value) {
+ validate(value, i18n) {
const knownKeys = ["protected", "private", "inherited", "external"];
if (!value || typeof value !== "object") {
- throw new Error("visibilityFilters must be an object.");
+ throw new Error(
+ i18n.option_0_must_be_an_object("visibilityFilters"),
+ );
}
for (const [key, val] of Object.entries(value)) {
if (!key.startsWith("@") && !knownKeys.includes(key)) {
throw new Error(
- `visibilityFilters can only include the following non-@ keys: ${knownKeys.join(
- ", ",
- )}`,
+ i18n.visibility_filters_only_include_0(
+ knownKeys.join(", "),
+ ),
);
}
if (typeof val !== "boolean") {
- throw new Error(
- `All values of visibilityFilters must be booleans.`,
- );
+ throw new Error(i18n.visibility_filters_must_be_booleans());
}
}
},
@@ -523,40 +628,42 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "searchCategoryBoosts",
- help: "Configure search to give a relevance boost to selected categories",
+ help: (i18n) => i18n.help_searchCategoryBoosts(),
type: ParameterType.Mixed,
configFileOnly: true,
defaultValue: {},
- validate(value) {
+ validate(value, i18n) {
if (!isObject(value)) {
throw new Error(
- "The 'searchCategoryBoosts' option must be a non-array object.",
+ i18n.option_0_must_be_an_object("searchCategoryBoosts"),
);
}
if (Object.values(value).some((x) => typeof x !== "number")) {
throw new Error(
- "All values of 'searchCategoryBoosts' must be numbers.",
+ i18n.option_0_values_must_be_numbers(
+ "searchCategoryBoosts",
+ ),
);
}
},
});
options.addDeclaration({
name: "searchGroupBoosts",
- help: 'Configure search to give a relevance boost to selected kinds (eg "class")',
+ help: (i18n) => i18n.help_searchGroupBoosts(),
type: ParameterType.Mixed,
configFileOnly: true,
defaultValue: {},
- validate(value: unknown) {
+ validate(value, i18n) {
if (!isObject(value)) {
throw new Error(
- "The 'searchGroupBoosts' option must be a non-array object.",
+ i18n.option_0_must_be_an_object("searchGroupBoosts"),
);
}
if (Object.values(value).some((x) => typeof x !== "number")) {
throw new Error(
- "All values of 'searchGroupBoosts' must be numbers.",
+ i18n.option_0_values_must_be_numbers("searchGroupBoosts"),
);
}
},
@@ -568,7 +675,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "jsDocCompatibility",
- help: "Sets compatibility options for comment parsing that increase similarity with JSDoc comments.",
+ help: (i18n) => i18n.help_jsDocCompatibility(),
type: ParameterType.Flags,
defaults: {
defaultTag: true,
@@ -578,9 +685,15 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
},
});
+ options.addDeclaration({
+ name: "suppressCommentWarningsInDeclarationFiles",
+ help: (i18n) => i18n.help_lang(),
+ type: ParameterType.Boolean,
+ });
+
options.addDeclaration({
name: "commentStyle",
- help: "Determines how TypeDoc searches for comments.",
+ help: (i18n) => i18n.help_commentStyle(),
type: ParameterType.Map,
map: CommentStyle,
defaultValue: CommentStyle.JSDoc,
@@ -588,52 +701,67 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "useTsLinkResolution",
- help: "Use TypeScript's link resolution when determining where @link tags point. This only applies to JSDoc style comments.",
+ help: (i18n) => i18n.help_useTsLinkResolution(),
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
name: "preserveLinkText",
- help: "If set, @link tags without link text will use the text content as the link. If not set, will use the target reflection name.",
+ help: (i18n) => i18n.help_preserveLinkText(),
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
name: "blockTags",
- help: "Block tags which TypeDoc should recognize when parsing comments.",
+ help: (i18n) => i18n.help_blockTags(),
type: ParameterType.Array,
defaultValue: blockTags,
- validate(value) {
+ validate(value, i18n) {
if (!Validation.validate([Array, Validation.isTagString], value)) {
throw new Error(
- `blockTags must be an array of valid tag names.`,
+ i18n.option_0_values_must_be_array_of_tags("blockTags"),
);
}
},
});
options.addDeclaration({
name: "inlineTags",
- help: "Inline tags which TypeDoc should recognize when parsing comments.",
+ help: (i18n) => i18n.help_inlineTags(),
type: ParameterType.Array,
defaultValue: inlineTags,
- validate(value) {
+ validate(value, i18n) {
if (!Validation.validate([Array, Validation.isTagString], value)) {
throw new Error(
- `inlineTags must be an array of valid tag names.`,
+ i18n.option_0_values_must_be_array_of_tags("inlineTags"),
);
}
},
});
options.addDeclaration({
name: "modifierTags",
- help: "Modifier tags which TypeDoc should recognize when parsing comments.",
+ help: (i18n) => i18n.help_modifierTags(),
type: ParameterType.Array,
defaultValue: modifierTags,
- validate(value) {
+ validate(value, i18n) {
+ if (!Validation.validate([Array, Validation.isTagString], value)) {
+ throw new Error(
+ i18n.option_0_values_must_be_array_of_tags("modifierTags"),
+ );
+ }
+ },
+ });
+ options.addDeclaration({
+ name: "cascadedModifierTags",
+ help: (i18n) => i18n.help_modifierTags(),
+ type: ParameterType.Array,
+ defaultValue: ["@alpha", "@beta", "@experimental"],
+ validate(value, i18n) {
if (!Validation.validate([Array, Validation.isTagString], value)) {
throw new Error(
- `modifierTags must be an array of valid tag names.`,
+ i18n.option_0_values_must_be_array_of_tags(
+ "cascadedModifierTags",
+ ),
);
}
},
@@ -645,52 +773,32 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "categorizeByGroup",
- help: "Specify whether categorization will be done at the group level.",
+ help: (i18n) => i18n.help_categorizeByGroup(),
type: ParameterType.Boolean,
defaultValue: false,
});
options.addDeclaration({
name: "defaultCategory",
- help: "Specify the default category for reflections without a category.",
+ help: (i18n) => i18n.help_defaultCategory(),
defaultValue: "Other",
});
options.addDeclaration({
name: "categoryOrder",
- help: "Specify the order in which categories appear. * indicates the relative order for categories not in the list.",
+ help: (i18n) => i18n.help_categoryOrder(),
type: ParameterType.Array,
});
options.addDeclaration({
name: "groupOrder",
- help: "Specify the order in which groups appear. * indicates the relative order for groups not in the list.",
+ help: (i18n) => i18n.help_groupOrder(),
type: ParameterType.Array,
- // Defaults to the same as the defaultKindSortOrder in sort.ts
- defaultValue: [
- ReflectionKind.Reference,
- // project is never a child so never added to a group
- ReflectionKind.Module,
- ReflectionKind.Namespace,
- ReflectionKind.Enum,
- ReflectionKind.EnumMember,
- ReflectionKind.Class,
- ReflectionKind.Interface,
- ReflectionKind.TypeAlias,
-
- ReflectionKind.Constructor,
- ReflectionKind.Property,
- ReflectionKind.Variable,
- ReflectionKind.Function,
- ReflectionKind.Accessor,
- ReflectionKind.Method,
-
- // others are never added to groups
- ].map(ReflectionKind.pluralString),
+ // default order specified in GroupPlugin to correctly handle localization.
});
options.addDeclaration({
name: "sort",
- help: "Specify the sort strategy for documented values.",
+ help: (i18n) => i18n.help_sort(),
type: ParameterType.Array,
defaultValue: ["kind", "instance-first", "alphabetical"],
- validate(value) {
+ validate(value, i18n) {
const invalid = new Set(value);
for (const v of SORT_STRATEGIES) {
invalid.delete(v);
@@ -698,29 +806,27 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
if (invalid.size !== 0) {
throw new Error(
- `sort may only specify known values, and invalid values were provided (${Array.from(
- invalid,
- ).join(
- ", ",
- )}). The valid sort strategies are:\n${SORT_STRATEGIES.join(
- ", ",
- )}`,
+ i18n.option_0_specified_1_but_only_2_is_valid(
+ "sort",
+ Array.from(invalid).join(", "),
+ SORT_STRATEGIES.join(", "),
+ ),
);
}
},
});
options.addDeclaration({
name: "sortEntryPoints",
- help: "If set, entry points will be subject to the same sorting rules as other reflections.",
+ help: (i18n) => i18n.help_sortEntryPoints(),
type: ParameterType.Boolean,
defaultValue: true,
});
options.addDeclaration({
name: "kindSortOrder",
- help: "Specify the sort order for reflections when 'kind' is specified.",
+ help: (i18n) => i18n.help_kindSortOrder(),
type: ParameterType.Array,
defaultValue: [],
- validate(value) {
+ validate(value, i18n) {
const invalid = new Set(value);
const valid = getEnumKeys(ReflectionKind);
for (const v of valid) {
@@ -729,9 +835,11 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
if (invalid.size !== 0) {
throw new Error(
- `kindSortOrder may only specify known values, and invalid values were provided (${Array.from(
- invalid,
- ).join(", ")}). The valid kinds are:\n${valid.join(", ")}`,
+ i18n.option_0_specified_1_but_only_2_is_valid(
+ `kindSortOrder`,
+ Array.from(invalid).join(", "),
+ valid.join(", "),
+ ),
);
}
},
@@ -743,44 +851,44 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "watch",
- help: "Watch files for changes and rebuild docs on change.",
+ help: (i18n) => i18n.help_watch(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "preserveWatchOutput",
- help: "If set, TypeDoc will not clear the screen between compilation runs.",
+ help: (i18n) => i18n.help_preserveWatchOutput(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "skipErrorChecking",
- help: "Do not run TypeScript's type checking before generating docs.",
+ help: (i18n) => i18n.help_skipErrorChecking(),
type: ParameterType.Boolean,
defaultValue: false,
});
options.addDeclaration({
name: "help",
- help: "Print this message.",
+ help: (i18n) => i18n.help_help(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "version",
- help: "Print TypeDoc's version.",
+ help: (i18n) => i18n.help_version(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "showConfig",
- help: "Print the resolved configuration and exit.",
+ help: (i18n) => i18n.help_showConfig(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "plugin",
- help: "Specify the npm plugins that should be loaded. Omit to load all installed plugins.",
+ help: (i18n) => i18n.help_plugin(),
type: ParameterType.ModuleArray,
});
options.addDeclaration({
name: "logLevel",
- help: "Specify what level of logging should be used.",
+ help: (i18n) => i18n.help_logLevel(),
type: ParameterType.Map,
map: LogLevel,
defaultValue: LogLevel.Info,
@@ -788,33 +896,35 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "treatWarningsAsErrors",
- help: "If set, all warnings will be treated as errors.",
+ help: (i18n) => i18n.help_treatWarningsAsErrors(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "treatValidationWarningsAsErrors",
- help: "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings.",
+ help: (i18n) => i18n.help_treatValidationWarningsAsErrors(),
type: ParameterType.Boolean,
});
options.addDeclaration({
name: "intentionallyNotExported",
- help: "A list of types which should not produce 'referenced but not documented' warnings.",
+ help: (i18n) => i18n.help_intentionallyNotExported(),
type: ParameterType.Array,
});
options.addDeclaration({
name: "requiredToBeDocumented",
- help: "A list of reflection kinds that must be documented",
+ help: (i18n) => i18n.help_requiredToBeDocumented(),
type: ParameterType.Array,
- validate(values) {
+ validate(values, i18n) {
// this is good enough because the values of the ReflectionKind enum are all numbers
const validValues = getEnumKeys(ReflectionKind);
for (const kind of values) {
if (!validValues.includes(kind)) {
throw new Error(
- `'${kind}' is an invalid value for 'requiredToBeDocumented'. Must be one of: ${validValues.join(
- ", ",
- )}`,
+ i18n.option_0_specified_1_but_only_2_is_valid(
+ "requiredToBeDocumented",
+ kind,
+ validValues.join(", "),
+ ),
);
}
}
@@ -835,7 +945,7 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
options.addDeclaration({
name: "validation",
- help: "Specify which validation steps TypeDoc should perform on your generated documentation.",
+ help: (i18n) => i18n.help_validation(),
type: ParameterType.Flags,
defaults: {
notExported: true,
diff --git a/src/lib/utils/options/tsdoc-defaults.ts b/src/lib/utils/options/tsdoc-defaults.ts
index 9ae30e874..17a7e23c9 100644
--- a/src/lib/utils/options/tsdoc-defaults.ts
+++ b/src/lib/utils/options/tsdoc-defaults.ts
@@ -1,66 +1,79 @@
// If updating these lists, also update tsdoc.json
export const tsdocBlockTags = [
+ "@defaultValue",
"@deprecated",
+ "@example",
"@param",
+ "@privateRemarks",
"@remarks",
"@returns",
+ "@see",
"@throws",
- "@privateRemarks",
- "@defaultValue",
"@typeParam",
] as const;
export const blockTags = [
...tsdocBlockTags,
- "@module",
- "@inheritDoc",
- "@group",
- "@groupDescription",
+ "@author",
+ "@callback",
"@category",
"@categoryDescription",
- // Alias for @typeParam
- "@template",
- // Because TypeScript is important!
- "@type",
- "@typedef",
- "@callback",
+ "@default",
+ "@document",
+ "@group",
+ "@groupDescription",
+ "@import",
+ "@inheritDoc",
+ "@jsx",
+ "@license",
+ "@module",
"@prop",
"@property",
+ "@return",
"@satisfies",
+ "@since",
+ "@template", // Alias for @typeParam
+ "@type",
+ "@typedef",
] as const;
export const tsdocInlineTags = ["@link", "@inheritDoc", "@label"] as const;
-export const inlineTags = [...tsdocInlineTags, "@linkcode", "@linkplain"];
+export const inlineTags = [
+ ...tsdocInlineTags,
+ "@linkcode",
+ "@linkplain",
+] as const;
export const tsdocModifierTags = [
- "@public",
- "@private",
- "@protected",
- "@internal",
- "@readonly",
- "@packageDocumentation",
- "@eventProperty",
"@alpha",
"@beta",
+ "@eventProperty",
"@experimental",
- "@sealed",
+ "@internal",
"@override",
+ "@packageDocumentation",
+ "@public",
+ "@readonly",
+ "@sealed",
"@virtual",
] as const;
export const modifierTags = [
...tsdocModifierTags,
- "@hidden",
- "@ignore",
"@class",
"@enum",
"@event",
- "@overload",
- "@namespace",
+ "@hidden",
+ "@hideCategories",
+ "@hideconstructor",
+ "@hideGroups",
+ "@ignore",
"@interface",
+ "@namespace",
+ "@overload",
+ "@private",
+ "@protected",
"@showCategories",
- "@hideCategories",
"@showGroups",
- "@hideGroups",
] as const;
diff --git a/src/lib/utils/package-manifest.ts b/src/lib/utils/package-manifest.ts
index 00c70f2fe..bd390acc3 100644
--- a/src/lib/utils/package-manifest.ts
+++ b/src/lib/utils/package-manifest.ts
@@ -29,7 +29,9 @@ export function loadPackageManifest(
): Record<string, unknown> | undefined {
const packageJson: unknown = JSON.parse(readFile(packageJsonPath));
if (typeof packageJson !== "object" || !packageJson) {
- logger.error(`The file ${packageJsonPath} is not an object.`);
+ logger.error(
+ logger.i18n.file_0_not_an_object(nicePath(packageJsonPath)),
+ );
return undefined;
}
return packageJson as Record<string, unknown>;
@@ -66,7 +68,7 @@ function getPackagePaths(
}
/**
- * Given a list of (potentially wildcarded) package paths,
+ * Given a list of (potentially wildcard containing) package paths,
* return all the actual package folders found.
*/
export function expandPackages(
@@ -81,35 +83,34 @@ export function expandPackages(
// be dealing with either a root or a leaf. So let's do this recursively,
// as it actually is simpler from an implementation perspective anyway.
return workspaces.flatMap((workspace) => {
- const globbedPackageJsonPaths = glob(
+ const expandedPackageJsonPaths = glob(
resolve(packageJsonDir, workspace, "package.json"),
resolve(packageJsonDir),
);
- if (globbedPackageJsonPaths.length === 0) {
+ if (expandedPackageJsonPaths.length === 0) {
logger.warn(
- `The entrypoint glob ${nicePath(
- workspace,
- )} did not match any directories containing package.json.`,
+ logger.i18n.entry_point_0_did_not_match_any_packages(
+ nicePath(workspace),
+ ),
);
} else {
logger.verbose(
`Expanded ${nicePath(
workspace,
- )} to:\n\t${globbedPackageJsonPaths
+ )} to:\n\t${expandedPackageJsonPaths
.map(nicePath)
.join("\n\t")}`,
);
}
- return globbedPackageJsonPaths.flatMap((packageJsonPath) => {
+ return expandedPackageJsonPaths.flatMap((packageJsonPath) => {
if (matchesAny(exclude, dirname(packageJsonPath))) {
return [];
}
const packageJson = loadPackageManifest(logger, packageJsonPath);
if (packageJson === undefined) {
- logger.error(`Failed to load ${packageJsonPath}`);
return [];
}
const packagePaths = getPackagePaths(packageJson);
diff --git a/src/lib/utils/paths.ts b/src/lib/utils/paths.ts
index cfef4e857..2f25c4192 100644
--- a/src/lib/utils/paths.ts
+++ b/src/lib/utils/paths.ts
@@ -37,5 +37,21 @@ export function nicePath(absPath: string) {
* @returns The normalized path.
*/
export function normalizePath(path: string) {
- return path.replace(/\\/g, "/");
+ if (process.platform === "win32") {
+ // Ensure forward slashes
+ path = path.replace(/\\/g, "/");
+
+ // Msys2 git on windows will give paths which use unix-style
+ // absolute paths, like /c/users/you. Since the rest of TypeDoc
+ // expects drive letters, convert it to that here.
+ path = path.replace(/^\/([a-zA-Z])\//, (_m, m1: string) => `${m1}:/`);
+
+ // Make Windows drive letters upper case
+ path = path.replace(
+ /^([^:]+):\//,
+ (_m, m1: string) => m1.toUpperCase() + ":/",
+ );
+ }
+
+ return path;
}
diff --git a/src/lib/utils/perf.ts b/src/lib/utils/perf.ts
index e63dfcbca..1950feaf3 100644
--- a/src/lib/utils/perf.ts
+++ b/src/lib/utils/perf.ts
@@ -50,7 +50,9 @@ export function Bench<T extends Function>(
let runner: T | undefined;
return function (this: any, ...args: any) {
if (!runner) {
- const className = Object.getPrototypeOf(this).constructor.name;
+ const className = context.static
+ ? this.name
+ : Object.getPrototypeOf(this).constructor.name;
runner = bench(value, `${className}.${String(context.name)}`);
}
return runner.apply(this, args);
diff --git a/src/lib/utils/plugins.ts b/src/lib/utils/plugins.ts
index 25019cb72..9bf43dd51 100644
--- a/src/lib/utils/plugins.ts
+++ b/src/lib/utils/plugins.ts
@@ -3,6 +3,7 @@ import { pathToFileURL } from "url";
import type { Application } from "../application";
import { nicePath } from "./paths";
+import type { TranslatedString } from "../internationalization/internationalization";
export async function loadPlugins(
app: Application,
@@ -12,7 +13,6 @@ export async function loadPlugins(
const pluginDisplay = getPluginDisplayName(plugin);
try {
- // eslint-disable-next-line @typescript-eslint/no-var-requires
let instance: any;
try {
instance = require(plugin);
@@ -32,18 +32,20 @@ export async function loadPlugins(
if (typeof initFunction === "function") {
await initFunction(app);
- app.logger.info(`Loaded plugin ${pluginDisplay}`);
+ app.logger.info(app.i18n.loaded_plugin_0(pluginDisplay));
} else {
app.logger.error(
- `Invalid structure in plugin ${pluginDisplay}, no load function found.`,
+ app.i18n.invalid_plugin_0_missing_load_function(
+ pluginDisplay,
+ ),
);
}
} catch (error) {
app.logger.error(
- `The plugin ${pluginDisplay} could not be loaded.`,
+ app.i18n.plugin_0_could_not_be_loaded(pluginDisplay),
);
if (error instanceof Error && error.stack) {
- app.logger.error(error.stack);
+ app.logger.error(error.stack as TranslatedString);
}
}
}
diff --git a/src/lib/utils/reflections.ts b/src/lib/utils/reflections.ts
index c215ff001..d8f367d3f 100644
--- a/src/lib/utils/reflections.ts
+++ b/src/lib/utils/reflections.ts
@@ -3,8 +3,8 @@ import {
DeclarationReflection,
makeRecursiveVisitor,
ParameterReflection,
- ProjectReflection,
- ReferenceType,
+ type ProjectReflection,
+ type ReferenceType,
Reflection,
SignatureReflection,
TypeParameterReflection,
@@ -46,7 +46,7 @@ export function discoverAllReferenceTypes(
current.type?.visit(visitor);
add(current.typeParameters);
add(current.signatures);
- add(current.indexSignature);
+ add(current.indexSignatures);
add(current.getSignature);
add(current.setSignature);
current.overwrites?.visit(visitor);
diff --git a/src/lib/utils/set.ts b/src/lib/utils/set.ts
new file mode 100644
index 000000000..2c9692d17
--- /dev/null
+++ b/src/lib/utils/set.ts
@@ -0,0 +1,17 @@
+export function setIntersection<T>(a: Iterable<T>, b: Set<T>): Set<T> {
+ const result = new Set<T>();
+ for (const elem of a) {
+ if (b.has(elem)) {
+ result.add(elem);
+ }
+ }
+ return result;
+}
+
+export function setDifference<T>(a: Iterable<T>, b: Iterable<T>): Set<T> {
+ const result = new Set(a);
+ for (const elem of b) {
+ result.delete(elem);
+ }
+ return result;
+}
diff --git a/src/lib/utils/sort.ts b/src/lib/utils/sort.ts
index 476fb65fd..4770d40ff 100644
--- a/src/lib/utils/sort.ts
+++ b/src/lib/utils/sort.ts
@@ -5,12 +5,13 @@
import { ReflectionKind } from "../models/reflections/kind";
import type { DeclarationReflection } from "../models/reflections/declaration";
-import { LiteralType } from "../models/types";
import type { Options } from "./options";
+import type { DocumentReflection } from "../models";
export const SORT_STRATEGIES = [
"source-order",
"alphabetical",
+ "alphabetical-ignoring-documents",
"enum-value-ascending",
"enum-value-descending",
"enum-member-source-order",
@@ -20,11 +21,14 @@ export const SORT_STRATEGIES = [
"required-first",
"kind",
"external-last",
+ "documents-first",
+ "documents-last",
] as const;
export type SortStrategy = (typeof SORT_STRATEGIES)[number];
const defaultKindSortOrder = [
+ ReflectionKind.Document,
ReflectionKind.Reference,
ReflectionKind.Project,
ReflectionKind.Module,
@@ -56,8 +60,8 @@ const defaultKindSortOrder = [
const sorts: Record<
SortStrategy,
(
- a: DeclarationReflection,
- b: DeclarationReflection,
+ a: DeclarationReflection | DocumentReflection,
+ b: DeclarationReflection | DocumentReflection,
data: { kindSortOrder: ReflectionKind[] },
) => boolean
> = {
@@ -88,15 +92,27 @@ const sorts: Record<
alphabetical(a, b) {
return a.name < b.name;
},
+ "alphabetical-ignoring-documents"(a, b) {
+ if (
+ a.kindOf(ReflectionKind.Document) ||
+ b.kindOf(ReflectionKind.Document)
+ ) {
+ return false;
+ }
+ return a.name < b.name;
+ },
"enum-value-ascending"(a, b) {
if (
a.kind == ReflectionKind.EnumMember &&
b.kind == ReflectionKind.EnumMember
) {
+ const aRefl = a as DeclarationReflection;
+ const bRefl = b as DeclarationReflection;
+
const aValue =
- a.type instanceof LiteralType ? a.type.value : -Infinity;
+ aRefl.type?.type === "literal" ? aRefl.type.value : -Infinity;
const bValue =
- b.type instanceof LiteralType ? b.type.value : -Infinity;
+ bRefl.type?.type === "literal" ? bRefl.type.value : -Infinity;
return aValue! < bValue!;
}
@@ -107,10 +123,13 @@ const sorts: Record<
a.kind == ReflectionKind.EnumMember &&
b.kind == ReflectionKind.EnumMember
) {
+ const aRefl = a as DeclarationReflection;
+ const bRefl = b as DeclarationReflection;
+
const aValue =
- a.type instanceof LiteralType ? a.type.value : -Infinity;
+ aRefl.type?.type === "literal" ? aRefl.type.value : -Infinity;
const bValue =
- b.type instanceof LiteralType ? b.type.value : -Infinity;
+ bRefl.type?.type === "literal" ? bRefl.type.value : -Infinity;
return bValue! < aValue!;
}
@@ -155,6 +174,18 @@ const sorts: Record<
"external-last"(a, b) {
return !a.flags.isExternal && b.flags.isExternal;
},
+ "documents-first"(a, b) {
+ return (
+ a.kindOf(ReflectionKind.Document) &&
+ !b.kindOf(ReflectionKind.Document)
+ );
+ },
+ "documents-last"(a, b) {
+ return (
+ !a.kindOf(ReflectionKind.Document) &&
+ b.kindOf(ReflectionKind.Document)
+ );
+ },
};
export function getSortFunction(opts: Options) {
@@ -171,7 +202,9 @@ export function getSortFunction(opts: Options) {
const strategies = opts.getValue("sort");
const data = { kindSortOrder };
- return function sortReflections(reflections: DeclarationReflection[]) {
+ return function sortReflections(
+ reflections: (DeclarationReflection | DocumentReflection)[],
+ ) {
reflections.sort((a, b) => {
for (const s of strategies) {
if (sorts[s](a, b, data)) {
diff --git a/src/lib/utils/tsconfig.ts b/src/lib/utils/tsconfig.ts
index f25bd41bf..76e982861 100644
--- a/src/lib/utils/tsconfig.ts
+++ b/src/lib/utils/tsconfig.ts
@@ -55,7 +55,7 @@ export function getTypeDocOptionsFromTsConfig(file: string): any {
return result;
}
-const tsConfigCache: Record<string, ts.ParsedCommandLine> = {};
+const tsConfigCache: Record<string, ts.ParsedCommandLine | undefined> = {};
export function readTsConfig(
path: string,
diff --git a/src/lib/utils/validation.ts b/src/lib/utils/validation.ts
index 2c6cce782..b2aea68c0 100644
--- a/src/lib/utils/validation.ts
+++ b/src/lib/utils/validation.ts
@@ -1,27 +1,28 @@
-export type Infer<T extends Schema> = T extends Optional<infer U>
- ? Infer<U>
- : T extends Guard<infer U>
- ? U
- : T extends typeof String
- ? string
- : T extends typeof Number
- ? number
- : T extends typeof Boolean
- ? boolean
- : T extends readonly string[]
- ? T[number]
- : T extends readonly [typeof Array, Schema]
- ? Array<Infer<T[1]>>
- : {
- -readonly [K in OptionalKeys<T>]?: Infer<
- Extract<T[K & keyof T], Schema>
- >;
- } & {
- -readonly [K in Exclude<
- keyof T,
- OptionalKeys<T> | typeof additionalProperties
- >]: Infer<Extract<T[K], Schema>>;
- };
+export type Infer<T extends Schema> =
+ T extends Optional<infer U>
+ ? Infer<U>
+ : T extends Guard<infer U>
+ ? U
+ : T extends typeof String
+ ? string
+ : T extends typeof Number
+ ? number
+ : T extends typeof Boolean
+ ? boolean
+ : T extends readonly string[]
+ ? T[number]
+ : T extends readonly [typeof Array, Schema]
+ ? Array<Infer<T[1]>>
+ : {
+ -readonly [K in OptionalKeys<T>]?: Infer<
+ Extract<T[K & keyof T], Schema>
+ >;
+ } & {
+ -readonly [K in Exclude<
+ keyof T,
+ OptionalKeys<T> | typeof additionalProperties
+ >]: Infer<Extract<T[K], Schema>>;
+ };
export type Optional<T extends Schema> = Record<typeof opt, T>;
export type Guard<T> = (x: unknown) => x is T;
diff --git a/src/lib/validation/documentation.ts b/src/lib/validation/documentation.ts
index 29e7fcdda..da9df9db4 100644
--- a/src/lib/validation/documentation.ts
+++ b/src/lib/validation/documentation.ts
@@ -1,7 +1,7 @@
import {
DeclarationReflection,
- ProjectReflection,
- Reflection,
+ type ProjectReflection,
+ type Reflection,
ReflectionKind,
ReflectionType,
} from "../models";
@@ -43,7 +43,7 @@ export function validateDocumentation(
if (seen.has(ref)) continue;
seen.add(ref);
- // If we're a non-parameter inside a parameter, we shouldn't care. Parameters don't get deeply documented
+ // If inside a parameter, we shouldn't care. Callback parameter's values don't get deeply documented.
let r: Reflection | undefined = ref.parent;
while (r) {
if (r.kindOf(ReflectionKind.Parameter)) {
@@ -71,6 +71,15 @@ export function validateDocumentation(
continue;
}
+ // Construct signatures are considered documented if they are directly within a documented type alias.
+ if (
+ ref.kindOf(ReflectionKind.ConstructorSignature) &&
+ ref.parent?.parent?.kindOf(ReflectionKind.TypeAlias)
+ ) {
+ toProcess.push(ref.parent.parent);
+ continue;
+ }
+
if (ref instanceof DeclarationReflection) {
const signatures =
ref.type instanceof ReflectionType
@@ -97,11 +106,11 @@ export function validateDocumentation(
}
logger.warn(
- `${ref.getFriendlyFullName()} (${
- ReflectionKind[ref.kind]
- }), defined in ${nicePath(
- symbolId.fileName,
- )}, does not have any documentation.`,
+ logger.i18n.reflection_0_kind_1_defined_in_2_does_not_have_any_documentation(
+ ref.getFriendlyFullName(),
+ ReflectionKind[ref.kind],
+ nicePath(symbolId.fileName),
+ ),
);
}
}
diff --git a/src/lib/validation/exports.ts b/src/lib/validation/exports.ts
index 236ae6f01..b439f0db3 100644
--- a/src/lib/validation/exports.ts
+++ b/src/lib/validation/exports.ts
@@ -85,9 +85,11 @@ export function validateExports(
warned.add(uniqueId!);
logger.warn(
- `${type.qualifiedName}, defined in ${nicePath(
- type.symbolId!.fileName,
- )}, is referenced by ${owner.getFullName()} but not included in the documentation.`,
+ logger.i18n.type_0_defined_in_1_is_referenced_by_2_but_not_included_in_docs(
+ type.qualifiedName,
+ nicePath(type.symbolId!.fileName),
+ owner.getFriendlyFullName(),
+ ),
);
}
}
@@ -95,8 +97,9 @@ export function validateExports(
const unusedIntentional = intentional.getUnused();
if (unusedIntentional.length) {
logger.warn(
- "The following symbols were marked as intentionally not exported, but were either not referenced in the documentation, or were exported:\n\t" +
+ logger.i18n.invalid_intentionally_not_exported_symbols_0(
unusedIntentional.join("\n\t"),
+ ),
);
}
}
diff --git a/src/lib/validation/links.ts b/src/lib/validation/links.ts
index ca2fb39d4..3a2c103d3 100644
--- a/src/lib/validation/links.ts
+++ b/src/lib/validation/links.ts
@@ -1,12 +1,17 @@
-import type { Comment, CommentDisplayPart, ProjectReflection } from "../models";
+import {
+ ReflectionKind,
+ type Comment,
+ type CommentDisplayPart,
+ type ProjectReflection,
+} from "../models";
import type { Logger } from "../utils";
const linkTags = ["@link", "@linkcode", "@linkplain"];
-function getBrokenLinks(comment: Comment | undefined) {
+function getBrokenPartLinks(parts: readonly CommentDisplayPart[]) {
const links: string[] = [];
- function processPart(part: CommentDisplayPart) {
+ for (const part of parts) {
if (
part.kind === "inline-tag" &&
linkTags.includes(part.tag) &&
@@ -16,8 +21,16 @@ function getBrokenLinks(comment: Comment | undefined) {
}
}
- comment?.summary.forEach(processPart);
- comment?.blockTags.forEach((tag) => tag.content.forEach(processPart));
+ return links;
+}
+
+function getBrokenLinks(comment: Comment | undefined) {
+ if (!comment) return [];
+
+ const links = [...getBrokenPartLinks(comment.summary)];
+ for (const tag of comment.blockTags) {
+ links.push(...getBrokenPartLinks(tag.content));
+ }
return links;
}
@@ -28,20 +41,79 @@ export function validateLinks(
): void {
for (const id in project.reflections) {
const reflection = project.reflections[id];
+
+ if (reflection.isProject() || reflection.isDeclaration()) {
+ for (const broken of getBrokenPartLinks(reflection.readme || [])) {
+ // #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(
+ logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1_may_have_meant_2(
+ broken,
+ reflection.getFriendlyFullName(),
+ broken.replace(/[.#~]/, "!"),
+ ),
+ );
+ } else {
+ logger.warn(
+ logger.i18n.failed_to_resolve_link_to_0_in_readme_for_1(
+ broken,
+ reflection.getFriendlyFullName(),
+ ),
+ );
+ }
+ }
+ }
+
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.
- let extra = "";
if (broken.startsWith("@") && !broken.includes("!")) {
- extra = `\n\tYou may have wanted "${broken.replace(
- /[.#~]/,
- "!",
- )}"`;
+ logger.warn(
+ logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(
+ broken,
+ reflection.getFriendlyFullName(),
+ broken.replace(/[.#~]/, "!"),
+ ),
+ );
+ } else {
+ logger.warn(
+ logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(
+ broken,
+ reflection.getFriendlyFullName(),
+ ),
+ );
+ }
+ }
+
+ if (
+ reflection.isDeclaration() &&
+ reflection.kindOf(ReflectionKind.TypeAlias) &&
+ reflection.type?.type === "union" &&
+ reflection.type.elementSummaries
+ ) {
+ for (const broken of reflection.type.elementSummaries.flatMap(
+ getBrokenPartLinks,
+ )) {
+ if (broken.startsWith("@") && !broken.includes("!")) {
+ logger.warn(
+ logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1_may_have_meant_2(
+ broken,
+ reflection.getFriendlyFullName(),
+ broken.replace(/[.#~]/, "!"),
+ ),
+ );
+ } else {
+ logger.warn(
+ logger.i18n.failed_to_resolve_link_to_0_in_comment_for_1(
+ broken,
+ reflection.getFriendlyFullName(),
+ ),
+ );
+ }
}
- logger.warn(
- `Failed to resolve link to "${broken}" in comment for ${reflection.getFriendlyFullName()}.${extra}`,
- );
}
}
}
diff --git a/src/test/Repository.test.ts b/src/test/Repository.test.ts
index e62d95383..c1efd8441 100644
--- a/src/test/Repository.test.ts
+++ b/src/test/Repository.test.ts
@@ -1,14 +1,31 @@
import {
GitRepository,
guessSourceUrlTemplate,
+ RepositoryManager,
} from "../lib/converter/utils/repository";
-import { strictEqual as equal, ok } from "assert";
-import { tempdirProject } from "@typestrong/fs-fixture-builder";
+import { deepStrictEqual as equal, ok } from "assert";
+import { type Project, tempdirProject } from "@typestrong/fs-fixture-builder";
import { spawnSync } from "child_process";
import { TestLogger } from "./TestLogger";
import { join } from "path";
import { normalizePath } from "../lib/utils/paths";
+function git(cwd: string, ...args: string[]) {
+ const env = {
+ GIT_AUTHOR_NAME: "test",
+ GIT_AUTHOR_EMAIL: "test@example.com",
+ GIT_AUTHOR_DATE: "2024-03-31T22:04:50.119Z",
+ GIT_COMMITTER_NAME: "test",
+ GIT_COMMITTER_EMAIL: "test@example.com",
+ GIT_COMMITTER_DATE: "2024-03-31T22:04:50.119Z",
+ };
+ return spawnSync("git", ["-C", cwd, ...args], {
+ encoding: "utf-8",
+ windowsHide: true,
+ env,
+ });
+}
+
describe("Repository", function () {
describe("guessSourceUrlTemplate helper", () => {
it("handles a personal GitHub HTTPS URL", () => {
@@ -109,23 +126,7 @@ describe("Repository", function () {
});
describe("getURL", () => {
- const project = tempdirProject();
- function git(...args: string[]) {
- const env = {
- GIT_AUTHOR_NAME: "test",
- GIT_AUTHOR_EMAIL: "test@example.com",
- GIT_AUTHOR_DATE: "2024-03-31T22:04:50.119Z",
- GIT_COMMITTER_NAME: "test",
- GIT_COMMITTER_EMAIL: "test@example.com",
- GIT_COMMITTER_DATE: "2024-03-31T22:04:50.119Z",
- };
- return spawnSync("git", ["-C", project.cwd, ...args], {
- encoding: "utf-8",
- windowsHide: true,
- env,
- });
- }
-
+ using project = tempdirProject();
afterEach(() => {
project.rm();
});
@@ -134,10 +135,11 @@ describe("Repository", function () {
project.addFile("test.js", "console.log('hi!')");
project.write();
- git("init", "-b", "test");
- git("add", ".");
- git("commit", "-m", "Test commit");
+ git(project.cwd, "init", "-b", "test");
+ git(project.cwd, "add", ".");
+ git(project.cwd, "commit", "-m", "Test commit");
git(
+ project.cwd,
"remote",
"add",
"origin",
@@ -160,3 +162,157 @@ describe("Repository", function () {
});
});
});
+
+describe("RepositoryManager - no git", () => {});
+
+describe("RepositoryManager - git enabled", () => {
+ let fix: Project;
+ const logger = new TestLogger();
+ const manager = new RepositoryManager(
+ "",
+ "revision",
+ "remote",
+ "link:{path}",
+ false, // disable git
+ logger,
+ );
+
+ before(function () {
+ function createRepo(path: string) {
+ git(path, "init", "-b", "test");
+ git(path, "add", ".");
+ git(path, "commit", "-m", "Test commit");
+ }
+
+ fix = tempdirProject();
+ fix.addFile("root.txt");
+ fix.addFile(".gitignore", "/ignored");
+ fix.addSymlink("self", ".");
+ fix.addSymlink("sub", "subfolder");
+ fix.dir("subfolder", (dir) => {
+ dir.addFile("sub.txt");
+ });
+ fix.dir("ignored", (dir) => {
+ dir.addFile("ignored.txt");
+ });
+ fix.dir("sub_repo", (dir) => {
+ dir.addFile("repo.txt");
+ });
+
+ try {
+ fix.write();
+ } catch (error) {
+ if (process.platform === "win32") {
+ // Don't have permission to create symlinks
+ return this.skip();
+ }
+ throw error;
+ }
+ createRepo(join(fix.cwd, "sub_repo"));
+ createRepo(fix.cwd);
+ });
+ after(() => {
+ fix.rm();
+ });
+
+ afterEach(() => {
+ logger.expectNoOtherMessages();
+ logger.reset();
+ });
+
+ it("Handles the simplest case", () => {
+ const root = normalizePath(join(fix.cwd, "root.txt"));
+ const repo = manager.getRepository(root) as GitRepository;
+ ok(repo);
+ equal(repo.getURL(root, 1), "link:root.txt");
+ equal(
+ repo.files,
+ new Set(
+ [
+ ".gitignore",
+ "root.txt",
+ "self",
+ "sub",
+ "sub_repo",
+ "subfolder/sub.txt",
+ ].map((f) => normalizePath(join(fix.cwd, f))),
+ ),
+ );
+ });
+
+ it("Handles a recursive self-symlink", () => {
+ const root = join(fix.cwd, "self/self/self/root.txt");
+ const repo = manager.getRepository(root) as GitRepository;
+ ok(repo);
+ // Ideally, this would probably be link:root.txt, but I'll
+ // settle for not crashing right now.
+ equal(repo.getURL(root, 1), undefined);
+ equal(
+ repo.files,
+ new Set(
+ [
+ ".gitignore",
+ "root.txt",
+ "self",
+ "sub",
+ "sub_repo",
+ "subfolder/sub.txt",
+ ].map((f) => normalizePath(join(fix.cwd, f))),
+ ),
+ );
+ });
+
+ it("Handles a nested repository", () => {
+ const sub = normalizePath(join(fix.cwd, "sub_repo/repo.txt"));
+ const repo = manager.getRepository(sub) as GitRepository;
+ ok(repo);
+ equal(repo.path, normalizePath(join(fix.cwd, "sub_repo")));
+ equal(repo.getURL(sub, 1), "link:repo.txt");
+ equal(repo.files.size, 1);
+ });
+
+ it("Caches repositories", () => {
+ // Load cache
+ for (const path of [
+ "root.txt",
+ "self/self/self/root.txt",
+ "sub_repo/repo.txt",
+ "ignored/ignored.txt",
+ "subfolder/sub.txt",
+ ]) {
+ manager.getRepository(join(fix.cwd, path));
+ }
+
+ const root = join(fix.cwd, "root.txt");
+ const rootIndirect = join(fix.cwd, "self/self/self/root.txt");
+ const subfolder = join(fix.cwd, "subfolder/sub.txt");
+ const repo = manager.getRepository(root) as GitRepository;
+ const repo2 = manager.getRepository(rootIndirect) as GitRepository;
+ const repo3 = manager.getRepository(subfolder) as GitRepository;
+ ok(repo === repo2);
+ ok(repo === repo3);
+
+ const sub = join(fix.cwd, "sub_repo/repo.txt");
+ const subRepo = manager.getRepository(sub) as GitRepository;
+ const subRepo2 = manager.getRepository(sub) as GitRepository;
+ ok(subRepo === subRepo2);
+
+ equal(
+ manager["cache"],
+ new Map([
+ [normalizePath(fix.cwd), repo],
+ [normalizePath(join(fix.cwd, "self/self/self")), repo],
+ [normalizePath(join(fix.cwd, "sub_repo")), subRepo],
+ [normalizePath(join(fix.cwd, "ignored")), repo],
+ [normalizePath(join(fix.cwd, "subfolder")), repo],
+ ]),
+ );
+ });
+
+ it("Handles .gitignored paths", () => {
+ const ign = join(fix.cwd, "ignored/ignored.txt");
+ const repo = manager.getRepository(ign);
+ equal(repo?.path, normalizePath(fix.cwd));
+ equal(repo.getURL(ign, 1), undefined);
+ });
+});
diff --git a/src/test/TestLogger.ts b/src/test/TestLogger.ts
index b1d63a0c8..cde695170 100644
--- a/src/test/TestLogger.ts
+++ b/src/test/TestLogger.ts
@@ -2,6 +2,10 @@ import { Logger, LogLevel } from "../lib/utils";
import { fail, ok } from "assert";
import ts from "typescript";
import { resolve } from "path";
+import {
+ Internationalization,
+ type TranslationProxy,
+} from "../lib/internationalization/internationalization";
const levelMap: Record<LogLevel, string> = {
[LogLevel.None]: "none: ",
@@ -13,6 +17,7 @@ const levelMap: Record<LogLevel, string> = {
export class TestLogger extends Logger {
messages: string[] = [];
+ override i18n: TranslationProxy = new Internationalization(null).proxy;
reset() {
this.resetErrors();
diff --git a/src/test/behavior.c2.test.ts b/src/test/behavior.c2.test.ts
index ff1f5c970..82a875c86 100644
--- a/src/test/behavior.c2.test.ts
+++ b/src/test/behavior.c2.test.ts
@@ -6,7 +6,7 @@ import {
CommentTag,
Reflection,
SignatureReflection,
- ContainerReflection,
+ type ContainerReflection,
} from "../lib/models";
import { filterMap } from "../lib/utils";
import { CommentStyle } from "../lib/utils/options/declaration";
@@ -21,7 +21,7 @@ import { existsSync } from "fs";
import { clearCommentCache } from "../lib/converter/comments";
import { getComment, query, querySig } from "./utils";
-type NameTree = { [name: string]: NameTree };
+type NameTree = { [name: string]: NameTree | undefined };
function buildNameTree(
refl: ContainerReflection,
@@ -49,7 +49,7 @@ function getLinks(refl: Reflection) {
];
}
if (p.target instanceof Reflection) {
- return [p.target?.kind, p.target?.getFullName()];
+ return [p.target.kind, p.target.getFullName()];
}
return [p.target?.qualifiedName];
}
@@ -272,11 +272,10 @@ describe("Behavior Tests", () => {
["Variable class", "Stat docs", "Inst docs"],
);
- equal(project.children?.map((c) => c.name), [
- "BadClass",
- "CallableClass",
- "VariableClass",
- ]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["BadClass", "CallableClass", "VariableClass"],
+ );
});
it("Handles const type parameters", () => {
@@ -289,7 +288,10 @@ describe("Behavior Tests", () => {
it("Handles declare global 'modules'", () => {
const project = convert("declareGlobal");
- equal(project.children?.map((c) => c.name), ["DeclareGlobal"]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["DeclareGlobal"],
+ );
});
it("Handles duplicate heritage clauses", () => {
@@ -384,7 +386,7 @@ describe("Behavior Tests", () => {
]);
logger.expectMessage(
- "warn: The first line of an example tag will be taken literally as the example name, and should only contain text.",
+ "warn: The first line of an example tag will be taken literally as the example name, and should only contain text",
);
logger.expectNoOtherMessages();
});
@@ -429,7 +431,7 @@ describe("Behavior Tests", () => {
);
logger.expectMessage("warn: Unmatched closing brace");
logger.expectMessage(
- "warn: The first line of an example tag will be taken literally as the example name, and should only contain text.",
+ "warn: The first line of an example tag will be taken literally as the example name, and should only contain text",
);
logger.expectNoOtherMessages();
});
@@ -438,7 +440,10 @@ describe("Behavior Tests", () => {
app.options.setValue("excludeCategories", ["A", "Default"]);
app.options.setValue("defaultCategory", "Default");
const project = convert("excludeCategories");
- equal(project.children?.map((c) => c.name), ["c"]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["c"],
+ );
});
it("Handles excludeNotDocumentedKinds", () => {
@@ -478,14 +483,15 @@ describe("Behavior Tests", () => {
typescript: {
Promise: "/promise2",
},
- "@types/marked": {
- Lexer: "https://marked.js.org/using_pro#lexer",
- "*": "https://marked.js.org",
+ "@types/markdown-it": {
+ "MarkdownIt.Token":
+ "https://markdown-it.github.io/markdown-it/#Token",
+ "*": "https://markdown-it.github.io/markdown-it/",
},
});
const project = convert("externalSymbols");
const p = query(project, "P");
- equal(p.comment?.summary?.[1], {
+ equal(p.comment?.summary[1], {
kind: "inline-tag",
tag: "@link",
target: "/promise",
@@ -495,13 +501,16 @@ describe("Behavior Tests", () => {
equal(p.type?.type, "reference" as const);
equal(p.type.externalUrl, "/promise2");
- const m = query(project, "L");
+ const m = query(project, "T");
equal(m.type?.type, "reference" as const);
- equal(m.type.externalUrl, "https://marked.js.org/using_pro#lexer");
+ equal(
+ m.type.externalUrl,
+ "https://markdown-it.github.io/markdown-it/#Token",
+ );
- const s = query(project, "S");
+ const s = query(project, "Pr");
equal(s.type?.type, "reference" as const);
- equal(s.type.externalUrl, "https://marked.js.org");
+ equal(s.type.externalUrl, "https://markdown-it.github.io/markdown-it/");
});
it("Handles @group tag", () => {
@@ -511,15 +520,13 @@ describe("Behavior Tests", () => {
const C = query(project, "C");
const D = query(project, "D");
- equal(project.groups?.map((g) => g.title), [
- "Variables",
- "A",
- "B",
- "With Spaces",
- ]);
+ equal(
+ project.groups?.map((g) => g.title),
+ ["Variables", "A", "B", "With Spaces"],
+ );
equal(
- project.groups?.map((g) =>
+ project.groups.map((g) =>
Comment.combineDisplayParts(g.description),
),
["Variables desc", "A description", "", "With spaces desc"],
@@ -534,7 +541,10 @@ describe("Behavior Tests", () => {
it("Inherits @group tag if comment is not redefined", () => {
const project = convert("groupInheritance");
const cls = query(project, "Cls");
- equal(cls.groups?.map((g) => g.title), ["Constructors", "Group"]);
+ equal(
+ cls.groups?.map((g) => g.title),
+ ["Constructors", "Group"],
+ );
equal(
cls.groups.map((g) => g.children),
[[query(project, "Cls.constructor")], [query(project, "Cls.prop")]],
@@ -545,9 +555,12 @@ describe("Behavior Tests", () => {
app.options.setValue("categorizeByGroup", false);
const project = convert("categoryInheritance");
const cls = query(project, "Cls");
- equal(cls.categories?.map((g) => g.title), ["Cat", "Other"]);
equal(
- cls.categories?.map((g) =>
+ cls.categories?.map((g) => g.title),
+ ["Cat", "Other"],
+ );
+ equal(
+ cls.categories.map((g) =>
Comment.combineDisplayParts(g.description),
),
["Cat desc", ""],
@@ -561,12 +574,18 @@ describe("Behavior Tests", () => {
it("Handles hidden accessors", () => {
const project = convert("hiddenAccessor");
const test = query(project, "Test");
- equal(test.children?.map((c) => c.name), [
- "constructor",
- "auto",
- "x",
- "y",
- ]);
+ equal(
+ test.children?.map((c) => c.name),
+ ["constructor", "auto", "x", "y"],
+ );
+ });
+
+ it("Handles @hideconstructor", () => {
+ const project = convert("hideconstructor");
+
+ ok(!project.getChildByName("StaticOnly.constructor"));
+ ok(!!project.getChildByName("StaticOnly.notHidden"));
+ ok(!project.getChildByName("IgnoredCtor.constructor"));
});
it("Handles simple @inheritDoc cases", () => {
@@ -708,11 +727,11 @@ describe("Behavior Tests", () => {
const target4 = query(project, "target4");
ok(target4.comment?.getTag("@inheritDoc"));
logger.expectMessage(
- "warn: target4 tried to copy a comment from source2 with @inheritDoc, but the source has no associated comment.",
+ "warn: target4 tried to copy a comment from source2 with @inheritDoc, but the source has no associated comment",
);
logger.expectMessage(
- "warn: Declaration reference in @inheritDoc for badParse was not fully parsed and may resolve incorrectly.",
+ "warn: Declaration reference in @inheritDoc for badParse was not fully parsed and may resolve incorrectly",
);
logger.expectNoOtherMessages();
@@ -900,7 +919,7 @@ describe("Behavior Tests", () => {
equal(Comment.combineDisplayParts(b.comment?.summary), "Comment 1");
logger.expectMessage(
- "warn: MultiCommentMultiDeclaration has multiple declarations with a comment. An arbitrary comment will be used.",
+ "warn: MultiCommentMultiDeclaration has multiple declarations with a comment. An arbitrary comment will be used",
);
logger.expectMessage(
"info: The comments for MultiCommentMultiDeclaration are declared at*",
@@ -937,20 +956,23 @@ describe("Behavior Tests", () => {
equal(fooComments, ["No arg comment\n", "No arg comment\n"]);
equal(foo.comment, undefined);
- equal(foo.signatures?.map((s) => s.comment?.label), [
- "NO_ARGS",
- "WITH_X",
- ]);
+ equal(
+ foo.signatures?.map((s) => s.comment?.label),
+ ["NO_ARGS", "WITH_X"],
+ );
const bar = query(project, "bar");
const barComments = bar.signatures?.map((sig) =>
Comment.combineDisplayParts(sig.comment?.summary),
);
- equal(barComments, ["Implementation comment", "Custom comment"]);
- equal(bar.comment, undefined);
+ equal(barComments, ["", "Custom comment"]);
+ equal(
+ Comment.combineDisplayParts(bar.comment?.summary),
+ "Implementation comment",
+ );
logger.expectMessage(
- 'warn: The label "bad" for badLabel cannot be referenced with a declaration reference. Labels may only contain A-Z, 0-9, and _, and may not start with a number.',
+ 'warn: The label "bad" for badLabel cannot be referenced with a declaration reference. Labels may only contain A-Z, 0-9, and _, and may not start with a number',
);
logger.expectNoOtherMessages();
});
@@ -1058,7 +1080,10 @@ describe("Behavior Tests", () => {
const project = convert("typeAliasInterface");
const bar = query(project, "Bar");
equal(bar.kind, ReflectionKind.Interface);
- equal(bar.children?.map((c) => c.name), ["a", "b"]);
+ equal(
+ bar.children?.map((c) => c.name),
+ ["a", "b"],
+ );
const comments = [bar, bar.children[0], bar.children[1]].map((r) =>
Comment.combineDisplayParts(r.comment?.summary),
@@ -1070,34 +1095,35 @@ describe("Behavior Tests", () => {
it("Allows specifying group sort order #2251", () => {
app.options.setValue("groupOrder", ["B", "Variables", "A"]);
const project = convert("groupTag");
- equal(project.groups?.map((g) => g.title), [
- "B",
- "Variables",
- "A",
- "With Spaces",
- ]);
+ equal(
+ project.groups?.map((g) => g.title),
+ ["B", "Variables", "A", "With Spaces"],
+ );
});
it("Supports disabling sorting of entry points #2393", () => {
app.options.setValue("sort", ["alphabetical"]);
const project = convert("blockComment", "asConstEnum");
- equal(project.children?.map((c) => c.name), [
- "asConstEnum",
- "blockComment",
- ]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["asConstEnum", "blockComment"],
+ );
app.options.setValue("sortEntryPoints", false);
const project2 = convert("blockComment", "asConstEnum");
- equal(project2.children?.map((c) => c.name), [
- "blockComment",
- "asConstEnum",
- ]);
+ equal(
+ project2.children?.map((c) => c.name),
+ ["blockComment", "asConstEnum"],
+ );
});
it("Respects resolution-mode when resolving types", () => {
app.options.setValue("excludeExternals", false);
const MergedType = query(convert("resolutionMode"), "MergedType");
- equal(MergedType.children?.map((child) => child.name), ["cjs", "esm"]);
+ equal(
+ MergedType.children?.map((child) => child.name),
+ ["cjs", "esm"],
+ );
});
it("Special cases some `this` type occurrences", () => {
@@ -1144,15 +1170,15 @@ describe("Behavior Tests", () => {
);
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.',
+ '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);
@@ -1179,4 +1205,32 @@ describe("Behavior Tests", () => {
equal(sig.parameters[0].type?.toString(), "C[]");
equal(sig.parameters[1].type?.toString(), "NoInfer<C>");
});
+
+ it("Handles inferred predicate functions from TS 5.5", () => {
+ const project = convert("inferredPredicates");
+ const sig = querySig(project, "isNumber");
+ equal(sig.type?.toString(), "x is number");
+ const sig2 = querySig(project, "isNonNullish");
+ equal(sig2.type?.toString(), "x is NonNullable<T>");
+ });
+
+ it("Cascades specified modifier tags to child reflections, #2056", () => {
+ const project = convert("cascadedModifiers");
+
+ const mods = (s: string) => query(project, s).comment?.modifierTags;
+ const sigMods = (s: string) =>
+ querySig(project, s).comment?.modifierTags;
+
+ equal(mods("BetaStuff"), new Set(["@beta"]));
+ equal(mods("BetaStuff.AlsoBeta"), new Set(["@beta"]));
+ equal(mods("BetaStuff.AlsoBeta.betaFish"), new Set());
+ equal(mods("BetaStuff.AlsoBeta.alphaFish"), new Set());
+
+ equal(sigMods("BetaStuff.AlsoBeta.betaFish"), new Set(["@beta"]));
+ equal(sigMods("BetaStuff.AlsoBeta.alphaFish"), new Set(["@alpha"]));
+
+ logger.expectMessage(
+ "warn: The modifier tag @alpha is mutually exclusive with @beta in the comment for mutuallyExclusive",
+ );
+ });
});
diff --git a/src/test/capture-screenshots.ts b/src/test/capture-screenshots.ts
deleted file mode 100644
index e46b4e0b8..000000000
--- a/src/test/capture-screenshots.ts
+++ /dev/null
@@ -1,130 +0,0 @@
-import * as fs from "fs";
-import { platform } from "os";
-import { resolve, join, dirname, relative } from "path";
-import { Application, EntryPointStrategy } from "..";
-import { glob } from "../lib/utils/fs";
-
-// The @types package plays badly with non-dom packages.
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const puppeteer = require("puppeteer");
-
-const concurrency = 10;
-const src = join(__dirname, "../../src/test/renderer/testProject/src");
-const baseDirectory = join(__dirname, "../../tmp/capture");
-const outputDirectory = join(__dirname, "../../tmp/screenshots");
-const viewport = { width: 1024, height: 768 };
-
-class PQueue {
- private queued: (() => Promise<void>)[] = [];
- constructor(private concurrency: number) {}
-
- add(action: () => Promise<void>) {
- this.queued.push(action);
- }
-
- run() {
- return new Promise<void>((resolve, reject) => {
- const queue: Promise<void>[] = [];
- const doReject = (err: unknown) => {
- this.queued.length = 0;
- queue.length = 0;
- reject(err);
- };
- const tick = () => {
- while (queue.length < this.concurrency) {
- const next = this.queued.shift();
- if (next) {
- const nextPromise = Promise.resolve().then(next);
- queue.push(nextPromise);
- nextPromise.then(() => {
- void queue.splice(queue.indexOf(nextPromise), 1);
- tick();
- }, doReject);
- } else {
- break;
- }
- }
-
- if (queue.length === 0) {
- resolve();
- }
- };
-
- tick();
- });
- }
-}
-
-export async function captureRegressionScreenshots() {
- const app = await Application.bootstrap({
- readme: join(src, "..", "README.md"),
- name: "typedoc",
- cleanOutputDir: true,
- tsconfig: join(src, "..", "tsconfig.json"),
- plugin: [],
- entryPoints: [src],
- entryPointStrategy: EntryPointStrategy.Expand,
- });
- const project = await app.convert();
- if (!project) throw new Error("Failed to convert.");
- await fs.promises.rm(outputDirectory, { recursive: true, force: true });
- await app.generateDocs(project, baseDirectory);
-
- await captureScreenshots(baseDirectory, outputDirectory);
-}
-
-export async function captureScreenshots(
- baseDirectory: string,
- outputDirectory: string,
-) {
- const browser = await puppeteer.launch({
- args:
- platform() === "win32"
- ? []
- : ["--no-sandbox", "--disable-setuid-sandbox"],
- });
-
- const queue = new PQueue(concurrency);
- for (const file of glob("**/*.html", baseDirectory)) {
- queue.add(async () => {
- const absPath = resolve(baseDirectory, file);
- const outputPath = resolve(
- outputDirectory,
- relative(baseDirectory, file).replace(".html", ""),
- );
- fs.mkdirSync(dirname(outputPath), { recursive: true });
-
- const page = await browser.newPage();
- await page.setViewport(viewport);
- await page.goto(`file://${absPath}`, {
- waitUntil: "domcontentloaded", // 'load' 'networkidle0' 'networkidle2'
- });
- await new Promise<void>((res) => setTimeout(() => res(), 100));
- await page.screenshot({
- path: outputPath + "-light.png",
- fullPage: true,
- });
-
- await page.evaluate('document.body.classList.add("dark")');
- await new Promise<void>((res) => setTimeout(() => res(), 100));
-
- await page.screenshot({
- path: outputPath + "-dark.png",
- fullPage: true,
- });
-
- await page.close();
- });
- }
- await queue.run();
-
- await browser.close();
-}
-
-if (require.main == module) {
- captureRegressionScreenshots().catch((err) => {
- // eslint-disable-next-line no-console
- console.error(err);
- process.exit(1);
- });
-}
diff --git a/src/test/comments.test.ts b/src/test/comments.test.ts
index e05a64d23..e15ce775f 100644
--- a/src/test/comments.test.ts
+++ b/src/test/comments.test.ts
@@ -4,13 +4,14 @@ import type { CommentParserConfig } from "../lib/converter/comments";
import { lexBlockComment } from "../lib/converter/comments/blockLexer";
import { lexLineComments } from "../lib/converter/comments/lineLexer";
-import { Token, TokenSyntaxKind } from "../lib/converter/comments/lexer";
+import { type Token, TokenSyntaxKind } from "../lib/converter/comments/lexer";
import { parseComment } from "../lib/converter/comments/parser";
import { lexCommentString } from "../lib/converter/comments/rawLexer";
-import { Comment, CommentTag } from "../lib/models";
+import { Comment, type CommentDisplayPart, CommentTag } from "../lib/models";
import { MinimalSourceFile } from "../lib/utils/minimalSourceFile";
import { TestLogger } from "./TestLogger";
import { extractTagName } from "../lib/converter/comments/tagName";
+import { FileRegistry } from "../lib/models/FileRegistry";
function dedent(text: string) {
const lines = text.split(/\r?\n/);
@@ -927,9 +928,7 @@ describe("Raw Lexer", () => {
const tokens = lex(" Comment\nNext line ");
equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "Comment", pos: 1 },
- { kind: TokenSyntaxKind.NewLine, text: "\n", pos: 8 },
- { kind: TokenSyntaxKind.Text, text: "Next line", pos: 9 },
+ { kind: TokenSyntaxKind.Text, text: "Comment\nNext line", pos: 1 },
]);
});
@@ -959,54 +958,22 @@ describe("Raw Lexer", () => {
]);
});
- it("Should recognize tags", () => {
- const tokens = lex("@tag @a @abc234");
-
- equal(tokens, [
- { kind: TokenSyntaxKind.Tag, text: "@tag", pos: 0 },
- { kind: TokenSyntaxKind.Text, text: " ", pos: 4 },
- { kind: TokenSyntaxKind.Tag, text: "@a", pos: 5 },
- { kind: TokenSyntaxKind.Text, text: " ", pos: 7 },
- { kind: TokenSyntaxKind.Tag, text: "@abc234", pos: 8 },
- ]);
- });
+ it("Should not recognize tags", () => {
+ const tokens = lex("@123 @@ @ @tag @a @abc234");
- it("Should not indiscriminately create tags", () => {
- const tokens = lex("@123 @@ @");
- equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "@123 @@ @", pos: 0 },
- ]);
- });
-
- it("Should allow escaping @ to prevent a tag creation", () => {
- const tokens = lex("not a \\@tag");
- equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "not a @tag", pos: 0 },
- ]);
- });
-
- it("Should not mistake an email for a modifier tag", () => {
- const tokens = lex("test@example.com");
- equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "test@example.com", pos: 0 },
- ]);
- });
-
- it("Should not mistake a scoped package for a tag", () => {
- const tokens = lex("@typescript-eslint/parser @jest/globals");
equal(tokens, [
{
kind: TokenSyntaxKind.Text,
- text: "@typescript-eslint/parser @jest/globals",
+ text: "@123 @@ @ @tag @a @abc234",
pos: 0,
},
]);
});
- it("Should allow escaping @ in an email", () => {
- const tokens = lex("test\\@example.com");
+ it("Should allow escaping @ to prevent a tag creation", () => {
+ const tokens = lex("not a \\@tag");
equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "test@example.com", pos: 0 },
+ { kind: TokenSyntaxKind.Text, text: "not a @tag", pos: 0 },
]);
});
@@ -1061,55 +1028,6 @@ describe("Raw Lexer", () => {
]);
});
- it("Should handle tags after unclosed code", () => {
- const tokens = lex(
- dedent(`
- Text
- code? \`\` fake
- @blockTag text
- `),
- );
- equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "Text", pos: 0 },
- { kind: TokenSyntaxKind.NewLine, text: "\n", pos: 4 },
- { kind: TokenSyntaxKind.Text, text: "code? `` fake", pos: 5 },
- { kind: TokenSyntaxKind.NewLine, text: "\n", pos: 18 },
- { kind: TokenSyntaxKind.Tag, text: "@blockTag", pos: 19 },
- { kind: TokenSyntaxKind.Text, text: " text", pos: 28 },
- ]);
- });
-
- it("Should handle a full comment", () => {
- const tokens = lex(
- dedent(`
- This is a summary.
-
- @remarks
- Detailed text here with a {@link Inline | inline link}
-
- @alpha @beta
- `),
- ).map((t) => ({ kind: t.kind, text: t.text }));
-
- equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "This is a summary." },
- { kind: TokenSyntaxKind.NewLine, text: "\n" },
- { kind: TokenSyntaxKind.NewLine, text: "\n" },
- { kind: TokenSyntaxKind.Tag, text: "@remarks" },
- { kind: TokenSyntaxKind.NewLine, text: "\n" },
- { kind: TokenSyntaxKind.Text, text: "Detailed text here with a " },
- { kind: TokenSyntaxKind.OpenBrace, text: "{" },
- { kind: TokenSyntaxKind.Tag, text: "@link" },
- { kind: TokenSyntaxKind.Text, text: " Inline | inline link" },
- { kind: TokenSyntaxKind.CloseBrace, text: "}" },
- { kind: TokenSyntaxKind.NewLine, text: "\n" },
- { kind: TokenSyntaxKind.NewLine, text: "\n" },
- { kind: TokenSyntaxKind.Tag, text: "@alpha" },
- { kind: TokenSyntaxKind.Text, text: " " },
- { kind: TokenSyntaxKind.Tag, text: "@beta" },
- ]);
- });
-
it("Should handle unclosed code blocks", () => {
const tokens = lex(
dedent(`
@@ -1119,120 +1037,47 @@ describe("Raw Lexer", () => {
);
equal(tokens, [
- { kind: TokenSyntaxKind.Text, text: "Text", pos: 0 },
- { kind: TokenSyntaxKind.NewLine, text: "\n", pos: 4 },
+ { kind: TokenSyntaxKind.Text, text: "Text\n", pos: 0 },
{ kind: TokenSyntaxKind.Code, text: "```\nText", pos: 5 },
]);
});
- it("Should handle type annotations after tags at the start of a line", () => {
- const tokens = lex(`@param {string} foo`);
-
- equal(tokens, [
- { kind: TokenSyntaxKind.Tag, text: "@param", pos: 0 },
- { kind: TokenSyntaxKind.Text, text: " ", pos: 6 },
- { kind: TokenSyntaxKind.TypeAnnotation, text: "{string}", pos: 7 },
- { kind: TokenSyntaxKind.Text, text: " foo", pos: 15 },
- ]);
- });
-
- it("Should handle type annotations containing string literals", () => {
- const tokens = lex(
- dedent(`
- @param {"{{}}"}
- @param {\`\${"{}"}\`}
- @param {"text\\"more {}"}
- @param {'{'}
- EOF
- `),
- );
-
- const expectedAnnotations = [
- '{"{{}}"}',
- '{`${"{}"}`}',
- '{"text\\"more {}"}',
- "{'{'}",
- ];
-
- const expectedTokens = expectedAnnotations.flatMap((text) => [
- { kind: TokenSyntaxKind.Tag, text: "@param" },
- { kind: TokenSyntaxKind.Text, text: " " },
- { kind: TokenSyntaxKind.TypeAnnotation, text },
- { kind: TokenSyntaxKind.NewLine, text: "\n" },
- ]);
- expectedTokens.push({ kind: TokenSyntaxKind.Text, text: "EOF" });
-
- equal(
- tokens.map((t) => ({ kind: t.kind, text: t.text })),
- expectedTokens,
- );
- });
-
- it("Should handle type annotations with object literals", () => {
- const tokens = lex(
- dedent(`
- @param {{ a: string }}
- @param {{ a: string; b: { c: { d: string }} }}
- EOF
- `),
- );
-
- const expectedAnnotations = [
- "{{ a: string }}",
- "{{ a: string; b: { c: { d: string }} }}",
- ];
-
- const expectedTokens = expectedAnnotations.flatMap((text) => [
- { kind: TokenSyntaxKind.Tag, text: "@param" },
- { kind: TokenSyntaxKind.Text, text: " " },
- { kind: TokenSyntaxKind.TypeAnnotation, text },
- { kind: TokenSyntaxKind.NewLine, text: "\n" },
- ]);
- expectedTokens.push({ kind: TokenSyntaxKind.Text, text: "EOF" });
-
- equal(
- tokens.map((t) => ({ kind: t.kind, text: t.text })),
- expectedTokens,
- );
- });
-
- it("Should handle unclosed type annotations", () => {
- const tokens = lex("@type {oops");
- equal(tokens, [
- { kind: TokenSyntaxKind.Tag, text: "@type", pos: 0 },
- { kind: TokenSyntaxKind.Text, text: " ", pos: 5 },
- { kind: TokenSyntaxKind.TypeAnnotation, text: "{oops", pos: 6 },
- ]);
- });
-
- it("Should not parse inline tags as types", () => {
- const tokens = lex("@param { @link foo}");
+ it("Should allow inline tags directly next to braces", () => {
+ const tokens = lex("{@inline}");
equal(tokens, [
- { kind: TokenSyntaxKind.Tag, text: "@param", pos: 0 },
- { kind: TokenSyntaxKind.Text, text: " ", pos: 6 },
- { kind: TokenSyntaxKind.OpenBrace, text: "{", pos: 7 },
- { kind: TokenSyntaxKind.Text, text: " ", pos: 8 },
- { kind: TokenSyntaxKind.Tag, text: "@link", pos: 9 },
- { kind: TokenSyntaxKind.Text, text: " foo", pos: 14 },
- { kind: TokenSyntaxKind.CloseBrace, text: "}", pos: 18 },
+ { kind: TokenSyntaxKind.OpenBrace, text: "{", pos: 0 },
+ { kind: TokenSyntaxKind.Tag, text: "@inline", pos: 1 },
+ { kind: TokenSyntaxKind.CloseBrace, text: "}", pos: 8 },
]);
});
- it("Should allow inline tags directly next to braces", () => {
- const tokens = lex("{@inline}");
+ it("Should allow inline tags with spaces surrounding the braces", () => {
+ const tokens = lex("{ @link https://example.com example }");
equal(tokens, [
{ kind: TokenSyntaxKind.OpenBrace, text: "{", pos: 0 },
- { kind: TokenSyntaxKind.Tag, text: "@inline", pos: 1 },
- { kind: TokenSyntaxKind.CloseBrace, text: "}", pos: 8 },
+ { kind: TokenSyntaxKind.Text, text: " ", pos: 1 },
+ { kind: TokenSyntaxKind.Tag, text: "@link", pos: 2 },
+ {
+ kind: TokenSyntaxKind.Text,
+ text: " https://example.com example ",
+ pos: 7,
+ },
+ { kind: TokenSyntaxKind.CloseBrace, text: "}", pos: 36 },
]);
});
});
describe("Comment Parser", () => {
const config: CommentParserConfig = {
- blockTags: new Set(["@param", "@remarks", "@module"]),
+ blockTags: new Set([
+ "@param",
+ "@remarks",
+ "@module",
+ "@inheritDoc",
+ "@defaultValue",
+ ]),
inlineTags: new Set(["@link"]),
modifierTags: new Set([
"@public",
@@ -1249,9 +1094,96 @@ describe("Comment Parser", () => {
ignoreUnescapedBraces: false,
inheritDocTag: false,
},
+ suppressCommentWarningsInDeclarationFiles: false,
+ useTsLinkResolution: false,
+ commentStyle: "jsdoc",
};
+ it("Should recognize @defaultValue as code", () => {
+ const files = new FileRegistry();
+ const logger = new TestLogger();
+ const file = "/** @defaultValue code */";
+ const content = lexBlockComment(file);
+ const comment = parseComment(
+ content,
+ config,
+ new MinimalSourceFile(file, "<memory>"),
+ logger,
+ files,
+ );
+
+ equal(
+ comment,
+ new Comment(
+ [],
+ [
+ new CommentTag("@defaultValue", [
+ { kind: "code", text: "```ts\ncode\n```" },
+ ]),
+ ],
+ ),
+ );
+ logger.expectNoOtherMessages();
+ });
+
+ it("Should recognize @defaultValue as not code if it contains an inline tag", () => {
+ const files = new FileRegistry();
+ const logger = new TestLogger();
+ const file = "/** @defaultValue text {@link foo} */";
+ const content = lexBlockComment(file);
+ const comment = parseComment(
+ content,
+ config,
+ new MinimalSourceFile(file, "<memory>"),
+ logger,
+ files,
+ );
+
+ equal(
+ comment,
+ new Comment(
+ [],
+ [
+ new CommentTag("@defaultValue", [
+ { kind: "text", text: "text " },
+ { kind: "inline-tag", tag: "@link", text: "foo" },
+ ]),
+ ],
+ ),
+ );
+ logger.expectNoOtherMessages();
+ });
+
+ it("Should recognize @defaultValue as not code if it contains code", () => {
+ const files = new FileRegistry();
+ const logger = new TestLogger();
+ const file = "/** @defaultValue text `code` */";
+ const content = lexBlockComment(file);
+ const comment = parseComment(
+ content,
+ config,
+ new MinimalSourceFile(file, "<memory>"),
+ logger,
+ files,
+ );
+
+ equal(
+ comment,
+ new Comment(
+ [],
+ [
+ new CommentTag("@defaultValue", [
+ { kind: "text", text: "text " },
+ { kind: "code", text: "`code`" },
+ ]),
+ ],
+ ),
+ );
+ logger.expectNoOtherMessages();
+ });
+
it("Should rewrite @inheritdoc to @inheritDoc", () => {
+ const files = new FileRegistry();
const logger = new TestLogger();
const file = "/** @inheritdoc */";
const content = lexBlockComment(file);
@@ -1260,6 +1192,7 @@ describe("Comment Parser", () => {
config,
new MinimalSourceFile(file, "<memory>"),
logger,
+ files,
);
logger.expectMessage(
@@ -1269,7 +1202,9 @@ describe("Comment Parser", () => {
equal(comment, new Comment([], [new CommentTag("@inheritDoc", [])]));
});
+ let files: FileRegistry;
function getComment(text: string) {
+ files = new FileRegistry();
const logger = new TestLogger();
const content = lexBlockComment(text);
const comment = parseComment(
@@ -1277,11 +1212,16 @@ describe("Comment Parser", () => {
config,
new MinimalSourceFile(text, "<memory>"),
logger,
+ files,
);
logger.expectNoOtherMessages();
return comment;
}
+ afterEach(() => {
+ files = undefined!;
+ });
+
it("Simple summary", () => {
const comment = getComment("/** Summary! */");
equal(comment.summary, [{ kind: "text", text: "Summary!" }]);
@@ -1415,6 +1355,161 @@ describe("Comment Parser", () => {
equal(comment.blockTags, [tag]);
equal(comment.modifierTags, new Set());
});
+
+ it("Recognizes markdown links", () => {
+ const comment = getComment(`/**
+ * [text](./relative.md) 
+ * Not relative: [passwd](/etc/passwd) [Windows](C:\\\\\\\\Windows) [example.com](http://example.com) [hash](#hash)
+ */`);
+
+ equal(comment.summary, [
+ { kind: "text", text: "[text](" },
+ { kind: "relative-link", text: "./relative.md", target: 1 },
+ { kind: "text", text: ") ![](" },
+ { kind: "relative-link", text: "image.png", target: 2 },
+ {
+ kind: "text",
+ text: ")\nNot relative: [passwd](/etc/passwd) [Windows](C:\\\\\\\\Windows) [example.com](http://example.com) [hash](#hash)",
+ },
+ ] satisfies CommentDisplayPart[]);
+ });
+
+ it("#2606 Recognizes markdown links which contain inline code in the label", () => {
+ const comment = getComment(`/**
+ * [\`text\`](./relative.md)
+ * [\`text\`
+ * more](./relative.md)
+ * [\`text\`
+ *
+ * more](./relative.md)
+ */`);
+
+ equal(comment.summary, [
+ // Simple case with code
+ { kind: "text", text: "[" },
+ { kind: "code", text: "`text`" },
+ { kind: "text", text: "](" },
+ { kind: "relative-link", text: "./relative.md", target: 1 },
+ // Labels can also include single newlines
+ { kind: "text", text: ")\n[" },
+ { kind: "code", text: "`text`" },
+ { kind: "text", text: "\nmore](" },
+ { kind: "relative-link", text: "./relative.md", target: 1 },
+ // But not double!
+ { kind: "text", text: ")\n[" },
+ { kind: "code", text: "`text`" },
+ { kind: "text", text: "\n\nmore](./relative.md)" },
+ ] satisfies CommentDisplayPart[]);
+ });
+
+ it("Recognizes markdown links which contain inline code in the label", () => {
+ const comment = getComment(`/**
+ * [\`text\`](./relative.md)
+ */`);
+
+ equal(comment.summary, [
+ { kind: "text", text: "[" },
+ { kind: "code", text: "`text`" },
+ { kind: "text", text: "](" },
+ { kind: "relative-link", text: "./relative.md", target: 1 },
+ { kind: "text", text: ")" },
+ ] satisfies CommentDisplayPart[]);
+ });
+
+ it("Recognizes markdown reference definition blocks", () => {
+ const comment = getComment(`/**
+ * [1]: ./example.md
+ * [2]:<./example with space>
+ * [3]: https://example.com
+ * [4]: #hash
+ */`);
+
+ equal(comment.summary, [
+ { kind: "text", text: "[1]: " },
+ { kind: "relative-link", text: "./example.md", target: 1 },
+ { kind: "text", text: "\n[2]:" },
+ {
+ kind: "relative-link",
+ text: "<./example with space>",
+ target: 2,
+ },
+ {
+ kind: "text",
+ text: "\n[3]: https://example.com\n[4]: #hash",
+ },
+ ] satisfies CommentDisplayPart[]);
+ });
+
+ it("Does not mistake mailto: links as relative paths", () => {
+ const comment = getComment(`/**
+ * [1]: mailto:example@example.com
+ */`);
+
+ equal(comment.summary, [
+ { kind: "text", text: "[1]: mailto:example@example.com" },
+ ] satisfies CommentDisplayPart[]);
+ });
+
+ it("Recognizes HTML image links", () => {
+ const comment = getComment(`/**
+ * <img width=100 height="200" src="./test.png" >
+ * <img src="./test space.png"/>
+ * <img src="https://example.com/favicon.ico">
+ */`);
+
+ equal(comment.summary, [
+ { kind: "text", text: '<img width=100 height="200" src="' },
+ { kind: "relative-link", text: "./test.png", target: 1 },
+ { kind: "text", text: '" >\n<img src="' },
+ {
+ kind: "relative-link",
+ text: "./test space.png",
+ target: 2,
+ },
+ {
+ kind: "text",
+ text: '"/>\n<img src="https://example.com/favicon.ico">',
+ },
+ ] satisfies CommentDisplayPart[]);
+ });
+
+ it("Recognizes HTML anchor links", () => {
+ const comment = getComment(`/**
+ * <a data-foo="./path.txt" href="./test.png" >
+ * <a href="./test space.png"/>
+ * <a href="https://example.com/favicon.ico">
+ * <a href="#hash">
+ */`);
+
+ equal(comment.summary, [
+ { kind: "text", text: '<a data-foo="./path.txt" href="' },
+ { kind: "relative-link", text: "./test.png", target: 1 },
+ { kind: "text", text: '" >\n<a href="' },
+ {
+ kind: "relative-link",
+ text: "./test space.png",
+ target: 2,
+ },
+ {
+ kind: "text",
+ text: '"/>\n<a href="https://example.com/favicon.ico">\n<a href="#hash">',
+ },
+ ] satisfies CommentDisplayPart[]);
+ });
+
+ it("Properly handles character escapes", () => {
+ const comment = getComment(`/**
+ * <a href="./&a.png" >
+ */`);
+
+ equal(comment.summary, [
+ { kind: "text", text: '<a href="' },
+ { kind: "relative-link", text: "./&a.png", target: 1 },
+ { kind: "text", text: '" >' },
+ ] satisfies CommentDisplayPart[]);
+
+ equal(files.getName(1), "&a.png");
+ });
});
describe("extractTagName", () => {
diff --git a/src/test/converter.test.ts b/src/test/converter.test.ts
index cecbc29a3..49ab152e0 100644
--- a/src/test/converter.test.ts
+++ b/src/test/converter.test.ts
@@ -8,21 +8,28 @@ import {
Reflection,
ReflectionCategory,
ReflectionGroup,
- JSONOutput,
+ type JSONOutput,
CommentTag,
ReferenceType,
Comment,
- CommentDisplayPart,
+ type CommentDisplayPart,
SourceReference,
ReferenceReflection,
} from "..";
-import type { ModelToObject } from "../lib/serialization/schema";
+import type {
+ SomeReflection,
+ ModelToObject,
+} from "../lib/serialization/schema";
import { getExpandedEntryPointsForPaths } from "../lib/utils";
import {
getConverterApp,
getConverterBase,
getConverterProgram,
} from "./programs";
+import {
+ FileRegistry,
+ ValidatingFileRegistry,
+} from "../lib/models/FileRegistry";
const comparisonSerializer = new Serializer();
comparisonSerializer.addSerializer({
@@ -54,7 +61,7 @@ comparisonSerializer.addSerializer({
return obj;
},
});
-comparisonSerializer.addSerializer({
+comparisonSerializer.addSerializer<CommentTag>({
priority: 0,
supports(x) {
return x instanceof CommentTag;
@@ -73,7 +80,7 @@ comparisonSerializer.addSerializer({
return obj;
},
});
-comparisonSerializer.addSerializer({
+comparisonSerializer.addSerializer<SomeReflection>({
priority: 0,
supports(x) {
return x instanceof Reflection;
@@ -99,7 +106,7 @@ comparisonSerializer.addSerializer({
return x instanceof ReflectionCategory || x instanceof ReflectionGroup;
},
toObject(refl: ReflectionCategory | ReflectionGroup, obj: any) {
- obj.children = refl.children?.map((c) => c.getFullName());
+ obj.children = refl.children.map((c) => c.getFullName());
return obj;
},
});
@@ -128,7 +135,7 @@ comparisonSerializer.addSerializer({
},
toObject(project: ProjectReflection, obj: JSONOutput.ProjectReflection) {
const idMap: Record<string, JSONOutput.ReflectionSymbolId> = {};
- for (const [k, v] of Object.entries(obj.symbolIdMap!)) {
+ for (const [k, v] of Object.entries(obj.symbolIdMap || {})) {
idMap[project.getReflectionById(+k)!.getFullName()] = v;
}
obj.symbolIdMap = idMap;
@@ -136,6 +143,16 @@ comparisonSerializer.addSerializer({
return obj;
},
});
+comparisonSerializer.addSerializer({
+ priority: -1,
+ supports(obj) {
+ return obj instanceof FileRegistry;
+ },
+ toObject(_media: FileRegistry, obj: JSONOutput.FileRegistry) {
+ obj.reflections = {};
+ return obj;
+ },
+});
describe("Converter", function () {
const base = getConverterBase();
@@ -187,6 +204,7 @@ describe("Converter", function () {
it(`[${file}] converts fixtures`, function () {
before();
resetReflectionID();
+ app.files = new ValidatingFileRegistry();
const entryPoints = getExpandedEntryPointsForPaths(
app.logger,
[path],
@@ -217,7 +235,12 @@ describe("Converter", function () {
});
it(`[${file}] round trips revival`, () => {
- const revived = app.deserializer.reviveProject(specs);
+ const revived = app.deserializer.reviveProject(
+ specs,
+ specs.name,
+ process.cwd(),
+ new FileRegistry(),
+ );
const specs2 = JSON.parse(
JSON.stringify(
comparisonSerializer.projectToObject(
diff --git a/src/test/converter/alias/specs.json b/src/test/converter/alias/specs.json
index 1d1bc0050..45f545373 100644
--- a/src/test/converter/alias/specs.json
+++ b/src/test/converter/alias/specs.json
@@ -362,5 +362,13 @@
"sourceFileName": "src/test/converter/alias/alias.ts",
"qualifiedName": "MergedCrossReference"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/alias/alias.ts"
+ },
+ "reflections": {
+ "1": 0
+ }
}
}
diff --git a/src/test/converter/class/specs-with-lump-categories.json b/src/test/converter/class/specs-with-lump-categories.json
index 4b308824e..ebdd6b2d3 100644
--- a/src/test/converter/class/specs-with-lump-categories.json
+++ b/src/test/converter/class/specs-with-lump-categories.json
@@ -1803,7 +1803,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isPublic": true
+ "isPublic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -1837,7 +1838,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isStatic": true
+ "isStatic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -1872,7 +1874,9 @@
"name": "arrowMethod",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "class.ts",
@@ -1887,7 +1891,9 @@
"name": "arrowMethod",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"comment": {
"summary": [
{
@@ -2083,7 +2089,8 @@
"variant": "declaration",
"kind": 2048,
"flags": {
- "isStatic": true
+ "isStatic": true,
+ "isInherited": true
},
"sources": [
{
@@ -2099,7 +2106,9 @@
"name": "staticMethod",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"comment": {
"summary": [
{
@@ -2746,7 +2755,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isReadonly": true
+ "isReadonly": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -2780,7 +2790,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isPublic": true
+ "isPublic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -2814,7 +2825,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isPublic": true
+ "isPublic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -4089,7 +4101,7 @@
"url": "typedoc://generic-class.ts#L20"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 170,
"name": "T",
@@ -4423,7 +4435,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isProtected": true
+ "isProtected": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -4457,7 +4470,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isProtected": true
+ "isProtected": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -4493,7 +4507,9 @@
"name": "getValue",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "generic-class.ts",
@@ -4508,7 +4524,9 @@
"name": "getValue",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"comment": {
"summary": [
{
@@ -5031,7 +5049,7 @@
"variant": "signature",
"kind": 16384,
"flags": {},
- "typeParameter": [
+ "typeParameters": [
{
"id": 214,
"name": "T",
@@ -6066,5 +6084,29 @@
"sourceFileName": "src/test/converter/class/type-operator.ts",
"qualifiedName": "GenericClass.T"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/class/access.ts",
+ "2": "src/test/converter/class/class.ts",
+ "3": "src/test/converter/class/constructor-properties.ts",
+ "4": "src/test/converter/class/decorators.ts",
+ "5": "src/test/converter/class/events-overloads.ts",
+ "6": "src/test/converter/class/events.ts",
+ "7": "src/test/converter/class/generic-class.ts",
+ "8": "src/test/converter/class/getter-setter.ts",
+ "9": "src/test/converter/class/type-operator.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 21,
+ "3": 94,
+ "4": 115,
+ "5": 134,
+ "6": 161,
+ "7": 166,
+ "8": 185,
+ "9": 205
+ }
}
}
diff --git a/src/test/converter/class/specs.json b/src/test/converter/class/specs.json
index 4b308824e..ebdd6b2d3 100644
--- a/src/test/converter/class/specs.json
+++ b/src/test/converter/class/specs.json
@@ -1803,7 +1803,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isPublic": true
+ "isPublic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -1837,7 +1838,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isStatic": true
+ "isStatic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -1872,7 +1874,9 @@
"name": "arrowMethod",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "class.ts",
@@ -1887,7 +1891,9 @@
"name": "arrowMethod",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"comment": {
"summary": [
{
@@ -2083,7 +2089,8 @@
"variant": "declaration",
"kind": 2048,
"flags": {
- "isStatic": true
+ "isStatic": true,
+ "isInherited": true
},
"sources": [
{
@@ -2099,7 +2106,9 @@
"name": "staticMethod",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"comment": {
"summary": [
{
@@ -2746,7 +2755,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isReadonly": true
+ "isReadonly": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -2780,7 +2790,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isPublic": true
+ "isPublic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -2814,7 +2825,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isPublic": true
+ "isPublic": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -4089,7 +4101,7 @@
"url": "typedoc://generic-class.ts#L20"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 170,
"name": "T",
@@ -4423,7 +4435,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isProtected": true
+ "isProtected": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -4457,7 +4470,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isProtected": true
+ "isProtected": true,
+ "isInherited": true
},
"comment": {
"summary": [
@@ -4493,7 +4507,9 @@
"name": "getValue",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "generic-class.ts",
@@ -4508,7 +4524,9 @@
"name": "getValue",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"comment": {
"summary": [
{
@@ -5031,7 +5049,7 @@
"variant": "signature",
"kind": 16384,
"flags": {},
- "typeParameter": [
+ "typeParameters": [
{
"id": 214,
"name": "T",
@@ -6066,5 +6084,29 @@
"sourceFileName": "src/test/converter/class/type-operator.ts",
"qualifiedName": "GenericClass.T"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/class/access.ts",
+ "2": "src/test/converter/class/class.ts",
+ "3": "src/test/converter/class/constructor-properties.ts",
+ "4": "src/test/converter/class/decorators.ts",
+ "5": "src/test/converter/class/events-overloads.ts",
+ "6": "src/test/converter/class/events.ts",
+ "7": "src/test/converter/class/generic-class.ts",
+ "8": "src/test/converter/class/getter-setter.ts",
+ "9": "src/test/converter/class/type-operator.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 21,
+ "3": 94,
+ "4": 115,
+ "5": 134,
+ "6": 161,
+ "7": 166,
+ "8": 185,
+ "9": 205
+ }
}
}
diff --git a/src/test/converter/comment/comment.ts b/src/test/converter/comment/comment.ts
index 8f84e9263..04898ae8b 100644
--- a/src/test/converter/comment/comment.ts
+++ b/src/test/converter/comment/comment.ts
@@ -25,7 +25,6 @@ import "./comment2";
* }
* ```
* @deprecated
- * @todo something
*
* @type {Data<object>} will also be removed
*
@@ -84,3 +83,13 @@ export class CommentedClass {
*/
ignoredprop: string;
}
+
+export type UnionWithCommentsOnMembers =
+ /**
+ * Doc of foo1.
+ */
+ | "foo1"
+ /**
+ * Doc of foo2.
+ */
+ | "foo2";
diff --git a/src/test/converter/comment/specs.json b/src/test/converter/comment/specs.json
index 81789794b..883a708cc 100644
--- a/src/test/converter/comment/specs.json
+++ b/src/test/converter/comment/specs.json
@@ -33,15 +33,6 @@
{
"tag": "@deprecated",
"content": []
- },
- {
- "tag": "@todo",
- "content": [
- {
- "kind": "text",
- "text": "something"
- }
- ]
}
]
},
@@ -85,9 +76,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 39,
+ "line": 38,
"character": 4,
- "url": "typedoc://comment.ts#L39"
+ "url": "typedoc://comment.ts#L38"
}
],
"type": {
@@ -104,9 +95,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 79,
+ "line": 78,
"character": 4,
- "url": "typedoc://comment.ts#L79"
+ "url": "typedoc://comment.ts#L78"
}
],
"signatures": [
@@ -127,9 +118,9 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 79,
+ "line": 78,
"character": 4,
- "url": "typedoc://comment.ts#L79"
+ "url": "typedoc://comment.ts#L78"
}
],
"parameters": [
@@ -193,11 +184,53 @@
"sources": [
{
"fileName": "comment.ts",
- "line": 35,
+ "line": 34,
"character": 13,
- "url": "typedoc://comment.ts#L35"
+ "url": "typedoc://comment.ts#L34"
}
]
+ },
+ {
+ "id": 26,
+ "name": "UnionWithCommentsOnMembers",
+ "variant": "declaration",
+ "kind": 2097152,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "comment.ts",
+ "line": 87,
+ "character": 12,
+ "url": "typedoc://comment.ts#L87"
+ }
+ ],
+ "type": {
+ "type": "union",
+ "types": [
+ {
+ "type": "literal",
+ "value": "foo1"
+ },
+ {
+ "type": "literal",
+ "value": "foo2"
+ }
+ ],
+ "elementSummaries": [
+ [
+ {
+ "kind": "text",
+ "text": "Doc of foo1."
+ }
+ ],
+ [
+ {
+ "kind": "text",
+ "text": "Doc of foo2."
+ }
+ ]
+ ]
+ }
}
],
"groups": [
@@ -206,6 +239,12 @@
"children": [
2
]
+ },
+ {
+ "title": "Type Aliases",
+ "children": [
+ 26
+ ]
}
],
"sources": [
@@ -218,7 +257,7 @@
]
},
{
- "id": 26,
+ "id": 27,
"name": "comment2",
"variant": "declaration",
"kind": 2,
@@ -241,7 +280,7 @@
},
"children": [
{
- "id": 27,
+ "id": 28,
"name": "multiply",
"variant": "declaration",
"kind": 64,
@@ -256,7 +295,7 @@
],
"signatures": [
{
- "id": 28,
+ "id": 29,
"name": "multiply",
"variant": "signature",
"kind": 4096,
@@ -271,7 +310,7 @@
],
"parameters": [
{
- "id": 29,
+ "id": 30,
"name": "a",
"variant": "param",
"kind": 32768,
@@ -282,7 +321,7 @@
}
},
{
- "id": 30,
+ "id": 31,
"name": "b",
"variant": "param",
"kind": 32768,
@@ -305,7 +344,7 @@
{
"title": "Functions",
"children": [
- 27
+ 28
]
}
],
@@ -319,7 +358,7 @@
]
},
{
- "id": 31,
+ "id": 32,
"name": "comment3",
"variant": "declaration",
"kind": 2,
@@ -342,7 +381,7 @@
},
"children": [
{
- "id": 32,
+ "id": 33,
"name": "multiply",
"variant": "declaration",
"kind": 64,
@@ -357,7 +396,7 @@
],
"signatures": [
{
- "id": 33,
+ "id": 34,
"name": "multiply",
"variant": "signature",
"kind": 4096,
@@ -372,7 +411,7 @@
],
"parameters": [
{
- "id": 34,
+ "id": 35,
"name": "a",
"variant": "param",
"kind": 32768,
@@ -383,7 +422,7 @@
}
},
{
- "id": 35,
+ "id": 36,
"name": "b",
"variant": "param",
"kind": 32768,
@@ -406,7 +445,7 @@
{
"title": "Functions",
"children": [
- 32
+ 33
]
}
],
@@ -420,7 +459,7 @@
]
},
{
- "id": 36,
+ "id": 37,
"name": "comment4",
"variant": "declaration",
"kind": 2,
@@ -439,7 +478,7 @@
},
"children": [
{
- "id": 37,
+ "id": 38,
"name": "multiply",
"variant": "declaration",
"kind": 64,
@@ -454,7 +493,7 @@
],
"signatures": [
{
- "id": 38,
+ "id": 39,
"name": "multiply",
"variant": "signature",
"kind": 4096,
@@ -469,7 +508,7 @@
],
"parameters": [
{
- "id": 39,
+ "id": 40,
"name": "a",
"variant": "param",
"kind": 32768,
@@ -480,7 +519,7 @@
}
},
{
- "id": 40,
+ "id": 41,
"name": "b",
"variant": "param",
"kind": 32768,
@@ -503,7 +542,7 @@
{
"title": "Functions",
"children": [
- 37
+ 38
]
}
],
@@ -522,9 +561,9 @@
"title": "Modules",
"children": [
1,
- 26,
- 31,
- 36
+ 27,
+ 32,
+ 37
]
}
],
@@ -559,12 +598,12 @@
"qualifiedName": "arg2"
},
"26": {
- "sourceFileName": "src/test/converter/comment/comment2.ts",
- "qualifiedName": ""
+ "sourceFileName": "src/test/converter/comment/comment.ts",
+ "qualifiedName": "UnionWithCommentsOnMembers"
},
"27": {
"sourceFileName": "src/test/converter/comment/comment2.ts",
- "qualifiedName": "multiply"
+ "qualifiedName": ""
},
"28": {
"sourceFileName": "src/test/converter/comment/comment2.ts",
@@ -572,19 +611,19 @@
},
"29": {
"sourceFileName": "src/test/converter/comment/comment2.ts",
- "qualifiedName": "a"
+ "qualifiedName": "multiply"
},
"30": {
"sourceFileName": "src/test/converter/comment/comment2.ts",
- "qualifiedName": "b"
+ "qualifiedName": "a"
},
"31": {
- "sourceFileName": "src/test/converter/comment/comment3.ts",
- "qualifiedName": ""
+ "sourceFileName": "src/test/converter/comment/comment2.ts",
+ "qualifiedName": "b"
},
"32": {
"sourceFileName": "src/test/converter/comment/comment3.ts",
- "qualifiedName": "multiply"
+ "qualifiedName": ""
},
"33": {
"sourceFileName": "src/test/converter/comment/comment3.ts",
@@ -592,19 +631,19 @@
},
"34": {
"sourceFileName": "src/test/converter/comment/comment3.ts",
- "qualifiedName": "a"
+ "qualifiedName": "multiply"
},
"35": {
"sourceFileName": "src/test/converter/comment/comment3.ts",
- "qualifiedName": "b"
+ "qualifiedName": "a"
},
"36": {
- "sourceFileName": "src/test/converter/comment/comment4.ts",
- "qualifiedName": ""
+ "sourceFileName": "src/test/converter/comment/comment3.ts",
+ "qualifiedName": "b"
},
"37": {
"sourceFileName": "src/test/converter/comment/comment4.ts",
- "qualifiedName": "multiply"
+ "qualifiedName": ""
},
"38": {
"sourceFileName": "src/test/converter/comment/comment4.ts",
@@ -612,11 +651,29 @@
},
"39": {
"sourceFileName": "src/test/converter/comment/comment4.ts",
- "qualifiedName": "a"
+ "qualifiedName": "multiply"
},
"40": {
+ "sourceFileName": "src/test/converter/comment/comment4.ts",
+ "qualifiedName": "a"
+ },
+ "41": {
"sourceFileName": "src/test/converter/comment/comment4.ts",
"qualifiedName": "b"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/comment/comment.ts",
+ "2": "src/test/converter/comment/comment2.ts",
+ "3": "src/test/converter/comment/comment3.ts",
+ "4": "src/test/converter/comment/comment4.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 27,
+ "3": 32,
+ "4": 37
+ }
}
}
diff --git a/src/test/converter/declaration/specs.json b/src/test/converter/declaration/specs.json
index 55a422a3f..e8e9d729e 100644
--- a/src/test/converter/declaration/specs.json
+++ b/src/test/converter/declaration/specs.json
@@ -349,5 +349,17 @@
"sourceFileName": "src/test/converter/declaration/external.d.ts",
"qualifiedName": "ActionSet"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/declaration/declaration.d.ts",
+ "2": "src/test/converter/declaration/export-declaration.d.ts",
+ "3": "src/test/converter/declaration/external.d.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 7,
+ "3": 14
+ }
}
}
diff --git a/src/test/converter/enum/specs.json b/src/test/converter/enum/specs.json
index c9efd3c7c..624069bcc 100644
--- a/src/test/converter/enum/specs.json
+++ b/src/test/converter/enum/specs.json
@@ -516,5 +516,13 @@
"sourceFileName": "src/test/converter/enum/enum.ts",
"qualifiedName": "ConstEnum.b"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/enum/enum.ts"
+ },
+ "reflections": {
+ "1": 0
+ }
}
}
diff --git a/src/test/converter/enum/specs.nodoc.json b/src/test/converter/enum/specs.nodoc.json
index c9efd3c7c..624069bcc 100644
--- a/src/test/converter/enum/specs.nodoc.json
+++ b/src/test/converter/enum/specs.nodoc.json
@@ -516,5 +516,13 @@
"sourceFileName": "src/test/converter/enum/enum.ts",
"qualifiedName": "ConstEnum.b"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/enum/enum.ts"
+ },
+ "reflections": {
+ "1": 0
+ }
}
}
diff --git a/src/test/converter/exports/specs.json b/src/test/converter/exports/specs.json
index 6e8c044dd..e888ba424 100644
--- a/src/test/converter/exports/specs.json
+++ b/src/test/converter/exports/specs.json
@@ -1161,5 +1161,23 @@
"sourceFileName": "src/test/converter/exports/mod.ts",
"qualifiedName": "GH1453Helper"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/exports/export-assignment.ts",
+ "2": "src/test/converter/exports/export-default.ts",
+ "3": "src/test/converter/exports/export-with-local.ts",
+ "4": "src/test/converter/exports/export.ts",
+ "5": "src/test/converter/exports/mod.ts",
+ "6": "src/test/converter/exports/no-doc-members.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 6,
+ "3": 8,
+ "4": 14,
+ "5": 29,
+ "6": 38
+ }
}
}
diff --git a/src/test/converter/exports/specs.nodoc.json b/src/test/converter/exports/specs.nodoc.json
index 731cc3279..efa9f878e 100644
--- a/src/test/converter/exports/specs.nodoc.json
+++ b/src/test/converter/exports/specs.nodoc.json
@@ -326,5 +326,20 @@
"sourceFileName": "src/test/converter/exports/mod.ts",
"qualifiedName": "b"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/exports/export-assignment.ts",
+ "2": "src/test/converter/exports/export-default.ts",
+ "3": "src/test/converter/exports/export-with-local.ts",
+ "4": "src/test/converter/exports/export.ts",
+ "5": "src/test/converter/exports/mod.ts",
+ "6": "src/test/converter/exports/no-doc-members.ts"
+ },
+ "reflections": {
+ "4": 14,
+ "5": 29,
+ "6": 38
+ }
}
}
diff --git a/src/test/converter/function/function.ts b/src/test/converter/function/function.ts
index c0a4ed128..c07486051 100644
--- a/src/test/converter/function/function.ts
+++ b/src/test/converter/function/function.ts
@@ -95,12 +95,12 @@ export function multipleSignatures(value: string): string;
export function multipleSignatures(value: { name: string }): string;
/**
- * This is the actual implementation, this comment will not be visible
- * in the generated documentation. The `@inheritdoc` tag can not be used
- * to pull content from this signature into documentation for the real
- * signatures.
- *
- * @return This is the return value of the function.
+ * This comment is on the actual implementation of the function.
+ * TypeDoc used to allow this for providing "default" comments that would be
+ * copied to each signature. It no longer does this, and instead treats
+ * this comment as belonging to the function reflection itself.
+ * Any `@param` or `@returns` tags within this comment won't be applied
+ * to signatures.
*/
export function multipleSignatures(): string {
if (arguments.length > 0) {
diff --git a/src/test/converter/function/specs.json b/src/test/converter/function/specs.json
index 95c195124..c4c9a1ffd 100644
--- a/src/test/converter/function/specs.json
+++ b/src/test/converter/function/specs.json
@@ -425,6 +425,14 @@
"variant": "declaration",
"kind": 64,
"flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Returns true if fn returns true for every item in the iterator\n\nReturns true if the iterator is empty"
+ }
+ ]
+ },
"sources": [
{
"fileName": "function.ts",
@@ -440,14 +448,6 @@
"variant": "signature",
"kind": 4096,
"flags": {},
- "comment": {
- "summary": [
- {
- "kind": "text",
- "text": "Returns true if fn returns true for every item in the iterator\n\nReturns true if the iterator is empty"
- }
- ]
- },
"sources": [
{
"fileName": "function.ts",
@@ -456,7 +456,7 @@
"url": "typedoc://function.ts#L198"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 78,
"name": "T",
@@ -565,14 +565,6 @@
"variant": "signature",
"kind": 4096,
"flags": {},
- "comment": {
- "summary": [
- {
- "kind": "text",
- "text": "Returns true if fn returns true for every item in the iterator\n\nReturns true if the iterator is empty"
- }
- ]
- },
"sources": [
{
"fileName": "function.ts",
@@ -581,7 +573,7 @@
"url": "typedoc://function.ts#L199"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 85,
"name": "T",
@@ -760,7 +752,7 @@
"url": "typedoc://function.ts#L145"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 47,
"name": "T",
@@ -1527,7 +1519,7 @@
"url": "typedoc://function.ts#L157"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 51,
"name": "T",
@@ -1745,6 +1737,30 @@
"variant": "declaration",
"kind": 64,
"flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "This comment is on the actual implementation of the function.\nTypeDoc used to allow this for providing \"default\" comments that would be\ncopied to each signature. It no longer does this, and instead treats\nthis comment as belonging to the function reflection itself.\nAny "
+ },
+ {
+ "kind": "code",
+ "text": "`@param`"
+ },
+ {
+ "kind": "text",
+ "text": " or "
+ },
+ {
+ "kind": "code",
+ "text": "`@returns`"
+ },
+ {
+ "kind": "text",
+ "text": " tags within this comment won't be applied\nto signatures."
+ }
+ ]
+ },
"sources": [
{
"fileName": "function.ts",
@@ -1921,6 +1937,14 @@
"variant": "declaration",
"kind": 64,
"flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "This is a function that is assigned to a variable."
+ }
+ ]
+ },
"sources": [
{
"fileName": "function.ts",
@@ -1937,12 +1961,7 @@
"kind": 4096,
"flags": {},
"comment": {
- "summary": [
- {
- "kind": "text",
- "text": "This is a function that is assigned to a variable."
- }
- ],
+ "summary": [],
"blockTags": [
{
"tag": "@returns",
@@ -2090,7 +2109,7 @@
"url": "typedoc://generic-function.ts#L18"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 100,
"name": "T",
@@ -2190,7 +2209,7 @@
"url": "typedoc://generic-function.ts#L29"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 105,
"name": "T",
@@ -2289,7 +2308,7 @@
"url": "typedoc://generic-function.ts#L7"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 96,
"name": "T",
@@ -3110,5 +3129,17 @@
"sourceFileName": "src/test/converter/function/implicit-types.ts",
"qualifiedName": "BreakpointRange.end"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/function/function.ts",
+ "2": "src/test/converter/function/generic-function.ts",
+ "3": "src/test/converter/function/implicit-types.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 93,
+ "3": 107
+ }
}
}
diff --git a/src/test/converter/inherit-param-doc/inherit-param-doc.ts b/src/test/converter/inherit-param-doc/inherit-param-doc.ts
index 50ece38d1..58fc3f69b 100644
--- a/src/test/converter/inherit-param-doc/inherit-param-doc.ts
+++ b/src/test/converter/inherit-param-doc/inherit-param-doc.ts
@@ -4,11 +4,18 @@ export interface Base {
* @param b - Parameter B.
*/
method1(a: number, b: string): void;
+ /**
+ * @param a - Parameter A.
+ * @param b - Parameter B.
+ */
+ method2(a: number, b: string): void;
}
export class Class1 implements Base {
/** @inheritDoc */
method1(a: number, b: string): void {}
+ /** @inheritDoc */
+ method2(): void {}
}
export class Class2 implements Base {
@@ -18,6 +25,12 @@ export class Class2 implements Base {
* @param a - Custom parameter A doc.
*/
method1(a: number, b: string): void {}
+ /**
+ * @inheritDoc
+ *
+ * @param a - Custom parameter A doc.
+ */
+ method2(a: number): void {}
}
export class Class3 implements Base {
@@ -27,4 +40,5 @@ export class Class3 implements Base {
* @param c - Custom second parameter doc with name change.
*/
method1(a: number, c: string): void {}
+ method2(a: number): void {}
}
diff --git a/src/test/converter/inherit-param-doc/specs.json b/src/test/converter/inherit-param-doc/specs.json
index e03b60da2..264c557bf 100644
--- a/src/test/converter/inherit-param-doc/specs.json
+++ b/src/test/converter/inherit-param-doc/specs.json
@@ -6,28 +6,28 @@
"flags": {},
"children": [
{
- "id": 6,
+ "id": 10,
"name": "Class1",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
- "id": 7,
+ "id": 11,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
- "id": 8,
+ "id": 12,
"name": "new Class1",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
- "target": 6,
+ "target": 10,
"name": "Class1",
"package": "typedoc"
}
@@ -35,7 +35,7 @@
]
},
{
- "id": 9,
+ "id": 13,
"name": "method1",
"variant": "declaration",
"kind": 2048,
@@ -43,14 +43,14 @@
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 11,
+ "line": 16,
"character": 4,
- "url": "typedoc://inherit-param-doc.ts#L11"
+ "url": "typedoc://inherit-param-doc.ts#L16"
}
],
"signatures": [
{
- "id": 10,
+ "id": 14,
"name": "method1",
"variant": "signature",
"kind": 4096,
@@ -58,14 +58,14 @@
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 11,
+ "line": 16,
"character": 4,
- "url": "typedoc://inherit-param-doc.ts#L11"
+ "url": "typedoc://inherit-param-doc.ts#L16"
}
],
"parameters": [
{
- "id": 11,
+ "id": 15,
"name": "a",
"variant": "param",
"kind": 32768,
@@ -84,7 +84,7 @@
}
},
{
- "id": 12,
+ "id": 16,
"name": "b",
"variant": "param",
"kind": 32768,
@@ -119,28 +119,75 @@
"target": 2,
"name": "Base.method1"
}
+ },
+ {
+ "id": 17,
+ "name": "method2",
+ "variant": "declaration",
+ "kind": 2048,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 18,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L18"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 18,
+ "name": "method2",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 18,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L18"
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "void"
+ },
+ "implementationOf": {
+ "type": "reference",
+ "target": 7,
+ "name": "Base.method2"
+ }
+ }
+ ],
+ "implementationOf": {
+ "type": "reference",
+ "target": 6,
+ "name": "Base.method2"
+ }
}
],
"groups": [
{
"title": "Constructors",
"children": [
- 7
+ 11
]
},
{
"title": "Methods",
"children": [
- 9
+ 13,
+ 17
]
}
],
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 9,
+ "line": 14,
"character": 13,
- "url": "typedoc://inherit-param-doc.ts#L9"
+ "url": "typedoc://inherit-param-doc.ts#L14"
}
],
"implementedTypes": [
@@ -153,28 +200,28 @@
]
},
{
- "id": 13,
+ "id": 19,
"name": "Class2",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
- "id": 14,
+ "id": 20,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
- "id": 15,
+ "id": 21,
"name": "new Class2",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
- "target": 13,
+ "target": 19,
"name": "Class2",
"package": "typedoc"
}
@@ -182,7 +229,7 @@
]
},
{
- "id": 16,
+ "id": 22,
"name": "method1",
"variant": "declaration",
"kind": 2048,
@@ -190,14 +237,14 @@
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 20,
+ "line": 27,
"character": 4,
- "url": "typedoc://inherit-param-doc.ts#L20"
+ "url": "typedoc://inherit-param-doc.ts#L27"
}
],
"signatures": [
{
- "id": 17,
+ "id": 23,
"name": "method1",
"variant": "signature",
"kind": 4096,
@@ -205,14 +252,14 @@
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 20,
+ "line": 27,
"character": 4,
- "url": "typedoc://inherit-param-doc.ts#L20"
+ "url": "typedoc://inherit-param-doc.ts#L27"
}
],
"parameters": [
{
- "id": 18,
+ "id": 24,
"name": "a",
"variant": "param",
"kind": 32768,
@@ -231,7 +278,7 @@
}
},
{
- "id": 19,
+ "id": 25,
"name": "b",
"variant": "param",
"kind": 32768,
@@ -266,28 +313,96 @@
"target": 2,
"name": "Base.method1"
}
+ },
+ {
+ "id": 26,
+ "name": "method2",
+ "variant": "declaration",
+ "kind": 2048,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 33,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L33"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 27,
+ "name": "method2",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 33,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L33"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 28,
+ "name": "a",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Custom parameter A doc."
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "void"
+ },
+ "implementationOf": {
+ "type": "reference",
+ "target": 7,
+ "name": "Base.method2"
+ }
+ }
+ ],
+ "implementationOf": {
+ "type": "reference",
+ "target": 6,
+ "name": "Base.method2"
+ }
}
],
"groups": [
{
"title": "Constructors",
"children": [
- 14
+ 20
]
},
{
"title": "Methods",
"children": [
- 16
+ 22,
+ 26
]
}
],
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 14,
+ "line": 21,
"character": 13,
- "url": "typedoc://inherit-param-doc.ts#L14"
+ "url": "typedoc://inherit-param-doc.ts#L21"
}
],
"implementedTypes": [
@@ -300,28 +415,28 @@
]
},
{
- "id": 20,
+ "id": 29,
"name": "Class3",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
- "id": 21,
+ "id": 30,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
- "id": 22,
+ "id": 31,
"name": "new Class3",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
- "target": 20,
+ "target": 29,
"name": "Class3",
"package": "typedoc"
}
@@ -329,7 +444,7 @@
]
},
{
- "id": 23,
+ "id": 32,
"name": "method1",
"variant": "declaration",
"kind": 2048,
@@ -337,14 +452,14 @@
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 29,
+ "line": 42,
"character": 4,
- "url": "typedoc://inherit-param-doc.ts#L29"
+ "url": "typedoc://inherit-param-doc.ts#L42"
}
],
"signatures": [
{
- "id": 24,
+ "id": 33,
"name": "method1",
"variant": "signature",
"kind": 4096,
@@ -352,14 +467,14 @@
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 29,
+ "line": 42,
"character": 4,
- "url": "typedoc://inherit-param-doc.ts#L29"
+ "url": "typedoc://inherit-param-doc.ts#L42"
}
],
"parameters": [
{
- "id": 25,
+ "id": 34,
"name": "a",
"variant": "param",
"kind": 32768,
@@ -378,7 +493,7 @@
}
},
{
- "id": 26,
+ "id": 35,
"name": "c",
"variant": "param",
"kind": 32768,
@@ -413,28 +528,96 @@
"target": 2,
"name": "Base.method1"
}
+ },
+ {
+ "id": 36,
+ "name": "method2",
+ "variant": "declaration",
+ "kind": 2048,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 43,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L43"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 37,
+ "name": "method2",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 43,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L43"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 38,
+ "name": "a",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parameter A."
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "void"
+ },
+ "implementationOf": {
+ "type": "reference",
+ "target": 7,
+ "name": "Base.method2"
+ }
+ }
+ ],
+ "implementationOf": {
+ "type": "reference",
+ "target": 6,
+ "name": "Base.method2"
+ }
}
],
"groups": [
{
"title": "Constructors",
"children": [
- 21
+ 30
]
},
{
"title": "Methods",
"children": [
- 23
+ 32,
+ 36
]
}
],
"sources": [
{
"fileName": "inherit-param-doc.ts",
- "line": 23,
+ "line": 36,
"character": 13,
- "url": "typedoc://inherit-param-doc.ts#L23"
+ "url": "typedoc://inherit-param-doc.ts#L36"
}
],
"implementedTypes": [
@@ -528,13 +711,90 @@
}
}
]
+ },
+ {
+ "id": 6,
+ "name": "method2",
+ "variant": "declaration",
+ "kind": 2048,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 11,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L11"
+ }
+ ],
+ "signatures": [
+ {
+ "id": 7,
+ "name": "method2",
+ "variant": "signature",
+ "kind": 4096,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "inherit-param-doc.ts",
+ "line": 11,
+ "character": 4,
+ "url": "typedoc://inherit-param-doc.ts#L11"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 8,
+ "name": "a",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parameter A."
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ },
+ {
+ "id": 9,
+ "name": "b",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Parameter B."
+ }
+ ]
+ },
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "void"
+ }
+ }
+ ]
}
],
"groups": [
{
"title": "Methods",
"children": [
- 2
+ 2,
+ 6
]
}
],
@@ -549,17 +809,17 @@
"implementedBy": [
{
"type": "reference",
- "target": 6,
+ "target": 10,
"name": "Class1"
},
{
"type": "reference",
- "target": 13,
+ "target": 19,
"name": "Class2"
},
{
"type": "reference",
- "target": 20,
+ "target": 29,
"name": "Class3"
}
]
@@ -569,9 +829,9 @@
{
"title": "Classes",
"children": [
- 6,
- 13,
- 20
+ 10,
+ 19,
+ 29
]
},
{
@@ -609,63 +869,119 @@
},
"6": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
- "qualifiedName": "Class1"
+ "qualifiedName": "Base.method2"
+ },
+ "7": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Base.method2"
+ },
+ "8": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "a"
},
"9": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
- "qualifiedName": "Class1.method1"
+ "qualifiedName": "b"
},
"10": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class1"
+ },
+ "13": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class1.method1"
+ },
+ "14": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "Class1.method1"
},
- "11": {
+ "15": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "a"
},
- "12": {
+ "16": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "b"
},
- "13": {
+ "17": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class1.method2"
+ },
+ "18": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class1.method2"
+ },
+ "19": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "Class2"
},
- "16": {
+ "22": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "Class2.method1"
},
- "17": {
+ "23": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "Class2.method1"
},
- "18": {
+ "24": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "a"
},
- "19": {
+ "25": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "b"
},
- "20": {
+ "26": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class2.method2"
+ },
+ "27": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class2.method2"
+ },
+ "28": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "a"
+ },
+ "29": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "Class3"
},
- "23": {
+ "32": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "Class3.method1"
},
- "24": {
+ "33": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "Class3.method1"
},
- "25": {
+ "34": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "a"
},
- "26": {
+ "35": {
"sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
"qualifiedName": "c"
+ },
+ "36": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class3.method2"
+ },
+ "37": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "Class3.method2"
+ },
+ "38": {
+ "sourceFileName": "src/test/converter/inherit-param-doc/inherit-param-doc.ts",
+ "qualifiedName": "a"
+ }
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/inherit-param-doc/inherit-param-doc.ts"
+ },
+ "reflections": {
+ "1": 0
}
}
}
diff --git a/src/test/converter/inheritance/inherit-doc.ts b/src/test/converter/inheritance/inherit-doc.ts
index 22394cc04..f901abddb 100644
--- a/src/test/converter/inheritance/inherit-doc.ts
+++ b/src/test/converter/inheritance/inherit-doc.ts
@@ -46,9 +46,9 @@ export interface InterfaceTarget<T> {
*
* Remarks will be inherited
*
- * @customBlock
+ * @default
*
- * This part of the commentary will not be inherited
+ * This part of the commentary will not be inherited (this is an abuse of this tag)
*
* @typeParam T - Type of arguments
* @param arg1 - First argument
diff --git a/src/test/converter/inheritance/specs.json b/src/test/converter/inheritance/specs.json
index f61997853..3370f5e10 100644
--- a/src/test/converter/inheritance/specs.json
+++ b/src/test/converter/inheritance/specs.json
@@ -359,11 +359,11 @@
]
},
{
- "tag": "@customBlock",
+ "tag": "@default",
"content": [
{
- "kind": "text",
- "text": "This part of the commentary will not be inherited"
+ "kind": "code",
+ "text": "```ts\nThis part of the commentary will not be inherited (this is an abuse of this tag)\n```"
}
]
},
@@ -386,7 +386,7 @@
"url": "typedoc://inherit-doc.ts#L58"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 4,
"name": "T",
@@ -531,7 +531,7 @@
"url": "typedoc://inherit-doc.ts#L78"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 9,
"name": "T",
@@ -694,7 +694,9 @@
"name": "instanceProp",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mergable-class.ts",
@@ -719,7 +721,8 @@
"variant": "declaration",
"kind": 1024,
"flags": {
- "isStatic": true
+ "isStatic": true,
+ "isInherited": true
},
"sources": [
{
@@ -1131,5 +1134,15 @@
"sourceFileName": "src/test/converter/inheritance/mergable-class.ts",
"qualifiedName": "My.instanceProp"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/inheritance/inherit-doc.ts",
+ "2": "src/test/converter/inheritance/mergable-class.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 24
+ }
}
}
diff --git a/src/test/converter/interface/index-signature.ts b/src/test/converter/interface/index-signature.ts
index b6fdaba3f..f73f81cb4 100644
--- a/src/test/converter/interface/index-signature.ts
+++ b/src/test/converter/interface/index-signature.ts
@@ -6,9 +6,10 @@ export interface NumIndex {
[x: number]: 1;
}
-// This is broken... but here's a test for the broken behavior so we know when it is fixed.
export interface BothIndex {
+ /** Number index */
[x: number]: 1;
+ /** String index */
[x: string]: 1 | 2;
}
diff --git a/src/test/converter/interface/specs.json b/src/test/converter/interface/specs.json
index fdc8b8859..471b6f3c0 100644
--- a/src/test/converter/interface/specs.json
+++ b/src/test/converter/interface/specs.json
@@ -237,43 +237,102 @@
"sources": [
{
"fileName": "index-signature.ts",
- "line": 10,
+ "line": 9,
"character": 17,
- "url": "typedoc://index-signature.ts#L10"
+ "url": "typedoc://index-signature.ts#L9"
}
],
- "indexSignature": {
- "id": 22,
- "name": "__index",
- "variant": "signature",
- "kind": 8192,
- "flags": {},
- "sources": [
- {
- "fileName": "index-signature.ts",
- "line": 11,
- "character": 4,
- "url": "typedoc://index-signature.ts#L11"
+ "indexSignatures": [
+ {
+ "id": 22,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Number index"
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 11,
+ "character": 4,
+ "url": "typedoc://index-signature.ts#L11"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 23,
+ "name": "x",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ }
+ ],
+ "type": {
+ "type": "literal",
+ "value": 1
}
- ],
- "parameters": [
- {
- "id": 23,
- "name": "x",
- "variant": "param",
- "kind": 32768,
- "flags": {},
- "type": {
- "type": "intrinsic",
- "name": "number"
+ },
+ {
+ "id": 24,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "String index"
+ }
+ ]
+ },
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 13,
+ "character": 4,
+ "url": "typedoc://index-signature.ts#L13"
}
+ ],
+ "parameters": [
+ {
+ "id": 25,
+ "name": "x",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "union",
+ "types": [
+ {
+ "type": "literal",
+ "value": 1
+ },
+ {
+ "type": "literal",
+ "value": 2
+ }
+ ]
}
- ],
- "type": {
- "type": "literal",
- "value": 1
}
- }
+ ]
},
{
"id": 18,
@@ -289,38 +348,40 @@
"url": "typedoc://index-signature.ts#L5"
}
],
- "indexSignature": {
- "id": 19,
- "name": "__index",
- "variant": "signature",
- "kind": 8192,
- "flags": {},
- "sources": [
- {
- "fileName": "index-signature.ts",
- "line": 6,
- "character": 4,
- "url": "typedoc://index-signature.ts#L6"
- }
- ],
- "parameters": [
- {
- "id": 20,
- "name": "x",
- "variant": "param",
- "kind": 32768,
- "flags": {},
- "type": {
- "type": "intrinsic",
- "name": "number"
+ "indexSignatures": [
+ {
+ "id": 19,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 6,
+ "character": 4,
+ "url": "typedoc://index-signature.ts#L6"
}
+ ],
+ "parameters": [
+ {
+ "id": 20,
+ "name": "x",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "number"
+ }
+ }
+ ],
+ "type": {
+ "type": "literal",
+ "value": 1
}
- ],
- "type": {
- "type": "literal",
- "value": 1
}
- }
+ ]
},
{
"id": 15,
@@ -336,41 +397,43 @@
"url": "typedoc://index-signature.ts#L1"
}
],
- "indexSignature": {
- "id": 16,
- "name": "__index",
- "variant": "signature",
- "kind": 8192,
- "flags": {},
- "sources": [
- {
- "fileName": "index-signature.ts",
- "line": 2,
- "character": 4,
- "url": "typedoc://index-signature.ts#L2"
- }
- ],
- "parameters": [
- {
- "id": 17,
- "name": "x",
- "variant": "param",
- "kind": 32768,
- "flags": {},
- "type": {
- "type": "intrinsic",
- "name": "string"
+ "indexSignatures": [
+ {
+ "id": 16,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 2,
+ "character": 4,
+ "url": "typedoc://index-signature.ts#L2"
}
+ ],
+ "parameters": [
+ {
+ "id": 17,
+ "name": "x",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "literal",
+ "value": 1
}
- ],
- "type": {
- "type": "literal",
- "value": 1
}
- }
+ ]
},
{
- "id": 24,
+ "id": 26,
"name": "TypeIndex",
"variant": "declaration",
"kind": 2097152,
@@ -378,15 +441,15 @@
"sources": [
{
"fileName": "index-signature.ts",
- "line": 15,
+ "line": 16,
"character": 12,
- "url": "typedoc://index-signature.ts#L15"
+ "url": "typedoc://index-signature.ts#L16"
}
],
"type": {
"type": "reflection",
"declaration": {
- "id": 25,
+ "id": 27,
"name": "__type",
"variant": "declaration",
"kind": 65536,
@@ -394,43 +457,45 @@
"sources": [
{
"fileName": "index-signature.ts",
- "line": 15,
+ "line": 16,
"character": 24,
- "url": "typedoc://index-signature.ts#L15"
+ "url": "typedoc://index-signature.ts#L16"
}
],
- "indexSignature": {
- "id": 26,
- "name": "__index",
- "variant": "signature",
- "kind": 8192,
- "flags": {},
- "sources": [
- {
- "fileName": "index-signature.ts",
- "line": 15,
- "character": 26,
- "url": "typedoc://index-signature.ts#L15"
- }
- ],
- "parameters": [
- {
- "id": 27,
- "name": "x",
- "variant": "param",
- "kind": 32768,
- "flags": {},
- "type": {
- "type": "intrinsic",
- "name": "string"
+ "indexSignatures": [
+ {
+ "id": 28,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 16,
+ "character": 26,
+ "url": "typedoc://index-signature.ts#L16"
}
+ ],
+ "parameters": [
+ {
+ "id": 29,
+ "name": "x",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "string"
+ }
+ }
+ ],
+ "type": {
+ "type": "literal",
+ "value": 1
}
- ],
- "type": {
- "type": "literal",
- "value": 1
}
- }
+ ]
}
}
}
@@ -447,7 +512,7 @@
{
"title": "Type Aliases",
"children": [
- 24
+ 26
]
}
],
@@ -461,14 +526,14 @@
]
},
{
- "id": 28,
+ "id": 30,
"name": "interface-empty",
"variant": "declaration",
"kind": 2,
"flags": {},
"children": [
{
- "id": 30,
+ "id": 32,
"name": "ClassImplementingEmptyInterface",
"variant": "declaration",
"kind": 128,
@@ -483,21 +548,21 @@
},
"children": [
{
- "id": 31,
+ "id": 33,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
- "id": 32,
+ "id": 34,
"name": "new ClassImplementingEmptyInterface",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
- "target": 30,
+ "target": 32,
"name": "ClassImplementingEmptyInterface",
"package": "typedoc"
}
@@ -505,7 +570,7 @@
]
},
{
- "id": 33,
+ "id": 35,
"name": "name",
"variant": "declaration",
"kind": 1024,
@@ -526,7 +591,7 @@
}
},
{
- "id": 34,
+ "id": 36,
"name": "goto",
"variant": "declaration",
"kind": 2048,
@@ -543,7 +608,7 @@
],
"signatures": [
{
- "id": 35,
+ "id": 37,
"name": "goto",
"variant": "signature",
"kind": 4096,
@@ -568,19 +633,19 @@
{
"title": "Constructors",
"children": [
- 31
+ 33
]
},
{
"title": "Properties",
"children": [
- 33
+ 35
]
},
{
"title": "Methods",
"children": [
- 34
+ 36
]
}
],
@@ -595,14 +660,14 @@
"implementedTypes": [
{
"type": "reference",
- "target": 29,
+ "target": 31,
"name": "EmptyInterface",
"package": "typedoc"
}
]
},
{
- "id": 29,
+ "id": 31,
"name": "EmptyInterface",
"variant": "declaration",
"kind": 256,
@@ -626,7 +691,7 @@
"implementedBy": [
{
"type": "reference",
- "target": 30,
+ "target": 32,
"name": "ClassImplementingEmptyInterface"
}
]
@@ -636,13 +701,13 @@
{
"title": "Classes",
"children": [
- 30
+ 32
]
},
{
"title": "Interfaces",
"children": [
- 29
+ 31
]
}
],
@@ -656,21 +721,21 @@
]
},
{
- "id": 36,
+ "id": 38,
"name": "interface-implementation",
"variant": "declaration",
"kind": 2,
"flags": {},
"children": [
{
- "id": 37,
+ "id": 39,
"name": "Forms",
"variant": "declaration",
"kind": 4,
"flags": {},
"children": [
{
- "id": 81,
+ "id": 83,
"name": "EventDispatcher",
"variant": "declaration",
"kind": 128,
@@ -696,21 +761,21 @@
},
"children": [
{
- "id": 82,
+ "id": 84,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
- "id": 83,
+ "id": 85,
"name": "new EventDispatcher",
"variant": "signature",
"kind": 16384,
"flags": {},
- "typeParameter": [
+ "typeParameters": [
{
- "id": 84,
+ "id": 86,
"name": "T",
"variant": "typeParam",
"kind": 131072,
@@ -719,11 +784,11 @@
],
"type": {
"type": "reference",
- "target": 81,
+ "target": 83,
"typeArguments": [
{
"type": "reference",
- "target": 84,
+ "target": 86,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcher.T",
@@ -738,7 +803,7 @@
]
},
{
- "id": 85,
+ "id": 87,
"name": "subscriptions",
"variant": "declaration",
"kind": 1024,
@@ -757,11 +822,11 @@
"type": "array",
"elementType": {
"type": "reference",
- "target": 42,
+ "target": 44,
"typeArguments": [
{
"type": "reference",
- "target": 84,
+ "target": 86,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcher.T",
@@ -775,7 +840,7 @@
}
},
{
- "id": 86,
+ "id": 88,
"name": "add",
"variant": "declaration",
"kind": 2048,
@@ -790,7 +855,7 @@
],
"signatures": [
{
- "id": 87,
+ "id": 89,
"name": "add",
"variant": "signature",
"kind": 4096,
@@ -805,18 +870,18 @@
],
"parameters": [
{
- "id": 88,
+ "id": 90,
"name": "listener",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 38,
+ "target": 40,
"typeArguments": [
{
"type": "reference",
- "target": 84,
+ "target": 86,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcher.T",
@@ -829,7 +894,7 @@
}
},
{
- "id": 89,
+ "id": 91,
"name": "filter",
"variant": "param",
"kind": 32768,
@@ -841,7 +906,7 @@
"defaultValue": "null"
},
{
- "id": 90,
+ "id": 92,
"name": "priority",
"variant": "param",
"kind": 32768,
@@ -855,11 +920,11 @@
],
"type": {
"type": "reference",
- "target": 42,
+ "target": 44,
"typeArguments": [
{
"type": "reference",
- "target": 84,
+ "target": 86,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcher.T",
@@ -872,19 +937,19 @@
},
"implementationOf": {
"type": "reference",
- "target": 66,
+ "target": 68,
"name": "EventDispatcherInt.add"
}
}
],
"implementationOf": {
"type": "reference",
- "target": 65,
+ "target": 67,
"name": "EventDispatcherInt.add"
}
},
{
- "id": 97,
+ "id": 99,
"name": "clear",
"variant": "declaration",
"kind": 2048,
@@ -899,7 +964,7 @@
],
"signatures": [
{
- "id": 98,
+ "id": 100,
"name": "clear",
"variant": "signature",
"kind": 4096,
@@ -918,19 +983,19 @@
},
"implementationOf": {
"type": "reference",
- "target": 77,
+ "target": 79,
"name": "EventDispatcherInt.clear"
}
}
],
"implementationOf": {
"type": "reference",
- "target": 76,
+ "target": 78,
"name": "EventDispatcherInt.clear"
}
},
{
- "id": 94,
+ "id": 96,
"name": "dispatch",
"variant": "declaration",
"kind": 2048,
@@ -945,7 +1010,7 @@
],
"signatures": [
{
- "id": 95,
+ "id": 97,
"name": "dispatch",
"variant": "signature",
"kind": 4096,
@@ -960,14 +1025,14 @@
],
"parameters": [
{
- "id": 96,
+ "id": 98,
"name": "event",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 84,
+ "target": 86,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcher.T",
@@ -981,19 +1046,19 @@
},
"implementationOf": {
"type": "reference",
- "target": 74,
+ "target": 76,
"name": "EventDispatcherInt.dispatch"
}
}
],
"implementationOf": {
"type": "reference",
- "target": 73,
+ "target": 75,
"name": "EventDispatcherInt.dispatch"
}
},
{
- "id": 99,
+ "id": 101,
"name": "hasListeners",
"variant": "declaration",
"kind": 2048,
@@ -1008,7 +1073,7 @@
],
"signatures": [
{
- "id": 100,
+ "id": 102,
"name": "hasListeners",
"variant": "signature",
"kind": 4096,
@@ -1027,19 +1092,19 @@
},
"implementationOf": {
"type": "reference",
- "target": 79,
+ "target": 81,
"name": "EventDispatcherInt.hasListeners"
}
}
],
"implementationOf": {
"type": "reference",
- "target": 78,
+ "target": 80,
"name": "EventDispatcherInt.hasListeners"
}
},
{
- "id": 91,
+ "id": 93,
"name": "remove",
"variant": "declaration",
"kind": 2048,
@@ -1054,7 +1119,7 @@
],
"signatures": [
{
- "id": 92,
+ "id": 94,
"name": "remove",
"variant": "signature",
"kind": 4096,
@@ -1069,18 +1134,18 @@
],
"parameters": [
{
- "id": 93,
+ "id": 95,
"name": "subscription",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 42,
+ "target": 44,
"typeArguments": [
{
"type": "reference",
- "target": 84,
+ "target": 86,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcher.T",
@@ -1099,14 +1164,14 @@
},
"implementationOf": {
"type": "reference",
- "target": 71,
+ "target": 73,
"name": "EventDispatcherInt.remove"
}
}
],
"implementationOf": {
"type": "reference",
- "target": 70,
+ "target": 72,
"name": "EventDispatcherInt.remove"
}
}
@@ -1115,23 +1180,23 @@
{
"title": "Constructors",
"children": [
- 82
+ 84
]
},
{
"title": "Properties",
"children": [
- 85
+ 87
]
},
{
"title": "Methods",
"children": [
- 86,
- 97,
- 94,
+ 88,
99,
- 91
+ 96,
+ 101,
+ 93
]
}
],
@@ -1145,7 +1210,7 @@
],
"typeParameters": [
{
- "id": 101,
+ "id": 103,
"name": "T",
"variant": "typeParam",
"kind": 131072,
@@ -1155,11 +1220,11 @@
"implementedTypes": [
{
"type": "reference",
- "target": 64,
+ "target": 66,
"typeArguments": [
{
"type": "reference",
- "target": 84,
+ "target": 86,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcher.T",
@@ -1173,7 +1238,7 @@
]
},
{
- "id": 49,
+ "id": 51,
"name": "Subscription",
"variant": "declaration",
"kind": 128,
@@ -1188,7 +1253,7 @@
},
"children": [
{
- "id": 50,
+ "id": 52,
"name": "constructor",
"variant": "declaration",
"kind": 512,
@@ -1203,7 +1268,7 @@
],
"signatures": [
{
- "id": 51,
+ "id": 53,
"name": "new Subscription",
"variant": "signature",
"kind": 16384,
@@ -1216,9 +1281,9 @@
"url": "typedoc://interface-implementation.ts#L25"
}
],
- "typeParameter": [
+ "typeParameters": [
{
- "id": 52,
+ "id": 54,
"name": "V",
"variant": "typeParam",
"kind": 131072,
@@ -1227,18 +1292,18 @@
],
"parameters": [
{
- "id": 53,
+ "id": 55,
"name": "listener",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 38,
+ "target": 40,
"typeArguments": [
{
"type": "reference",
- "target": 52,
+ "target": 54,
"name": "V",
"package": "typedoc",
"qualifiedName": "Forms.Subscription.V",
@@ -1251,7 +1316,7 @@
}
},
{
- "id": 54,
+ "id": 56,
"name": "filter",
"variant": "param",
"kind": 32768,
@@ -1262,7 +1327,7 @@
}
},
{
- "id": 55,
+ "id": 57,
"name": "priority",
"variant": "param",
"kind": 32768,
@@ -1273,18 +1338,18 @@
}
},
{
- "id": 56,
+ "id": 58,
"name": "dispatcher",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 81,
+ "target": 83,
"typeArguments": [
{
"type": "reference",
- "target": 52,
+ "target": 54,
"name": "V",
"package": "typedoc",
"qualifiedName": "Forms.Subscription.V",
@@ -1299,11 +1364,11 @@
],
"type": {
"type": "reference",
- "target": 49,
+ "target": 51,
"typeArguments": [
{
"type": "reference",
- "target": 52,
+ "target": 54,
"name": "V",
"package": "typedoc",
"qualifiedName": "Forms.Subscription.V",
@@ -1318,7 +1383,7 @@
]
},
{
- "id": 60,
+ "id": 62,
"name": "dispatcher",
"variant": "declaration",
"kind": 1024,
@@ -1335,11 +1400,11 @@
],
"type": {
"type": "reference",
- "target": 81,
+ "target": 83,
"typeArguments": [
{
"type": "reference",
- "target": 52,
+ "target": 54,
"name": "V",
"package": "typedoc",
"qualifiedName": "Forms.Subscription.V",
@@ -1352,7 +1417,7 @@
}
},
{
- "id": 58,
+ "id": 60,
"name": "filter",
"variant": "declaration",
"kind": 1024,
@@ -1373,12 +1438,12 @@
},
"implementationOf": {
"type": "reference",
- "target": 45,
+ "target": 47,
"name": "SubscriptionInt.filter"
}
},
{
- "id": 57,
+ "id": 59,
"name": "listener",
"variant": "declaration",
"kind": 1024,
@@ -1395,11 +1460,11 @@
],
"type": {
"type": "reference",
- "target": 38,
+ "target": 40,
"typeArguments": [
{
"type": "reference",
- "target": 52,
+ "target": 54,
"name": "V",
"package": "typedoc",
"qualifiedName": "Forms.Subscription.V",
@@ -1412,12 +1477,12 @@
},
"implementationOf": {
"type": "reference",
- "target": 43,
+ "target": 45,
"name": "SubscriptionInt.listener"
}
},
{
- "id": 59,
+ "id": 61,
"name": "priority",
"variant": "declaration",
"kind": 1024,
@@ -1438,12 +1503,12 @@
},
"implementationOf": {
"type": "reference",
- "target": 44,
+ "target": 46,
"name": "SubscriptionInt.priority"
}
},
{
- "id": 61,
+ "id": 63,
"name": "unsubscribe",
"variant": "declaration",
"kind": 2048,
@@ -1458,7 +1523,7 @@
],
"signatures": [
{
- "id": 62,
+ "id": 64,
"name": "unsubscribe",
"variant": "signature",
"kind": 4096,
@@ -1485,14 +1550,14 @@
},
"implementationOf": {
"type": "reference",
- "target": 47,
+ "target": 49,
"name": "SubscriptionInt.unsubscribe"
}
}
],
"implementationOf": {
"type": "reference",
- "target": 46,
+ "target": 48,
"name": "SubscriptionInt.unsubscribe"
}
}
@@ -1501,22 +1566,22 @@
{
"title": "Constructors",
"children": [
- 50
+ 52
]
},
{
"title": "Properties",
"children": [
+ 62,
60,
- 58,
- 57,
- 59
+ 59,
+ 61
]
},
{
"title": "Methods",
"children": [
- 61
+ 63
]
}
],
@@ -1530,7 +1595,7 @@
],
"typeParameters": [
{
- "id": 63,
+ "id": 65,
"name": "V",
"variant": "typeParam",
"kind": 131072,
@@ -1540,11 +1605,11 @@
"implementedTypes": [
{
"type": "reference",
- "target": 42,
+ "target": 44,
"typeArguments": [
{
"type": "reference",
- "target": 52,
+ "target": 54,
"name": "V",
"package": "typedoc",
"qualifiedName": "Forms.Subscription.V",
@@ -1558,7 +1623,7 @@
]
},
{
- "id": 64,
+ "id": 66,
"name": "EventDispatcherInt",
"variant": "declaration",
"kind": 256,
@@ -1573,7 +1638,7 @@
},
"children": [
{
- "id": 65,
+ "id": 67,
"name": "add",
"variant": "declaration",
"kind": 2048,
@@ -1588,7 +1653,7 @@
],
"signatures": [
{
- "id": 66,
+ "id": 68,
"name": "add",
"variant": "signature",
"kind": 4096,
@@ -1603,18 +1668,18 @@
],
"parameters": [
{
- "id": 67,
+ "id": 69,
"name": "listener",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 38,
+ "target": 40,
"typeArguments": [
{
"type": "reference",
- "target": 80,
+ "target": 82,
"name": "U",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcherInt.U",
@@ -1627,7 +1692,7 @@
}
},
{
- "id": 68,
+ "id": 70,
"name": "filter",
"variant": "param",
"kind": 32768,
@@ -1640,7 +1705,7 @@
}
},
{
- "id": 69,
+ "id": 71,
"name": "priority",
"variant": "param",
"kind": 32768,
@@ -1655,11 +1720,11 @@
],
"type": {
"type": "reference",
- "target": 42,
+ "target": 44,
"typeArguments": [
{
"type": "reference",
- "target": 80,
+ "target": 82,
"name": "U",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcherInt.U",
@@ -1674,7 +1739,7 @@
]
},
{
- "id": 76,
+ "id": 78,
"name": "clear",
"variant": "declaration",
"kind": 2048,
@@ -1689,7 +1754,7 @@
],
"signatures": [
{
- "id": 77,
+ "id": 79,
"name": "clear",
"variant": "signature",
"kind": 4096,
@@ -1710,7 +1775,7 @@
]
},
{
- "id": 73,
+ "id": 75,
"name": "dispatch",
"variant": "declaration",
"kind": 2048,
@@ -1725,7 +1790,7 @@
],
"signatures": [
{
- "id": 74,
+ "id": 76,
"name": "dispatch",
"variant": "signature",
"kind": 4096,
@@ -1740,14 +1805,14 @@
],
"parameters": [
{
- "id": 75,
+ "id": 77,
"name": "parameter",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 80,
+ "target": 82,
"name": "U",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcherInt.U",
@@ -1763,7 +1828,7 @@
]
},
{
- "id": 78,
+ "id": 80,
"name": "hasListeners",
"variant": "declaration",
"kind": 2048,
@@ -1778,7 +1843,7 @@
],
"signatures": [
{
- "id": 79,
+ "id": 81,
"name": "hasListeners",
"variant": "signature",
"kind": 4096,
@@ -1799,7 +1864,7 @@
]
},
{
- "id": 70,
+ "id": 72,
"name": "remove",
"variant": "declaration",
"kind": 2048,
@@ -1814,7 +1879,7 @@
],
"signatures": [
{
- "id": 71,
+ "id": 73,
"name": "remove",
"variant": "signature",
"kind": 4096,
@@ -1829,18 +1894,18 @@
],
"parameters": [
{
- "id": 72,
+ "id": 74,
"name": "subscription",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
- "target": 42,
+ "target": 44,
"typeArguments": [
{
"type": "reference",
- "target": 80,
+ "target": 82,
"name": "U",
"package": "typedoc",
"qualifiedName": "Forms.EventDispatcherInt.U",
@@ -1865,11 +1930,11 @@
{
"title": "Methods",
"children": [
- 65,
- 76,
- 73,
+ 67,
78,
- 70
+ 75,
+ 80,
+ 72
]
}
],
@@ -1883,7 +1948,7 @@
],
"typeParameters": [
{
- "id": 80,
+ "id": 82,
"name": "U",
"variant": "typeParam",
"kind": 131072,
@@ -1893,13 +1958,13 @@
"implementedBy": [
{
"type": "reference",
- "target": 81,
+ "target": 83,
"name": "EventDispatcher"
}
]
},
{
- "id": 38,
+ "id": 40,
"name": "EventListener",
"variant": "declaration",
"kind": 256,
@@ -1922,7 +1987,7 @@
],
"typeParameters": [
{
- "id": 39,
+ "id": 41,
"name": "T",
"variant": "typeParam",
"kind": 131072,
@@ -1931,7 +1996,7 @@
],
"signatures": [
{
- "id": 40,
+ "id": 42,
"name": "EventListener",
"variant": "signature",
"kind": 4096,
@@ -1946,7 +2011,7 @@
],
"parameters": [
{
- "id": 41,
+ "id": 43,
"name": "parameter",
"variant": "param",
"kind": 32768,
@@ -1961,7 +2026,7 @@
},
"type": {
"type": "reference",
- "target": 39,
+ "target": 41,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.EventListener.T",
@@ -1977,7 +2042,7 @@
]
},
{
- "id": 42,
+ "id": 44,
"name": "SubscriptionInt",
"variant": "declaration",
"kind": 256,
@@ -1992,7 +2057,7 @@
},
"children": [
{
- "id": 45,
+ "id": 47,
"name": "filter",
"variant": "declaration",
"kind": 1024,
@@ -2011,7 +2076,7 @@
}
},
{
- "id": 43,
+ "id": 45,
"name": "listener",
"variant": "declaration",
"kind": 1024,
@@ -2026,11 +2091,11 @@
],
"type": {
"type": "reference",
- "target": 38,
+ "target": 40,
"typeArguments": [
{
"type": "reference",
- "target": 48,
+ "target": 50,
"name": "T",
"package": "typedoc",
"qualifiedName": "Forms.SubscriptionInt.T",
@@ -2043,7 +2108,7 @@
}
},
{
- "id": 44,
+ "id": 46,
"name": "priority",
"variant": "declaration",
"kind": 1024,
@@ -2062,7 +2127,7 @@
}
},
{
- "id": 46,
+ "id": 48,
"name": "unsubscribe",
"variant": "declaration",
"kind": 2048,
@@ -2077,7 +2142,7 @@
],
"signatures": [
{
- "id": 47,
+ "id": 49,
"name": "unsubscribe",
"variant": "signature",
"kind": 4096,
@@ -2110,15 +2175,15 @@
{
"title": "Properties",
"children": [
+ 47,
45,
- 43,
- 44
+ 46
]
},
{
"title": "Methods",
"children": [
- 46
+ 48
]
}
],
@@ -2132,7 +2197,7 @@
],
"typeParameters": [
{
- "id": 48,
+ "id": 50,
"name": "T",
"variant": "typeParam",
"kind": 131072,
@@ -2142,7 +2207,7 @@
"implementedBy": [
{
"type": "reference",
- "target": 49,
+ "target": 51,
"name": "Subscription"
}
]
@@ -2152,16 +2217,16 @@
{
"title": "Classes",
"children": [
- 81,
- 49
+ 83,
+ 51
]
},
{
"title": "Interfaces",
"children": [
- 64,
- 38,
- 42
+ 66,
+ 40,
+ 44
]
}
],
@@ -2179,7 +2244,7 @@
{
"title": "Namespaces",
"children": [
- 37
+ 39
]
}
],
@@ -2193,21 +2258,21 @@
]
},
{
- "id": 102,
+ "id": 104,
"name": "merging",
"variant": "declaration",
"kind": 2,
"flags": {},
"children": [
{
- "id": 103,
+ "id": 105,
"name": "Base",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
- "id": 104,
+ "id": 106,
"name": "base",
"variant": "declaration",
"kind": 1024,
@@ -2230,7 +2295,7 @@
{
"title": "Properties",
"children": [
- 104
+ 106
]
}
],
@@ -2245,25 +2310,25 @@
"extendedBy": [
{
"type": "reference",
- "target": 107,
+ "target": 109,
"name": "Child"
},
{
"type": "reference",
- "target": 112,
+ "target": 114,
"name": "Child2"
}
]
},
{
- "id": 105,
+ "id": 107,
"name": "Base2",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
- "id": 106,
+ "id": 108,
"name": "base2",
"variant": "declaration",
"kind": 1024,
@@ -2286,7 +2351,7 @@
{
"title": "Properties",
"children": [
- 106
+ 108
]
}
],
@@ -2301,24 +2366,26 @@
"extendedBy": [
{
"type": "reference",
- "target": 107,
+ "target": 109,
"name": "Child"
}
]
},
{
- "id": 107,
+ "id": 109,
"name": "Child",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
- "id": 110,
+ "id": 112,
"name": "base",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "merging.ts",
@@ -2333,16 +2400,18 @@
},
"inheritedFrom": {
"type": "reference",
- "target": 104,
+ "target": 106,
"name": "Base.base"
}
},
{
- "id": 111,
+ "id": 113,
"name": "base2",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "merging.ts",
@@ -2357,12 +2426,12 @@
},
"inheritedFrom": {
"type": "reference",
- "target": 106,
+ "target": 108,
"name": "Base2.base2"
}
},
{
- "id": 108,
+ "id": 110,
"name": "child",
"variant": "declaration",
"kind": 1024,
@@ -2381,7 +2450,7 @@
}
},
{
- "id": 109,
+ "id": 111,
"name": "child3",
"variant": "declaration",
"kind": 1024,
@@ -2404,10 +2473,10 @@
{
"title": "Properties",
"children": [
+ 112,
+ 113,
110,
- 111,
- 108,
- 109
+ 111
]
}
],
@@ -2428,13 +2497,13 @@
"extendedTypes": [
{
"type": "reference",
- "target": 103,
+ "target": 105,
"name": "Base",
"package": "typedoc"
},
{
"type": "reference",
- "target": 105,
+ "target": 107,
"name": "Base2",
"package": "typedoc"
}
@@ -2442,24 +2511,26 @@
"extendedBy": [
{
"type": "reference",
- "target": 112,
+ "target": 114,
"name": "Child2"
}
]
},
{
- "id": 112,
+ "id": 114,
"name": "Child2",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
- "id": 116,
+ "id": 118,
"name": "base",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "merging.ts",
@@ -2474,16 +2545,18 @@
},
"inheritedFrom": {
"type": "reference",
- "target": 104,
+ "target": 106,
"name": "Base.base"
}
},
{
- "id": 117,
+ "id": 119,
"name": "base2",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "merging.ts",
@@ -2498,16 +2571,18 @@
},
"inheritedFrom": {
"type": "reference",
- "target": 111,
+ "target": 113,
"name": "Child.base2"
}
},
{
- "id": 114,
+ "id": 116,
"name": "child",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "merging.ts",
@@ -2522,12 +2597,12 @@
},
"inheritedFrom": {
"type": "reference",
- "target": 108,
+ "target": 110,
"name": "Child.child"
}
},
{
- "id": 113,
+ "id": 115,
"name": "child2",
"variant": "declaration",
"kind": 1024,
@@ -2546,11 +2621,13 @@
}
},
{
- "id": 115,
+ "id": 117,
"name": "child3",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "merging.ts",
@@ -2565,7 +2642,7 @@
},
"inheritedFrom": {
"type": "reference",
- "target": 109,
+ "target": 111,
"name": "Child.child3"
}
}
@@ -2574,11 +2651,11 @@
{
"title": "Properties",
"children": [
+ 118,
+ 119,
116,
- 117,
- 114,
- 113,
- 115
+ 115,
+ 117
]
}
],
@@ -2593,13 +2670,13 @@
"extendedTypes": [
{
"type": "reference",
- "target": 107,
+ "target": 109,
"name": "Child",
"package": "typedoc"
},
{
"type": "reference",
- "target": 103,
+ "target": 105,
"name": "Base",
"package": "typedoc"
}
@@ -2610,10 +2687,10 @@
{
"title": "Interfaces",
"children": [
- 103,
105,
107,
- 112
+ 109,
+ 114
]
}
],
@@ -2633,9 +2710,9 @@
"children": [
1,
14,
- 28,
- 36,
- 102
+ 30,
+ 38,
+ 104
]
}
],
@@ -2722,360 +2799,380 @@
"qualifiedName": "BothIndex.__index"
},
"24": {
+ "sourceFileName": "src/test/converter/interface/index-signature.ts",
+ "qualifiedName": "BothIndex.__index"
+ },
+ "26": {
"sourceFileName": "src/test/converter/interface/index-signature.ts",
"qualifiedName": "TypeIndex"
},
- "25": {
+ "27": {
"sourceFileName": "src/test/converter/interface/index-signature.ts",
"qualifiedName": "__type"
},
- "26": {
+ "28": {
"sourceFileName": "src/test/converter/interface/index-signature.ts",
"qualifiedName": "__type.__index"
},
- "28": {
+ "30": {
"sourceFileName": "src/test/converter/interface/interface-empty.ts",
"qualifiedName": ""
},
- "29": {
+ "31": {
"sourceFileName": "src/test/converter/interface/interface-empty.ts",
"qualifiedName": "EmptyInterface"
},
- "30": {
+ "32": {
"sourceFileName": "src/test/converter/interface/interface-empty.ts",
"qualifiedName": "ClassImplementingEmptyInterface"
},
- "33": {
+ "35": {
"sourceFileName": "src/test/converter/interface/interface-empty.ts",
"qualifiedName": "ClassImplementingEmptyInterface.name"
},
- "34": {
+ "36": {
"sourceFileName": "src/test/converter/interface/interface-empty.ts",
"qualifiedName": "ClassImplementingEmptyInterface.goto"
},
- "35": {
+ "37": {
"sourceFileName": "src/test/converter/interface/interface-empty.ts",
"qualifiedName": "ClassImplementingEmptyInterface.goto"
},
- "36": {
+ "38": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": ""
},
- "37": {
+ "39": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms"
},
- "38": {
+ "40": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventListener"
},
- "39": {
+ "41": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventListener.T"
},
- "40": {
+ "42": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventListener"
},
- "41": {
+ "43": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "parameter"
},
- "42": {
+ "44": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.SubscriptionInt"
},
- "43": {
+ "45": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.SubscriptionInt.listener"
},
- "44": {
+ "46": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.SubscriptionInt.priority"
},
- "45": {
+ "47": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.SubscriptionInt.filter"
},
- "46": {
+ "48": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.SubscriptionInt.unsubscribe"
},
- "47": {
+ "49": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.SubscriptionInt.unsubscribe"
},
- "48": {
+ "50": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.SubscriptionInt.T"
},
- "49": {
+ "51": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription"
},
- "50": {
+ "52": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.__constructor"
},
- "51": {
+ "53": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription"
},
- "52": {
+ "54": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.V"
},
- "53": {
+ "55": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "listener"
},
- "54": {
+ "56": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "filter"
},
- "55": {
+ "57": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "priority"
},
- "56": {
+ "58": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "dispatcher"
},
- "57": {
+ "59": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.listener"
},
- "58": {
+ "60": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.filter"
},
- "59": {
+ "61": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.priority"
},
- "60": {
+ "62": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.dispatcher"
},
- "61": {
+ "63": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.unsubscribe"
},
- "62": {
+ "64": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.unsubscribe"
},
- "63": {
+ "65": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.Subscription.V"
},
- "64": {
+ "66": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt"
},
- "65": {
+ "67": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.add"
},
- "66": {
+ "68": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.add"
},
- "67": {
+ "69": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "listener"
},
- "68": {
+ "70": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "filter"
},
- "69": {
+ "71": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "priority"
},
- "70": {
+ "72": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.remove"
},
- "71": {
+ "73": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.remove"
},
- "72": {
+ "74": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "subscription"
},
- "73": {
+ "75": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.dispatch"
},
- "74": {
+ "76": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.dispatch"
},
- "75": {
+ "77": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "parameter"
},
- "76": {
+ "78": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.clear"
},
- "77": {
+ "79": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.clear"
},
- "78": {
+ "80": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.hasListeners"
},
- "79": {
+ "81": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.hasListeners"
},
- "80": {
+ "82": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcherInt.U"
},
- "81": {
+ "83": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher"
},
- "84": {
+ "86": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.T"
},
- "85": {
+ "87": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.subscriptions"
},
- "86": {
+ "88": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.add"
},
- "87": {
+ "89": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.add"
},
- "88": {
+ "90": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "listener"
},
- "89": {
+ "91": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "filter"
},
- "90": {
+ "92": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "priority"
},
- "91": {
+ "93": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.remove"
},
- "92": {
+ "94": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.remove"
},
- "93": {
+ "95": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "subscription"
},
- "94": {
+ "96": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.dispatch"
},
- "95": {
+ "97": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.dispatch"
},
- "96": {
+ "98": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "event"
},
- "97": {
+ "99": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.clear"
},
- "98": {
+ "100": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.clear"
},
- "99": {
+ "101": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.hasListeners"
},
- "100": {
+ "102": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.hasListeners"
},
- "101": {
+ "103": {
"sourceFileName": "src/test/converter/interface/interface-implementation.ts",
"qualifiedName": "Forms.EventDispatcher.T"
},
- "102": {
+ "104": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": ""
},
- "103": {
+ "105": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base"
},
- "104": {
+ "106": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base.base"
},
- "105": {
+ "107": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base2"
},
- "106": {
+ "108": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base2.base2"
},
- "107": {
+ "109": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Child"
},
- "108": {
+ "110": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Child.child"
},
- "109": {
+ "111": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Child.child3"
},
- "110": {
+ "112": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base.base"
},
- "111": {
+ "113": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base2.base2"
},
- "112": {
+ "114": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Child2"
},
- "113": {
+ "115": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Child2.child2"
},
- "114": {
+ "116": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Child.child"
},
- "115": {
+ "117": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Child.child3"
},
- "116": {
+ "118": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base.base"
},
- "117": {
+ "119": {
"sourceFileName": "src/test/converter/interface/merging.ts",
"qualifiedName": "Base2.base2"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/interface/constructor-type.ts",
+ "2": "src/test/converter/interface/index-signature.ts",
+ "3": "src/test/converter/interface/interface-empty.ts",
+ "4": "src/test/converter/interface/interface-implementation.ts",
+ "5": "src/test/converter/interface/merging.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 14,
+ "3": 30,
+ "4": 38,
+ "5": 104
+ }
}
}
diff --git a/src/test/converter/js/export-eq-type.js b/src/test/converter/js/export-eq-type.js
index 3bf3ea400..feeddbe07 100644
--- a/src/test/converter/js/export-eq-type.js
+++ b/src/test/converter/js/export-eq-type.js
@@ -1,6 +1,6 @@
/** @typedef {string} Foo */
-/** @param {Foo} x */
+/** @param {Foo} x x desc */
const foo = (x) => x;
module.exports = foo;
diff --git a/src/test/converter/js/index.js b/src/test/converter/js/index.js
index a325b7569..172f95e6a 100644
--- a/src/test/converter/js/index.js
+++ b/src/test/converter/js/index.js
@@ -47,8 +47,8 @@
/**
* @callback Foo
- * @param {...string} args
- * @returns {number}
+ * @param {...string} args Foo param description
+ * @returns {number} Foo return description
*/
/** @type {Foo} */
diff --git a/src/test/converter/js/specs.json b/src/test/converter/js/specs.json
index a51677c34..88f393ac6 100644
--- a/src/test/converter/js/specs.json
+++ b/src/test/converter/js/specs.json
@@ -67,6 +67,14 @@
"variant": "param",
"kind": 32768,
"flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "x desc"
+ }
+ ]
+ },
"type": {
"type": "intrinsic",
"name": "string"
@@ -375,6 +383,14 @@
"flags": {
"isRest": true
},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Foo param description"
+ }
+ ]
+ },
"type": {
"type": "array",
"elementType": {
@@ -894,6 +910,20 @@
"variant": "signature",
"kind": 4096,
"flags": {},
+ "comment": {
+ "summary": [],
+ "blockTags": [
+ {
+ "tag": "@returns",
+ "content": [
+ {
+ "kind": "text",
+ "text": "Foo return description"
+ }
+ ]
+ }
+ ]
+ },
"sources": [
{
"fileName": "index.js",
@@ -911,6 +941,14 @@
"flags": {
"isRest": true
},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "Foo param description"
+ }
+ ]
+ },
"type": {
"type": "array",
"elementType": {
@@ -1164,5 +1202,15 @@
"sourceFileName": "src/test/converter/js/index.js",
"qualifiedName": "args"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/js/export-eq-type.js",
+ "2": "src/test/converter/js/index.js"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 6
+ }
}
}
diff --git a/src/test/converter/mixin/specs.json b/src/test/converter/mixin/specs.json
index c96ba825a..5ba85c2b5 100644
--- a/src/test/converter/mixin/specs.json
+++ b/src/test/converter/mixin/specs.json
@@ -180,7 +180,9 @@
"name": "baseProperty",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -225,7 +227,9 @@
"name": "property1",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -250,7 +254,9 @@
"name": "property2",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -275,7 +281,9 @@
"name": "baseMethod",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -290,7 +298,9 @@
"name": "baseMethod",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -357,7 +367,9 @@
"name": "method1",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -372,7 +384,9 @@
"name": "method1",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -426,7 +440,9 @@
"name": "method2",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -441,7 +457,9 @@
"name": "method2",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -705,7 +723,9 @@
"name": "baseProperty",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -730,7 +750,9 @@
"name": "property1",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -755,7 +777,9 @@
"name": "baseMethod",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -770,7 +794,9 @@
"name": "baseMethod",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -801,7 +827,9 @@
"name": "method1",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -816,7 +844,9 @@
"name": "method1",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -930,7 +960,9 @@
"name": "baseProperty",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -955,7 +987,9 @@
"name": "property1",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -980,7 +1014,9 @@
"name": "property2",
"variant": "declaration",
"kind": 1024,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1005,7 +1041,9 @@
"name": "baseMethod",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1020,7 +1058,9 @@
"name": "baseMethod",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1051,7 +1091,9 @@
"name": "method1",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1066,7 +1108,9 @@
"name": "method1",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1120,7 +1164,9 @@
"name": "method2",
"variant": "declaration",
"kind": 2048,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1135,7 +1181,9 @@
"name": "method2",
"variant": "signature",
"kind": 4096,
- "flags": {},
+ "flags": {
+ "isInherited": true
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1532,6 +1580,14 @@
"variant": "declaration",
"kind": 64,
"flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The \"mixin function\" of the Mixin1"
+ }
+ ]
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1547,14 +1603,6 @@
"variant": "signature",
"kind": 4096,
"flags": {},
- "comment": {
- "summary": [
- {
- "kind": "text",
- "text": "The \"mixin function\" of the Mixin1"
- }
- ]
- },
"sources": [
{
"fileName": "mixin.ts",
@@ -1563,7 +1611,7 @@
"url": "typedoc://mixin.ts#L30"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 21,
"name": "T",
@@ -1720,6 +1768,14 @@
"variant": "declaration",
"kind": 64,
"flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The \"mixin function\" of the Mixin2"
+ }
+ ]
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1735,14 +1791,6 @@
"variant": "signature",
"kind": 4096,
"flags": {},
- "comment": {
- "summary": [
- {
- "kind": "text",
- "text": "The \"mixin function\" of the Mixin2"
- }
- ]
- },
"sources": [
{
"fileName": "mixin.ts",
@@ -1751,7 +1799,7 @@
"url": "typedoc://mixin.ts#L50"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 37,
"name": "T",
@@ -1919,6 +1967,14 @@
"variant": "declaration",
"kind": 64,
"flags": {},
+ "comment": {
+ "summary": [
+ {
+ "kind": "text",
+ "text": "The \"mixin function\" of the Mixin3"
+ }
+ ]
+ },
"sources": [
{
"fileName": "mixin.ts",
@@ -1940,14 +1996,6 @@
"variant": "signature",
"kind": 4096,
"flags": {},
- "comment": {
- "summary": [
- {
- "kind": "text",
- "text": "The \"mixin function\" of the Mixin3"
- }
- ]
- },
"sources": [
{
"fileName": "mixin.ts",
@@ -1956,7 +2004,7 @@
"url": "typedoc://mixin.ts#L70"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 57,
"name": "T",
@@ -2465,5 +2513,13 @@
"sourceFileName": "src/test/converter/mixin/mixin.ts",
"qualifiedName": "Base.baseMethod"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/mixin/mixin.ts"
+ },
+ "reflections": {
+ "1": 0
+ }
}
}
diff --git a/src/test/converter/react/specs.json b/src/test/converter/react/specs.json
index 8fd237a69..c3225a456 100644
--- a/src/test/converter/react/specs.json
+++ b/src/test/converter/react/specs.json
@@ -277,5 +277,13 @@
"sourceFileName": "src/test/converter/react/react.tsx",
"qualifiedName": "Demo.render"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/react/react.tsx"
+ },
+ "reflections": {
+ "1": 0
+ }
}
}
diff --git a/src/test/converter/types/specs.json b/src/test/converter/types/specs.json
index c8428ec5e..066942332 100644
--- a/src/test/converter/types/specs.json
+++ b/src/test/converter/types/specs.json
@@ -344,47 +344,49 @@
"url": "typedoc://index-signature.ts#L5"
}
],
- "indexSignature": {
- "id": 18,
- "name": "__index",
- "variant": "signature",
- "kind": 8192,
- "flags": {},
- "sources": [
- {
- "fileName": "index-signature.ts",
- "line": 6,
- "character": 4,
- "url": "typedoc://index-signature.ts#L6"
- }
- ],
- "parameters": [
- {
- "id": 19,
- "name": "optName",
- "variant": "param",
- "kind": 32768,
- "flags": {},
- "type": {
- "type": "templateLiteral",
- "head": "data-",
- "tail": [
- [
- {
- "type": "intrinsic",
- "name": "string"
- },
- ""
+ "indexSignatures": [
+ {
+ "id": 18,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 6,
+ "character": 4,
+ "url": "typedoc://index-signature.ts#L6"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 19,
+ "name": "optName",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "templateLiteral",
+ "head": "data-",
+ "tail": [
+ [
+ {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ ""
+ ]
]
- ]
+ }
}
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "unknown"
}
- ],
- "type": {
- "type": "intrinsic",
- "name": "unknown"
}
- }
+ ]
},
{
"id": 14,
@@ -400,38 +402,40 @@
"url": "typedoc://index-signature.ts#L1"
}
],
- "indexSignature": {
- "id": 15,
- "name": "__index",
- "variant": "signature",
- "kind": 8192,
- "flags": {},
- "sources": [
- {
- "fileName": "index-signature.ts",
- "line": 2,
- "character": 4,
- "url": "typedoc://index-signature.ts#L2"
- }
- ],
- "parameters": [
- {
- "id": 16,
- "name": "sym",
- "variant": "param",
- "kind": 32768,
- "flags": {},
- "type": {
- "type": "intrinsic",
- "name": "symbol"
+ "indexSignatures": [
+ {
+ "id": 15,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 2,
+ "character": 4,
+ "url": "typedoc://index-signature.ts#L2"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 16,
+ "name": "sym",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "intrinsic",
+ "name": "symbol"
+ }
}
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "unknown"
}
- ],
- "type": {
- "type": "intrinsic",
- "name": "unknown"
}
- }
+ ]
},
{
"id": 20,
@@ -447,47 +451,49 @@
"url": "typedoc://index-signature.ts#L9"
}
],
- "indexSignature": {
- "id": 21,
- "name": "__index",
- "variant": "signature",
- "kind": 8192,
- "flags": {},
- "sources": [
- {
- "fileName": "index-signature.ts",
- "line": 10,
- "character": 4,
- "url": "typedoc://index-signature.ts#L10"
- }
- ],
- "parameters": [
- {
- "id": 22,
- "name": "optName",
- "variant": "param",
- "kind": 32768,
- "flags": {},
- "type": {
- "type": "union",
- "types": [
- {
- "type": "intrinsic",
- "name": "string"
- },
- {
- "type": "intrinsic",
- "name": "symbol"
- }
- ]
+ "indexSignatures": [
+ {
+ "id": 21,
+ "name": "__index",
+ "variant": "signature",
+ "kind": 8192,
+ "flags": {},
+ "sources": [
+ {
+ "fileName": "index-signature.ts",
+ "line": 10,
+ "character": 4,
+ "url": "typedoc://index-signature.ts#L10"
+ }
+ ],
+ "parameters": [
+ {
+ "id": 22,
+ "name": "optName",
+ "variant": "param",
+ "kind": 32768,
+ "flags": {},
+ "type": {
+ "type": "union",
+ "types": [
+ {
+ "type": "intrinsic",
+ "name": "string"
+ },
+ {
+ "type": "intrinsic",
+ "name": "symbol"
+ }
+ ]
+ }
}
+ ],
+ "type": {
+ "type": "intrinsic",
+ "name": "unknown"
}
- ],
- "type": {
- "type": "intrinsic",
- "name": "unknown"
}
- }
+ ]
}
],
"groups": [
@@ -704,7 +710,7 @@
"url": "typedoc://mapped.ts#L9"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 30,
"name": "T",
@@ -821,7 +827,7 @@
"url": "typedoc://mapped.ts#L1"
}
],
- "typeParameter": [
+ "typeParameters": [
{
"id": 26,
"name": "T",
@@ -2297,5 +2303,27 @@
"sourceFileName": "src/test/converter/types/union-or-intersection.ts",
"qualifiedName": "ThirdType.thirdComplexProperty"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/types/general.ts",
+ "2": "src/test/converter/types/index-signature.ts",
+ "3": "src/test/converter/types/mapped.ts",
+ "4": "src/test/converter/types/parens.ts",
+ "5": "src/test/converter/types/query.ts",
+ "6": "src/test/converter/types/tuple.ts",
+ "7": "src/test/converter/types/type-operator.ts",
+ "8": "src/test/converter/types/union-or-intersection.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 13,
+ "3": 23,
+ "4": 36,
+ "5": 40,
+ "6": 43,
+ "7": 54,
+ "8": 62
+ }
}
}
diff --git a/src/test/converter/variables/specs.json b/src/test/converter/variables/specs.json
index cc2390a04..b0d5a47fc 100644
--- a/src/test/converter/variables/specs.json
+++ b/src/test/converter/variables/specs.json
@@ -40,7 +40,7 @@
"variant": "signature",
"kind": 16384,
"flags": {},
- "typeParameter": [
+ "typeParameters": [
{
"id": 5,
"name": "T",
@@ -2696,5 +2696,19 @@
"sourceFileName": "src/test/converter/variables/variable.ts",
"qualifiedName": "__object.b"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/variables/array.ts",
+ "2": "src/test/converter/variables/destructuring.ts",
+ "3": "src/test/converter/variables/literal.ts",
+ "4": "src/test/converter/variables/variable.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 15,
+ "3": 34,
+ "4": 96
+ }
}
}
diff --git a/src/test/converter/variables/specs.nodoc.json b/src/test/converter/variables/specs.nodoc.json
index 83567507f..2b7a85989 100644
--- a/src/test/converter/variables/specs.nodoc.json
+++ b/src/test/converter/variables/specs.nodoc.json
@@ -1528,5 +1528,18 @@
"sourceFileName": "src/test/converter/variables/literal.ts",
"qualifiedName": "__object.literal2"
}
+ },
+ "files": {
+ "entries": {
+ "1": "src/test/converter/variables/array.ts",
+ "2": "src/test/converter/variables/destructuring.ts",
+ "3": "src/test/converter/variables/literal.ts",
+ "4": "src/test/converter/variables/variable.ts"
+ },
+ "reflections": {
+ "1": 1,
+ "2": 15,
+ "3": 34
+ }
}
}
diff --git a/src/test/converter2/behavior/cascadedModifiers.ts b/src/test/converter2/behavior/cascadedModifiers.ts
new file mode 100644
index 000000000..a5730a522
--- /dev/null
+++ b/src/test/converter2/behavior/cascadedModifiers.ts
@@ -0,0 +1,14 @@
+/**
+ * @beta
+ */
+export namespace BetaStuff {
+ export class AlsoBeta {
+ betaFish() {}
+
+ /** @alpha */
+ alphaFish() {}
+ }
+}
+
+/** @alpha @beta */
+export const mutuallyExclusive = true;
diff --git a/src/test/converter2/behavior/externalSymbols.ts b/src/test/converter2/behavior/externalSymbols.ts
index f3a7d93c9..05625ed79 100644
--- a/src/test/converter2/behavior/externalSymbols.ts
+++ b/src/test/converter2/behavior/externalSymbols.ts
@@ -1,4 +1,4 @@
-import { Lexer, Slugger } from "marked";
+import { Token, ParseLinkTitleResult } from "markdown-it";
/**
* Testing custom external link resolution
@@ -6,5 +6,5 @@ import { Lexer, Slugger } from "marked";
*/
export type P = Promise<string>;
-export const L = new Lexer();
-export const S = new Slugger();
+export declare const T: Token;
+export declare const Pr: ParseLinkTitleResult;
diff --git a/src/test/converter2/behavior/hideconstructor.ts b/src/test/converter2/behavior/hideconstructor.ts
new file mode 100644
index 000000000..fb65d0370
--- /dev/null
+++ b/src/test/converter2/behavior/hideconstructor.ts
@@ -0,0 +1,14 @@
+// https://github.com/TypeStrong/typedoc/issues/2577
+
+/** @hideconstructor */
+export class StaticOnly {
+ static foo() {}
+
+ /** @hideconstructor */
+ notHidden = true;
+}
+
+export class IgnoredCtor {
+ /** @hideconstructor */
+ constructor() {}
+}
diff --git a/src/test/converter2/behavior/inferredPredicates.ts b/src/test/converter2/behavior/inferredPredicates.ts
new file mode 100644
index 000000000..f24f43836
--- /dev/null
+++ b/src/test/converter2/behavior/inferredPredicates.ts
@@ -0,0 +1,3 @@
+export const isNumber = (x: unknown) => typeof x === "number";
+
+export const isNonNullish = <T>(x: T) => x != null;
diff --git a/src/test/converter2/behavior/refusingToRecurse.ts b/src/test/converter2/behavior/refusingToRecurse.ts
index 6eb6719d0..4afa5bee7 100644
--- a/src/test/converter2/behavior/refusingToRecurse.ts
+++ b/src/test/converter2/behavior/refusingToRecurse.ts
@@ -5,14 +5,14 @@ type OptionalKeys<T> = {
type FromSchema<T> = T extends typeof String
? string
: T extends readonly [typeof Array, infer U]
- ? FromSchema<U>[]
- : {
- [K in OptionalKeys<T>]?: FromSchema<
- (T[K] & { $opt: unknown })["$opt"]
- >;
- } & {
- [K in Exclude<keyof T, OptionalKeys<T>>]: FromSchema<T[K]>;
- };
+ ? FromSchema<U>[]
+ : {
+ [K in OptionalKeys<T>]?: FromSchema<
+ (T[K] & { $opt: unknown })["$opt"]
+ >;
+ } & {
+ [K in Exclude<keyof T, OptionalKeys<T>>]: FromSchema<T[K]>;
+ };
export const schema = {
x: [
diff --git a/src/test/converter2/behavior/resolutionMode.ts b/src/test/converter2/behavior/resolutionMode.ts
index e4e1db574..601055ec9 100644
--- a/src/test/converter2/behavior/resolutionMode.ts
+++ b/src/test/converter2/behavior/resolutionMode.ts
@@ -1,11 +1,7 @@
// Resolve `pkg` as if we were importing with a `require()`
-import type { TypeFromRequire } from "dual" with {
- "resolution-mode": "require"
-};
+import type { TypeFromRequire } from "dual" with { "resolution-mode": "require" };
// Resolve `pkg` as if we were importing with an `import`
-import type { TypeFromImport } from "dual" with {
- "resolution-mode": "import"
-};
+import type { TypeFromImport } from "dual" with { "resolution-mode": "import" };
export interface MergedType extends TypeFromRequire, TypeFromImport {}
diff --git a/src/test/converter2/issues/gh2521.d.ts b/src/test/converter2/issues/gh2521.d.ts
new file mode 100644
index 000000000..253cd0dee
--- /dev/null
+++ b/src/test/converter2/issues/gh2521.d.ts
@@ -0,0 +1,18 @@
+/**
+ * Original comment.
+ */
+export interface Foo {
+ /** Overload 1 */
+ (): void;
+ /** Overload 2 */
+ (baz: number): void;
+}
+
+// Inherits overload comments, but not Foo comment
+// Foo comment could be inherited with {@inheritDoc Foo}
+export const fooWithoutComment: Foo;
+
+/**
+ * New comment.
+ */
+export const fooWithComment: Foo;
diff --git a/src/test/converter2/issues/gh2545.ts b/src/test/converter2/issues/gh2545.ts
new file mode 100644
index 000000000..3061484fb
--- /dev/null
+++ b/src/test/converter2/issues/gh2545.ts
@@ -0,0 +1,28 @@
+/** Parent docs */
+abstract class Parent {
+ /** notAbstract docs */
+ notAbstract(): void {}
+ /** notAbstract2 docs */
+ notAbstract2(): void {}
+ /** isAbstract docs */
+ abstract isAbstract(): void;
+ /** abstractProperty docs */
+ abstract abstractProperty: string;
+}
+
+export class Child extends Parent {
+ override notAbstract2(): void {}
+ override isAbstract(): void {}
+
+ override abstractProperty = "";
+}
+
+// #2084
+export class Foo {
+ /** @internal*/
+ isInternal() {}
+}
+
+export class Bar extends Foo {
+ isInternal() {} // also internal
+}
diff --git a/src/test/converter2/issues/gh2552.js b/src/test/converter2/issues/gh2552.js
new file mode 100644
index 000000000..d4d97f3a0
--- /dev/null
+++ b/src/test/converter2/issues/gh2552.js
@@ -0,0 +1,17 @@
+/**
+ * Summary
+ * @license MIT
+ *
+ * Full permission notice.
+ */
+
+// TS 5.5 @import comments
+/** @import * as ts from "typescript" */
+
+/**
+ * This is an awesome module.
+ * @module good-module
+ */
+
+/** @import * as ts2 from "typescript" */
+export const something = 1;
diff --git a/src/test/converter2/issues/gh2553.ts b/src/test/converter2/issues/gh2553.ts
new file mode 100644
index 000000000..892454b11
--- /dev/null
+++ b/src/test/converter2/issues/gh2553.ts
@@ -0,0 +1,16 @@
+/**
+ * Constructor.
+ *
+ * @param args - Constructor arguments.
+ * @returns New instance.
+ */
+export type Constructor = new (...args: any[]) => object;
+
+/**
+ * Typed constructor.
+ *
+ * @typeParam T - Class type.
+ * @param args - Constructor arguments.
+ * @returns New instance.
+ */
+export type TypedConstructor<T> = new (...args: any[]) => T;
diff --git a/src/test/converter2/issues/gh2574/default.ts b/src/test/converter2/issues/gh2574/default.ts
new file mode 100644
index 000000000..196131c09
--- /dev/null
+++ b/src/test/converter2/issues/gh2574/default.ts
@@ -0,0 +1,6 @@
+/**
+ * Default export and class implementation
+ */
+export default class DefaultExport {
+ constructor() {}
+}
diff --git a/src/test/converter2/issues/gh2574/index.ts b/src/test/converter2/issues/gh2574/index.ts
new file mode 100644
index 000000000..5f521cb67
--- /dev/null
+++ b/src/test/converter2/issues/gh2574/index.ts
@@ -0,0 +1,5 @@
+import { Default, NotDefault } from "./reexported";
+
+export function usesDefaultExport(param: Default) {}
+
+export function usesNonDefaultExport(param: NotDefault) {}
diff --git a/src/test/converter2/issues/gh2574/notDefault.ts b/src/test/converter2/issues/gh2574/notDefault.ts
new file mode 100644
index 000000000..d2482e2c0
--- /dev/null
+++ b/src/test/converter2/issues/gh2574/notDefault.ts
@@ -0,0 +1,3 @@
+export class NotDefaultExport {
+ constructor() {}
+}
diff --git a/src/test/converter2/issues/gh2574/reexported.ts b/src/test/converter2/issues/gh2574/reexported.ts
new file mode 100644
index 000000000..f09daf171
--- /dev/null
+++ b/src/test/converter2/issues/gh2574/reexported.ts
@@ -0,0 +1,2 @@
+export { default as Default } from "./default";
+export { NotDefaultExport as NotDefault } from "./notDefault";
diff --git a/src/test/converter2/issues/gh2582.ts b/src/test/converter2/issues/gh2582.ts
new file mode 100644
index 000000000..7e65eddd9
--- /dev/null
+++ b/src/test/converter2/issues/gh2582.ts
@@ -0,0 +1,22 @@
+function getApi<T>(Ctor: new () => T) {
+ return {
+ /** Member comment */
+ member: 1,
+ /** Fn comment */
+ fn: () => new Ctor(),
+ };
+}
+
+function getAPIs<T1, T2>(Ctor1: new () => T1, Ctor2: new () => T2) {
+ const a = getApi(Ctor1);
+
+ return {
+ /** A comment @namespace*/
+ a,
+ /** B comment @namespace */
+ b: getApi(Ctor2),
+ };
+}
+
+/** f32 comment @namespace */
+export const f32 = getAPIs(Float32Array, Float64Array);
diff --git a/src/test/converter2/issues/gh2585.ts b/src/test/converter2/issues/gh2585.ts
new file mode 100644
index 000000000..8bf1e280e
--- /dev/null
+++ b/src/test/converter2/issues/gh2585.ts
@@ -0,0 +1,13 @@
+// prettier-ignore
+
+export type Foo =
+ /**
+ * Doc of foo1.
+ */
+ | "foo1"
+ /** Not used */
+ |
+ /**
+ * Doc of foo2.
+ */
+ "foo2";
diff --git a/src/test/converter2/issues/gh2587.ts b/src/test/converter2/issues/gh2587.ts
new file mode 100644
index 000000000..9a94e84dd
--- /dev/null
+++ b/src/test/converter2/issues/gh2587.ts
@@ -0,0 +1,9 @@
+export function foo() {
+ const x = 1;
+ return {
+ /**
+ * Shorthand comment
+ */
+ x,
+ };
+}
diff --git a/src/test/converter2/issues/gh2603.ts b/src/test/converter2/issues/gh2603.ts
new file mode 100644
index 000000000..c12406c6a
--- /dev/null
+++ b/src/test/converter2/issues/gh2603.ts
@@ -0,0 +1,4 @@
+/**
+ * @author Ian Awesome
+ */
+export const x = 1;
diff --git a/src/test/converter2/issues/gh2611.d.ts b/src/test/converter2/issues/gh2611.d.ts
new file mode 100644
index 000000000..03ca47322
--- /dev/null
+++ b/src/test/converter2/issues/gh2611.d.ts
@@ -0,0 +1,4 @@
+/**
+ * @tagThatIsNotDefined
+ */
+export var num: number;
diff --git a/src/test/converter2/issues/gh2614.ts b/src/test/converter2/issues/gh2614.ts
new file mode 100644
index 000000000..2f495bb60
--- /dev/null
+++ b/src/test/converter2/issues/gh2614.ts
@@ -0,0 +1,4 @@
+/**
+ * @since 1.0.0
+ */
+export function foo() {}
diff --git a/src/test/events.test.ts b/src/test/events.test.ts
index 4e74b18dd..5f3a1b107 100644
--- a/src/test/events.test.ts
+++ b/src/test/events.test.ts
@@ -1,957 +1,80 @@
-// Backbone.js 1.2.3
-// (c) 2010-2015 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors
-// Backbone may be freely distributed under the MIT license.
-// For all details and documentation:
-// https://backbonejs.org
-//
-// This test case was taken from
-// https://github.com/jashkenas/backbone/blob/6b927eb5e7081af16f97d9c15e34b030624a68f9/test/events.js
+import { deepStrictEqual as equal } from "assert";
+import { EventDispatcher } from "../lib/utils";
-import Assert = require("assert");
-import { EventDispatcher, Event } from "../lib/utils/events";
+describe("EventDispatcher", () => {
+ it("Works in simple cases", () => {
+ const emitter = new EventDispatcher<{ a: [] }>();
-function size(thing: any): number {
- if (!thing) return 0;
- return Object.keys(thing).length;
-}
-
-class Events extends EventDispatcher {
- counter = 0;
- counterA = 0;
- counterB = 0;
-}
-
-describe("Events", function () {
- it("on and trigger", function () {
- const obj = new Events();
- obj.counter = 0;
-
- obj.on("event", function () {
- obj.counter += 1;
- });
- obj.trigger("event");
- Assert.equal(obj.counter, 1, "counter should be incremented.");
-
- obj.trigger("event");
- obj.trigger("event");
- obj.trigger("event");
- obj.trigger("event");
- Assert.equal(
- obj.counter,
- 5,
- "counter should be incremented five times.",
- );
- });
-
- it("binding and triggering multiple events", function () {
- const obj = new Events();
- obj.counter = 0;
-
- obj.on("a b c", function () {
- obj.counter += 1;
- });
-
- obj.trigger("a");
- Assert.equal(obj.counter, 1);
-
- obj.trigger("a b");
- Assert.equal(obj.counter, 3);
-
- obj.trigger("c");
- Assert.equal(obj.counter, 4);
-
- obj.off("a c");
- obj.trigger("a b c");
- Assert.equal(obj.counter, 5);
- });
-
- it("binding and triggering with event maps", function () {
- const obj = new Events();
- obj.counter = 0;
-
- const increment = function (this: Events) {
- this.counter += 1;
- };
-
- obj.on(
- {
- a: increment,
- b: increment,
- c: increment,
- },
- obj,
- );
-
- obj.trigger("a");
- Assert.equal(obj.counter, 1);
-
- obj.trigger("a b");
- Assert.equal(obj.counter, 3);
-
- obj.trigger("c");
- Assert.equal(obj.counter, 4);
-
- obj.off(
- {
- a: increment,
- c: increment,
- },
- obj,
- );
- obj.trigger("a b c");
- Assert.equal(obj.counter, 5);
- });
-
- it("binding and triggering multiple event names with event maps", function () {
- const obj = new Events();
- obj.counter = 0;
-
- const increment = function (this: Events) {
- this.counter += 1;
- };
-
- obj.on({
- "a b c": increment,
- });
-
- obj.trigger("a");
- Assert.equal(obj.counter, 1);
-
- obj.trigger("a b");
- Assert.equal(obj.counter, 3);
-
- obj.trigger("c");
- Assert.equal(obj.counter, 4);
-
- obj.off({
- "a c": increment,
- });
- obj.trigger("a b c");
- Assert.equal(obj.counter, 5);
- });
-
- it("binding and trigger with event maps context", function (this: any) {
- const obj = new Events();
- obj.counter = 0;
- const context = {};
-
- obj.on(
- {
- a: function () {
- Assert.strictEqual(
- this,
- context,
- "defaults `context` to `callback` param",
- );
- },
- },
- context,
- ).trigger("a");
-
- obj.off()
- .on(
- {
- a: function (this: any) {
- Assert.strictEqual(
- this,
- context,
- "will not override explicit `context` param",
- );
- },
- },
- this,
- context,
- )
- .trigger("a");
- });
-
- it("listenTo and stopListening", function () {
- const a = new Events();
- const b = new Events();
-
- a.listenTo(b, "all", function () {
- Assert(true);
- });
- b.trigger("anything");
-
- a.listenTo(b, "all", function () {
- Assert(false);
- });
- a.stopListening();
- b.trigger("anything");
- });
-
- it("listenTo and stopListening with event maps", function () {
- const a = new Events();
- const b = new Events();
- const cb = function () {
- Assert(true);
- };
-
- a.listenTo(b, { event: cb });
- b.trigger("event");
-
- a.listenTo(b, { event2: cb });
- b.on("event2", cb);
- a.stopListening(b, { event2: cb });
- b.trigger("event event2");
-
- a.stopListening();
- b.trigger("event event2");
- });
-
- it("stopListening with omitted args", function () {
- const a = new Events();
- const b = new Events();
- const cb = function () {
- Assert(true);
- };
- a.listenTo(b, "event", cb);
- b.on("event", cb);
- a.listenTo(b, "event2", cb);
- a.stopListening(undefined, { event: cb });
- b.trigger("event event2");
- b.off();
- a.listenTo(b, "event event2", cb);
- a.stopListening(undefined, "event");
- a.stopListening();
- b.trigger("event2");
- });
-
- it("listenToOnce", function () {
- // Same as the previous test, but we use once rather than having to explicitly unbind
- const obj = new Events();
- obj.counterA = 0;
- obj.counterB = 0;
-
- const incrA = function () {
- obj.counterA += 1;
- obj.trigger("event");
- };
- const incrB = function () {
- obj.counterB += 1;
- };
- obj.listenToOnce(obj, "event", incrA);
- obj.listenToOnce(obj, "event", incrB);
- obj.trigger("event");
- Assert.equal(
- obj.counterA,
- 1,
- "counterA should have only been incremented once.",
- );
- Assert.equal(
- obj.counterB,
- 1,
- "counterB should have only been incremented once.",
- );
- });
-
- it("listenToOnce and stopListening", function () {
- const a = new Events();
- const b = new Events();
- a.listenToOnce(b, "all", function () {
- Assert(true);
- });
- b.trigger("anything");
- b.trigger("anything");
- a.listenToOnce(b, "all", function () {
- Assert(false);
- });
- a.stopListening();
- b.trigger("anything");
- });
-
- it("listenTo, listenToOnce and stopListening", function () {
- const a = new Events();
- const b = new Events();
- a.listenToOnce(b, "all", function () {
- Assert(true);
- });
- b.trigger("anything");
- b.trigger("anything");
- a.listenTo(b, "all", function () {
- Assert(false);
- });
- a.stopListening();
- b.trigger("anything");
- });
-
- it("listenTo and stopListening with event maps", function () {
- const a = new Events();
- const b = new Events();
- a.listenTo(b, {
- change: function () {
- Assert(true);
- },
- });
- b.trigger("change");
- a.listenTo(b, {
- change: function () {
- Assert(false);
- },
- });
- a.stopListening();
- b.trigger("change");
- });
-
- it("listenTo yourself", function () {
- const e = new Events();
- e.listenTo(e, "foo", function () {
- Assert(true);
- });
- e.trigger("foo");
- });
-
- it("listenTo yourself cleans yourself up with stopListening", function () {
- const e = new Events();
- e.listenTo(e, "foo", function () {
- Assert(true);
- });
- e.trigger("foo");
-
- e.listenTo(e, "foo", function () {
- Assert(false);
- });
- e.stopListening();
- e.trigger("foo");
- });
-
- it("stopListening cleans up references", function () {
- const a: any = new Events();
- const b: any = new Events();
- const fn = function () {
- // nop
- };
- b.on("event", fn);
-
- a.listenTo(b, "event", fn).stopListening();
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
-
- a.listenTo(b, "event", fn).stopListening(b);
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
-
- a.listenTo(b, "event", fn).stopListening(b, "event");
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
-
- a.listenTo(b, "event", fn).stopListening(b, "event", fn);
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
- });
-
- it("stopListening cleans up references from listenToOnce", function () {
- const a: any = new Events();
- const b: any = new Events();
- const fn = function () {
- // nop
- };
- b.on("event", fn);
-
- a.listenToOnce(b, "event", fn).stopListening();
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
-
- a.listenToOnce(b, "event", fn).stopListening(b);
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
-
- a.listenToOnce(b, "event", fn).stopListening(b, "event");
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
-
- a.listenToOnce(b, "event", fn).stopListening(b, "event", fn);
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._events.event), 1);
- Assert.equal(size(b._listeners), 0);
- });
-
- it("listenTo and off cleaning up references", function () {
- const a: any = new Events();
- const b: any = new Events();
- const fn = function () {
- // nop
- };
-
- a.listenTo(b, "event", fn);
- b.off();
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._listeners), 0);
-
- a.listenTo(b, "event", fn);
- b.off("event");
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._listeners), 0);
-
- a.listenTo(b, "event", fn);
- b.off(null, fn);
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._listeners), 0);
-
- a.listenTo(b, "event", fn);
- b.off(null, null, a);
- Assert.equal(size(a._listeningTo), 0);
- Assert.equal(size(b._listeners), 0);
- });
-
- it("listenTo and stopListening cleaning up references", function () {
- const a = new Events();
- const b = new Events();
-
- a.listenTo(b, "all", function () {
- Assert(true);
- });
- b.trigger("anything");
-
- a.listenTo(b, "other", function () {
- Assert(false);
- });
- a.stopListening(b, "other");
- a.stopListening(b, "all");
-
- Assert.equal(size((<any>a)._listeningTo), 0);
- });
-
- it("listenToOnce without context cleans up references after the event has fired", function () {
- const a = new Events();
- const b = new Events();
- a.listenToOnce(b, "all", function () {
- Assert(true);
+ let calls = 0;
+ emitter.on("a", () => {
+ calls++;
});
- b.trigger("anything");
- Assert.equal(size((<any>a)._listeningTo), 0);
- });
-
- it("listenToOnce with event maps cleans up references", function () {
- const a = new Events();
- const b = new Events();
- a.listenToOnce(b, {
- one: function () {
- Assert(true);
- },
- two: function () {
- Assert(false);
- },
- });
- b.trigger("one");
- Assert.equal(size((<any>a)._listeningTo), 1);
- });
-
- it("listenToOnce with event maps binds the correct `this`", function () {
- const a = new Events();
- const b = new Events();
- a.listenToOnce(b, {
- one: function (this: Events) {
- Assert(this === a);
- },
- two: function () {
- Assert(false);
- },
- });
- b.trigger("one");
- });
-
- it("listenTo with empty callback does not throw an error", function () {
- const e = new Events();
- e.listenTo(e, "foo", undefined);
- e.trigger("foo");
- Assert(true);
- });
-
- it("trigger all for each event", function () {
- let a = false;
- let b = false;
- const obj = new Events();
- obj.counter = 0;
- obj.on("all", function (event: string) {
- obj.counter++;
- if (event === "a") {
- a = true;
- }
- if (event === "b") {
- b = true;
- }
- }).trigger("a b");
- Assert(a);
- Assert(b);
- Assert.equal(obj.counter, 2);
- });
-
- it("on, then unbind all functions", function () {
- const obj = new Events();
- obj.counter = 0;
- const callback = function () {
- obj.counter += 1;
- };
+ equal(calls, 0);
- obj.on("event", callback);
- obj.trigger("event");
- obj.off("event");
- obj.trigger("event");
- Assert.equal(
- obj.counter,
- 1,
- "counter should have only been incremented once.",
- );
+ emitter.trigger("a");
+ equal(calls, 1);
+ emitter.trigger("a");
+ equal(calls, 2);
});
- it("bind two callbacks, unbind only one", function () {
- const obj = new Events();
- obj.counterA = 0;
- obj.counterB = 0;
- const callback = function () {
- obj.counterA += 1;
- };
- obj.on("event", callback);
- obj.on("event", function () {
- obj.counterB += 1;
- });
- obj.trigger("event");
- obj.off("event", callback);
- obj.trigger("event");
- Assert.equal(
- obj.counterA,
- 1,
- "counterA should have only been incremented once.",
- );
- Assert.equal(
- obj.counterB,
- 2,
- "counterB should have been incremented twice.",
- );
- });
+ it("Allows removing listeners", () => {
+ const emitter = new EventDispatcher<{ a: [] }>();
- it("unbind a callback in the midst of it firing", function () {
- const obj = new Events();
- obj.counter = 0;
- const callback = function () {
- obj.counter += 1;
- obj.off("event", callback);
+ let calls = 0;
+ const listener = () => {
+ calls++;
};
- obj.on("event", callback);
- obj.trigger("event");
- obj.trigger("event");
- obj.trigger("event");
- Assert.equal(obj.counter, 1, "the callback should have been unbound.");
- });
-
- it("two binds that unbind themeselves", function () {
- const obj = new Events();
- obj.counterA = 0;
- obj.counterB = 0;
- const incrA = function () {
- obj.counterA += 1;
- obj.off("event", incrA);
- };
- const incrB = function () {
- obj.counterB += 1;
- obj.off("event", incrB);
- };
- obj.on("event", incrA);
- obj.on("event", incrB);
- obj.trigger("event");
- obj.trigger("event");
- obj.trigger("event");
- Assert.equal(
- obj.counterA,
- 1,
- "counterA should have only been incremented once.",
- );
- Assert.equal(
- obj.counterB,
- 1,
- "counterB should have only been incremented once.",
- );
- });
-
- it("bind a callback with a supplied context", function () {
- class TestClass {
- assertTrue() {
- Assert(true, "`this` was bound to the callback");
- }
- }
-
- const obj = new Events();
- obj.on(
- "event",
- function (this: TestClass) {
- this.assertTrue();
- },
- new TestClass(),
- );
- obj.trigger("event");
- });
+ emitter.off("a", listener);
+ equal(calls, 0);
- it("nested trigger with unbind", function () {
- const obj = new Events();
- obj.counter = 0;
- const incr1 = function () {
- obj.counter += 1;
- obj.off("event", incr1);
- obj.trigger("event");
- };
- const incr2 = function () {
- obj.counter += 1;
- };
- obj.on("event", incr1);
- obj.on("event", incr2);
- obj.trigger("event");
- Assert.equal(
- obj.counter,
- 3,
- "counter should have been incremented three times",
- );
+ emitter.trigger("a");
+ equal(calls, 0);
});
- it("callback list is not altered during trigger", function () {
- let counter = 0;
- const obj = new Events();
- const incr = function () {
- counter++;
- };
- const incrOn = function () {
- obj.on("event all", incr);
- };
- const incrOff = function () {
- obj.off("event all", incr);
- };
-
- obj.on("event all", incrOn).trigger("event");
- Assert.equal(counter, 0, "on does not alter callback list");
+ it("Works correctly with missing listeners", () => {
+ const emitter = new EventDispatcher<{ a: [] }>();
- obj.off().on("event", incrOff).on("event all", incr).trigger("event");
- Assert.equal(counter, 2, "off does not alter callback list");
- });
-
- it("#1282 - 'all' callback list is retrieved after each event.", function () {
- let counter = 0;
- const obj = new Events();
- const incr = function () {
- counter++;
+ let calls = 0;
+ const listener = () => {
+ calls++;
};
-
- obj.on("x", function () {
- obj.on("y", incr).on("all", incr);
- }).trigger("x y");
-
- Assert.strictEqual(counter, 2);
- });
-
- it("if no callback is provided, `on` is a noop", function () {
- (<any>new Events()).on("test").trigger("test");
- });
-
- it("if callback is truthy but not a function, `on` should throw an error just like jQuery", function () {
- const view = (<any>new Events()).on("test", "noop");
- Assert.throws(function () {
- view.trigger("test");
+ emitter.on("a", () => {
+ calls++;
});
- });
-
- it("remove all events for a specific context", function () {
- const obj = new Events();
- obj.on("x y all", function () {
- Assert(true);
- });
- obj.on(
- "x y all",
- function () {
- Assert(false);
- },
- obj,
- );
- obj.off(undefined, undefined, obj);
- obj.trigger("x y");
- });
-
- it("remove all events for a specific callback", function () {
- const obj = new Events();
- const success = function () {
- Assert(true);
- };
- const fail = function () {
- Assert(false);
- };
- obj.on("x y all", success);
- obj.on("x y all", fail);
- obj.off(undefined, fail);
- obj.trigger("x y");
- });
-
- it("#1310 - off does not skip consecutive events", function () {
- const obj = new Events();
- obj.on(
- "event",
- function () {
- Assert(false);
- },
- obj,
- );
- obj.on(
- "event",
- function () {
- Assert(false);
- },
- obj,
- );
- obj.off(undefined, undefined, obj);
- obj.trigger("event");
- });
-
- it("once", function () {
- // Same as the previous test, but we use once rather than having to explicitly unbind
- const obj = new Events();
- obj.counterA = 0;
- obj.counterB = 0;
+ emitter.off("a", listener);
- const incrA = function () {
- obj.counterA += 1;
- obj.trigger("event");
- };
- const incrB = function () {
- obj.counterB += 1;
- };
- obj.once("event", incrA);
- obj.once("event", incrB);
- obj.trigger("event");
- Assert.equal(
- obj.counterA,
- 1,
- "counterA should have only been incremented once.",
- );
- Assert.equal(
- obj.counterB,
- 1,
- "counterB should have only been incremented once.",
- );
- });
-
- it("once variant one", function () {
- let count = 0;
- const f = function () {
- count += 1;
- };
-
- const a = new Events().once("event", f);
- const b = new Events().on("event", f);
-
- a.trigger("event");
- b.trigger("event");
- b.trigger("event");
-
- Assert.equal(count, 3);
- });
-
- it("once variant two", function () {
- let count = 0;
- const obj = new Events();
- const f = function () {
- count += 1;
- };
-
- obj.once("event", f).on("event", f).trigger("event").trigger("event");
-
- Assert.equal(count, 3);
- });
-
- it("once with off", function () {
- const obj = new Events();
- const f = function () {
- Assert(false);
- };
-
- obj.once("event", f);
- obj.off("event", f);
- obj.trigger("event");
- });
-
- it("once with event maps", function () {
- const obj = new Events();
- obj.counter = 0;
-
- const increment = function (this: Events) {
- this.counter += 1;
- };
-
- obj.once(
- {
- a: increment,
- b: increment,
- c: increment,
- },
- obj,
- );
-
- obj.trigger("a");
- Assert.equal(obj.counter, 1);
-
- obj.trigger("a b");
- Assert.equal(obj.counter, 2);
-
- obj.trigger("c");
- Assert.equal(obj.counter, 3);
-
- obj.trigger("a b c");
- Assert.equal(obj.counter, 3);
+ emitter.trigger("a");
+ equal(calls, 1);
});
- it("once with off only by context", function () {
- const context = {};
- const obj = new Events();
- obj.once(
- "event",
- function () {
- Assert(false);
- },
- context,
- );
- obj.off(undefined, undefined, context);
- obj.trigger("event");
- });
+ it("Works if a listener is removed while emitting", () => {
+ const emitter = new EventDispatcher<{ a: [] }>();
- it("once with multiple events.", function () {
- let count = 0;
- const obj = new Events();
- obj.once("x y", function () {
- count += 1;
+ let calls = 0;
+ emitter.on("a", function rem() {
+ calls++;
+ emitter.off("a", rem);
});
- obj.trigger("x y");
- Assert.equal(count, 2);
- });
-
- it("Off during iteration with once.", function () {
- let count = 0;
- const obj = new Events();
- const f = function (this: Events) {
- this.off("event", f);
- };
- obj.on("event", f);
- obj.once("event", function () {
- // nop
+ emitter.on("a", () => {
+ calls++;
});
- obj.on("event", function () {
- count += 1;
- });
-
- obj.trigger("event");
- obj.trigger("event");
- Assert.equal(count, 2);
- });
-
- it("`once` on `all` should work as expected", function () {
- let count = 0;
- const obj = new Events();
- obj.once("all", function () {
- count += 1;
- obj.trigger("all");
- });
- obj.trigger("all");
-
- Assert.equal(count, 1);
- });
-
- it("once without a callback is a noop", function () {
- (<any>new Events()).once("event").trigger("event");
- });
+ equal(calls, 0);
- it("listenToOnce without a callback is a noop", function () {
- const obj = new Events();
- (<any>obj).listenToOnce(obj, "event").trigger("event");
+ emitter.trigger("a");
+ equal(calls, 2);
+ emitter.trigger("a");
+ equal(calls, 3);
});
- it("event functions are chainable", function () {
- const obj = new Events();
- const obj2 = new Events();
- const fn = function () {
- // nop
- };
-
- Assert.equal(obj, obj.trigger("noeventssetyet"));
- Assert.equal(obj, obj.off("noeventssetyet"));
- Assert.equal(obj, obj.stopListening(undefined, "noeventssetyet"));
- Assert.equal(obj, obj.on("a", fn));
- Assert.equal(obj, obj.once("c", fn));
- Assert.equal(obj, obj.trigger("a"));
- Assert.equal(obj, obj.listenTo(obj2, "a", fn));
- Assert.equal(obj, obj.listenToOnce(obj2, "b", fn));
- Assert.equal(obj, obj.off("a c"));
- Assert.equal(obj, obj.stopListening(obj2, "a"));
- Assert.equal(obj, obj.stopListening());
- });
-
- it("#3448 - listenToOnce with space-separated events", function () {
- const one = new Events();
- const two = new Events();
- let count = 1;
- one.listenToOnce(two, "x y", function (n: number) {
- Assert(n === count++);
- });
- two.trigger("x", 1);
- two.trigger("x", 1);
- two.trigger("y", 2);
- two.trigger("y", 2);
- });
-});
+ it("Calls listeners according to their order", () => {
+ const emitter = new EventDispatcher<{ a: [] }>();
-describe("Events (customized)", function () {
- it("accepts event objects", function () {
- let count = 0;
- const events = new Events();
- const event = new Event("myEvent");
- events.on("myEvent", function (e: Event) {
- Assert(e instanceof Event);
- count += 1;
- });
- events.trigger(event);
- Assert.equal(count, 1);
- });
-
- it("stops propagation", function () {
- let count = 0;
- const events = new Events();
- const event = new Event("myEvent");
- events.on("myEvent", function (e: Event) {
- count++;
- e.stopPropagation();
- });
- events.on("myEvent", function () {
- count++;
- Assert(false);
- });
- events.trigger(event);
- Assert.equal(count, 1);
- });
+ const calls: number[] = [];
+ emitter.on("a", () => calls.push(3), 25);
+ emitter.on("a", () => calls.push(2), 50);
+ emitter.on("a", () => calls.push(1), 50);
- it("sorts handlers by priority", function () {
- let count = 0;
- const events = new Events();
- events.on(
- "myEvent",
- function () {
- Assert.equal(count, 1);
- count++;
- },
- void 0,
- 0,
- );
- events.on(
- "myEvent",
- function () {
- Assert.equal(count, 0);
- count++;
- },
- void 0,
- 100,
- );
- events.trigger("myEvent");
- Assert.equal(count, 2);
+ emitter.trigger("a");
+ equal(calls, [1, 2, 3]);
});
});
diff --git a/src/test/internationalization.test.ts b/src/test/internationalization.test.ts
new file mode 100644
index 000000000..293ce8c78
--- /dev/null
+++ b/src/test/internationalization.test.ts
@@ -0,0 +1,96 @@
+import { deepEqual as equal, ok } from "assert/strict";
+import { Application } from "..";
+import { readdirSync } from "fs";
+import { join } from "path";
+import { translatable } from "../lib/internationalization/translatable";
+import { setDifference } from "../lib/utils/set";
+import {
+ blockTags,
+ inlineTags,
+ modifierTags,
+} from "../lib/utils/options/tsdoc-defaults";
+
+const allValidTranslationKeys = Object.keys(translatable);
+// The tag names do not actually exist in the default locale, but are valid
+// for translation, so include them here.
+allValidTranslationKeys.push(...blockTags.map((s) => "tag_" + s.substring(1)));
+allValidTranslationKeys.push(
+ ...modifierTags.map((s) => "tag_" + s.substring(1)),
+);
+allValidTranslationKeys.push(...inlineTags.map((s) => "tag_" + s.substring(1)));
+
+describe("Internationalization", () => {
+ let app: Application;
+ before(async () => {
+ app = await Application.bootstrap({}, []);
+ });
+
+ afterEach(() => {
+ app.options.reset();
+ });
+
+ it("Supports getting the list of supported languages", () => {
+ const langs = app.internationalization.getSupportedLanguages();
+ ok(langs.includes("en"));
+ ok(langs.includes("ko"));
+ ok(langs.includes("jp"));
+ });
+
+ it("Supports translating without placeholders", () => {
+ equal(
+ app.i18n.no_entry_points_to_merge(),
+ "No entry points provided to merge",
+ );
+ app.options.setValue("lang", "zh");
+ equal(app.i18n.no_entry_points_to_merge(), "没有提供合并的入口点");
+ });
+
+ it("Supports translating with placeholders", () => {
+ equal(
+ app.i18n.docs_generated_at_0("X"),
+ "Documentation generated at X",
+ );
+ app.options.setValue("lang", "zh");
+ equal(app.i18n.docs_generated_at_0("X"), "文档生成于 X");
+ });
+});
+
+describe("Locales", () => {
+ const localeRoot = join(__dirname, "../lib/internationalization/locales");
+
+ for (const locale of readdirSync(localeRoot)) {
+ it(`${locale} defines a valid locale`, () => {
+ // eslint-disable-next-line @typescript-eslint/no-var-requires
+ const translations = require(join(localeRoot, locale)) as Record<
+ string,
+ string
+ >;
+
+ for (const [key, translation] of Object.entries(translations)) {
+ const validPlaceholders = Array.from(
+ key.matchAll(/_(\d+)_|(\d+)$/g),
+ (m) => m[1] || m[2],
+ );
+
+ for (const placeholder of translation.matchAll(/\{(\d+?)\}/g)) {
+ ok(
+ validPlaceholders.includes(placeholder[1]),
+ `${key} translation references "${placeholder[0]}" which will not be available at runtime.`,
+ );
+ }
+ }
+
+ const extraKeys = Array.from(
+ setDifference(
+ Object.keys(translations),
+ allValidTranslationKeys,
+ ),
+ );
+ equal(
+ extraKeys,
+ [],
+ `${locale} defines translations which do not exist in the default locale.`,
+ );
+ });
+ }
+});
diff --git a/src/test/issues.c2.test.ts b/src/test/issues.c2.test.ts
index 7c2c69425..bb3866389 100644
--- a/src/test/issues.c2.test.ts
+++ b/src/test/issues.c2.test.ts
@@ -12,7 +12,7 @@ import {
DeclarationReflection,
IntrinsicType,
LiteralType,
- ProjectReflection,
+ type ProjectReflection,
QueryType,
ReferenceReflection,
ReflectionKind,
@@ -27,7 +27,14 @@ import {
getConverter2Program,
} from "./programs";
import { TestLogger } from "./TestLogger";
-import { getComment, getLinks, query, querySig } from "./utils";
+import {
+ equalKind,
+ getComment,
+ getLinks,
+ getSigComment,
+ query,
+ querySig,
+} from "./utils";
import { DefaultTheme, PageEvent } from "..";
const base = getConverter2Base();
@@ -112,7 +119,10 @@ describe("Issue Tests", () => {
(r) => r.name === "Foo" && r.kind === ReflectionKind.Class,
);
ok(classFoo instanceof DeclarationReflection);
- equal(classFoo.children?.find((r) => r.name === "x"), undefined);
+ equal(
+ classFoo.children?.find((r) => r.name === "x"),
+ undefined,
+ );
const nsFoo = project.children?.find(
(r) => r.name === "Foo" && r.kind === ReflectionKind.Namespace,
@@ -121,7 +131,7 @@ describe("Issue Tests", () => {
ok(nsFoo.children?.find((r) => r.name === "x"));
});
- it("Supports computed names #941", () => {
+ it("#941 Supports computed names ", () => {
const project = convert();
const obj = query(project, "Obj");
equal(
@@ -146,7 +156,7 @@ describe("Issue Tests", () => {
it("#1150", () => {
const project = convert();
const refl = query(project, "IntersectFirst");
- equal(refl?.kind, ReflectionKind.TypeAlias);
+ equal(refl.kind, ReflectionKind.TypeAlias);
equal(refl.type?.type, "indexedAccess");
});
@@ -191,7 +201,7 @@ describe("Issue Tests", () => {
it("#1330", () => {
const project = convert();
const example = query(project, "ExampleParam");
- equal(example?.type?.type, "reference");
+ equal(example.type?.type, "reference");
equal(example.type.toString(), "Example");
});
@@ -203,15 +213,17 @@ describe("Issue Tests", () => {
it("#1408", () => {
const project = convert();
- const foo = query(project, "foo");
- const type = foo?.signatures?.[0]?.typeParameters?.[0].type;
- equal(type?.type, "array");
+ const foo = querySig(project, "foo");
+ const type = foo.typeParameters?.[0].type;
equal(type?.toString(), "unknown[]");
});
it("#1436", () => {
const project = convert();
- equal(project.children?.map((c) => c.name), ["gh1436"]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["gh1436"],
+ );
});
it("#1449", () => {
@@ -225,15 +237,13 @@ describe("Issue Tests", () => {
it("#1454", () => {
const project = convert();
- const foo = query(project, "foo");
- const fooRet = foo?.signatures?.[0]?.type;
- equal(fooRet?.type, "reference");
- equal(fooRet?.toString(), "Foo");
+ const foo = querySig(project, "foo");
+ equal(foo.type?.type, "reference");
+ equal(foo.type.toString(), "Foo");
- const bar = query(project, "bar");
- const barRet = bar?.signatures?.[0]?.type;
- equal(barRet?.type, "reference");
- equal(barRet?.toString(), "Bar");
+ const bar = querySig(project, "bar");
+ equal(bar.type?.type, "reference");
+ equal(bar.type.toString(), "Bar");
});
it("#1462", () => {
@@ -303,9 +313,10 @@ describe("Issue Tests", () => {
it("#1522", () => {
app.options.setValue("categorizeByGroup", true);
const project = convert();
- equal(project.groups?.map((g) => g.categories?.map((c) => c.title)), [
- ["cat"],
- ]);
+ equal(
+ project.groups?.map((g) => g.categories?.map((c) => c.title)),
+ [["cat"]],
+ );
});
it("#1524", () => {
@@ -330,11 +341,10 @@ describe("Issue Tests", () => {
it("#1547", () => {
const project = convert();
- equal(project.children?.map((c) => c.name), [
- "Test",
- "ThingA",
- "ThingB",
- ]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["Test", "ThingA", "ThingB"],
+ );
});
it("#1552", () => {
@@ -384,26 +394,29 @@ describe("Issue Tests", () => {
const project = convert();
const ctor = query(project, "Foo.constructor");
equal(ctor.sources?.[0]?.line, 2);
- equal(ctor.sources?.[0]?.character, 4);
+ equal(ctor.sources[0].character, 4);
});
- it("Handles comment discovery with expando functions #1651", () => {
+ it("#1651 Handles comment discovery with expando functions ", () => {
const project = convert();
- equal(project.children?.map((c) => c.name), ["bar"]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["bar"],
+ );
- equal(project.children[0].children?.map((c) => c.name), [
- "metadata",
- "fn",
- ]);
+ equal(
+ project.children[0].children?.map((c) => c.name),
+ ["metadata", "fn"],
+ );
const comments = [
- project.children[0].comment?.summary,
- project.children[0].children[0].comment?.summary,
- project.children[0].children[1].signatures![0].comment?.summary,
- project.children[0].signatures![0].comment?.summary,
- ].map(Comment.combineDisplayParts);
+ query(project, "bar"),
+ query(project, "bar.metadata"),
+ querySig(project, "bar.fn"),
+ querySig(project, "bar"),
+ ].map((r) => Comment.combineDisplayParts(r.comment?.summary));
- equal(comments, ["", "metadata", "fn", "bar"]);
+ equal(comments, ["bar", "metadata", "fn", ""]);
});
it("#1660", () => {
@@ -436,6 +449,8 @@ describe("Issue Tests", () => {
]),
];
equal(alias.comment, expectedComment);
+
+ logger.expectMessage("warn: Encountered an unknown block tag @asdf");
});
it("#1745", () => {
@@ -455,8 +470,8 @@ describe("Issue Tests", () => {
ok(!Foo.comment?.getTag("@category"), "has cat tag");
ok(!Foo.type.declaration.comment?.getTag("@category"), "has cat tag 2");
ok(
- !Foo.type.declaration.signatures?.some(
- (s) => s.comment?.getTag("@category"),
+ !Foo.type.declaration.signatures?.some((s) =>
+ s.comment?.getTag("@category"),
),
"has cat tag 3",
);
@@ -466,7 +481,7 @@ describe("Issue Tests", () => {
const project = convert();
const sym1 = query(project, "sym1");
equal(
- Comment.combineDisplayParts(sym1.signatures?.[0].comment?.summary),
+ Comment.combineDisplayParts(sym1.comment?.summary),
"Docs for Sym1",
);
@@ -493,9 +508,12 @@ describe("Issue Tests", () => {
it("#1795", () => {
const project = convert();
- equal(project.children?.map((c) => c.name), ["default", "foo"]);
- ok(project.children![0].kind === ReflectionKind.Reference);
- ok(project.children![1].kind !== ReflectionKind.Reference);
+ equal(
+ project.children?.map((c) => c.name),
+ ["default", "foo"],
+ );
+ ok(project.children[0].kind === ReflectionKind.Reference);
+ ok(project.children[1].kind !== ReflectionKind.Reference);
});
it("#1804", () => {
@@ -511,10 +529,10 @@ describe("Issue Tests", () => {
it("#1875", () => {
const project = convert();
const test = query(project, "test");
- equal(test.signatures?.[0].parameters?.map((p) => p.type?.toString()), [
- "typeof globalThis",
- "string",
- ]);
+ equal(
+ test.signatures?.[0].parameters?.map((p) => p.type?.toString()),
+ ["typeof globalThis", "string"],
+ );
const test2 = query(project, "test2");
equal(
@@ -588,7 +606,7 @@ describe("Issue Tests", () => {
const project = convert();
app.validate(project);
logger.expectMessage(
- "warn: UnDocFn (TypeAlias), defined in */gh1898.ts, does not have any documentation.",
+ "warn: UnDocFn (TypeAlias), defined in */gh1898.ts, does not have any documentation",
);
});
@@ -705,9 +723,7 @@ describe("Issue Tests", () => {
equal(comments, ["A override", "B module"]);
const comments2 = ["A.a", "B.b"].map((n) =>
- Comment.combineDisplayParts(
- query(project, n).signatures![0].comment?.summary,
- ),
+ Comment.combineDisplayParts(query(project, n).comment?.summary),
);
equal(comments2, ["Comment for a", "Comment for b"]);
@@ -716,26 +732,29 @@ describe("Issue Tests", () => {
it("#1980", () => {
const project = convert();
const link = query(project, "link");
- equal(link.comment?.summary.filter((t) => t.kind === "inline-tag"), [
- {
- kind: "inline-tag",
- tag: "@link",
- target: "http://example.com",
- text: "http://example.com",
- },
- {
- kind: "inline-tag",
- tag: "@link",
- target: "http://example.com",
- text: "with text",
- },
- {
- kind: "inline-tag",
- tag: "@link",
- target: "http://example.com",
- text: "jsdoc support",
- },
- ]);
+ equal(
+ link.comment?.summary.filter((t) => t.kind === "inline-tag"),
+ [
+ {
+ kind: "inline-tag",
+ tag: "@link",
+ target: "http://example.com",
+ text: "http://example.com",
+ },
+ {
+ kind: "inline-tag",
+ tag: "@link",
+ target: "http://example.com",
+ text: "with text",
+ },
+ {
+ kind: "inline-tag",
+ tag: "@link",
+ target: "http://example.com",
+ text: "jsdoc support",
+ },
+ ],
+ );
});
it("#1986", () => {
@@ -765,19 +784,19 @@ describe("Issue Tests", () => {
it("#1996", () => {
const project = convert();
- const a = query(project, "a");
- equal(a.signatures![0].sources?.[0].fileName, "gh1996.ts");
- equal(a.signatures![0].sources?.[0].line, 1);
- equal(a.signatures![0].sources?.[0].character, 17);
- const b = query(project, "b");
- equal(b.signatures![0].sources?.[0].fileName, "gh1996.ts");
- equal(b.signatures![0].sources?.[0].line, 3);
- equal(b.signatures![0].sources?.[0].character, 16);
+ const a = querySig(project, "a");
+ equal(a.sources?.[0].fileName, "gh1996.ts");
+ equal(a.sources[0].line, 1);
+ equal(a.sources[0].character, 17);
+ const b = querySig(project, "b");
+ equal(b.sources?.[0].fileName, "gh1996.ts");
+ equal(b.sources[0].line, 3);
+ equal(b.sources[0].character, 16);
});
it("#2008", () => {
const project = convert();
- const fn = query(project, "myFn").signatures![0];
+ const fn = query(project, "myFn");
equal(Comment.combineDisplayParts(fn.comment?.summary), "Docs");
});
@@ -876,20 +895,25 @@ describe("Issue Tests", () => {
it("#2042", () => {
const project = convert();
- for (const [name, docs] of [
- ["built", "inner docs"],
- ["built2", "outer docs"],
- ["fn", "inner docs"],
- ["fn2", "outer docs"],
+ for (const [name, docs, sigDocs] of [
+ ["built", "", "inner docs"],
+ ["built2", "outer docs", "inner docs"],
+ ["fn", "", "inner docs"],
+ ["fn2", "outer docs", "inner docs"],
]) {
const refl = query(project, name);
ok(refl.signatures?.[0]);
+ equal(
+ Comment.combineDisplayParts(refl.comment?.summary),
+ docs,
+ name + " docs",
+ );
equal(
Comment.combineDisplayParts(
refl.signatures[0].comment?.summary,
),
- docs,
- name,
+ sigDocs,
+ name + " sig docs",
);
}
});
@@ -909,6 +933,7 @@ describe("Issue Tests", () => {
});
it("#2064", () => {
+ app.options.setValue("excludePrivate", false);
const project = convert();
query(project, "PrivateCtorDecl.x");
});
@@ -929,7 +954,7 @@ describe("Issue Tests", () => {
);
});
- it("Handles types/values with same name #2106", () => {
+ it("#2106 Handles types/values with same name ", () => {
const project = convert();
const balance = querySig(project, "balance");
equal(balance.type?.type, "reference");
@@ -994,7 +1019,7 @@ describe("Issue Tests", () => {
const foo = query(project, "foo");
equal(foo.signatures?.length, 1);
equal(
- Comment.combineDisplayParts(foo.signatures[0].comment?.summary),
+ Comment.combineDisplayParts(foo.comment?.summary),
"Is documented",
);
});
@@ -1073,20 +1098,19 @@ describe("Issue Tests", () => {
equal(
clsSig!.implementationOf?.reflection?.getFullName(),
- intTarget!.getFullName(),
+ intTarget.getFullName(),
`${name} signature not properly linked`,
);
}
});
- it("Handles implementationOf with symbols #2234", () => {
+ it("#2234 Handles implementationOf with symbols ", () => {
const project = convert();
const cm = query(project, "CharMap");
- equal(cm.children?.map((c) => c.name), [
- "constructor",
- "[iterator]",
- "at",
- ]);
+ equal(
+ cm.children?.map((c) => c.name),
+ ["constructor", "[iterator]", "at"],
+ );
equal(
cm.children[1].implementationOf?.name,
@@ -1094,7 +1118,7 @@ describe("Issue Tests", () => {
);
});
- it("Handles http links with TS link resolution #2270", () => {
+ it("#2270 Handles http links with TS link resolution ", () => {
const project = convert();
const links = getLinks(query(project, "A"));
equal(links, [
@@ -1109,7 +1133,7 @@ describe("Issue Tests", () => {
]);
});
- it("Handles comments on interfaces with call signatures #2290", () => {
+ it("#2290 Handles comments on interfaces with call signatures ", () => {
const project = convert();
equal(getComment(project, "CallSignature"), "Int comment");
@@ -1132,14 +1156,14 @@ describe("Issue Tests", () => {
);
});
- it("Does not warn on notDocumented edge case #2291", () => {
+ it("#2291 Does not warn on notDocumented edge case ", () => {
app.options.setValue("validation", { notDocumented: true });
const project = convert();
app.validate(project);
logger.expectNoOtherMessages();
});
- it("Supports TS 5.0 #2296", () => {
+ it("#2296 Supports TS 5.0 ", () => {
const project = convert();
const names = query(project, "names");
equal(names.type?.toString(), 'readonly ["Alice", "Bob", "Eve"]');
@@ -1150,7 +1174,7 @@ describe("Issue Tests", () => {
equal(tp.flags.isConst, true);
});
- it("Detects source locations coming from types and prefers value declarations, #2307", () => {
+ it("#2307 Detects source locations coming from types and prefers value declarations, ", () => {
const project = convert();
const getLines = (name: string) => {
@@ -1165,14 +1189,14 @@ describe("Issue Tests", () => {
equal(getLines("all"), [8, 9]);
});
- it("Uses type parameters from parent class in arrow-methods, #2320", () => {
+ it("#2320 Uses type parameters from parent class in arrow-methods, ", () => {
const project = convert();
const arrow = querySig(project, "ResolvedSubclass.arrowFunction");
equal(arrow.typeParameters![0].type?.toString(), '"one" | "two"');
});
- it("Handles comments with nested methods #2336", () => {
+ it("#2336 Handles comments with nested methods ", () => {
const project = convert();
const outer = querySig(project, "ClassVersion.outer");
@@ -1187,7 +1211,7 @@ describe("Issue Tests", () => {
);
});
- it("Supports nested paths with tsLinkResolution #2360", () => {
+ it("#2360 Supports nested paths with tsLinkResolution ", () => {
const project = convert();
const x = query(project, "x");
const link = x.comment?.summary[0];
@@ -1195,22 +1219,31 @@ describe("Issue Tests", () => {
equal(link.target, query(project, "Foo.bar"));
});
- it("Handles duplicate declarations with @namespace #2364", () => {
+ it("#2364 Handles duplicate declarations with @namespace ", () => {
const project = convert();
- equal(project.children?.map((c) => c.name), ["NS", "NS2", "NS2"]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["NS", "NS2", "NS2"],
+ );
const ns = query(project, "NS");
- equal(ns.children?.map((c) => c.name), ["T", "property"]);
+ equal(
+ ns.children?.map((c) => c.name),
+ ["T", "property"],
+ );
});
- it("Gets properties when types/variables are merged with @namespace #2364", () => {
+ it("#2364 Gets properties when types/variables are merged with @namespace ", () => {
const project = convert();
const ns = project.children?.find(
(c) => c.name == "NS2" && c.kind == ReflectionKind.Namespace,
);
- equal(ns?.children?.map((c) => c.name), ["property"]);
+ equal(
+ ns?.children?.map((c) => c.name),
+ ["property"],
+ );
});
- it("Puts delegate type alias comments on the type alias #2372", () => {
+ it("#2372 Puts delegate type alias comments on the type alias ", () => {
const project = convert();
equal(
getComment(project, "EventHandler"),
@@ -1226,7 +1259,7 @@ describe("Issue Tests", () => {
equal(Comment.combineDisplayParts(typeSig?.comment?.summary), "");
});
- it("Handles spaces in JSDoc default parameter names #2384", () => {
+ it("#2384 Handles spaces in JSDoc default parameter names ", () => {
const project = convert();
const Typed = query(project, "Typed");
equal(Typed.typeParameters?.length, 1);
@@ -1238,7 +1271,7 @@ describe("Issue Tests", () => {
);
});
- it("Handles @template parameter constraints correctly, #2389", () => {
+ it("#2389 Handles @template parameter constraints correctly, ", () => {
const project = convert();
const foo = query(project, "foo");
equal(foo.signatures?.length, 1);
@@ -1253,7 +1286,7 @@ describe("Issue Tests", () => {
// a single declare module can still have a comment on them, but it looks really
// weird and wrong if there are multiple declare module statements in a file...
// there's probably some nicer way of doing this that I'm not seeing right now.
- it("Uses module comment discovery on 'declare module \"foo\"' #2401", () => {
+ it("#2401 Uses module comment discovery on 'declare module \"foo\"' ", () => {
const project = convert();
equal(
Comment.combineDisplayParts(project.comment?.summary),
@@ -1261,37 +1294,35 @@ describe("Issue Tests", () => {
);
});
- it("Includes index signature comments #2414", () => {
+ it("#2414 Includes index signature comments ", () => {
const project = convert();
equal(
Comment.combineDisplayParts(
- query(project, "ObjectWithIndexSignature").indexSignature
+ query(project, "ObjectWithIndexSignature").indexSignatures?.[0]
?.comment?.summary,
),
"Index comment.",
);
});
- it("Handles destructured object parameter defaults, #2430", () => {
+ it("#2430 Handles destructured object parameter defaults, ", () => {
const project = convert();
const Checkbox = querySig(project, "Checkbox");
equal(Checkbox.parameters?.length, 1);
equal(Checkbox.parameters[0].name, "props");
const type = Checkbox.parameters[0].type;
equal(type?.type, "reflection");
- equal(type.declaration.children?.map((c) => c.name), [
- "falseValue",
- "trueValue",
- "value",
- ]);
- equal(type.declaration.children?.map((c) => c.defaultValue), [
- "false",
- "true",
- undefined,
- ]);
+ equal(
+ type.declaration.children?.map((c) => c.name),
+ ["falseValue", "trueValue", "value"],
+ );
+ equal(
+ type.declaration.children.map((c) => c.defaultValue),
+ ["false", "true", undefined],
+ );
});
- it("Handles function-namespaces created with Object.assign #2436", () => {
+ it("#2436 Handles function-namespaces created with Object.assign ", () => {
const project = convert();
equal(query(project, "bug").kind, ReflectionKind.Function);
const foo = query(project, "bug.foo");
@@ -1302,17 +1333,17 @@ describe("Issue Tests", () => {
equal(bar.kind, ReflectionKind.Property, "property");
});
- it("Does not warn due to the diamond problem in comment discovery #2437", () => {
+ it("#2437 Does not warn due to the diamond problem in comment discovery ", () => {
convert();
logger.expectNoOtherMessages();
});
- it("Handles recursive aliases without looping infinitely #2438", () => {
+ it("#2438 Handles recursive aliases without looping infinitely ", () => {
const bad = query(convert(), "Bad");
equal(bad.kind, ReflectionKind.Interface);
});
- it("Handles transient symbols correctly, #2444", () => {
+ it("#2444 Handles transient symbols correctly, ", () => {
const project = convert();
const boolEq = query(project, "Boolean.equal");
const numEq = query(project, "Number.equal");
@@ -1320,14 +1351,14 @@ describe("Issue Tests", () => {
equal(numEq.signatures![0].parameters![0].type?.toString(), "number");
});
- it("Handles unions created due to union within intersection, #2451", () => {
+ it("#2451 Handles unions created due to union within intersection, ", () => {
const project = convert();
const is = querySig(project, "FooA.is");
equal(is.type?.toString(), "this is Foo & Object");
});
- it("Does not care about conversion order for @link resolution, #2466", () => {
+ it("#2466 Does not care about conversion order for @link resolution, ", () => {
const project = convert();
const Two = query(project, "Two");
@@ -1347,29 +1378,41 @@ describe("Issue Tests", () => {
]);
});
- it("Creates a separate namespace for `declare namespace` case #2476", () => {
+ it("#2476 Creates a separate namespace for `declare namespace` case ", () => {
const project = convert();
- equal(project.children?.map((c) => [c.name, c.kind]), [
- ["test", ReflectionKind.Namespace],
- ["test", ReflectionKind.Function],
- ]);
+ equal(
+ project.children?.map((c) => [c.name, c.kind]),
+ [
+ ["test", ReflectionKind.Namespace],
+ ["test", ReflectionKind.Function],
+ ],
+ );
- equal(project.children[0].children?.map((c) => c.name), ["Options"]);
+ equal(
+ project.children[0].children?.map((c) => c.name),
+ ["Options"],
+ );
});
- it("Creates a separate namespace for `declare namespace` case with variables #2478", () => {
+ it("#2478 Creates a separate namespace for `declare namespace` case with variables ", () => {
const project = convert();
- equal(project.children?.map((c) => [c.name, c.kind]), [
- ["test", ReflectionKind.Namespace],
- ["test", ReflectionKind.Function],
- ]);
+ equal(
+ project.children?.map((c) => [c.name, c.kind]),
+ [
+ ["test", ReflectionKind.Namespace],
+ ["test", ReflectionKind.Function],
+ ],
+ );
- equal(project.children[0].children?.map((c) => c.name), ["Options"]);
+ equal(
+ project.children[0].children?.map((c) => c.name),
+ ["Options"],
+ );
});
- it("Does not crash when rendering recursive hierarchy, #2495", () => {
+ it("#2495 Does not crash when rendering recursive hierarchy, ", () => {
const project = convert();
const theme = new DefaultTheme(app.renderer);
@@ -1379,18 +1422,18 @@ describe("Issue Tests", () => {
context.hierarchyTemplate(page);
});
- it("Correctly cleans up references to functions #2496", () => {
+ it("#2496 Correctly cleans up references to functions ", () => {
app.options.setValue("excludeNotDocumented", true);
convert();
});
- it("Sorts literal numeric unions when converting a type, #2502", () => {
+ it("#2502 Sorts literal numeric unions when converting a type, ", () => {
const project = convert();
const refl = query(project, "Test");
equal(refl.type?.toString(), "1 | 2 | 3");
});
- it("Handles an infinitely recursive type, #2507", () => {
+ it("#2507 Handles an infinitely recursive type, ", () => {
const project = convert();
const type = querySig(project, "fromPartial").typeParameters![0].type;
@@ -1408,7 +1451,7 @@ describe("Issue Tests", () => {
equal(type?.toString(), "Value & Object");
});
- it("Handles constructed references to enumeration types, #2508", () => {
+ it("#2508 Handles constructed references to enumeration types, ", () => {
const project = convert();
const refl = query(project, "Bar.color");
equal(refl.type?.type, "reference");
@@ -1416,7 +1459,7 @@ describe("Issue Tests", () => {
equal(refl.type.reflection?.id, query(project, "Color").id);
});
- it("Does not duplicate comments due to signatures being present, #2509", () => {
+ it("#2509 Does not duplicate comments due to signatures being present, ", () => {
const project = convert();
const cb = query(project, "Int.cb");
equal(Comment.combineDisplayParts(cb.comment?.summary), "Cb");
@@ -1430,4 +1473,167 @@ describe("Issue Tests", () => {
equal(cb2.type?.type, "reflection");
equal(cb2.type.declaration.signatures![0].comment, undefined);
});
+
+ it("#2521 Specifying comment on variable still inherits signature comments, ", () => {
+ const project = convert();
+
+ equal(getComment(project, "fooWithoutComment"), "");
+ equal(getSigComment(project, "fooWithoutComment", 0), "Overload 1");
+ equal(getSigComment(project, "fooWithoutComment", 1), "Overload 2");
+
+ equal(getComment(project, "fooWithComment"), "New comment.");
+ equal(getSigComment(project, "fooWithComment", 0), "Overload 1");
+ equal(getSigComment(project, "fooWithComment", 1), "Overload 2");
+ });
+
+ it("#2545 discovers comments from non-exported 'parent' methods", () => {
+ const project = convert();
+
+ equal(getSigComment(project, "Child.notAbstract"), "notAbstract docs");
+ equal(
+ getSigComment(project, "Child.notAbstract2"),
+ "notAbstract2 docs",
+ );
+ equal(getSigComment(project, "Child.isAbstract"), "isAbstract docs");
+ equal(
+ getComment(project, "Child.abstractProperty"),
+ "abstractProperty docs",
+ );
+
+ // #2084
+ equal(
+ querySig(project, "Bar.isInternal").comment?.hasModifier(
+ "@internal",
+ ),
+ true,
+ );
+ });
+
+ it("#2552 Ignores @license and @import comments, ", () => {
+ const project = convert();
+ equal(
+ Comment.combineDisplayParts(project.comment?.summary),
+ "This is an awesome module.",
+ );
+ equal(getComment(project, "something"), "");
+ });
+
+ it("#2553 Does not warn about documented constructor signature type aliases, ", () => {
+ const project = convert();
+ app.validate(project);
+ logger.expectNoOtherMessages();
+ });
+
+ it("#2574 default export", () => {
+ const project = convert();
+ const sig = querySig(project, "usesDefaultExport");
+ const param = sig.parameters?.[0];
+ ok(param, "Missing parameter");
+ equal(param.name, "param", "Incorrect parameter name");
+ equal(
+ param.type?.type,
+ "reference",
+ "Parameter is not a reference type",
+ );
+ equal(param.type.name, "DefaultExport", "Incorrect reference name");
+ equal(param.type.qualifiedName, "default", "Incorrect qualified name");
+ });
+
+ it("#2574 not default export", () => {
+ const project = convert();
+ const sig = querySig(project, "usesNonDefaultExport");
+ const param = sig.parameters?.[0];
+ ok(param, "Missing parameter");
+ equal(param.name, "param", "Incorrect parameter name");
+ equal(
+ param.type?.type,
+ "reference",
+ "Parameter is not a reference type",
+ );
+ equal(param.type.name, "NotDefaultExport", "Incorrect reference name");
+ equal(
+ param.type.qualifiedName,
+ "NotDefaultExport",
+ "Incorrect qualified name",
+ );
+ });
+
+ it("#2582 nested @namespace", () => {
+ const project = convert();
+
+ equalKind(query(project, "f32"), ReflectionKind.Namespace);
+ equalKind(query(project, "f32.a"), ReflectionKind.Namespace);
+ equalKind(query(project, "f32.a.member"), ReflectionKind.Variable);
+ equalKind(query(project, "f32.a.fn"), ReflectionKind.Function);
+ equalKind(query(project, "f32.b"), ReflectionKind.Namespace);
+ equalKind(query(project, "f32.b.member"), ReflectionKind.Reference); // Somewhat odd, but not wrong...
+ equalKind(query(project, "f32.b.fn"), ReflectionKind.Function);
+
+ equal(getComment(project, "f32"), "f32 comment");
+ equal(getComment(project, "f32.a"), "A comment");
+ equal(getComment(project, "f32.a.member"), "Member comment");
+ equal(getComment(project, "f32.a.fn"), "Fn comment");
+ equal(getComment(project, "f32.b"), "B comment");
+ });
+
+ it("#2585 supports comments on union members", () => {
+ const project = convert();
+ const Foo = query(project, "Foo");
+ equal(Foo.type?.type, "union");
+
+ equal(Foo.type.elementSummaries?.length, 2);
+ equal(Foo.type.elementSummaries.map(Comment.combineDisplayParts), [
+ "Doc of foo1.",
+ "Doc of foo2.",
+ ]);
+ });
+
+ it("#2587 comment on shorthand property declaration", () => {
+ const project = convert();
+
+ const sig = querySig(project, "foo");
+ equal(sig.type?.type, "reflection");
+ const x = sig.type.declaration.getChildByName("x");
+ ok(x);
+
+ equal(
+ Comment.combineDisplayParts(x.comment?.summary),
+ "Shorthand comment",
+ );
+ });
+
+ it("#2603 handles @author tag", () => {
+ const project = convert();
+ const x = query(project, "x");
+ equal(
+ x.comment?.getTag("@author"),
+ new CommentTag("@author", [{ kind: "text", text: "Ian Awesome" }]),
+ );
+
+ logger.expectNoOtherMessages();
+ });
+
+ it("#2611 can suppress warnings from comments in declaration files", () => {
+ convert();
+ logger.expectMessage(
+ "warn: Encountered an unknown block tag @tagThatIsNotDefined",
+ );
+ logger.expectNoOtherMessages();
+ logger.reset();
+
+ app.options.setValue("suppressCommentWarningsInDeclarationFiles", true);
+ convert();
+ logger.expectNoOtherMessages();
+ });
+
+ it("#2614 supports @since tag", () => {
+ const project = convert();
+ const foo = querySig(project, "foo");
+ equal(
+ foo.comment?.getTag("@since"),
+ new CommentTag("@since", [{ kind: "text", text: "1.0.0" }]),
+ );
+
+ logger.expectNoOtherMessages();
+ });
});
diff --git a/src/test/merge.test.ts b/src/test/merge.test.ts
index e4c023564..de89b76a4 100644
--- a/src/test/merge.test.ts
+++ b/src/test/merge.test.ts
@@ -2,7 +2,7 @@ import { deepStrictEqual as equal, ok } from "assert";
import { join } from "path";
import {
Application,
- DeclarationReflection,
+ type DeclarationReflection,
EntryPointStrategy,
ReferenceType,
} from "../index";
@@ -27,7 +27,10 @@ describe("Merging projects", () => {
logger.expectNoOtherMessages();
equal(project?.name, "typedoc");
- equal(project.children?.map((c) => c.name), ["alias", "class"]);
+ equal(
+ project.children?.map((c) => c.name),
+ ["alias", "class"],
+ );
const crossRef = project.getChildByName(
"alias.MergedCrossReference",
diff --git a/src/test/models/comment.test.ts b/src/test/models/comment.test.ts
index 3cbdb735a..255b8ddef 100644
--- a/src/test/models/comment.test.ts
+++ b/src/test/models/comment.test.ts
@@ -1,5 +1,5 @@
import { deepStrictEqual as equal } from "assert";
-import { Comment, CommentDisplayPart } from "../../index";
+import { Comment, type CommentDisplayPart } from "../../index";
describe("Comment.combineDisplayParts", () => {
it("Handles text and code", () => {
diff --git a/src/test/models/types.test.ts b/src/test/models/types.test.ts
index 21c1dff5b..35efedacf 100644
--- a/src/test/models/types.test.ts
+++ b/src/test/models/types.test.ts
@@ -3,6 +3,7 @@
import * as T from "../../lib/models/types";
import { strictEqual as equal } from "assert";
import { ProjectReflection } from "../../lib/models";
+import { FileRegistry } from "../../lib/models/FileRegistry";
describe("Type.toString", () => {
describe("Union types", () => {
@@ -262,7 +263,7 @@ describe("Type.toString", () => {
});
it("Does not wrap type query", () => {
- const project = new ProjectReflection("test");
+ const project = new ProjectReflection("test", new FileRegistry());
const type = new T.OptionalType(
new T.QueryType(
T.ReferenceType.createResolvedReference("X", -1, project),
@@ -283,7 +284,7 @@ describe("Type.toString", () => {
describe("Type operator", () => {
it("Does not wrap type query", () => {
- const project = new ProjectReflection("test");
+ const project = new ProjectReflection("test", new FileRegistry());
const type = new T.TypeOperatorType(
new T.QueryType(
T.ReferenceType.createResolvedReference("X", -1, project),
@@ -327,14 +328,3 @@ describe("Type.toString", () => {
});
});
});
-
-describe("Union Types", () => {
- it("Normalizes true | false to boolean", () => {
- const type = new T.UnionType([
- new T.LiteralType(true),
- new T.LiteralType(123),
- new T.LiteralType(false),
- ]);
- equal(type.toString(), "boolean | 123");
- });
-});
diff --git a/src/test/packages.test.ts b/src/test/packages.test.ts
index e40a568a3..6b10befc5 100644
--- a/src/test/packages.test.ts
+++ b/src/test/packages.test.ts
@@ -8,11 +8,7 @@ import { TestLogger } from "./TestLogger";
import { createMinimatch } from "../lib/utils/paths";
describe("Packages support", () => {
- let project: ReturnType<typeof tempdirProject>;
-
- beforeEach(() => {
- project = tempdirProject();
- });
+ using project = tempdirProject();
afterEach(() => {
project.rm();
diff --git a/src/test/programs.ts b/src/test/programs.ts
index 63055f0ea..0ceda952f 100644
--- a/src/test/programs.ts
+++ b/src/test/programs.ts
@@ -2,9 +2,9 @@ import { deepStrictEqual as equal } from "assert";
import { join } from "path";
import ts from "typescript";
import {
- Application,
+ type Application,
EntryPointStrategy,
- JSONOutput,
+ type JSONOutput,
ProjectReflection,
SourceReference,
TSConfigReader,
@@ -28,6 +28,7 @@ export function getConverterApp() {
name: "typedoc",
excludeExternals: true,
disableSources: false,
+ excludePrivate: false,
tsconfig: join(getConverterBase(), "tsconfig.json"),
externalPattern: ["**/node_modules/**"],
plugin: [],
diff --git a/src/test/slow/entry-point.test.ts b/src/test/slow/entry-point.test.ts
index 14b7837ea..c44f805af 100644
--- a/src/test/slow/entry-point.test.ts
+++ b/src/test/slow/entry-point.test.ts
@@ -1,20 +1,24 @@
-import { tempdirProject } from "@typestrong/fs-fixture-builder";
+import { type Project, tempdirProject } from "@typestrong/fs-fixture-builder";
import { deepStrictEqual as equal, ok } from "assert";
import { join } from "path";
import { Application, EntryPointStrategy } from "../..";
-const fixture = tempdirProject();
-fixture.addJsonFile("tsconfig.json", {
- include: ["."],
-});
-fixture.addJsonFile("package.json", {
- main: "index.ts",
-});
-fixture.addFile("index.ts", "export function fromIndex() {}");
-fixture.addFile("extra.ts", "export function extra() {}");
-
describe("Entry Points", () => {
+ let fixture: Project;
+ let tsconfig: string;
+
beforeEach(() => {
+ fixture = tempdirProject();
+ tsconfig = join(fixture.cwd, "tsconfig.json");
+
+ fixture.addJsonFile("tsconfig.json", {
+ include: ["."],
+ });
+ fixture.addJsonFile("package.json", {
+ main: "index.ts",
+ });
+ fixture.addFile("index.ts", "export function fromIndex() {}");
+ fixture.addFile("extra.ts", "export function extra() {}");
fixture.write();
});
@@ -22,8 +26,6 @@ describe("Entry Points", () => {
fixture.rm();
});
- const tsconfig = join(fixture.cwd, "tsconfig.json");
-
it("Supports expanding existing paths", async () => {
const app = await Application.bootstrap({
tsconfig,
diff --git a/src/test/slow/internationalization-usage.test.ts b/src/test/slow/internationalization-usage.test.ts
new file mode 100644
index 000000000..f9f6a686c
--- /dev/null
+++ b/src/test/slow/internationalization-usage.test.ts
@@ -0,0 +1,85 @@
+import ts from "typescript";
+import { ok } from "assert/strict";
+import { Logger, Options, TSConfigReader } from "../..";
+import { join } from "path";
+import { existsSync, readFileSync } from "fs";
+import { Internationalization } from "../../lib/internationalization/internationalization";
+
+describe("Internationalization", () => {
+ it("Does not include strings in translatable object which are unused", () => {
+ const options = new Options(new Internationalization(null).proxy);
+ const tsconfigReader = new TSConfigReader();
+ tsconfigReader.read(options, new Logger(), process.cwd());
+
+ const translatableTs = join(
+ __dirname,
+ "../../lib/internationalization/translatable.ts",
+ );
+
+ const host: ts.LanguageServiceHost = {
+ getScriptFileNames: () => options.getFileNames().slice(),
+ getScriptVersion: () => "unused",
+ getScriptSnapshot: (fileName) => {
+ if (!existsSync(fileName)) return undefined;
+ return ts.ScriptSnapshot.fromString(
+ readFileSync(fileName, "utf-8"),
+ );
+ },
+ getCurrentDirectory: () => process.cwd(),
+ getCompilationSettings: () => options.getCompilerOptions(),
+ getDefaultLibFileName: (opts) => ts.getDefaultLibFilePath(opts),
+ fileExists: ts.sys.fileExists,
+ readFile: ts.sys.readFile,
+ readDirectory: ts.sys.readDirectory,
+ directoryExists: ts.sys.directoryExists,
+ getDirectories: ts.sys.getDirectories,
+ };
+
+ const service = ts.createLanguageService(
+ host,
+ ts.createDocumentRegistry(),
+ );
+
+ const program = service.getProgram();
+ ok(program, "Failed to get program for i18n analysis");
+
+ const sf = program.getSourceFile(translatableTs);
+ ok(sf, "Failed to get source file");
+
+ const moduleSymbol = program.getTypeChecker().getSymbolAtLocation(sf)!;
+ const translatable = program
+ .getTypeChecker()
+ .tryGetMemberInModuleExports("translatable", moduleSymbol);
+ ok(translatable, "Failed to get translatable symbol");
+
+ ok(ts.isVariableDeclaration(translatable.valueDeclaration!));
+ ok(ts.isAsExpression(translatable.valueDeclaration.initializer!));
+ ok(
+ ts.isObjectLiteralExpression(
+ translatable.valueDeclaration.initializer.expression,
+ ),
+ );
+ const translatableObj =
+ translatable.valueDeclaration.initializer.expression;
+
+ translatableObj.forEachChild((child) => {
+ ok(ts.isPropertyAssignment(child));
+ const refs = service.getReferencesAtPosition(
+ sf.fileName,
+ child.getStart(),
+ );
+ const refCount =
+ refs?.filter(
+ (ref) =>
+ !/locales\/.*\.cts$/.test(ref.fileName) &&
+ !ref.fileName.endsWith("translatable.ts"),
+ ).length ?? 0;
+ ok(
+ refCount,
+ `Translatable key ${child.name.getText()} is not referenced.`,
+ );
+ });
+
+ service.dispose();
+ });
+});
diff --git a/src/test/utils.ts b/src/test/utils.ts
index 53a630372..c1dec3e2c 100644
--- a/src/test/utils.ts
+++ b/src/test/utils.ts
@@ -2,12 +2,13 @@ import { ok } from "assert";
import {
Comment,
DeclarationReflection,
- ProjectReflection,
+ type ProjectReflection,
Reflection,
ReflectionKind,
- SignatureReflection,
+ type SignatureReflection,
} from "..";
import { filterMap } from "../lib/utils";
+import { equal } from "assert/strict";
export function query(
project: ProjectReflection,
@@ -35,6 +36,16 @@ export function getComment(project: ProjectReflection, name: string) {
return Comment.combineDisplayParts(query(project, name).comment?.summary);
}
+export function getSigComment(
+ project: ProjectReflection,
+ name: string,
+ index = 0,
+) {
+ return Comment.combineDisplayParts(
+ querySig(project, name, index).comment?.summary,
+ );
+}
+
export function getLinks(refl: Reflection): Array<{
display: string;
target: undefined | string | [ReflectionKind, string];
@@ -58,3 +69,11 @@ export function getLinks(refl: Reflection): Array<{
}
});
}
+
+export function equalKind(refl: Reflection, kind: ReflectionKind) {
+ equal(
+ refl.kind,
+ kind,
+ `Expected ${ReflectionKind[kind]} but got ${ReflectionKind[refl.kind]}`,
+ );
+}
diff --git a/src/test/utils/fs.test.ts b/src/test/utils/fs.test.ts
index 3c517c6e8..0d0a95133 100644
--- a/src/test/utils/fs.test.ts
+++ b/src/test/utils/fs.test.ts
@@ -1,20 +1,11 @@
import * as fs from "fs";
import { createServer } from "net";
-import { Project, tempdirProject } from "@typestrong/fs-fixture-builder";
-import { AssertionError, deepStrictEqual as equal } from "assert";
+import { type Project, tempdirProject } from "@typestrong/fs-fixture-builder";
+import { type AssertionError, deepStrictEqual as equal } from "assert";
import { basename, dirname, resolve, normalize } from "path";
import { getCommonDirectory, glob } from "../../lib/utils/fs";
describe("fs.ts", () => {
- let fix: Project;
- beforeEach(() => {
- fix = tempdirProject();
- });
-
- afterEach(() => {
- fix.rm();
- });
-
describe("getCommonDirectory", () => {
it("Returns the empty string if no files are provided", () => {
equal(getCommonDirectory([]), "");
@@ -38,6 +29,14 @@ describe("fs.ts", () => {
});
describe("glob", () => {
+ let fix: Project;
+ beforeEach(() => {
+ fix = tempdirProject();
+ });
+ afterEach(() => {
+ fix.rm();
+ });
+
it("handles root match", () => {
fix.write();
diff --git a/src/test/utils/html.test.ts b/src/test/utils/html.test.ts
index af0180f77..ddb2c7b44 100644
--- a/src/test/utils/html.test.ts
+++ b/src/test/utils/html.test.ts
@@ -1,32 +1,281 @@
-import { strictEqual as equal } from "assert";
-import { getTextContent } from "../../lib/utils/html";
+import { deepStrictEqual as equal } from "assert";
+import { HtmlAttributeParser, ParserState } from "../../lib/utils/html";
-describe("getTextContent", () => {
- it("Handles simple text", () => {
- equal(getTextContent("Hello there"), "Hello there");
+describe("HtmlAttributeParser", () => {
+ enum State {
+ BeforeAttributeName = "BeforeAttributeName",
+ AfterAttributeName = "AfterAttributeName",
+ BeforeAttributeValue = "BeforeAttributeValue",
+ }
+
+ function stateStr(state: ParserState) {
+ return {
+ [ParserState.BeforeAttributeName]: State.BeforeAttributeName,
+ [ParserState.AfterAttributeName]: State.AfterAttributeName,
+ [ParserState.BeforeAttributeValue]: State.BeforeAttributeValue,
+ [ParserState.END]: "<END>",
+ }[state];
+ }
+
+ function parseWithEnd(text: string) {
+ const parser = new HtmlAttributeParser(text);
+ const data = [];
+ do {
+ parser.step();
+ data.push([
+ stateStr(parser.state),
+ parser.currentAttributeName,
+ parser.currentAttributeValue,
+ ]);
+ } while (parser.state != ParserState.END);
+ return data;
+ }
+
+ function parse(text: string) {
+ const data = parseWithEnd(text);
+ data.pop();
+ return data;
+ }
+
+ function parseAttrsToObject(text: string) {
+ const result: Record<string, string> = {};
+ for (const elem of parseWithEnd(text)) {
+ result[elem[1]] = elem[2];
+ }
+ delete result[""];
+ return result;
+ }
+
+ it("Handles self closing tag", () => {
+ equal(parse(" >"), []);
+
+ equal(parse(" />"), []);
+ });
+
+ it("Handles EOF before end of tag", () => {
+ equal(parse(" \t\f"), []);
+ });
+
+ it("Handles names without values", () => {
+ equal(parse("a b c />"), [
+ [State.AfterAttributeName, "a", ""],
+ [State.AfterAttributeName, "b", ""],
+ [State.AfterAttributeName, "c", ""],
+ ]);
+ });
+
+ it("Handles unquoted value", () => {
+ equal(parse("a=1 b=bbb />"), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "1"],
+ [State.BeforeAttributeValue, "b", ""],
+ [State.BeforeAttributeName, "b", "bbb"],
+ ]);
+ });
+
+ it("Handles single quoted value", () => {
+ equal(parse("a='1' b='b b' />"), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "1"],
+ [State.BeforeAttributeValue, "b", ""],
+ [State.BeforeAttributeName, "b", "b b"],
+ ]);
+ });
+
+ it("Handles double quoted value", () => {
+ equal(parse('a="1" b="b b" />'), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "1"],
+ [State.BeforeAttributeValue, "b", ""],
+ [State.BeforeAttributeName, "b", "b b"],
+ ]);
+ });
+
+ it("Handles named escapes", () => {
+ equal(parse('a="&" b="&" />'), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "&"],
+ [State.BeforeAttributeValue, "b", ""],
+ [State.BeforeAttributeName, "b", "&"],
+ ]);
+ });
+
+ it("Handles invalid named escape", () => {
+ equal(parse('a="&ZZBADESCAPE;" />'), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "&ZZBADESCAPE;"],
+ ]);
+ });
+
+ it("Handles an attribute without a name", () => {
+ equal(parse(" =oops >"), [
+ [State.BeforeAttributeValue, "", ""],
+ [State.BeforeAttributeName, "", "oops"],
+ ]);
+ });
+
+ it("Handles invalid characters in attribute names", () => {
+ equal(parse(" a\" a' a< >"), [
+ [State.AfterAttributeName, 'a"', ""],
+ [State.AfterAttributeName, "a'", ""],
+ [State.AfterAttributeName, "a<", ""],
+ ]);
+ });
+
+ it("Handles missing attribute value", () => {
+ equal(parse(" a= \t\n\f>"), [[State.BeforeAttributeValue, "a", ""]]);
+ });
+
+ it("Handles a null character in a double quoted attribute value", () => {
+ equal(parse(' a="\0" >'), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "\ufffd"],
+ ]);
+ });
+
+ it("Handles an unterminated double quoted attribute value", () => {
+ equal(parse(' a="x'), [[State.BeforeAttributeValue, "a", ""]]);
});
- it("Handles entity escapes", () => {
- equal(getTextContent("A B"), "A B");
- equal(getTextContent("A B"), "A B");
- equal(getTextContent("A B"), "A B");
- equal(getTextContent("A B"), "A B");
- equal(getTextContent("A & B"), "A & B");
+ it("Handles missing attribute name after an attribute ", () => {
+ equal(parse(" a \t\n\f =>"), [
+ [State.AfterAttributeName, "a", ""],
+ [State.BeforeAttributeValue, "a", ""],
+ ]);
+ });
+
+ it("Handles named escapes in single quoted value", () => {
+ equal(parse("a='&' b='&' c='&oops' />"), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "&"],
+ [State.BeforeAttributeValue, "b", ""],
+ [State.BeforeAttributeName, "b", "&"],
+ [State.BeforeAttributeValue, "c", ""],
+ [State.BeforeAttributeName, "c", "&oops"],
+ ]);
+ });
+
+ it("Handles a null character in a single quoted attribute value", () => {
+ equal(parse(" a='\0' >"), [
+ [State.BeforeAttributeValue, "a", ""],
+ [State.BeforeAttributeName, "a", "\ufffd"],
+ ]);
+ });
+
+ it("Handles an unterminated single quoted attribute value", () => {
+ equal(parse(" a='x"), [[State.BeforeAttributeValue, "a", ""]]);
+ });
+
+ it("Properly terminates unquoted attributes", () => {
+ equal(parseAttrsToObject(" a=a\t b=b\n c=c\f"), {
+ a: "a",
+ b: "b",
+ c: "c",
+ });
+ });
+
+ it("Handles character references in unquoted attributes", () => {
+ equal(parseAttrsToObject(" a=&a b=& c=&oops >"), {
+ a: "&a",
+ b: "&",
+ c: "&oops",
+ });
+ });
+
+ it("Handles more unquoted attribute cases", () => {
+ equal(parseAttrsToObject(" a=a>"), {
+ a: "a",
+ });
+
+ equal(parseAttrsToObject(" a=\0x>"), {
+ a: "\ufffdx",
+ });
+
+ equal(parseAttrsToObject(" a=a\"'<=`>"), {
+ a: "a\"'<=`",
+ });
+
+ equal(parseAttrsToObject(" a=a"), {
+ a: "a",
+ });
+ });
+
+ it("Handles characters after a quoted attribute", () => {
+ equal(parseAttrsToObject(" a='a'\tb='b'\nc='c'\fd='d'>"), {
+ a: "a",
+ b: "b",
+ c: "c",
+ d: "d",
+ });
+
+ equal(parseAttrsToObject(" a='a'/"), {
+ a: "a",
+ });
+
+ equal(parseAttrsToObject(" a='a'"), {
+ a: "a",
+ });
+
+ equal(parseAttrsToObject(" a='a'b='b' "), {
+ a: "a",
+ b: "b",
+ });
+ });
+
+ it("Handles simple numeric character references", () => {
+ equal(parseAttrsToObject("a=a b=Z c=Z"), {
+ a: "a",
+ b: "Z",
+ c: "Z",
+ });
+ });
+
+ it("Handles an invalid character reference", () => {
+ equal(parseAttrsToObject("a=&a"), {
+ a: "&a",
+ });
+ });
+
+ it("Handles an invalid decimal character reference start", () => {
+ equal(parseAttrsToObject("a=&#;"), {
+ a: "&#;",
+ });
+ });
+
+ it("Handles an invalid hex character reference", () => {
+ equal(parseAttrsToObject("a=&#x;"), {
+ a: "&#x;",
+ });
+
+ equal(parseAttrsToObject("a=Z>"), {
+ a: "Z",
+ });
});
- it("Strips HTML tags", () => {
- equal(getTextContent("A <span>B</span> C"), "A B C");
- equal(getTextContent("A <span a=b>B</span> C"), "A B C");
- equal(getTextContent("A <span a='b'>B</span> C"), "A B C");
- equal(getTextContent('A <span a="b">B</span> C'), "A B C");
- equal(getTextContent('A <span a="b"'), "A ");
+ it("Handles an ambiguous ampersand without a trailing alphanumeric", () => {
+ equal(parseAttrsToObject("a=&a"), {
+ a: "&a",
+ });
});
- it("Handles nested HTML tags", () => {
- equal(getTextContent("A<span>B<span>C</span></span>"), "ABC");
+ it("Handles an invalid decimal character reference end", () => {
+ equal(parseAttrsToObject("a=a>"), {
+ a: "a",
+ });
});
- it("Preserves lt/gt", () => {
- equal(getTextContent("<a>"), "<a>");
+ it("Handles invalid characters in numeric character references", () => {
+ equal(parseAttrsToObject("a='nul:�x'>"), {
+ a: "nul:\ufffdx",
+ });
+ equal(parseAttrsToObject("a='rng:�x'>"), {
+ a: "rng:\ufffdx",
+ });
+ equal(parseAttrsToObject("a='leading surrogate:�x'>"), {
+ a: "leading surrogate:\ufffdx",
+ });
+ equal(parseAttrsToObject("a='trailing surrogate:�x'>"), {
+ a: "trailing surrogate:\ufffdx",
+ });
});
});
diff --git a/src/test/utils/minimalSourceFile.test.ts b/src/test/utils/minimalSourceFile.test.ts
index a45c07d3a..f38a6376b 100644
--- a/src/test/utils/minimalSourceFile.test.ts
+++ b/src/test/utils/minimalSourceFile.test.ts
@@ -24,4 +24,13 @@ describe("MinimalSourceFile", () => {
check("4", { line: 2, character: 0 });
check("5", { line: 3, character: 0 });
});
+
+ it("#2605 Should handle multiple consecutive newlines", () => {
+ const sf = new MinimalSourceFile("a\n\nb", "");
+
+ equal(sf.getLineAndCharacterOfPosition(0), { line: 0, character: 0 }); // a
+ equal(sf.getLineAndCharacterOfPosition(1), { line: 0, character: 1 }); // \n
+ equal(sf.getLineAndCharacterOfPosition(2), { line: 1, character: 0 }); // \n
+ equal(sf.getLineAndCharacterOfPosition(3), { line: 2, character: 0 }); // b
+ });
});
diff --git a/src/test/utils/options/declaration.test.ts b/src/test/utils/options/declaration.test.ts
index 953794063..cfc57f66e 100644
--- a/src/test/utils/options/declaration.test.ts
+++ b/src/test/utils/options/declaration.test.ts
@@ -1,56 +1,63 @@
import { deepStrictEqual as equal, ok, throws } from "assert";
import { join, resolve } from "path";
import {
- ArrayDeclarationOption,
+ type ArrayDeclarationOption,
convert,
- DeclarationOption,
+ type DeclarationOption,
getDefaultValue,
- MapDeclarationOption,
- MixedDeclarationOption,
- ObjectDeclarationOption,
- NumberDeclarationOption,
+ type MapDeclarationOption,
+ type MixedDeclarationOption,
+ type ObjectDeclarationOption,
+ type NumberDeclarationOption,
ParameterType,
- StringDeclarationOption,
+ type StringDeclarationOption,
} from "../../../lib/utils/options/declaration";
+import { Internationalization } from "../../../lib/internationalization/internationalization";
+
+const emptyHelp = () => "";
describe("Options - conversions", () => {
+ const i18n = new Internationalization(null).proxy;
const optionWithType = (type: ParameterType) =>
({
type,
defaultValue: undefined,
name: "test",
- help: "",
+ help: emptyHelp,
}) as DeclarationOption;
it("Converts to numbers", () => {
- equal(convert("123", optionWithType(ParameterType.Number), ""), 123);
- equal(convert("a", optionWithType(ParameterType.Number), ""), 0);
- equal(convert(NaN, optionWithType(ParameterType.Number), ""), 0);
+ equal(
+ convert("123", optionWithType(ParameterType.Number), i18n, ""),
+ 123,
+ );
+ equal(convert("a", optionWithType(ParameterType.Number), i18n, ""), 0);
+ equal(convert(NaN, optionWithType(ParameterType.Number), i18n, ""), 0);
});
it("Converts to number if value is the lowest allowed value for a number option", () => {
const declaration: NumberDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
minValue: 1,
maxValue: 10,
defaultValue: 1,
};
- equal(convert(1, declaration, ""), 1);
+ equal(convert(1, declaration, i18n, ""), 1);
});
it("Generates an error if value is too low for a number option", () => {
const declaration: NumberDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
minValue: 1,
maxValue: 10,
defaultValue: 1,
};
throws(
- () => convert(0, declaration, ""),
+ () => convert(0, declaration, i18n, ""),
new Error("test must be between 1 and 10"),
);
});
@@ -58,54 +65,54 @@ describe("Options - conversions", () => {
it("Generates an error if value is too low for a number option with no max", () => {
const declaration: NumberDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
minValue: 1,
defaultValue: 1,
};
throws(
- () => convert(0, declaration, ""),
- new Error("test must be >= 1"),
+ () => convert(0, declaration, i18n, ""),
+ new Error("test must be equal to or greater than 1"),
);
});
it("Generates an error if value is too high for a number option with no min", () => {
const declaration: NumberDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
maxValue: 10,
defaultValue: 1,
};
throws(
- () => convert(11, declaration, ""),
- new Error("test must be <= 10"),
+ () => convert(11, declaration, i18n, ""),
+ new Error("test must be less than or equal to 10"),
);
});
it("Converts to number if value is the highest allowed value for a number option", () => {
const declaration: NumberDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
minValue: 1,
maxValue: 10,
defaultValue: 1,
};
- equal(convert(10, declaration, ""), 10);
+ equal(convert(10, declaration, i18n, ""), 10);
});
it("Generates an error if value is too high for a number option", () => {
const declaration: NumberDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
minValue: 1,
maxValue: 10,
defaultValue: 1,
};
throws(
- () => convert(11, declaration, ""),
+ () => convert(11, declaration, i18n, ""),
new Error("test must be between 1 and 10"),
);
});
@@ -113,7 +120,7 @@ describe("Options - conversions", () => {
it("Validates number options", () => {
const declaration: NumberDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
validate: (value: number) => {
if (value % 2 !== 0) {
@@ -121,30 +128,42 @@ describe("Options - conversions", () => {
}
},
};
- equal(convert(0, declaration, ""), 0);
- equal(convert(2, declaration, ""), 2);
- equal(convert(4, declaration, ""), 4);
+ equal(convert(0, declaration, i18n, ""), 0);
+ equal(convert(2, declaration, i18n, ""), 2);
+ equal(convert(4, declaration, i18n, ""), 4);
throws(
- () => convert(1, declaration, ""),
+ () => convert(1, declaration, i18n, ""),
new Error("test must be even"),
);
});
it("Converts to strings", () => {
- equal(convert("123", optionWithType(ParameterType.String), ""), "123");
- equal(convert(123, optionWithType(ParameterType.String), ""), "123");
equal(
- convert(["1", "2"], optionWithType(ParameterType.String), ""),
+ convert("123", optionWithType(ParameterType.String), i18n, ""),
+ "123",
+ );
+ equal(
+ convert(123, optionWithType(ParameterType.String), i18n, ""),
+ "123",
+ );
+ equal(
+ convert(["1", "2"], optionWithType(ParameterType.String), i18n, ""),
"1,2",
);
- equal(convert(null, optionWithType(ParameterType.String), ""), "");
- equal(convert(void 0, optionWithType(ParameterType.String), ""), "");
+ equal(
+ convert(null, optionWithType(ParameterType.String), i18n, ""),
+ "",
+ );
+ equal(
+ convert(void 0, optionWithType(ParameterType.String), i18n, ""),
+ "",
+ );
});
it("Validates string options", () => {
const declaration: StringDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.String,
validate: (value: string) => {
if (value !== value.toUpperCase()) {
@@ -152,48 +171,83 @@ describe("Options - conversions", () => {
}
},
};
- equal(convert("TOASTY", declaration, ""), "TOASTY");
+ equal(convert("TOASTY", declaration, i18n, ""), "TOASTY");
throws(
- () => convert("toasty", declaration, ""),
+ () => convert("toasty", declaration, i18n, ""),
new Error("test must be upper case"),
);
});
it("Converts to booleans", () => {
- equal(convert("a", optionWithType(ParameterType.Boolean), ""), true);
- equal(convert([1], optionWithType(ParameterType.Boolean), ""), true);
- equal(convert(false, optionWithType(ParameterType.Boolean), ""), false);
+ equal(
+ convert("a", optionWithType(ParameterType.Boolean), i18n, ""),
+ true,
+ );
+ equal(
+ convert([1], optionWithType(ParameterType.Boolean), i18n, ""),
+ true,
+ );
+ equal(
+ convert(false, optionWithType(ParameterType.Boolean), i18n, ""),
+ false,
+ );
});
it("Converts to arrays", () => {
- equal(convert("12,3", optionWithType(ParameterType.Array), ""), [
- "12,3",
- ]);
- equal(convert(["12,3"], optionWithType(ParameterType.Array), ""), [
+ equal(convert("12,3", optionWithType(ParameterType.Array), i18n, ""), [
"12,3",
]);
- equal(convert(true, optionWithType(ParameterType.Array), ""), []);
+ equal(
+ convert(["12,3"], optionWithType(ParameterType.Array), i18n, ""),
+ ["12,3"],
+ );
+ equal(convert(true, optionWithType(ParameterType.Array), i18n, ""), []);
- equal(convert("/,a", optionWithType(ParameterType.PathArray), ""), [
- resolve("/,a"),
- ]);
- equal(convert(["/foo"], optionWithType(ParameterType.PathArray), ""), [
- resolve("/foo"),
- ]);
- equal(convert(true, optionWithType(ParameterType.PathArray), ""), []);
+ equal(
+ convert("/,a", optionWithType(ParameterType.PathArray), i18n, ""),
+ [resolve("/,a")],
+ );
+ equal(
+ convert(
+ ["/foo"],
+ optionWithType(ParameterType.PathArray),
+ i18n,
+ "",
+ ),
+ [resolve("/foo")],
+ );
+ equal(
+ convert(true, optionWithType(ParameterType.PathArray), i18n, ""),
+ [],
+ );
- equal(convert("a,b", optionWithType(ParameterType.ModuleArray), ""), [
- "a,b",
- ]);
- equal(convert(["a,b"], optionWithType(ParameterType.ModuleArray), ""), [
- "a,b",
- ]);
- equal(convert(true, optionWithType(ParameterType.ModuleArray), ""), []);
+ equal(
+ convert("a,b", optionWithType(ParameterType.ModuleArray), i18n, ""),
+ ["a,b"],
+ );
+ equal(
+ convert(
+ ["a,b"],
+ optionWithType(ParameterType.ModuleArray),
+ i18n,
+ "",
+ ),
+ ["a,b"],
+ );
+ equal(
+ convert(true, optionWithType(ParameterType.ModuleArray), i18n, ""),
+ [],
+ );
});
it("ModuleArray is resolved if relative", () => {
equal(
- convert(["./foo"], optionWithType(ParameterType.ModuleArray), ""),
+ convert(
+ ["./foo"],
+ optionWithType(ParameterType.ModuleArray),
+ i18n,
+ "",
+ ),
[join(process.cwd(), "foo")],
);
});
@@ -201,7 +255,7 @@ describe("Options - conversions", () => {
it("Validates array options", () => {
const declaration: ArrayDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Array,
validate: (value: string[]) => {
if (value.length === 0) {
@@ -209,10 +263,10 @@ describe("Options - conversions", () => {
}
},
};
- equal(convert(["1"], declaration, ""), ["1"]);
- equal(convert(["1", "2"], declaration, ""), ["1", "2"]);
+ equal(convert(["1"], declaration, i18n, ""), ["1"]);
+ equal(convert(["1", "2"], declaration, i18n, ""), ["1", "2"]);
throws(
- () => convert([], declaration, ""),
+ () => convert([], declaration, i18n, ""),
new Error("test must not be empty"),
);
});
@@ -220,7 +274,7 @@ describe("Options - conversions", () => {
it("Converts to mapped types", () => {
const declaration: MapDeclarationOption<number> = {
name: "",
- help: "",
+ help: emptyHelp,
type: ParameterType.Map,
map: {
a: 1,
@@ -228,15 +282,15 @@ describe("Options - conversions", () => {
},
defaultValue: 1,
};
- equal(convert("a", declaration, ""), 1);
- equal(convert("b", declaration, ""), 2);
- equal(convert(2, declaration, ""), 2);
+ equal(convert("a", declaration, i18n, ""), 1);
+ equal(convert("b", declaration, i18n, ""), 2);
+ equal(convert(2, declaration, i18n, ""), 2);
});
it("Converts to mapped types with a map", () => {
const declaration: MapDeclarationOption<number> = {
name: "",
- help: "",
+ help: emptyHelp,
type: ParameterType.Map,
map: new Map([
["a", 1],
@@ -244,30 +298,15 @@ describe("Options - conversions", () => {
]),
defaultValue: 1,
};
- equal(convert("a", declaration, ""), 1);
- equal(convert("b", declaration, ""), 2);
- equal(convert(2, declaration, ""), 2);
- });
-
- it("Uses the mapError if provided for errors", () => {
- const declaration: MapDeclarationOption<number> = {
- name: "",
- help: "",
- type: ParameterType.Map,
- map: {},
- defaultValue: 1,
- mapError: "Test error",
- };
- throws(
- () => convert("a", declaration, ""),
- new Error(declaration.mapError),
- );
+ equal(convert("a", declaration, i18n, ""), 1);
+ equal(convert("b", declaration, i18n, ""), 2);
+ equal(convert(2, declaration, i18n, ""), 2);
});
- it("Generates a nice error if no mapError is provided", () => {
+ it("Generates a nice error if value is invalid", () => {
const declaration: MapDeclarationOption<number> = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Map,
map: new Map([
["a", 1],
@@ -276,7 +315,7 @@ describe("Options - conversions", () => {
defaultValue: 1,
};
throws(
- () => convert("c", declaration, ""),
+ () => convert("c", declaration, i18n, ""),
new Error("test must be one of a, b"),
);
});
@@ -288,26 +327,29 @@ describe("Options - conversions", () => {
}
const declaration = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Map,
map: Enum,
defaultValue: Enum.a,
} as const;
throws(
- () => convert("c", declaration, ""),
+ () => convert("c", declaration, i18n, ""),
new Error("test must be one of a, b"),
);
});
it("Passes through mixed", () => {
const data = Symbol();
- equal(convert(data, optionWithType(ParameterType.Mixed), ""), data);
+ equal(
+ convert(data, optionWithType(ParameterType.Mixed), i18n, ""),
+ data,
+ );
});
it("Validates mixed options", () => {
const declaration: MixedDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Mixed,
defaultValue: "default",
validate: (value: unknown) => {
@@ -316,21 +358,24 @@ describe("Options - conversions", () => {
}
},
};
- equal(convert("text", declaration, ""), "text");
+ equal(convert("text", declaration, i18n, ""), "text");
throws(
- () => convert(1, declaration, ""),
+ () => convert(1, declaration, i18n, ""),
new Error("test must not be a number"),
);
});
it("Passes through object", () => {
const data = {};
- equal(convert(data, optionWithType(ParameterType.Object), ""), data);
+ equal(
+ convert(data, optionWithType(ParameterType.Object), i18n, ""),
+ data,
+ );
});
it("Validates object options", () => {
const declaration: ObjectDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Object,
defaultValue: "default",
validate: (value: unknown) => {
@@ -339,9 +384,9 @@ describe("Options - conversions", () => {
}
},
};
- equal(convert({}, declaration, ""), {});
+ equal(convert({}, declaration, i18n, ""), {});
throws(
- () => convert(1, declaration, ""),
+ () => convert(1, declaration, i18n, ""),
new Error("test must be an object"),
);
});
@@ -349,14 +394,17 @@ describe("Options - conversions", () => {
it("Converts object options", () => {
const declaration: ObjectDeclarationOption = {
name: "test",
- help: "",
+ help: emptyHelp,
type: ParameterType.Object,
defaultValue: { a: 1, b: 2 },
};
- equal(convert({ b: 3 }, declaration, "", declaration.defaultValue), {
- a: 1,
- b: 3,
- });
+ equal(
+ convert({ b: 3 }, declaration, i18n, "", declaration.defaultValue),
+ {
+ a: 1,
+ b: 3,
+ },
+ );
});
});
@@ -369,7 +417,7 @@ describe("Options - default values", () => {
type,
defaultValue,
name: "test",
- help: "",
+ help: emptyHelp,
} as DeclarationOption;
}
diff --git a/src/test/utils/options/default-options.test.ts b/src/test/utils/options/default-options.test.ts
index fc1ab95cf..a7c7900b0 100644
--- a/src/test/utils/options/default-options.test.ts
+++ b/src/test/utils/options/default-options.test.ts
@@ -1,26 +1,23 @@
import { ok, throws, strictEqual, doesNotThrow } from "assert";
-import { BUNDLED_THEMES } from "shiki";
import { Options } from "../../../lib/utils";
+import { Internationalization } from "../../../lib/internationalization/internationalization";
describe("Default Options", () => {
- const opts = new Options();
+ const opts = new Options(new Internationalization(null).proxy);
describe("Highlighting theme", () => {
it("Errors if an invalid theme is provided", () => {
throws(() =>
opts.setValue("lightHighlightTheme", "randomTheme" as never),
);
- opts.setValue("lightHighlightTheme", BUNDLED_THEMES[0]);
- strictEqual(
- opts.getValue("lightHighlightTheme"),
- BUNDLED_THEMES[0],
- );
+ opts.setValue("lightHighlightTheme", "github-light");
+ strictEqual(opts.getValue("lightHighlightTheme"), "github-light");
throws(() =>
opts.setValue("darkHighlightTheme", "randomTheme" as never),
);
- opts.setValue("darkHighlightTheme", BUNDLED_THEMES[0]);
- strictEqual(opts.getValue("darkHighlightTheme"), BUNDLED_THEMES[0]);
+ opts.setValue("darkHighlightTheme", "github-light");
+ strictEqual(opts.getValue("darkHighlightTheme"), "github-light");
});
});
@@ -46,19 +43,19 @@ describe("Default Options", () => {
});
});
- describe("markedOptions", () => {
+ describe("markdownItOptions", () => {
it("Errors if given a non-object", () => {
- throws(() => opts.setValue("markedOptions", null));
- throws(() => opts.setValue("markedOptions", "bad"));
- throws(() => opts.setValue("markedOptions", []));
+ throws(() => opts.setValue("markdownItOptions", null as never));
+ throws(() => opts.setValue("markdownItOptions", "bad" as never));
+ throws(() => opts.setValue("markdownItOptions", [] as never));
});
});
describe("compilerOptions", () => {
it("Errors if given a non-object", () => {
- throws(() => opts.setValue("markedOptions", null));
- throws(() => opts.setValue("markedOptions", "bad"));
- throws(() => opts.setValue("markedOptions", []));
+ throws(() => opts.setValue("compilerOptions", "bad"));
+ throws(() => opts.setValue("compilerOptions", null));
+ throws(() => opts.setValue("compilerOptions", []));
});
});
diff --git a/src/test/utils/options/help.test.ts b/src/test/utils/options/help.test.ts
index 646d01f9a..b57e2bb2a 100644
--- a/src/test/utils/options/help.test.ts
+++ b/src/test/utils/options/help.test.ts
@@ -2,9 +2,11 @@ import { ok } from "assert";
import { Options, ParameterType, ParameterHint } from "../../../lib/utils";
import { getOptionsHelp } from "../../../lib/utils/options/help";
+import { Internationalization } from "../../../lib/internationalization/internationalization";
describe("Options - help", () => {
- const options = new Options();
+ const i18n = new Internationalization(null).proxy;
+ const options = new Options(new Internationalization(null).proxy);
for (const decl of [
{ name: "td-option", help: "help", type: ParameterType.String },
{ name: "td-option2", help: "help" },
@@ -19,12 +21,12 @@ describe("Options - help", () => {
}
it("Describes TypeDoc options", () => {
- const help = getOptionsHelp(options);
+ const help = getOptionsHelp(options, i18n);
ok(help.includes("td-option"));
});
it("Does not list options without help", () => {
- const help = getOptionsHelp(options);
+ const help = getOptionsHelp(options, i18n);
ok(!help.includes("not displayed"));
});
});
diff --git a/src/test/utils/options/options.test.ts b/src/test/utils/options/options.test.ts
index 5b4f17afd..2d4a366a0 100644
--- a/src/test/utils/options/options.test.ts
+++ b/src/test/utils/options/options.test.ts
@@ -1,14 +1,15 @@
import { LogLevel, Options, ParameterType } from "../../../lib/utils";
import {
Option,
- MapDeclarationOption,
- NumberDeclarationOption,
+ type MapDeclarationOption,
+ type NumberDeclarationOption,
} from "../../../lib/utils";
import { deepStrictEqual as equal, throws } from "assert";
import type {
DeclarationOption,
EmitStrategy,
} from "../../../lib/utils/options";
+import { Internationalization } from "../../../lib/internationalization/internationalization";
describe("Options", () => {
let options: Options & {
@@ -17,13 +18,13 @@ describe("Options", () => {
};
beforeEach(() => {
- options = new Options();
+ options = new Options(new Internationalization(null).proxy);
options.addDeclaration({
name: "mapped",
type: ParameterType.Map,
map: { a: 1 },
defaultValue: 2,
- help: "",
+ help: () => "",
});
});
@@ -32,7 +33,7 @@ describe("Options", () => {
try {
options.addDeclaration({
name: "help",
- help: "",
+ help: () => "",
type: ParameterType.Boolean,
});
} catch {
@@ -45,7 +46,7 @@ describe("Options", () => {
it("Does not throw if number declaration has no min and max values", () => {
const declaration: NumberDeclarationOption = {
name: "test-number-declaration",
- help: "",
+ help: () => "",
type: ParameterType.Number,
defaultValue: 1,
};
@@ -55,7 +56,7 @@ describe("Options", () => {
it("Does not throw if default value is out of range for number declaration", () => {
const declaration: NumberDeclarationOption = {
name: "test-number-declaration",
- help: "",
+ help: () => "",
type: ParameterType.Number,
minValue: 1,
maxValue: 10,
@@ -67,7 +68,7 @@ describe("Options", () => {
it("Does not throw if a map declaration has a default value that is not part of the map of possible values", () => {
const declaration: MapDeclarationOption<number> = {
name: "testMapDeclarationWithForeignDefaultValue",
- help: "",
+ help: () => "",
type: ParameterType.Map,
map: new Map([
["a", 1],
@@ -121,7 +122,7 @@ describe("Options", () => {
});
it("Resets a flag to the default if set to null", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.setValue("validation", { notExported: true });
options.setValue("validation", { notExported: null! });
@@ -133,7 +134,7 @@ describe("Options", () => {
});
it("Handles mapped enums properly", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
equal(options.getValue("logLevel"), LogLevel.Info);
options.setValue("logLevel", LogLevel.Error);
@@ -147,7 +148,7 @@ describe("Options", () => {
});
it("Supports checking if an option is set", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
equal(options.isSet("excludePrivate"), false);
options.setValue("excludePrivate", false);
equal(options.isSet("excludePrivate"), true);
@@ -158,7 +159,7 @@ describe("Options", () => {
});
it("Throws if frozen and a value is set", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.freeze();
throws(() => options.setValue("categorizeByGroup", true));
@@ -166,7 +167,7 @@ describe("Options", () => {
});
it("Supports resetting values", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.setValue("entryPoints", ["x"]);
const oldExcludeTags = options.getValue("excludeTags");
@@ -178,7 +179,7 @@ describe("Options", () => {
});
it("Supports resetting a single value", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.setValue("name", "test");
const originalExclude = options.getValue("excludeTags");
@@ -190,7 +191,7 @@ describe("Options", () => {
});
it("Throws if resetting a single value which does not exist", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
throws(() => options.reset("thisOptionDoesNotExist" as never));
});
@@ -205,14 +206,14 @@ describe("Option", () => {
}
it("Supports fetching options", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
const container = new Container(options);
equal(container.emit, "docs");
});
it("Updates as option values change", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
const container = new Container(options);
equal(container.emit, "docs");
diff --git a/src/test/utils/options/readers/arguments.test.ts b/src/test/utils/options/readers/arguments.test.ts
index 25efd00c6..12bacb504 100644
--- a/src/test/utils/options/readers/arguments.test.ts
+++ b/src/test/utils/options/readers/arguments.test.ts
@@ -1,14 +1,17 @@
-import { deepStrictEqual as equal, ok } from "assert";
+import { deepStrictEqual as equal } from "assert";
-import { Options, Logger } from "../../../../lib/utils";
+import { Options } from "../../../../lib/utils";
import { ArgumentsReader } from "../../../../lib/utils/options/readers";
import {
ParameterType,
- NumberDeclarationOption,
- MapDeclarationOption,
+ type NumberDeclarationOption,
+ type MapDeclarationOption,
} from "../../../../lib/utils/options";
import { join, resolve } from "path";
import { TestLogger } from "../../../TestLogger";
+import { Internationalization } from "../../../../lib/internationalization/internationalization";
+
+const emptyHelp = () => "";
describe("Options - ArgumentsReader", () => {
const logger = new TestLogger();
@@ -32,16 +35,16 @@ describe("Options - ArgumentsReader", () => {
};
beforeEach(() => {
- options = new Options();
+ options = new Options(new Internationalization(null).proxy);
options.addDeclaration({
name: "numOption",
- help: "",
+ help: emptyHelp,
type: ParameterType.Number,
});
options.addDeclaration({
name: "mapped",
type: ParameterType.Map,
- help: "",
+ help: emptyHelp,
map: { a: 1, b: 2 },
defaultValue: 3,
});
@@ -135,19 +138,15 @@ describe("Options - ArgumentsReader", () => {
});
it("Warns if option is expecting a value but no value is provided", async () => {
- let check = false;
- class TestLogger extends Logger {
- override warn(msg: string) {
- ok(msg.includes("--out"));
- check = true;
- }
- }
-
const reader = new ArgumentsReader(1, ["--out"]);
options.reset();
options.addReader(reader);
- await options.read(new TestLogger());
- equal(check, true, "Reader did not report an error.");
+ const logger = new TestLogger();
+ await options.read(logger);
+ logger.expectMessage(
+ "warn: --out expected a value, but none was given as an argument",
+ );
+ logger.expectNoOtherMessages();
});
test(
diff --git a/src/test/utils/options/readers/package-json.test.ts b/src/test/utils/options/readers/package-json.test.ts
index a40ff95d4..fbeed7122 100644
--- a/src/test/utils/options/readers/package-json.test.ts
+++ b/src/test/utils/options/readers/package-json.test.ts
@@ -3,13 +3,14 @@ import { project } from "@typestrong/fs-fixture-builder";
import { PackageJsonReader } from "../../../../lib/utils/options/readers";
import { Options } from "../../../../lib/utils";
import { TestLogger } from "../../../TestLogger";
+import { Internationalization } from "../../../../lib/internationalization/internationalization";
describe("Options - PackageJsonReader", () => {
let optsContainer: Options;
let testLogger: TestLogger;
beforeEach(() => {
- optsContainer = new Options();
+ optsContainer = new Options(new Internationalization(null).proxy);
testLogger = new TestLogger();
optsContainer.addReader(new PackageJsonReader());
@@ -29,11 +30,10 @@ describe("Options - PackageJsonReader", () => {
const proj = project(testTitle.replace(/[ "]/g, "_"));
proj.addFile("package.json", pkgJsonContent);
proj.write();
+ after(() => proj.rm());
await optsContainer.read(testLogger, proj.cwd);
- proj.rm();
-
test(testLogger);
testLogger.expectNoOtherMessages();
});
@@ -50,7 +50,7 @@ describe("Options - PackageJsonReader", () => {
`{ "name": "x", "typedocOptions": 123 }`,
(l) =>
l.expectMessage(
- `error: Failed to parse the "typedocOptions" field in */package.json, ensure it exists and contains an object.`,
+ `error: Failed to parse the "typedocOptions" field in */package.json, ensure it exists and contains an object`,
),
);
@@ -59,7 +59,7 @@ describe("Options - PackageJsonReader", () => {
`{ "name": "x", "typedocOptions": { "someOptionThatDoesNotExist": true } }`,
(l) =>
l.expectMessage(
- "error: Tried to set an option (someOptionThatDoesNotExist) that was not declared.*",
+ "error: Unknown option 'someOptionThatDoesNotExist' You may have meant:*",
),
);
@@ -68,7 +68,7 @@ describe("Options - PackageJsonReader", () => {
`{ "name": "x", "typedoc": {} }`,
(l) =>
l.expectMessage(
- "warn: The 'typedoc' key in */package.json was used by the legacy-packages entryPointStrategy and will be ignored.",
+ "warn: The 'typedoc' key in */package.json was used by the legacy-packages entryPointStrategy and will be ignored",
),
);
});
diff --git a/src/test/utils/options/readers/tsconfig.test.ts b/src/test/utils/options/readers/tsconfig.test.ts
index b4be6e0c2..9bf5cf80b 100644
--- a/src/test/utils/options/readers/tsconfig.test.ts
+++ b/src/test/utils/options/readers/tsconfig.test.ts
@@ -4,11 +4,12 @@ import { deepStrictEqual as equal } from "assert";
import { TSConfigReader } from "../../../../lib/utils/options/readers";
import { Logger, Options } from "../../../../lib/utils";
import { TestLogger } from "../../../TestLogger";
-import { tempdirProject, Project } from "@typestrong/fs-fixture-builder";
+import { tempdirProject, type Project } from "@typestrong/fs-fixture-builder";
import { tmpdir } from "os";
+import { Internationalization } from "../../../../lib/internationalization/internationalization";
describe("Options - TSConfigReader", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.addReader(new TSConfigReader());
const logger = new TestLogger();
@@ -28,7 +29,6 @@ describe("Options - TSConfigReader", () => {
if (noErrors) {
logger.expectNoOtherMessages();
}
- project.rm();
}
it("Errors if the file cannot be found", async () => {
@@ -45,7 +45,7 @@ describe("Options - TSConfigReader", () => {
function testError(name: string, file: object) {
it(name, async () => {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addJsonFile("tsconfig.json", file);
await readWithProject(project, true, false);
equal(logger.hasErrors(), true, "No error was logged");
@@ -75,7 +75,7 @@ describe("Options - TSConfigReader", () => {
});
it("Errors if a tsconfig file cannot be parsed", async () => {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addFile("tsconfig.json", '{"test}');
await readWithProject(project, true, false);
logger.expectMessage("error: *");
@@ -88,7 +88,7 @@ describe("Options - TSConfigReader", () => {
override isSet() {
return false;
}
- })();
+ })(new Internationalization(null).proxy);
options.setValue(
"tsconfig",
@@ -100,7 +100,7 @@ describe("Options - TSConfigReader", () => {
});
it("Reads typedocOptions from extended tsconfig files", async () => {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addFile("file.ts", "export const abc = 123");
project.addJsonFile("tsconfig.json", {
extends: ["./base.tsconfig.json"],
@@ -118,7 +118,7 @@ describe("Options - TSConfigReader", () => {
});
async function readTsconfig(tsconfig: object) {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addFile("file.ts", "export const abc = 123");
project.addJsonFile("tsconfig.json", tsconfig);
@@ -146,7 +146,7 @@ describe("Options - TSConfigReader", () => {
});
it("Does not set excludeInternal by stripInternal if already set", async () => {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addJsonFile("tsconfig.json", {
compilerOptions: { stripInternal: true },
});
@@ -158,7 +158,7 @@ describe("Options - TSConfigReader", () => {
});
it("Correctly handles folder names ending with .json (#1712)", async () => {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addJsonFile("tsconfig.json", {
compilerOptions: { strict: true },
});
@@ -167,7 +167,7 @@ describe("Options - TSConfigReader", () => {
});
async function testTsdoc(tsdoc: object, cb?: () => void, reset = true) {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addFile("file.ts", "export const abc = 123");
project.addJsonFile("tsconfig.json", {});
project.addJsonFile("tsdoc.json", tsdoc);
@@ -180,7 +180,7 @@ describe("Options - TSConfigReader", () => {
it("Handles failed tsdoc reads", async () => {
await testTsdoc([], () => {
logger.expectMessage(
- "error: Failed to read tsdoc.json file at */tsdoc.json.",
+ "error: Failed to read tsdoc.json file at */tsdoc.json",
);
});
});
@@ -192,7 +192,7 @@ describe("Options - TSConfigReader", () => {
},
() => {
logger.expectMessage(
- `error: The file */tsdoc.json is not a valid tsdoc.json file.`,
+ `error: The file */tsdoc.json is not a valid tsdoc.json file`,
);
},
);
@@ -207,7 +207,7 @@ describe("Options - TSConfigReader", () => {
() => {
logger.expectMessage(
"warn: The blockTags, modifierTags defined in typedoc.json " +
- "will be overwritten by configuration in tsdoc.json.",
+ "will be overwritten by configuration in tsdoc.json",
);
},
false,
@@ -239,7 +239,7 @@ describe("Options - TSConfigReader", () => {
});
it("Handles extends in tsdoc.json", async () => {
- const project = tempdirProject();
+ using project = tempdirProject();
project.addFile("file.ts", "export const abc = 123");
project.addJsonFile("tsconfig.json", {});
project.addJsonFile("tsdoc.json", { extends: ["./tsdoc2.json"] });
diff --git a/src/test/utils/options/readers/typedoc.test.ts b/src/test/utils/options/readers/typedoc.test.ts
index 930c44382..c1646de9c 100644
--- a/src/test/utils/options/readers/typedoc.test.ts
+++ b/src/test/utils/options/readers/typedoc.test.ts
@@ -5,13 +5,16 @@ import { TypeDocReader } from "../../../../lib/utils/options/readers";
import { Logger, Options } from "../../../../lib/utils";
import { TestLogger } from "../../../TestLogger";
import { join } from "path";
+import { Internationalization } from "../../../../lib/internationalization/internationalization";
describe("Options - TypeDocReader", () => {
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.addReader(new TypeDocReader());
it("Supports comments in json", async () => {
const project = fsProject("jsonc");
+ after(() => project.rm());
+
project.addFile("typedoc.json", '//comment\n{"name": "comment"}');
const logger = new TestLogger();
@@ -19,7 +22,6 @@ describe("Options - TypeDocReader", () => {
options.reset();
options.setValue("options", project.cwd);
await options.read(logger);
- project.rm();
logger.expectNoOtherMessages();
equal(options.getValue("name"), "comment");
@@ -37,10 +39,10 @@ describe("Options - TypeDocReader", () => {
const logger = new TestLogger();
project.write();
+ after(() => project.rm());
options.reset();
options.setValue("options", project.cwd);
await options.read(logger);
- project.rm();
logger.expectNoOtherMessages();
equal(options.getValue("name"), "extends");
@@ -53,10 +55,10 @@ describe("Options - TypeDocReader", () => {
const logger = new TestLogger();
project.write();
+ after(() => project.rm());
options.reset();
options.setValue("options", project.cwd);
await options.read(logger);
- project.rm();
logger.expectNoOtherMessages();
equal(options.getValue("name"), "js");
@@ -68,7 +70,7 @@ describe("Options - TypeDocReader", () => {
const logger = new TestLogger();
await options.read(logger);
logger.expectMessage(
- "error: The options file */non-existent-file.json does not exist.",
+ "error: The options file */non-existent-file.json does not exist",
);
logger.expectNoOtherMessages();
});
@@ -92,8 +94,8 @@ describe("Options - TypeDocReader", () => {
options.setValue("options", project.cwd);
const logger = new TestLogger();
project.write();
+ after(() => project.rm());
await options.read(logger);
- project.rm();
logger.expectMessage(message);
});
}
@@ -101,17 +103,17 @@ describe("Options - TypeDocReader", () => {
testError(
"Errors if the data is invalid",
"Not valid json {}",
- "error: Failed to parse */typedoc.json, ensure it exists and contains an object.",
+ "error: Failed to parse */typedoc.json, ensure it exists and exports an object",
);
testError(
"Errors if the data is not an object in a json file",
123,
- "error: Failed to parse */typedoc.json, ensure it exists and contains an object.",
+ "error: Failed to parse */typedoc.json, ensure it exists and exports an object",
);
testError(
"Errors if the data is not an object in a js file",
"module.exports = 123",
- "error: The root value of */typedoc.js is not an object.",
+ "error: Failed to parse */typedoc.js, ensure it exists and exports an object",
false,
);
testError(
@@ -119,14 +121,14 @@ describe("Options - TypeDocReader", () => {
{
someOptionThatDoesNotExist: true,
},
- "error: Tried to set an option (someOptionThatDoesNotExist) that was not declared. You may have meant:*",
+ "error: Unknown option 'someOptionThatDoesNotExist' You may have meant:*",
);
testError(
"Errors if extends results in a loop",
{
extends: "./typedoc.json",
},
- "error: Tried to load the options file */typedoc.json multiple times.",
+ 'error: Circular reference encountered for "extends" field of *',
);
testError(
"Errors if the extended path cannot be found",
@@ -141,7 +143,7 @@ describe("Options - TypeDocReader", () => {
override isSet() {
return false;
}
- })();
+ })(new Internationalization(null).proxy);
options.addReader(new TypeDocReader());
const logger = new Logger();
@@ -156,44 +158,49 @@ describe("Options - TypeDocReader", () => {
"export default { pretty: false }",
);
project.write();
+ after(() => project.rm());
const logger = new TestLogger();
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.setValue("options", join(project.cwd, "typedoc.config.mjs"));
options.addReader(new TypeDocReader());
await options.read(logger);
equal(logger.hasErrors(), false);
-
- project.rm();
});
it("Handles errors when reading config files", async () => {
const project = fsProject("errors");
project.addFile("typedoc.config.mjs", "throw new Error('hi')");
project.write();
+ after(() => project.rm());
const logger = new TestLogger();
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.setValue("options", join(project.cwd, "typedoc.config.mjs"));
options.addReader(new TypeDocReader());
await options.read(logger);
- project.rm();
- logger.expectMessage("error: Failed to read */typedoc.config.mjs: hi");
+ logger.expectMessage(
+ "error: Failed to parse */typedoc.config.mjs, ensure it exists and exports an object",
+ );
+ logger.expectMessage("error: hi");
});
it("Handles non-Error throws when reading config files", async () => {
const project = fsProject("errors2");
project.addFile("typedoc.config.cjs", "throw 123");
project.write();
+ after(() => project.rm());
const logger = new TestLogger();
- const options = new Options();
+ const options = new Options(new Internationalization(null).proxy);
options.setValue("options", join(project.cwd, "typedoc.config.cjs"));
options.addReader(new TypeDocReader());
await options.read(logger);
- project.rm();
- logger.expectMessage("error: Failed to read */typedoc.config.cjs: 123");
+ logger.expectMessage(
+ "error: Failed to parse */typedoc.config.cjs, ensure it exists and exports an object",
+ );
+ logger.expectMessage("error: 123");
});
});
diff --git a/src/test/utils/options/tsdoc-defaults.test.ts b/src/test/utils/options/tsdoc-defaults.test.ts
new file mode 100644
index 000000000..7d636a0bb
--- /dev/null
+++ b/src/test/utils/options/tsdoc-defaults.test.ts
@@ -0,0 +1,61 @@
+import { deepEqual as equal } from "assert/strict";
+import { join } from "path";
+import ts from "typescript";
+import * as defaults from "../../../lib/utils/options/tsdoc-defaults";
+
+describe("tsdoc-defaults.ts", () => {
+ const tsdoc = ts.readConfigFile(
+ join(__dirname, "../../../../tsdoc.json"),
+ ts.sys.readFile,
+ );
+ const tagDefinitions = tsdoc.config?.tagDefinitions as Array<{
+ tagName: string;
+ syntaxKind: "block" | "modifier" | "inline";
+ }>;
+
+ function tagsByKind(kind: "block" | "modifier" | "inline") {
+ return tagDefinitions
+ .filter((t) => t.syntaxKind === kind)
+ .map((t) => t.tagName)
+ .sort((a, b) => a.localeCompare(b));
+ }
+
+ before(() => {
+ equal(tsdoc.error, undefined);
+ });
+
+ it("Should expose the same block tags as the tsdoc.json file", () => {
+ const tsdocTags = tagsByKind("block");
+
+ const typedocTags = defaults.blockTags
+ .filter((t) => !defaults.tsdocBlockTags.includes(t as never))
+ .sort((a, b) => a.localeCompare(b));
+
+ // @inheritDoc is a special case. We can't specify it in the tsdoc.json
+ // or the official parser blows up, because it thinks that it is only
+ // an inline tag.
+ typedocTags.splice(typedocTags.indexOf("@inheritDoc"), 1);
+
+ equal(tsdocTags, typedocTags);
+ });
+
+ it("Should expose the same modifier tags as the tsdoc.json file", () => {
+ const tsdocTags = tagsByKind("modifier");
+
+ const typedocTags = defaults.modifierTags
+ .filter((t) => !defaults.tsdocModifierTags.includes(t as never))
+ .sort((a, b) => a.localeCompare(b));
+
+ equal(tsdocTags, typedocTags);
+ });
+
+ it("Should expose the same inline tags as the tsdoc.json file", () => {
+ const tsdocTags = tagsByKind("inline");
+
+ const typedocTags = defaults.inlineTags
+ .filter((t) => !defaults.tsdocInlineTags.includes(t as never))
+ .sort((a, b) => a.localeCompare(b));
+
+ equal(tsdocTags, typedocTags);
+ });
+});
diff --git a/src/test/utils/path.test.ts b/src/test/utils/path.test.ts
new file mode 100644
index 000000000..70c84df3d
--- /dev/null
+++ b/src/test/utils/path.test.ts
@@ -0,0 +1,27 @@
+import { equal } from "assert";
+import { normalizePath } from "../../lib/utils";
+
+describe("normalizePath", () => {
+ const winTest = process.platform === "win32" ? it : it.skip;
+ const nixTest = process.platform === "win32" ? it.skip : it;
+
+ winTest("Returns paths with forward slashes", () => {
+ equal(
+ normalizePath("test\\test\\another/forward"),
+ "test/test/another/forward",
+ );
+ });
+
+ winTest("Normalizes drive letters", () => {
+ equal(normalizePath("c:\\foo"), "C:/foo");
+ equal(normalizePath("D:/foo"), "D:/foo");
+ });
+
+ winTest("Checks for unix style paths", () => {
+ equal(normalizePath("/c/users/you"), "C:/users/you");
+ });
+
+ nixTest("Returns the original path", () => {
+ equal(normalizePath("/c/users\\foo"), "/c/users\\foo");
+ });
+});
diff --git a/src/test/utils/plugins.test.ts b/src/test/utils/plugins.test.ts
index 113a1655e..17705534c 100644
--- a/src/test/utils/plugins.test.ts
+++ b/src/test/utils/plugins.test.ts
@@ -1,23 +1,21 @@
-import { Project, tempdirProject } from "@typestrong/fs-fixture-builder";
+import { tempdirProject } from "@typestrong/fs-fixture-builder";
import type { Application } from "../../index";
import { loadPlugins } from "../../lib/utils/plugins";
import { TestLogger } from "../TestLogger";
import { join, resolve } from "path";
+import { Internationalization } from "../../lib/internationalization/internationalization";
describe("loadPlugins", () => {
- let project: Project;
let logger: TestLogger;
- const fakeApp = {} as any as Application;
+ const fakeApp = {
+ i18n: new Internationalization(null).proxy,
+ } as any as Application;
beforeEach(() => {
- project = tempdirProject();
logger = fakeApp.logger = new TestLogger();
});
- afterEach(() => {
- project.rm();
- });
-
it("Should support loading a basic plugin", async () => {
+ using project = tempdirProject();
project.addJsonFile("package.json", {
type: "commonjs",
main: "index.js",
@@ -31,6 +29,7 @@ describe("loadPlugins", () => {
});
it("Should support loading a ESM plugin", async () => {
+ using project = tempdirProject();
project.addJsonFile("package.json", {
type: "module",
main: "index.js",
@@ -44,6 +43,7 @@ describe("loadPlugins", () => {
});
it("Should handle errors when requiring plugins", async () => {
+ using project = tempdirProject();
project.addJsonFile("package.json", {
type: "commonjs",
main: "index.js",
@@ -53,12 +53,11 @@ describe("loadPlugins", () => {
const plugin = join(resolve(project.cwd), "index.js");
await loadPlugins(fakeApp, [plugin]);
- logger.expectMessage(
- `error: The plugin ${plugin} could not be loaded.`,
- );
+ logger.expectMessage(`error: The plugin ${plugin} could not be loaded`);
});
it("Should handle errors when loading plugins", async () => {
+ using project = tempdirProject();
project.addJsonFile("package.json", {
type: "commonjs",
main: "index.js",
@@ -71,12 +70,11 @@ describe("loadPlugins", () => {
const plugin = join(resolve(project.cwd), "index.js");
await loadPlugins(fakeApp, [plugin]);
- logger.expectMessage(
- `error: The plugin ${plugin} could not be loaded.`,
- );
+ logger.expectMessage(`error: The plugin ${plugin} could not be loaded`);
});
it("Should handle plugins without a load method", async () => {
+ using project = tempdirProject();
project.addJsonFile("package.json", {
type: "commonjs",
main: "index.js",
@@ -87,7 +85,7 @@ describe("loadPlugins", () => {
const plugin = join(resolve(project.cwd), "index.js");
await loadPlugins(fakeApp, [plugin]);
logger.expectMessage(
- `error: Invalid structure in plugin ${plugin}, no load function found.`,
+ `error: Invalid structure in plugin ${plugin}, no load function found`,
);
});
});
diff --git a/src/test/utils/sort.test.ts b/src/test/utils/sort.test.ts
index 2c1fd49b8..c297b35e8 100644
--- a/src/test/utils/sort.test.ts
+++ b/src/test/utils/sort.test.ts
@@ -1,6 +1,7 @@
import { deepStrictEqual as equal } from "assert";
import {
DeclarationReflection,
+ DocumentReflection,
LiteralType,
ProjectReflection,
ReflectionFlag,
@@ -9,14 +10,16 @@ import {
} from "../../lib/models";
import { resetReflectionID } from "../../lib/models/reflections/abstract";
import { Options } from "../../lib/utils";
-import { getSortFunction, SortStrategy } from "../../lib/utils/sort";
+import { getSortFunction, type SortStrategy } from "../../lib/utils/sort";
+import { Internationalization } from "../../lib/internationalization/internationalization";
+import { FileRegistry } from "../../lib/models/FileRegistry";
describe("Sort", () => {
function sortReflections(
- arr: DeclarationReflection[],
+ arr: Array<DeclarationReflection | DocumentReflection>,
strategies: SortStrategy[],
) {
- const opts = new Options();
+ const opts = new Options(new Internationalization(null).proxy);
opts.setValue("sort", strategies);
getSortFunction(opts)(arr);
}
@@ -245,7 +248,7 @@ describe("Sort", () => {
});
it("source-order should do nothing if no symbols are available", () => {
- const proj = new ProjectReflection("");
+ const proj = new ProjectReflection("", new FileRegistry());
const arr = [
new DeclarationReflection("b", ReflectionKind.Function, proj),
new DeclarationReflection("a", ReflectionKind.Function, proj),
@@ -275,7 +278,7 @@ describe("Sort", () => {
});
cId.pos = 0;
- const proj = new ProjectReflection("");
+ const proj = new ProjectReflection("", new FileRegistry());
const a = new DeclarationReflection("a", ReflectionKind.Variable, proj);
proj.registerSymbolId(a, aId);
@@ -306,7 +309,7 @@ describe("Sort", () => {
});
cId.pos = 1;
- const proj = new ProjectReflection("");
+ const proj = new ProjectReflection("", new FileRegistry());
const a = new DeclarationReflection("a", ReflectionKind.Variable, proj);
const b = new DeclarationReflection(
@@ -332,4 +335,46 @@ describe("Sort", () => {
["a", "c", "b", "d"],
);
});
+
+ it("Should handle documents-first ordering", () => {
+ const proj = new ProjectReflection("", new FileRegistry());
+ const a = new DocumentReflection("a", proj, [], {});
+ const b = new DocumentReflection("b", proj, [], {});
+ const c = new DeclarationReflection("c", ReflectionKind.Class, proj);
+
+ const arr = [a, b, c];
+ sortReflections(arr, ["documents-first", "alphabetical"]);
+ equal(
+ arr.map((r) => r.name),
+ ["a", "b", "c"],
+ );
+
+ const arr2 = [c, b, a];
+ sortReflections(arr2, ["documents-first", "alphabetical"]);
+ equal(
+ arr2.map((r) => r.name),
+ ["a", "b", "c"],
+ );
+ });
+
+ it("Should handle documents-last ordering", () => {
+ const proj = new ProjectReflection("", new FileRegistry());
+ const a = new DocumentReflection("a", proj, [], {});
+ const b = new DocumentReflection("b", proj, [], {});
+ const c = new DeclarationReflection("c", ReflectionKind.Class, proj);
+
+ const arr = [a, b, c];
+ sortReflections(arr, ["documents-last", "alphabetical"]);
+ equal(
+ arr.map((r) => r.name),
+ ["c", "a", "b"],
+ );
+
+ const arr2 = [a, c, b];
+ sortReflections(arr2, ["documents-last", "alphabetical"]);
+ equal(
+ arr2.map((r) => r.name),
+ ["c", "a", "b"],
+ );
+ });
});
diff --git a/src/test/validation.test.ts b/src/test/validation.test.ts
index 549b1340e..5b311eb72 100644
--- a/src/test/validation.test.ts
+++ b/src/test/validation.test.ts
@@ -1,6 +1,5 @@
import { ok } from "assert";
import { join } from "path";
-import { Logger, LogLevel } from "..";
import { validateDocumentation } from "../lib/validation/documentation";
import { validateExports } from "../lib/validation/exports";
import { getConverter2App, getConverter2Program } from "./programs";
@@ -38,7 +37,7 @@ function expectWarning(
validateExports(project, logger, intentionallyNotExported);
logger.expectMessage(
- `warn: ${typeName}, defined in */${file}, is referenced by ${referencingName} but not included in the documentation.`,
+ `warn: ${typeName}, defined in */${file}, is referenced by ${referencingName} but not included in the documentation`,
);
}
@@ -86,11 +85,11 @@ describe("validateExports", () => {
});
it("Should warn if a get signature type is missing", () => {
- expectWarning("Bar", "getSignature.ts", "Foo.foo.foo");
+ expectWarning("Bar", "getSignature.ts", "Foo.foo");
});
it("Should warn if a set signature type is missing", () => {
- expectWarning("Bar", "setSignature.ts", "Foo.foo.foo._value");
+ expectWarning("Bar", "setSignature.ts", "Foo.foo._value");
});
it("Should warn if an implemented type is missing", () => {
@@ -98,11 +97,11 @@ describe("validateExports", () => {
});
it("Should warn if a parameter type is missing", () => {
- expectWarning("Bar", "parameter.ts", "Foo.Foo.x");
+ expectWarning("Bar", "parameter.ts", "Foo.x");
});
it("Should warn if a return type is missing", () => {
- expectWarning("Bar", "return.ts", "foo.foo");
+ expectWarning("Bar", "return.ts", "foo");
});
it("Should allow filtering warnings by file name", () => {
@@ -140,28 +139,12 @@ describe("validateExports", () => {
},
]);
- let sawWarning = false;
- class LoggerCheck extends Logger {
- override log(message: string, level: LogLevel) {
- if (
- level == LogLevel.Warn &&
- message.includes("intentionally not exported")
- ) {
- sawWarning = true;
- ok(
- message.includes("notDefined"),
- "Should have included a warning about notDefined",
- );
- ok(
- !message.includes("Foo"),
- "Should not include a warn about Foo",
- );
- }
- }
- }
-
- validateExports(project, new LoggerCheck(), ["notDefined", "Foo"]);
- ok(sawWarning, "Never saw warning.");
+ const logger = new TestLogger();
+ validateExports(project, logger, ["notDefined", "Foo"]);
+ logger.expectMessage(
+ "warn: The following symbols were marked as intentionally not exported, but were either not referenced in the documentation, or were exported:\n\tnotDefined",
+ );
+ logger.expectNoOtherMessages();
});
});
@@ -172,7 +155,7 @@ describe("validateDocumentation", () => {
validateDocumentation(project, logger, ["Function"]);
logger.expectMessage(
- "warn: bar (CallSignature), defined in */function.ts, does not have any documentation.",
+ "warn: bar (CallSignature), defined in */function.ts, does not have any documentation",
);
logger.expectNoOtherMessages();
});
@@ -183,7 +166,7 @@ describe("validateDocumentation", () => {
validateDocumentation(project, logger, ["Accessor"]);
logger.expectMessage(
- "warn: Foo.foo (GetSignature), defined in */getSignature.ts, does not have any documentation.",
+ "warn: Foo.foo (GetSignature), defined in */getSignature.ts, does not have any documentation",
);
logger.expectNoOtherMessages();
});
@@ -194,7 +177,7 @@ describe("validateDocumentation", () => {
validateDocumentation(project, logger, ["Constructor"]);
logger.expectMessage(
- "warn: Foo.constructor (ConstructorSignature), defined in */class.ts, does not have any documentation.",
+ "warn: Foo.constructor (ConstructorSignature), defined in */class.ts, does not have any documentation",
);
logger.expectNoOtherMessages();
});
@@ -205,7 +188,7 @@ describe("validateDocumentation", () => {
validateDocumentation(project, logger, ["Method"]);
logger.expectMessage(
- "warn: Foo.method (CallSignature), defined in */interface.ts, does not have any documentation.",
+ "warn: Foo.method (CallSignature), defined in */interface.ts, does not have any documentation",
);
logger.expectNoOtherMessages();
});
diff --git a/static/style.css b/static/style.css
index 778b94927..9d619a641 100644
--- a/static/style.css
+++ b/static/style.css
@@ -10,6 +10,7 @@
--light-color-text: #222;
--light-color-text-aside: #6e6e6e;
--light-color-link: #1f70c2;
+ --light-color-focus-outline: #3584e4;
--light-color-ts-keyword: #056bd6;
--light-color-ts-project: #b111c9;
@@ -35,6 +36,7 @@
--light-color-ts-set-signature: var(--light-color-ts-accessor);
--light-color-ts-type-alias: #d51270;
/* reference not included as links will be colored with the kind that it points to */
+ --light-color-document: #000000;
--light-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23000' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
--light-color-scheme: light;
@@ -50,6 +52,7 @@
--dark-color-text: #f5f5f5;
--dark-color-text-aside: #dddddd;
--dark-color-link: #00aff4;
+ --dark-color-focus-outline: #4c97f2;
--dark-color-ts-keyword: #3399ff;
--dark-color-ts-project: #e358ff;
@@ -75,6 +78,7 @@
--dark-color-ts-set-signature: var(--dark-color-ts-accessor);
--dark-color-ts-type-alias: #ff6492;
/* reference not included as links will be colored with the kind that it points to */
+ --dark-color-document: #ffffff;
--dark-external-icon: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 100 100' width='10' height='10'><path fill-opacity='0' stroke='%23fff' stroke-width='10' d='m43,35H5v60h60V57M45,5v10l10,10-30,30 20,20 30-30 10,10h10V5z'/></svg>");
--dark-color-scheme: dark;
@@ -92,6 +96,7 @@
--color-text: var(--light-color-text);
--color-text-aside: var(--light-color-text-aside);
--color-link: var(--light-color-link);
+ --color-focus-outline: var(--light-color-focus-outline);
--color-ts-keyword: var(--light-color-ts-keyword);
--color-ts-module: var(--light-color-ts-module);
@@ -116,6 +121,7 @@
--color-ts-get-signature: var(--light-color-ts-get-signature);
--color-ts-set-signature: var(--light-color-ts-set-signature);
--color-ts-type-alias: var(--light-color-ts-type-alias);
+ --color-document: var(--light-color-document);
--external-icon: var(--light-external-icon);
--color-scheme: var(--light-color-scheme);
@@ -134,6 +140,7 @@
--color-text: var(--dark-color-text);
--color-text-aside: var(--dark-color-text-aside);
--color-link: var(--dark-color-link);
+ --color-focus-outline: var(--dark-color-focus-outline);
--color-ts-keyword: var(--dark-color-ts-keyword);
--color-ts-module: var(--dark-color-ts-module);
@@ -158,6 +165,7 @@
--color-ts-get-signature: var(--dark-color-ts-get-signature);
--color-ts-set-signature: var(--dark-color-ts-set-signature);
--color-ts-type-alias: var(--dark-color-ts-type-alias);
+ --color-document: var(--dark-color-document);
--external-icon: var(--dark-external-icon);
--color-scheme: var(--dark-color-scheme);
@@ -183,6 +191,7 @@ body {
--color-text: var(--light-color-text);
--color-text-aside: var(--light-color-text-aside);
--color-link: var(--light-color-link);
+ --color-focus-outline: var(--light-color-focus-outline);
--color-ts-keyword: var(--light-color-ts-keyword);
--color-ts-module: var(--light-color-ts-module);
@@ -207,6 +216,7 @@ body {
--color-ts-get-signature: var(--light-color-ts-get-signature);
--color-ts-set-signature: var(--light-color-ts-set-signature);
--color-ts-type-alias: var(--light-color-ts-type-alias);
+ --color-document: var(--light-color-document);
--external-icon: var(--light-external-icon);
--color-scheme: var(--light-color-scheme);
@@ -223,6 +233,7 @@ body {
--color-text: var(--dark-color-text);
--color-text-aside: var(--dark-color-text-aside);
--color-link: var(--dark-color-link);
+ --color-focus-outline: var(--dark-color-focus-outline);
--color-ts-keyword: var(--dark-color-ts-keyword);
--color-ts-module: var(--dark-color-ts-module);
@@ -247,11 +258,17 @@ body {
--color-ts-get-signature: var(--dark-color-ts-get-signature);
--color-ts-set-signature: var(--dark-color-ts-set-signature);
--color-ts-type-alias: var(--dark-color-ts-type-alias);
+ --color-document: var(--dark-color-document);
--external-icon: var(--dark-external-icon);
--color-scheme: var(--dark-color-scheme);
}
+*:focus-visible,
+.tsd-accordion-summary:focus-visible svg {
+ outline: 2px solid var(--color-focus-outline);
+}
+
.always-visible,
.always-visible .tsd-signatures {
display: inherit !important;
@@ -266,16 +283,6 @@ h6 {
line-height: 1.2;
}
-h1 > a:not(.link),
-h2 > a:not(.link),
-h3 > a:not(.link),
-h4 > a:not(.link),
-h5 > a:not(.link),
-h6 > a:not(.link) {
- text-decoration: none;
- color: var(--color-text);
-}
-
h1 {
font-size: 1.875rem;
margin: 0.67rem 0;
@@ -306,10 +313,6 @@ h6 {
margin: 2.33rem 0;
}
-.uppercase {
- text-transform: uppercase;
-}
-
dl,
menu,
ol,
@@ -333,7 +336,7 @@ footer {
padding-bottom: 1rem;
max-height: 3.5rem;
}
-.tsd-generator {
+footer > p {
margin: 0 1em;
}
@@ -421,6 +424,9 @@ a.external[target="_blank"] {
background-repeat: no-repeat;
padding-right: 13px;
}
+a.tsd-anchor-link {
+ color: var(--color-text);
+}
code,
pre {
@@ -580,13 +586,13 @@ dl.tsd-comment-tag-group p {
}
.tsd-filter-input {
display: flex;
- width: fit-content;
width: -moz-fit-content;
+ width: fit-content;
align-items: center;
- user-select: none;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
+ user-select: none;
cursor: pointer;
}
.tsd-filter-input input[type="checkbox"] {
@@ -609,11 +615,8 @@ dl.tsd-comment-tag-group p {
Don't remove unless you know what you're doing. */
opacity: 0.99;
}
-.tsd-filter-input input[type="checkbox"]:focus + svg {
- transform: scale(0.95);
-}
-.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg {
- transform: scale(1);
+.tsd-filter-input input[type="checkbox"]:focus-visible + svg {
+ outline: 2px solid var(--color-focus-outline);
}
.tsd-checkbox-background {
fill: var(--color-accent);
@@ -630,13 +633,18 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
stroke: var(--color-accent);
}
-.tsd-theme-toggle {
- padding-top: 0.75rem;
+.settings-label {
+ font-weight: bold;
+ text-transform: uppercase;
+ display: inline-block;
}
-.tsd-theme-toggle > h4 {
- display: inline;
- vertical-align: middle;
- margin-right: 0.75rem;
+
+.tsd-filter-visibility .settings-label {
+ margin: 0.75rem 0 0.5rem 0;
+}
+
+.tsd-theme-toggle .settings-label {
+ margin: 0.75rem 0.75rem 0 0;
}
.tsd-hierarchy {
@@ -769,6 +777,9 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
padding: 0;
max-width: 100%;
}
+.tsd-navigation .tsd-nav-link {
+ display: none;
+}
.tsd-nested-navigation {
margin-left: 3rem;
}
@@ -782,6 +793,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark {
margin-left: -1.5rem;
}
+.tsd-page-navigation-section {
+ margin-left: 10px;
+}
+.tsd-page-navigation-section > summary {
+ padding: 0.25rem;
+}
+.tsd-page-navigation-section > div {
+ margin-left: 20px;
+}
.tsd-page-navigation ul {
padding-left: 1.75rem;
}
@@ -812,10 +832,10 @@ a.tsd-index-link {
}
.tsd-accordion-summary,
.tsd-accordion-summary a {
- user-select: none;
-moz-user-select: none;
-webkit-user-select: none;
-ms-user-select: none;
+ user-select: none;
cursor: pointer;
}
@@ -828,8 +848,9 @@ a.tsd-index-link {
padding-top: 0;
padding-bottom: 0;
}
-.tsd-index-accordion .tsd-accordion-summary > svg {
+.tsd-accordion .tsd-accordion-summary > svg {
margin-left: 0.25rem;
+ vertical-align: text-top;
}
.tsd-index-content > :not(:first-child) {
margin-top: 0.75rem;
@@ -877,7 +898,7 @@ a.tsd-index-link {
}
.tsd-panel-group {
- margin: 4rem 0;
+ margin: 2rem 0;
}
.tsd-panel-group.tsd-index-group {
margin: 2rem 0;
@@ -885,6 +906,9 @@ a.tsd-index-link {
.tsd-panel-group.tsd-index-group details {
margin: 2rem 0;
}
+.tsd-panel-group > .tsd-accordion-summary {
+ margin-bottom: 1rem;
+}
#tsd-search {
transition: background-color 0.2s;
@@ -1034,6 +1058,12 @@ a.tsd-index-link {
border-width: 1px 0;
transition: background-color 0.1s;
}
+.tsd-signatures .tsd-index-signature:not(:last-child) {
+ margin-bottom: 1em;
+}
+.tsd-signatures .tsd-index-signature .tsd-signature {
+ border-width: 1px;
+}
.tsd-description .tsd-signatures .tsd-signature {
border-width: 1px;
}
@@ -1347,6 +1377,12 @@ img {
.has-menu .tsd-navigation {
max-height: 100%;
}
+ #tsd-toolbar-links {
+ display: none;
+ }
+ .tsd-navigation .tsd-nav-link {
+ display: flex;
+ }
}
/* one sidebar */
diff --git a/tsconfig.json b/tsconfig.json
index 5de076553..70152b588 100644
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -6,11 +6,11 @@
// Add our `ts` internal types
"typeRoots": ["node_modules/@types", "src/lib/types"],
- "types": ["node", "lunr", "marked", "mocha"],
+ "types": ["node", "lunr", "mocha"],
// Speed up dev compilation time
"incremental": true,
"tsBuildInfoFile": "dist/.tsbuildinfo",
- // "skipLibCheck": true,
+ "skipLibCheck": false,
"strict": true,
"alwaysStrict": true,
@@ -34,12 +34,6 @@
"jsx": "react",
"jsxFactory": "JSX.createElement",
"jsxFragmentFactory": "JSX.Fragment",
-
- // TS 5 introduced verbatimModuleSyntax and deprecated importsNotUsedAsValues
- // But that flag is intentionally very unfriendly to projects emitting CommonJS
- // so for now, we're going to ignore that deprecation.
- "ignoreDeprecations": "5.0",
- "importsNotUsedAsValues": "error",
"isolatedModules": true
},
"include": ["src"],
diff --git a/tsdoc.json b/tsdoc.json
index 5e5590ec3..9bed22577 100644
--- a/tsdoc.json
+++ b/tsdoc.json
@@ -1,11 +1,20 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+ // If updating this, also update tsdoc-defaults.ts
"noStandardTags": false,
"tagDefinitions": [
+ {
+ "tagName": "@author",
+ "syntaxKind": "block"
+ },
{
"tagName": "@module",
"syntaxKind": "block"
},
+ {
+ "tagName": "@type",
+ "syntaxKind": "block"
+ },
{
"tagName": "@typedef",
"syntaxKind": "block"
@@ -58,6 +67,19 @@
"tagName": "@class",
"syntaxKind": "modifier"
},
+ {
+ "tagName": "@document",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@default",
+ "syntaxKind": "block"
+ },
+ {
+ // TSDoc defines @returns, we also recognize @return for JSDoc compat
+ "tagName": "@return",
+ "syntaxKind": "block"
+ },
{
"tagName": "@enum",
"syntaxKind": "modifier"
@@ -78,7 +100,7 @@
},
{
"tagName": "@linkplain",
- "syntaxKind": "block",
+ "syntaxKind": "inline",
"allowMultiple": true
},
{
@@ -93,6 +115,18 @@
"tagName": "@satisfies",
"syntaxKind": "block"
},
+ {
+ "tagName": "@since",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@license",
+ "syntaxKind": "block"
+ },
+ {
+ "tagName": "@import",
+ "syntaxKind": "block"
+ },
{
"tagName": "@overload",
"syntaxKind": "modifier"
@@ -120,6 +154,14 @@
{
"tagName": "@hideGroups",
"syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@hideconstructor",
+ "syntaxKind": "modifier"
+ },
+ {
+ "tagName": "@jsx",
+ "syntaxKind": "block"
}
]
}
diff --git a/example/src/documents/syntax-highlighting.md b/example/src/documents/syntax-highlighting.md
new file mode 100644
index 000000000..6bb96094a
--- /dev/null
+++ b/example/src/documents/syntax-highlighting.md
@@ -0,0 +1,64 @@
+---
+title: Syntax Highlighting
+category: Documents
+---
+
+TypeDoc supports code blocks in Markdown and uses
+[Shiki](https://shiki.matsu.io/) to provide syntax highlighting.
+
+TypeDoc supports all languages supported by Shiki, but does not load all of
+them by default. The `highlightLanguages` option can be used to customize
+which languages are loaded for highlighting.
+
+If no language is specified, the code block is assumed to be TypeScript:
+
+```
+// A fabulous variable
+const x: number | string = 12
+```
+
+You can specify the language at the start of your code block like this:
+
+````text
+```rust
+````
+
+Use the `tsx` language to get JSX support:
+
+```tsx
+function BasicComponent(): ReactElement {
+ return 
- *
- * This requires the [media option](https://typedoc.org/guides/options/#media)
- * to be set.
- */
-export function markdownShowcase(): void {
- // does nothing
-}
-
-/**
- * TypeDoc supports code blocks in Markdown and uses
- * [Shiki](https://shiki.matsu.io/) to provide syntax highlighting.
- *
- * If no language is specified, the code block is assumed to be TypeScript:
- *
- * ```
- * // A fabulous variable
- * const x: number | string = 12
- * ```
- *
- * You can specify the language at the start of your code block like this:
- *
- * ````text
- * ```rust
- * ````
- *
- * Use the `tsx` language to get JSX support:
- *
- * ```tsx
- * function BasicComponent(): ReactElement {
- * return