Elgato_dark/angular
1
0
Fork 0
mirror of https://github.com/angular/angular synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor(compiler-cli): exclude private computed properties from class member extractions (#57596)

Browse source 
This will exclude properties like `[ɵWRITABLE_SIGNAL]` from the `WritableSignal` interface.

PR Close #57596
This commit is contained in:
Matthieu Riegler 2024-08-21 01:07:13 +02:00 committed by Paul Gschwendtner
parent c15ec36bd1
commit ab91f0371b
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
packages/compiler-cli/src/ngtsc/docs/src/class_extractor.ts
View file

@ -110,7 +110,10 @@ class ClassExtractor {
protected extractClassMember(memberDeclaration: MemberElement): MemberEntry | undefined {
if (this.isMethod(memberDeclaration)) {
return this.extractMethod(memberDeclaration);
} else if (this.isProperty(memberDeclaration)) {
} else if (
this.isProperty(memberDeclaration) &&
!this.hasPrivateComputedProperty(memberDeclaration)
) {
return this.extractClassProperty(memberDeclaration);
} else if (ts.isAccessor(memberDeclaration)) {
return this.extractGetterSetter(memberDeclaration);
@ -375,6 +378,17 @@ class ClassExtractor {
const modifiers = this.declaration.modifiers ?? [];
return modifiers.some((mod) => mod.kind === ts.SyntaxKind.AbstractKeyword);
}
/**
* Check wether a member has a private computed property name like [ɵWRITABLE_SIGNAL]
*
* This will prevent exposing private computed properties in the docs.
*/
private hasPrivateComputedProperty(property: PropertyLike) {
return (
ts.isComputedPropertyName(property.name) && property.name.expression.getText().startsWith('ɵ')
);
}
}
/** Extractor to pull info for API reference documentation for an Angular directive. */