microsoft / microsoft/language-server-protocol

Clarification: diagnostic ranges

Open
#257 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

VSCode supports a few diagnostic ranges that aren't documented in the LSP spec:

  • If a diagnostic's range has start and end position the same, then VSCode will squiggle the word at that position.
  • If a diagnostic's range has end position at character Number.MAX_VALUE, then VSCode will squiggle to the end of the line.

I think the LSP spec should call out these two cases, so that other clients implementing it will be sure to do the same.

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 locating the diagnostic range section in the LSP specification and compare its wording with the two VSCode behaviors described here. Document the same-position and Number.MAX_VALUE end-position cases, with completion marked by both behaviors being explicitly covered in the specification.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.