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

fix(docs): use ts types for inherited properties instead of jsdoc (#10125)

Browse Source 
* fix(docs): use ts types for inherited properties instead of jsdoc

* fix(docs): remove spaces in type parameters
This commit is contained in:
Qjuh
2024-02-10 21:36:25 +01:00
committed by GitHub
parent 597340f288
commit 36db77f107
2 changed files with 63 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
packages/api-extractor/src/generators/ApiModelGenerator.ts
View File

@@ -1231,7 +1231,11 @@ export class ApiModelGenerator {
let apiProperty: ApiProperty | undefined = parentApiItem.tryGetMemberByKey(containerKey) as ApiProperty;
if (apiProperty === undefined) {
if (
apiProperty === undefined &&
(astDeclaration ||
!this._isInherited(parent as DocgenClassJson | DocgenInterfaceJson, jsDoc!, parentApiItem.kind))
) {
if (astDeclaration) {
const declaration: ts.Declaration = astDeclaration.declaration;
const nodesToCapture: IExcerptBuilderNodeToCapture[] = [];
@@ -1322,7 +1326,10 @@ export class ApiModelGenerator {
const parent = context.parentDocgenJson as DocgenInterfaceJson | DocgenPropertyJson | DocgenTypedefJson | undefined;
const jsDoc = parent?.props?.find((prop) => prop.name === name);
if (apiPropertySignature === undefined) {
if (
apiPropertySignature === undefined &&
(astDeclaration || !this._isInherited(parent as DocgenInterfaceJson, jsDoc!, parentApiItem.kind))
) {
if (astDeclaration) {
const propertySignature: ts.PropertySignature = astDeclaration.declaration as ts.PropertySignature;
@@ -1645,6 +1652,54 @@ export class ApiModelGenerator {
return parameters;
}
private _isInherited(
container: DocgenClassJson | DocgenInterfaceJson,
jsDoc: DocgenParamJson | DocgenPropertyJson,
containerKind: ApiItemKind,
): boolean {
switch (containerKind) {
case ApiItemKind.Class: {
const token = (container as DocgenClassJson).extends;
const parentName = Array.isArray(token) ? token[0]?.[0]?.[0] : token?.types?.[0]?.[0]?.[0];
const parentJson = this._jsDocJson?.classes.find((clas) => clas.name === parentName);
if (parentJson) {
if (parentJson.props?.find((prop) => prop.name === jsDoc.name)) {
return true;
} else {
return this._isInherited(parentJson, jsDoc, containerKind);
}
}
break;
}
case ApiItemKind.Interface: {
const token = (container as DocgenInterfaceJson).extends;
const parentNames = Array.isArray(token) ? token.map((parent) => parent[0]?.[0]) : undefined;
const parentJsons = parentNames?.map((name) =>
this._jsDocJson?.interfaces.find((inter) => inter.name === name),
);
if (parentJsons?.length) {
for (const parentJson of parentJsons) {
if (
parentJson?.props?.find((prop) => prop.name === jsDoc.name) ||
this._isInherited(parentJson as DocgenInterfaceJson, jsDoc, containerKind)
) {
return true;
}
}
}
break;
}
default:
console.log(`Unexpected parent of type ${containerKind} (${container.name}) of ${jsDoc?.name} `);
}
return false;
}
private _isReadonly(astDeclaration: AstDeclaration): boolean {
switch (astDeclaration.declaration.kind) {
case ts.SyntaxKind.GetAccessor:

8
packages/api-extractor/src/generators/ExcerptBuilder.ts
View File

@@ -324,8 +324,12 @@ export class ExcerptBuilder {
prevToken.text += currentToken.text;
// Remove BarTokens from excerpts if they immediately follow a LessThanToken, e.g. `Promise< | Something>`
// would become `Promise<Something>`
if (/<\s*\|/.test(prevToken.text)) {
prevToken.text = prevToken.text.replace(/<\s*\|\s*/, '<');
if (/<(?:\s*\||\s+)/.test(prevToken.text)) {
prevToken.text = prevToken.text.replace(/<\s*\|?\s*/, '<');
}
if (/\s+>/.test(prevToken.text)) {
prevToken.text = prevToken.text.replace(/\s*>/, '>');
}
mergeCount = 1;