microsoft / microsoft/language-server-protocol

Unclear handling of nil diagnostic responses

Open
#1,882 0 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The protocol indicates that the response to the textDocument/diagnostic request is a proper DiagnosticReport, yet certain language servers return null as a response (like the Ruby language server).

Initially one would blame this on the misbehaving server that's not following the specification, yet one finds editors/clients that accommodate this behavior (example here).

Hence the issue is: Should we allow null responses for this request and send the same reply as VS Code does? Or should we handle this as an invalid reply?

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 textDocument/diagnostic request and its DiagnosticReport response definition, then compare the linked VS Code diagnostic.ts handling with the protocol wording. Done means deciding whether null is valid and documenting or specifying the resulting behavior; the issue names no repository test or implementation file.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.