microsoft / microsoft/language-server-protocol

Long diagnostic message field

Open
#1,461 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

In the bug I filed yesterday #1458 discusses tranfsering documents from server to client.
The impetus for that request though was dealing with long diagnostic messages.

Thinking through it a different solution than #1458 might be instead adding an long_message?: string field to diagnostic. This would appear to be a much simpler fix for the problem that I am dealing with, having less weirdness involving uri for the lsp server, and new request types.

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

Read this proposal together with issue #1458, which discusses transferring documents from server to client. Focus on how a long_message field on diagnostic would address long diagnostic messages without using uri or introducing new request types. Done would require a decided protocol design and its documented specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api
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.