vscode-languageserver-protocol

What is vscode-languageserver-protocol?

The vscode-languageserver-protocol npm package provides the necessary protocols to implement a language server that communicates with development environments like Visual Studio Code. It defines the protocol used between an editor or IDE and a language server that provides language features like auto-complete, go to definition, or find all references.

What are vscode-languageserver-protocol's main functionalities?

Defining Language Server Capabilities

This code sample demonstrates how to define the capabilities of a language server, such as synchronization, completion, and definition lookup.

{"capabilities": {"textDocumentSync": 1, "completionProvider": {"resolveProvider": true, "triggerCharacters": [".", "{"]}, "definitionProvider": true}}

Handling Language Server Initialization

This code sample shows how to handle the initialization request from a client to a language server, specifying the process ID, root path, client capabilities, and trace settings.

{"jsonrpc": "2.0", "id": 1, "method": "initialize", "params": {"processId": null, "rootPath": null, "capabilities": {}, "trace": "off"}}

Sending Diagnostics to the Client

This code sample illustrates how a language server can send diagnostics (such as errors or warnings) to the client for a specific document.

{"jsonrpc": "2.0", "method": "textDocument/publishDiagnostics", "params": {"uri": "file:///path/to/file", "diagnostics": [{"range": {"start": {"line": 0, "character": 0}, "end": {"line": 0, "character": 1}}, "severity": 1, "message": "Error message"}]}}

Other packages similar to vscode-languageserver-protocol

monaco-languageclient

monaco-languageclient is a package that allows the Monaco editor, which is the code editor that powers Visual Studio Code, to communicate with language servers using the language server protocol. It is similar to vscode-languageserver-protocol but is specifically tailored for the Monaco editor.

README

VSCode Language Server - Protocol Module

This npm module is a tool independent implementation of the language server protocol and can be used in any type of node application. Please note that the protocol is versioned using the LSP specification version number. Since the protocol depends on the vscode-jsonrpc version a a breaking change on that dependencies might not be reflected in a major version change of this module. Changing the major version number in these cases was more confusing this it would result in a version mismatch between the protocol and the LSP specification.

See here for a detailed documentation on the language server protocol.

History

For the history please see the main repository

License

MIT