microsoft / microsoft/TypeScript-TmLanguage

Splitting a default tuple type across multiple lines breaks highlighting

Open
#1,040 0 comments 2 reactions 0 assignees View on GitHub

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.6.0-dev.20240819

Splitting a tuple across multiple lines, which is used as the default type for a parameter on a method in an interface or class in a declaration file (.d.ts), breaks syntax highlighting below that line.

Code

// Please include a code snippet that demonstrates the issue
export interface Broken {
    a<A extends [number] = [
        number
    ]>(value: number): boolean;

    b(value: number): string;
}

export interface Other {
    constructor(name: string);
}

Broken:
broken_interface

Working:
working_interface

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the issue with the provided TypeScript declaration snippet and inspect the TypeScript TextMate grammar rules involved in multiline tuple defaults. Done means syntax highlighting remains correct below the split tuple, including the following interface and constructor.

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
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.