microsoft / microsoft/TypeScript-TmLanguage

The default template parameter JSDoc annotation is not highlighted

Open
#1,046 0 comments 0 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

Does this issue occur when all extensions are disabled?: Yes/No

  • VS Code Version: 1.97.2
  • OS Version: macOS 15.2

Steps to Reproduce:

  1. Describe a simple javascript class:
export class SubProcess {
}
  1. Add template with default value JSDoc annotation to this class:
/**
 * @template [TSubProcessOptions={}]
 */
export class SubProcess {
}

Actual result:
The above JSDoc value is not highlighted properly

Expected result:
The above JSDoc value must be highlighted properly same way as the below fragment works (SubProcessOptions is an interface defined elsewhere):

/**
 * @template {SubProcessOptions} TSubProcessOptions
 */
export class SubProcess {
}

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 JSDoc example in VS Code and inspect the TypeScript TextMate grammar files in this repository. Compare highlighting for the default-value form with the working constrained template form; done means the default template parameter is highlighted correctly without regressing the existing form.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
developer-experience, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.