@codemirror/lsp-client 

[WEBSITE | DOCS | ISSUES | FORUM | CHANGELOG ]

This package implements a language server protocol (LSP) client for
the CodeMirror code editor.

The project page has more information, a
number of examples and the
documentation.

This code is released under an
MIT license.

We aim to be an inclusive, welcoming community. To make that explicit,
we have a code of
conduct that applies
to communication around the project.

Usage

There are various ways to run a language server and connect it to a
web page. You can run it on the server and proxy it through a web
socket, or, if it is written in JavaScript or can be compiled to WASM,
run it directly in the client. The @codemirror/lsp-client package
talks to the server through a (Transport)
object, which exposes a small interface for sending and receiving JSON
messages.

Responsibility for how to actually talk to the server, how to connect
and to handle disconnects are left to the code that implements the
transport.

This example uses a crude transport that doesn't handle errors at all.

``javascript
import {Transport, LSPClient, languageServerExtensions} from "@codemirror/lsp-client"
import {basicSetup, EditorView} from "codemirror"
import {typescriptLanguage} from "@codemirror/lang-javascript"

function simpleWebSocketTransport(uri: string): Promise {
let handlers: ((value: string) => void)[] = []
let sock = new WebSocket(uri)
sock.onmessage = e => { for (let h of handlers) h(e.data.toString()) }
return new Promise(resolve => {
sock.onopen = () => resolve({
send(message: string) { sock.send(message) },
subscribe(handler: (value: string) => void) { handlers.push(handler) },
unsubscribe(handler: (value: string) => void) { handlers = handlers.filter(h => h != handler) }
})
})
}

let transport = await simpleWebSocketTransport("ws://host:port")
let client = new LSPClient({extensions: languageServerExtensions()}).connect(transport)

new EditorView({
extensions: [
basicSetup,
typescriptLanguage,
client.plugin("file:///some/file.ts"),
],
parent: document.body
})
``