Microsoft/TypeScript

getLeadingCommentRanges misses comment in call expression

Open

#54.906 geöffnet am 7. Juli 2023

Auf GitHub ansehen
 (0 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import
Domain: ParserHelp WantedPossible Improvement

Repository-Metriken

Stars
 (48.455 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (9 gemergte PRs in 30 T)

Beschreibung

Bug Report

getLeadingCommentRanges misses comments that are in front of arguments passed to a call expression.

Comments being missed is a known issue when comments are within a node between tokens not stored in the tree: https://github.com/Microsoft/TypeScript/wiki/FAQ#why-some-comments-are-not-preserved-in-emitted-javascript-even-when---removecomments-is-not-specified

However that is not the case here and in fact tsc will preserve that particular comment.

Note: here I refer to getLeadingCommentRanges but in reality the bug is present inside of iterateCommentRanges (what getLeadingCommentRanges uses under the hood)

🔎 Search Terms

  • leading, trailing comment undefined
  • getLeadingCommentRanges, getTrailingCommentRanges
  • Call expression, function call, method call

🕗 Version & Regression Information

  • This is the behavior in every version I tried (4.3.5 (the oldest version on ts-ast-viewer.com), 5.1.6, @next (5.2.0-dev.20230706))

⏯ Playground Link

https://ts-ast-viewer.com/#code/MYewdgziA2CmB00QHMAUB6AVAAgBa2iW03WwCIB3EAJ2gBMyBKIA

💻 Code

console.log(/* hello */ "world")

Calling getLeadingCommentRanges on the string literal returns undefined.

🙁 Actual behavior

ts.getLeadingCommentRanges('console.log(/* hello */ "world")', 12)

returns undefined

🙂 Expected behavior

ts.getLeadingCommentRanges('console.log(/* hello */ "world")', 12)

returns [ { kind: 3, start: 12, end: 23, hasTrailingNewLine: false } ]

Contributor Guide

Research-Richtung
Der Fehler liegt in `getLeadingCommentRanges`, das intern `iterateCommentRanges` aufruft. Das Problem tritt auf, wenn ein Kommentar vor einem Argument in einem Aufrufausdruck erscheint (z. B. `console.log(/* hello */ "world")`). Die Logik des Scanners zum Finden von vorangestellten Kommentaren vor Tokens behandelt diesen Fall nicht, obwohl tsc den Kommentar beibehält. Die Korrektur sollte im Scanner Code erfolgen (wahrscheinlich `src/services/scanner.ts` oder `src/compiler/scanner.ts`). Das erwartete Verhalten ist, den Kommentarbereich zurückzugeben, wenn `getLeadingCommentRanges` auf das String Literal an Position 12 aufgerufen wird. Das Problem bietet eine klare Reproduktion und erwartete Ausgabe, daher besteht die Korrektur darin, die Scan Logik anzupassen, um solche Kommentare einzubeziehen.
Tech Stack
typescript
Domain
Keine
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptcompiler scanner
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65