Microsoft/TypeScript

getLeadingCommentRanges misses comment in call expression

Aberta

#54.906 aberto em 7 de jul. de 2023

Ver no GitHubGuia do colaborador
 (0 comentário) (3 reações) (0 responsável)TypeScript (13.395 forks)batch import
Domain: ParserHelp WantedPossible Improvement

Métricas do repositório

Stars
 (108.860 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

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 } ]

Guia do colaborador

Direção de pesquisa
O bug está em `getLeadingCommentRanges`, que internamente chama `iterateCommentRanges`. O problema ocorre quando um comentário aparece antes de um argumento em uma expressão de chamada (por exemplo, `console.log(/* hello */ "world")`). A lógica do scanner para encontrar comentários iniciais antes de tokens não lida com esse caso, mesmo que o tsc preserve o comentário. A correção deve estar no código do scanner (provavelmente em `src/services/scanner.ts` ou `src/compiler/scanner.ts`). O comportamento esperado é retornar o intervalo do comentário ao chamar `getLeadingCommentRanges` no literal de string na posição 12. O problema fornece uma reprodução clara e a saída esperada, portanto, a correção é ajustar a lógica de varredura para incluir tais comentários.
Pilha de tecnologia
typescript
Domain
None
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScriptcompiler scanner
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65