Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-11 17:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat: generate all tags

Browse Source
This commit is contained in:
iCrawl
2022-08-22 18:30:46 +02:00
parent 4644e45e85
commit 6dfb9bbc48
12 changed files with 271 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
packages/website/src/util/parse.server.ts
View File

@@ -23,7 +23,7 @@ export function findPackage(model: ApiModel, name: string): ApiPackage | undefin
| undefined;
}
export function generatePath(items: readonly ApiItem[]) {
export function generatePath(items: readonly ApiItem[], version: string) {
let path = '/docs/packages';
for (const item of items) {
switch (item.kind) {
@@ -53,7 +53,7 @@ export function generatePath(items: readonly ApiItem[]) {
}
}
return path.replace(/@discordjs\/(.*)\/(.*)?/, '$1/main/$2');
return path.replace(/@discordjs\/(.*)\/(.*)?/, `$1/${version}/$2`);
}
export function resolveDocComment(item: ApiDocumentedItem) {
@@ -164,14 +164,14 @@ function createDapiTypesURL(meaning: Meaning, name: string) {
}
}
export function genReference(item: ApiItem) {
export function genReference(item: ApiItem, version: string) {
return {
name: resolveName(item),
path: generatePath(item.getHierarchy()),
path: generatePath(item.getHierarchy(), version),
};
}
export function genToken(model: ApiModel, token: ExcerptToken) {
export function genToken(model: ApiModel, token: ExcerptToken, version: string) {
if (token.canonicalReference) {
// @ts-expect-error
token.canonicalReference._navigation = '.';
@@ -197,24 +197,26 @@ export function genToken(model: ApiModel, token: ExcerptToken) {
return {
kind: token.kind,
text: token.text,
path: item ? generatePath(item.getHierarchy()) : null,
path: item ? generatePath(item.getHierarchy(), version) : null,
};
}
export function genParameter(model: ApiModel, param: Parameter): ParameterDocumentation {
export function genParameter(model: ApiModel, param: Parameter, version: string): ParameterDocumentation {
return {
name: param.name,
isOptional: param.isOptional,
tokens: param.parameterTypeExcerpt.spannedTokens.map((token) => genToken(model, token)),
paramCommentBlock: param.tsdocParamBlock ? (createCommentNode(param.tsdocParamBlock, model) as DocBlockJSON) : null,
tokens: param.parameterTypeExcerpt.spannedTokens.map((token) => genToken(model, token, version)),
paramCommentBlock: param.tsdocParamBlock
? (createCommentNode(param.tsdocParamBlock, model, version) as DocBlockJSON)
: null,
};
}
export function getMembers(pkg: ApiPackage) {
export function getMembers(pkg: ApiPackage, version = 'main') {
return pkg.members[0]!.members.map((member) => ({
name: member.displayName,
kind: member.kind as string,
path: generatePath(member.getHierarchy()),
path: generatePath(member.getHierarchy(), version),
containerKey: member.containerKey,
overloadIndex: member.kind === 'Function' ? (member as ApiFunction).overloadIndex : null,
}));