Microsoft/TypeScript
Voir sur GitHubClass member incorrectly stripped from .d.ts output if @internal is mentioned in unrelated comment
Open
#57 352 ouverte le 9 févr. 2024
Domain: Declaration EmitHelp WantedPossible Improvement
Métriques du dépôt
- Stars
- (48 455 stars)
- Métriques de merge PR
- (Merge moyen 6j 17h) (9 PRs mergées en 30 j)
Description
🔎 Search Terms
internal, .d.ts, stripInternal
🕗 Version & Regression Information
This issue appears to be present in all version of TypeScript (tested down to 3.3.3).
⏯ Playground Link
💻 Code
export class Foo {
/**
* Should be stripped
* @internal
*/
shouldBeStripped = 1;
// TODO: maybe make this @internal?
/**
* Should *not* be stripped
*/
shouldNotBeStripped = 2;
}
🙁 Actual behavior
The compiler should preserve the Foo.shouldNotBeStripped property while removing Foo.shouldBeStripped.
🙂 Expected behavior
Both Foo.shouldNotBeStripped and Foo.shouldBeStripped are removed.
Additional information about the issue
If a class member has an unrelated comment mentioning @internal preceding it, TypeScript will drop that member from the .d.ts output, even though that's not the intent since there's another comment after it. Only the first comment should be checked for @internal.