microsoft / microsoft/TypeScript-TmLanguage
TypeScript union members in a function return value highlighted inconsistently
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 471
- Forks
- 149
- PR merge metrics
- No merged PRs in 30d
Description
JavaScript and TypeScript Nightly version: 5.9.20250330
When returning a union from a function in TypeScript, the first member of the union is rendered inconsistently.
export function myFunction():
| null
| null
| null {
return null;
}
The first | is rendered as mtk5 while the other ones are rendered as mtk1. This is an issue for color themes where both are rendered differently (e.g. the default Monokai theme). Similarily, the first null value is rendered as mtk17 while the other ones are rendered as mtk16.
This might be the same bug as #997. #1043 and #1041 also seem related.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the TypeScript TextMate grammar used to tokenize the provided union-return example, then compare how the first and subsequent | and null tokens are classified. Reproduce the inconsistent scopes with the sample and confirm that the relevant grammar change gives all equivalent union members consistent highlighting without regressing the related cases in #997, #1043, and #1041.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100