Skip to content

build: filter out docs private members from interfaces #22831

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions tools/dgeni/processors/docs-private-filter.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import {DocCollection, Processor} from 'dgeni';
import {BaseApiDoc} from 'dgeni-packages/typescript/api-doc-types/ApiDoc';
import {ClassExportDoc} from 'dgeni-packages/typescript/api-doc-types/ClassExportDoc';
import {InterfaceExportDoc} from 'dgeni-packages/typescript/api-doc-types/InterfaceExportDoc';
import {getDocsPublicTag, isPublicDoc} from '../common/private-docs';

/**
Expand All @@ -12,26 +13,30 @@ export class DocsPrivateFilter implements Processor {
$runAfter = ['mergeInheritedProperties'];

$process(docs: DocCollection) {
return docs.filter(doc => {
const isPublic = isPublicDoc(doc);
const publicDocs = docs.filter(isPublicDoc);

publicDocs.forEach(doc => {
// Update the API document name in case the "@docs-public" tag is used
// with an alias name.
if (isPublic && doc instanceof BaseApiDoc) {
if (doc instanceof BaseApiDoc) {
const docsPublicTag = getDocsPublicTag(doc);
if (docsPublicTag !== undefined && docsPublicTag.description) {
doc.name = docsPublicTag.description;
}
}

if (doc instanceof InterfaceExportDoc) {
doc.members = doc.members.filter(isPublicDoc);
}

// Filter out private class members which could be annotated
// with the "@docs-private" tag.
if (isPublic && doc instanceof ClassExportDoc) {
if (doc instanceof ClassExportDoc) {
doc.members = doc.members.filter(isPublicDoc);
doc.statics = doc.statics.filter(isPublicDoc);
}

return isPublic;
});

return publicDocs;
}
}