mirror of
https://github.com/discordjs/discord.js.git
synced 2026-06-01 16:40:07 +00:00
* fix(ExceptText): don't display import("d..-types/v10"). in return type
* Squashed 'packages/api-extractor-model/' content from commit 39ecb196c
git-subtree-dir: packages/api-extractor-model
git-subtree-split: 39ecb196ca210bdf84ba6c9cadb1bb93571849d7
* Squashed 'packages/api-extractor/' content from commit 341ad6c51
git-subtree-dir: packages/api-extractor
git-subtree-split: 341ad6c51b01656d4f73b74ad4bdb3095f9262c4
* feat(api-extractor): add api-extractor and -model
* fix: package.json docs script
* fix(SourcLink): use <> instead of function syntax
* fix: make packages private
* fix: rest params showing in docs, added labels
* fix: missed two files
* feat: merge docs.json from docgen and docs.api.json
* fix: cpy-cli & pnpm-lock
* fix: increase icon size
* fix: icon size again
* feat: run both docs on mainlib
* chore: website fixes
* fix: more website fixes
* fix: tests and dev database script
* chore: comment out old docs
* fix: increase max fetch cache
* fix: env should always be a string
* fix: try to reapply patches
* fix: remove prepare for docgen
* fix: temporary cosmetic fixes
* fix: horizontal scroll
* feat: generate index for new docs
---------
Co-authored-by: Noel <buechler.noel@outlook.com>
70 lines
2.2 KiB
TypeScript
70 lines
2.2 KiB
TypeScript
import type { ApiModel, Excerpt } from '@discordjs/api-extractor-model';
|
|
import { ExcerptTokenKind } from '@discordjs/api-extractor-model';
|
|
import { DISCORD_API_TYPES_DOCS_URL } from '~/util/constants';
|
|
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) => {
|
|
// TODO: Real fix in api-extractor needed
|
|
const text = token.text.replaceAll('\n', '').replaceAll(/\s{2}$/g, '');
|
|
if (token.kind === ExcerptTokenKind.Reference) {
|
|
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') href += `#${text}`;
|
|
else href += `/${meaning}/${text}`;
|
|
|
|
return (
|
|
<a className="text-blurple" href={href} key={idx} rel="external noreferrer noopener" target="_blank">
|
|
{text}
|
|
</a>
|
|
);
|
|
}
|
|
|
|
const item = model.resolveDeclarationReference(token.canonicalReference!, model).resolvedApiItem;
|
|
|
|
if (!item) {
|
|
return text;
|
|
}
|
|
|
|
return (
|
|
<ItemLink
|
|
className="text-blurple"
|
|
itemURI={resolveItemURI(item)}
|
|
key={`${item.displayName}-${item.containerKey}-${idx}`}
|
|
packageName={item.getAssociatedPackage()?.displayName.replace('@discordjs/', '')}
|
|
>
|
|
{text}
|
|
</ItemLink>
|
|
);
|
|
}
|
|
|
|
return text.replace(/import\("discord-api-types(?:\/v\d+)?"\)\./, '');
|
|
})}
|
|
</span>
|
|
);
|
|
}
|