microsoft/language-server-protocol

What's the correct way for an LSP server to know whether a command is available on the client?

Open

#642 opened on Dec 17, 2018

View on GitHub
 (43 comments) (1 reaction) (0 assignees)HTML (956 forks)batch import
commandsfeature-requesthelp wanted

Repository metrics

Stars
 (12,810 stars)
PR merge metrics
 (Avg merge 19h 29m) (12 merged PRs in 30d)

Description

I'm implementing some refactors where the server needs some input from the user. In order to get input from the user I'm going to need to trigger a command on the client that can ask the user for input (for example, by having a command in the client extension that can call window.showInputBox or some equiv).

However, I can't find a way for the client to advertise (or server to know) which commands are supported on the client.

What's the expected way to handle this? Although I can document the commands that a client needs to implement for specific functionality in the server, that's not very compatible - if I wanted to add new requirements in the future, I'd need to know if the connected client supports them.

Contributor guide

Research direction
Examine the LSP specification for client capabilities related to command execution. Look for whether the client can advertise supported commands or if the server can query.
Tech stack
None
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75