Language Server Protocol
This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these template messages)(Learn how and when to remove this template message)
The Language Server Protocol (LSP) is an open, JSON-RPC-based protocol for use between source code editors or integrated development environments (IDEs) and servers that provide programming language-specific features. The goal of the protocol is to allow programming language support to be implemented and distributed independently of any given editor or IDE.
The Language Server Protocol was originally developed for Microsoft's Visual Studio Code and is now an open standard. On 2016 June 27, Microsoft announced a collaboration with Red Hat and Codenvy to standardize the protocol's specification. The protocol is supported and has been adopted by the three companies. Its specification is hosted and developed on GitHub.
Modern integrated development environments (IDEs) provide developers with sophisticated features like code completion, refactoring, navigating to a symbol's definition, syntax highlighting, and error and warning markers.
For example, in a text-based programming language, a programmer might want to rename a method
read. The programmer could either manually edit the respective source code files and change the appropriate occurrences of the old method name into the new name, or instead use an IDE's refactoring capabilities to make all the necessary changes automatically. To be able to support this style of refactoring, an IDE needs a sophisticated understanding of the programming language that the program's source is written in. A programming tool without a such an understanding—for example, one that performs a naive search-and-replace instead—could introduce errors. When renaming a
read method, for example, the tool should not replace the partial match in a variable that might be called
readyState, nor should it replace the portion of a code comment containing the word "already". Neither should renaming a local variable
view, for example, end up altering similarly named variables in other scopes.
Conventional compilers or interpreters for a specific programming language are typically unable to provide these language services, because they are written with the goal of either transforming the source code into object code or immediately executing the code. Additionally, language services must be able to handle source code that is not well-formed, e.g. because the programmer is in the middle of editing and has not yet finished typing a statement, procedure, or other construct. Additionally, small changes to a source code file which are done during typing usually change the semantics of the program. In order to provide instant feedback to the user, the editing tool must be able to very quickly evaluate the syntactical and semantical consequences of a specific modification. Compilers and interpreters therefore provide a poor candidate for producing the information needed for an editing tool to consume.
Prior to the design and implementation of the Language Server Protocol for the development of Visual Studio Code, most language services were generally tied to a given IDE or other editor. In the absence of the Language Server Protocol, language services are typically implemented by utilizing a tool-specific extension API. Providing the same language service to another editing tool requires effort to adapt the existing code so that the service may target the second editor's extension interfaces.
The Language Server Protocol allows for decoupling language services from the editor so that the services may be contained within a general purpose language server. Any editor can inherit sophisticated support for many different languages by making use of existing language servers. Similarly, a programmer involved with the development of a new programming language can make services for that language available to existing editing tools. Making use of language servers via the Language Server Protocol thus also reduces the burden on vendors of editing tools, because vendors do not need to develop language services of their own for the languages the vendor intends to support, as long as the language servers have already been implemented. The Language Server Protocol also enables the distribution and development of servers contributed by an interested third-party, such as end users, without additional involvement by either the vendor of the compiler for the programming language in use or the vendor of the editor to which the language support is being added.
When a user edits one or more source code files using a language server protocol-enabled tool, the tool acts as a client that consumes the language services provided by a language server. The tool may be a text editor or IDE and the language services could be e.g. refactoring, code completion, etc.
The client informs the server about what the user is doing, e.g. opening a file, inserting a character at a specific text position, etc. The client can also request the server to perform a language service, e.g. to format a specified range in the text document. The server answers a client's request with an appropriate response. For example, the formatting request is answered either by a response that transfers the formatted text to the client or by an error response containing details about the error.
The Language Server Protocol (LSP) defines the messages that are exchanged between client and language server:
- Request: The client sends a request to the server in the form of a JSON-RPC call. A request must always be answered with a response.
- Response: The server answers a client request by a response.
- Notification: Notifications can be sent in both directions. Unlike requests, a notification never receives a response.
The protocol does not make any provisions about how requests, responses and notifications are transferred between client and server. For example, client and server could be components within the same process exchanging JSON strings via method calls. They could also be different processes on the same or on different machines communicating via network sockets.
Language service registry
A global language service registry, hosted by the Eclipse Foundation, should make language servers publicly available. Additionally, there are lists of LSP-compatible implementations, maintained by the community-driven Langserver.org or Microsoft.
- Efftinge, Sven; Spönemann, Miro (11 December 2016). "Language Server Protocol Explained". Eclipse Foundation. Retrieved 25 April 2017.
- "A Common Protocol for Languages". Microsoft. 27 June 2016. Retrieved 25 April 2017.
- "Red Hat, Codenvy and Microsoft Collaborate on Language Server Protocol". Red Hat. 27 June 2016. Retrieved 22 February 2017.
- "Press Release: Red Hat, Codenvy and Microsoft Collaborate on Language Server Protocol". Codenvy. 27 June 2016. Retrieved 26 April 2017.
- Krill, Paul (27 June 2016). "Microsoft-backed Language Server Protocol strives for language, tools interoperability". InfoWorld. Retrieved 26 April 2017.
- Handy, Alex (27 June 2016). "Codenvy, Microsoft and Red Hat collaborate on Language Server Protocol". SD Times. Retrieved 26 April 2017.
- Kalenda, Florian (28 June 2016). "Microsoft und Red Hat legen quelloffenes Language Server Protocol vor" [Microsoft and Red Hat present open-source Language Server Protocol] (in German). ZDNet. Retrieved 26 April 2017.
- "Language Server Protocol". Microsoft. GitHub. 27 June 2016. Retrieved 25 April 2017.
- Juarez, Seth (12 May 2016). "Anders Hejlsberg on Modern Compiler Construction". Microsoft. Retrieved 22 February 2017.
- Efftinge, Sven (December 2016). "Eclipse Is Learning New Protocols". Retrieved 26 April 2017.
- Tomassetti, Gabriele (16 February 2017). "Why You Should Know the Language Server Protocol". Federico Tomassetti. Retrieved 8 May 2017.
- Neumann, Alexander (1 June 2016). "Xtext 2.11 unterstützt Language Server Protocol" [Xtext 2.11 supports Language Server Protocol]. Heise Developer (in German). Heise Medien. Retrieved 8 May 2017.
- Mohilo, Dominik (28 June 2016). "Polyglott dank Language Server Protocol: Microsoft, Red Hat und Codenvy streben nach der universellen IDE" [Polyglot thanks to the Language Server Protocol: Microsoft, Red Hat and Codenvy are striving for the universal IDE]. Jaxenter (in German). Software & Support Media. Retrieved 8 May 2017.
- "Langserver.org". Langserver.org. Retrieved 8 May 2017 – via Sourcegraph.
- Gamma, Erich (8 May 2017). "Protocol Implementations". Microsoft. Retrieved 8 May 2017 – via GitHub.