microsoft / microsoft/language-server-protocol

[protocol] Add range information to DocumentDiagnosticParams

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

Nobody has claimed this yet.

diagnostics feature-request
Dominant language
TypeScript
Stars
13k
Forks
1k
Avg merge
6d 1h
Merged PRs (30d)
10

Description

As discussed in https://github.com/microsoft/language-server-protocol/issues/737#issuecomment-1287302940 and https://github.com/microsoft/language-server-protocol/issues/718#issuecomment-1206503252 , for some languages computing diagnostics can be quite expensive.

In such cases, it'd be very convenient for the Pull Diagnostics request to provide a range parameter, so the server can opt to compute diagnostics for the relevant part of the file that is in view of the user.

That is only meant to be a hint, and servers should be free to ignore it.

I understand that this change together with the current support for Pull Diagnostics would be enough to implement a reasonable "check on scroll" functionality which a few IDEs in the context of theorem proving support.

c.f. #1414

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 with the DocumentDiagnosticParams definition and the Pull Diagnostics request in the protocol specification, then read the linked discussions and issue #1414. Determine how a range hint should be represented and documented while preserving servers’ ability to ignore it. Done means the protocol clearly defines the optional range behavior and its compatibility implications.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.