mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 00:23:30 +01:00
* refactor: use tokenRange for typeParams in heritage * fix: correct type param replacement
81 lines
2.5 KiB
TypeScript
81 lines
2.5 KiB
TypeScript
import type { ApiModel, Excerpt } from '@discordjs/api-extractor-model';
|
|
import { ExcerptTokenKind } from '@discordjs/api-extractor-model';
|
|
import { BuiltinDocumentationLinks } from '~/util/builtinDocumentationLinks';
|
|
import { DISCORD_API_TYPES_DOCS_URL } from '~/util/constants';
|
|
import { DocumentationLink } from './DocumentationLink';
|
|
import { ItemLink } from './ItemLink';
|
|
import { resolveItemURI } from './documentation/util';
|
|
|
|
export interface ExcerptTextProps {
|
|
/**
|
|
* The tokens to render.
|
|
*/
|
|
readonly excerpt: Excerpt;
|
|
/**
|
|
* The model to resolve item references from.
|
|
*/
|
|
readonly model: ApiModel;
|
|
}
|
|
|
|
/**
|
|
* A component that renders excerpt tokens from an api item.
|
|
*/
|
|
export function ExcerptText({ model, excerpt }: ExcerptTextProps) {
|
|
return (
|
|
<span>
|
|
{excerpt.spannedTokens.map((token, idx) => {
|
|
if (token.kind === ExcerptTokenKind.Reference) {
|
|
if (token.text in BuiltinDocumentationLinks) {
|
|
const href = BuiltinDocumentationLinks[token.text as keyof typeof BuiltinDocumentationLinks];
|
|
return (
|
|
<DocumentationLink key={`${token.text}-${idx}`} href={href}>
|
|
{token.text}
|
|
</DocumentationLink>
|
|
);
|
|
}
|
|
|
|
const source = token.canonicalReference?.source;
|
|
const symbol = token.canonicalReference?.symbol;
|
|
if (source && 'packageName' in source && source.packageName === 'discord-api-types' && symbol) {
|
|
const { meaning, componentPath: path } = symbol;
|
|
let href = DISCORD_API_TYPES_DOCS_URL;
|
|
|
|
// dapi-types doesn't have routes for class members
|
|
// so we can assume this member is for an enum
|
|
if (meaning === 'member' && path && 'parent' in path) href += `/enum/${path.parent}#${path.component}`;
|
|
else if (meaning === 'type' || meaning === 'var') href += `#${token.text}`;
|
|
else href += `/${meaning}/${token.text}`;
|
|
|
|
return (
|
|
<DocumentationLink key={`${token.text}-${idx}`} href={href}>
|
|
{token.text}
|
|
</DocumentationLink>
|
|
);
|
|
}
|
|
|
|
const item = token.canonicalReference
|
|
? model.resolveDeclarationReference(token.canonicalReference!, model).resolvedApiItem
|
|
: null;
|
|
|
|
if (!item) {
|
|
return token.text;
|
|
}
|
|
|
|
return (
|
|
<ItemLink
|
|
className="text-blurple"
|
|
itemURI={resolveItemURI(item)}
|
|
key={`${item.displayName}-${item.containerKey}-${idx}`}
|
|
packageName={item.getAssociatedPackage()?.displayName.replace('@discordjs/', '')}
|
|
>
|
|
{token.text}
|
|
</ItemLink>
|
|
);
|
|
}
|
|
|
|
return token.text.replace(/import\("discord-api-types(?:\/v\d+)?"\)\./, '');
|
|
})}
|
|
</span>
|
|
);
|
|
}
|