Incorrect syntax highlighting JSDoc comments `@default { }`

Open
#1,023 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reproducing the issue with the provided @default { } and spaced object examples in VS Code. Inspect the TypeScript TextMate grammar files described by the repository and adjust the relevant JSDoc matching so inline object values receive the same correct highlighting as the multiline form; verify the reproduction examples afterward.

Written by the indexing model from the issue text.

Description

Type: Bug

image

/** @default { open: "---", close: "---" } */

Highlighting works (kind of but not really) if I remove the whitespace like this:

image

/** @default {open:"---",close:"---"} */

Note that this ^^^ syntax highlighting is incorrect! Correct syntax highlighting looks like this:

image

Which is achieved by writing:

/**
 * @default
 * { open: "---", close: "---" }
 */

For simple reproduction use:

/** @default { } */

image

image

VS Code version: Code 1.87.2 (863d2581ecda6849923a2118d93a088b0745d9d6, 2024-03-08T15:20:17.278Z)
OS version: Windows_NT x64 10.0.22631
Modes: Unsupported

Dominant language
TypeScript
Stars
471
Forks
149
No merged PRs in 30d

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.

More from microsoft/TypeScript-TmLanguage

All issues in microsoft/TypeScript-TmLanguage

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.