microsoft/language-server-protocol

Add a free-text "description" field to `serverInfo`

Open

#1,752 opened on 2023年6月23日

GitHub で見る
 (0 comments) (1 reaction) (0 assignees)HTML (12,810 stars) (956 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
over 1 week
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
fresh
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
LSP protocol understanding
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
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.