microsoft / microsoft/TypeScript

Inlay hints look awkward for callback parameters with a single parameter

Open
#45,389 4 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: LS: Inlay Hints Experience Enhancement Help Wanted Rescheduled Suggestion
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

When you have a callback whose parameter has no parentheses, inlay hints starts to look a little bit weird.

For example, in this code

            return hints.map(hint => ({
                ...hint,
                position: scriptInfo.positionToLineOffset(hint.position),
            }));

you get the following:

image

Ideally, you'd see that line rewritten as

callbackfn: (hint: InlayHint) => ({
```

Contributor guide

Open the contributing guide

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 callback example in the issue and tracing the inlay hints implementation that formats single-parameter arrow callbacks. Compare the current display with the requested callbackfn: (hint: InlayHint) => ( wording. Done means the parameter hint is presented without the awkward layout and existing inlay-hint tests still pass.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.