microsoft / microsoft/TypeScript

Class member incorrectly stripped from .d.ts output if @internal is mentioned in unrelated comment

Offen
#57,352 6 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Domain: Declaration Emit Help Wanted Possible Improvement
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

🔎 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

https://www.typescriptlang.org/play?stripInternal=true&ts=5.3.3#code/KYDwDg9gTgLgBAYwDYEMDOa4DEITgbwCg44B6AKnOJPLgGUALCAVyQBM4AjYONGKAJZgwwNtTi0AAgIB2MYFBkok48qWpomrNgCFgdfkJEcAvHACMAbkLVSpOABUA8gBEnALjgBbFAE9u3igA1jwwDAKY0nIKSkgA-LaUqvRa7BIyEDC0AXyCwqKq6iSaLOwAcpl6BnnGcGYATNYAvkA

💻 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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Reproduziere das Verhalten mit dem verknüpften TypeScript Playground, wobei stripInternal aktiviert ist, und der bereitgestellten Klasse. Verfolge die Verarbeitung der Deklarationsausgabe für aufeinanderfolgende Kommentare und füge einen Regressionstest hinzu, der eine unabhängige @internal-Erwähnung vor einem separaten @internal-Kommentar abdeckt. Erledigt bedeutet, dass nur shouldBeStripped weggelassen wird, während shouldNotBeStripped in der .d.ts-Ausgabe verbleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.