Add a free-text "description" field to `serverInfo` · microsoft/language-server-protocol#1752

(0 评论) (1 反应) (0 负责人)HTML (12,810 star) (956 fork)batch import

feature-requesthelp wantedinitialization

描述

It would be nice to have a free-text (or perhaps markdown) field in serverInfo for the server to provide any server-specific information that it thinks the user might want to see.

Here's an example. The Haskell language server supports different features depending which version of the Haskell compiler it is built for (typically we start with partial support for a new compiler version and then add more over time). This means that users can be surprised that some feature is not available. At the moment, we have no easy way of conveying this to the user. The information is HLS-specific, so it's not clear that we could have a standard format for "server features". The simplest thing would just be to have a free text field so the server can put whatever it wants in there.

We can of course emit this information to the log, but it would be nice for users to have a standard place where static information about the server was recorded.

贡献者指南

技术栈: 无
领域: api
议题类型: feature
难度: 3
预计时间: over 1 week
活动状态: fresh
清晰度: clear
前置要求: LSP protocol understanding
新手友好度: 30
研究方向: This issue proposes adding a free text description field to serverInfo in the LSP. The implementation would likely require updating the LSP specification document and JSON schema. Discussion should focus on whether the field should be plain text or Markdown, and how it interacts with existing capabilities. See examples in the Haskell Language Server for motivation.