arcodange/mediabunny
1
0
Fork 0
mirror of https://github.com/arcodange-org/mediabunny.git synced 2026-09-27 19:03:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix @internal fields on type aliases being printed to API docs

Browse Source
This commit is contained in:
Vanilagy
2026-07-24 14:13:39 +02:00
parent 7ff06c3f65
commit 2f5e2f0a3e
1 changed files with 17 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/generate-api-docs.ts
+17 -1
View File
@@ -1469,13 +1469,19 @@ const generateDocs = (entryFiles: string[], apiConfigFile: string, dry = false)
typeProperties.forEach((prop) => {
// Create a synthetic property signature for each resolved property
const propName = prop.getName();
const propDeclaration = prop.valueDeclaration || prop.declarations?.[0];
// Skip members marked @internal
if (propDeclaration && ts.getJSDocTags(propDeclaration).some(tag => tag.tagName.text === 'internal')) {
return;
}
const propType = typeChecker.getTypeOfSymbolAtLocation(prop, declaration);
const propTypeString = getTypeString(propType);
const isOptional = (prop.flags & ts.SymbolFlags.Optional) !== 0;
// Get JSDoc from the original declaration
let desc = '';
const propDeclaration = prop.valueDeclaration || prop.declarations?.[0];
if (propDeclaration) {
const rawDesc = getFullJSDocDescription(propDeclaration);
if (rawDesc) {
@@ -1689,6 +1695,16 @@ const generateDocs = (entryFiles: string[], apiConfigFile: string, dry = false)
} else {
// For complex types, use the original text
typeText = declaration.type.getText();
// Drop members marked @internal from the printed definition
if (ts.isTypeLiteralNode(declaration.type)) {
for (const member of declaration.type.members) {
if (ts.getJSDocTags(member).some(tag => tag.tagName.text === 'internal')) {
typeText = typeText.replace(member.getText(), '');
}
}
}
// Format object types with proper line breaks
if (typeText.includes('{')) {
typeText = formatObjectType(typeText);