microsoft / microsoft/TypeScript

Inlay hints should accept a list of files, not individual files

Open
#45,380 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: API Domain: LS: Inlay Hints Domain: LS: TSServer Revisit
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

Inlay hints can be affected by edits in other files. That means you can end up in situations where 2 files can be edited side-by-side where one ends up with stale inlay hints.

image

To spare editors from making multiple requests, we should consider accepting a list of files instead of a single file as an argument.

Tracking on VS Code's side: https://github.com/microsoft/vscode/issues/130430

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 reviewing the inlay hints request described in this issue and the linked VS Code tracking issue. Determine how the request can accept multiple files while avoiding repeated editor requests and stale hints; done means the API supports a file list and the side-by-side editing case is addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, developer-experience, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.