Name: lsp-adapter
Owner: Sourcegraph
Description: lsp-adapter provides a proxy which adapts Sourcegraph LSP requests to vanilla LSP requests
Created: 2018-04-18 22:07:44.0
Updated: 2018-05-23 21:31:22.0
Pushed: 2018-05-23 21:31:28.0
Size: 220
Language: Go
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Command lsp-adapter provides a proxy which adapts Sourcegraph LSP requests to
vanilla LSP requests.
Code Intelligence on Sourcegraph is powered by the Language Server Protocol.
Previously, language servers that were used on sourcegraph.com were additionally required to support our custom LSP files extensions. These extensions allowed language servers to operate without sharing a physical file system with the client. While it's preferable for language servers to implement these extensions for performance reasons, implementing this functionality is a large undertaking.
lsp-adapter eliminates the need for this requirement, which allows off-the-shelf language servers to be able to provide basic functionality (hovers, local definitions) to Sourcegraph.
You can download the latest binary on the releases page.
Alternatively, install it with go get:
et -u -v github.com/sourcegraph/lsp-adapter
Running lsp-adapter --help shows you some of its options:
p-adapter --help
e: lsp-adapter [OPTIONS] LSP_COMMAND_ARGS...
ons:
acheDirectory string
cache directory location (default "/tmp/proxy-cache")
idOpenLanguage string
(HACK) If non-empty, send 'textDocument/didOpen' notifications with the specified language field (e.x. 'python') to the language server for every file.
lob string
A colon (:) separated list of file globs to sync locally. By default we place all files into the workspace, but some language servers may only look at a subset of files. Specifying this allows us to avoid syncing all files. Note: This is done by basename only.
sonrpc2IDRewrite string
(HACK) Rewrite jsonrpc2 ID. none (default) is no rewriting. string will use a string ID. number will use a number ID. Useful for language servers with non-spec complaint JSONRPC2 implementations. (default "none")
roxyAddress string
proxy server listen address (tcp) (default "127.0.0.1:8080")
race
trace logs to stderr
lsp-adapterlsp-adapter proxies requests between your Sourcegraph instance and the language server, and modifies them in such a way that allows for the two to communicate correctly. In order to do this, we need to know
lsp-adapter to the language serverlsp-adapterlsp-adapter to the Language Serverlsp-adapter can talk to language servers over standard I/O.
lsp-adapter interprets any positional arguments after the flags as the necessary command (+ arguments) to start the language server binary. It uses this command to communicate to the language server inside of a subprocess.
For example, if I am trying to use Rust?s language server, the command to start it up is just rls. lsp-adapter can be told to start the start the same server via:
adapter rls
Any stderr output from the binary will also appear in lsp-adapter's logs.
lsp-adapterUse the -proxyAddress flag to tell lsp-adapter what address to listen for connections from Sourcegraph on. For example, I can tell lsp-adapter to listen on my local 8080 port with -proxyAddress=127.0.0.1:8080.
We then need to add a new entry to the "langservers" field in the site configuration in order to point Sourcegraph at lsp-adapter (similar to the steps in this document). For example, if lsp-adapter is connected to the Rust language server, and the lsp-adapter itself is listening on 127.0.0.1:8080:
"language": "rust",
"address": "tcp://127.0.0.1:8080"
would be the new entry that needs to be added to the "langservers" field.
Connect via standard I/O to a language server whose command can be run with rls, and listen for connections from Sourcegraph from any address on port 1234.
p-adapter -proxyAddresss=0.0.0.0:1234 rls
/04/04 15:27:04 proxy.go:71: CloneProxy: accepting connections at [::]:8080
Connect via standard I/O to a language server whose command can be run with rls, change the location of the cache directory (used for cloning the repo locally) to /tmpDir, and enable tracing for every request to/from the language server.
p-adapter -cacheDir='/tmpDir' -trace rls
There is a skeleton Dockerfile that shows how to package lsp-adapter along with your desired language server inside of a docker container. There are fully working examples in dockerfiles. For example dockerfiles/rust/Dockerfile, which can be built with:
cker build -f dockerfiles/rust/Dockerfile .
Most language servers will only ever look at files that match a set of known patterns. On initialize lsp-adapter copies a full work-tree to disk for a repository, but by specifying -glob we can avoid copying over files that will not be looked at. For example, if a python language server only looks at py and pyc files you can specify -glob=*.py:*.pyc. The matching is done on the basename of the path using path.Match.
Some language servers do not follow the LSP spec correctly and refuse to work unless the textDocument/didOpen notification has been sent. See this commit for more context. If the language server that you?re trying to use has this issue, try setting the didOpenLanguage flag (example: if a python language server had this issue - use ./lsp-adapter -didOpenLanguage=python ...) to work around it.
Some language servers do not follow the JSONRPC2 spec correctly and fail if the Request ID is not a number of string. If the language server that you?re trying to use has this issue, try setting the jsonrpc2IDRewrite flag (example: if a rust language server had this issue - use ./lsp-adapter -jsonrpc2IDRewrite=number ...) to work around it.