Skip to content

Commit 8c10440

Browse files
committed
Remove preview references.
1 parent efae872 commit 8c10440

File tree

1 file changed

+9
-29
lines changed

1 file changed

+9
-29
lines changed

docs/extensibility/adding-an-lsp-extension.md

Lines changed: 9 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,22 @@ The Language Server Protocol (LSP) is a common protocol, in the form of JSON RPC
2020

2121
## Language Server Protocol
2222

23-
For more information on the protocol itself, see the documentation [here](https://github.com/Microsoft/language-server-protocol). Visual Studio’s implementation of Language Server Protocol is in preview, and support should be considered experimental. The preview release is in the form of an extension ([Language Server Protocol Client Preview](https://marketplace.visualstudio.com/items?itemName=vsext.LanguageServerClientPreview)), **but this extension can only be installed on the preview channel of Visual Studio**. A later release of Visual Studio will include built-in support for Language Server Protocol, at which time the Preview flag will be dropped. **You should not use the preview for production purposes.**
24-
25-
For more information on how to create a sample language server or how to integrate an existing language server into Visual Studio Code, see the documentation [here](https://code.visualstudio.com/docs/extensions/example-language-server).
26-
2723
![language server protocol implementation](media/lsp-implementation.png)
2824

2925
This article describes how to create a Visual Studio extension that uses an LSP-based language server. It assumes that you have already developed an LSP-based language server and just want to integrate it into Visual Studio.
3026

31-
For support within Visual Studio, language servers can communicate with the client (Visual Studio) via the following mechanisms:
27+
For support within Visual Studio, language servers can communicate with the client (Visual Studio) via any stream based transmission mechanism, i.e.:
3228

3329
* Standard input/output streams
3430
* Named pipes
35-
* Sockets
31+
* Sockets (TCP only)
3632

3733
The intent of the LSP and support for it in Visual Studio is to onboard language services that are not part of Visual Studio product. It is not intended to extend existing language services (like C#) in Visual Studio. To extend existing languages, refer to the language service’s extensibility guide (for example, the ["Roslyn" .NET Compiler Platform](../extensibility/dotnet-compiler-platform-roslyn-extensibility.md)).
3834

35+
For more information on the protocol itself, see the documentation [here](https://github.com/Microsoft/language-server-protocol).
36+
37+
For more information on how to create a sample language server or how to integrate an existing language server into Visual Studio Code, see the documentation [here](https://code.visualstudio.com/docs/extensions/example-language-server).
38+
3939
## Language Server Protocol features supported
4040

4141
The following LSP features are supported in Visual Studio so far:
@@ -70,7 +70,7 @@ completion/resolve | yes
7070
textDocument/hover | yes
7171
textDocument/signatureHelp | yes
7272
textDocument/references | yes
73-
textDocument/documentHighlight |
73+
textDocument/documentHighlight | yes
7474
textDocument/documentSymbol | yes
7575
textDocument/formatting | yes
7676
textDocument/rangeFormatting | yes
@@ -93,26 +93,6 @@ Next create a new blank VSIXProject by navigating to **File** > **New Project**
9393

9494
![create vsix project](media/lsp-vsix-project.png)
9595

96-
For the preview release, VS support for the LSP will be in the form of a VSIX ([Microsoft.VisualStudio.LanguageServer.Client.Preview](https://marketplace.visualstudio.com/items?itemName=vsext.LanguageServerClientPreview)). Extension developers who wish to create an extension using LSP language servers must take a dependency on this VSIX. Therefore, customers wishing to install a language server extension **must first install the Language Server Protocol Client Preview VSIX.**
97-
98-
To define the VSIX dependency, open the VSIX manifest designer for your VSIX (by double-clicking the source.extension.vsixmanifest file in your project) and navigate to **Dependencies**:
99-
100-
![add reference to language server protocol client](media/lsp-reference-lsp-dependency.png)
101-
102-
Create a new dependency like the following:
103-
104-
![define language server protocol client dependency](media/lsp-define-lsp-dependency.png)
105-
106-
* **Source**: Defined manually
107-
* **Name**: Language Server Protocol Client Preview
108-
* **Identifier**: Microsoft.VisualStudio.LanguageServer.Client.Preview
109-
* **Version Range**: [1.0,2.0)
110-
* **How is dependency resolved**: Installed by User
111-
* **Download URL**: [https://marketplace.visualstudio.com/items?itemName=vsext.LanguageServerClientPreview](https://marketplace.visualstudio.com/items?itemName=vsext.LanguageServerClientPreview)
112-
113-
> [!NOTE]
114-
> The **Download URL** must be filled in so users installing your extension know how to install the required dependency.
115-
11696
### Language server and runtime installation
11797

11898
By default, the extensions created to support LSP-based language servers in Visual Studio will not contain the language servers themselves or the runtimes needed to execute them. Extension developers are responsible for distributing the language servers and the runtimes needed. There are several ways to do so:
@@ -290,7 +270,7 @@ Adding support for LSP language servers does not require you to implement your o
290270

291271
### Settings
292272

293-
Support for custom language-server-specific settings is available for Preview release of LSP support in Visual Studio, but it is still in the process of being improved. Settings are specific to what the language server supports and usually control how the language server emits data. For example, a language server might have a setting for the maximum number of errors reported. Extension authors would define a default value, which can be changed by users for specific projects.
273+
Support for custom language-server-specific settings is available, but it is still in the process of being improved. Settings are specific to what the language server supports and usually control how the language server emits data. For example, a language server might have a setting for the maximum number of errors reported. Extension authors would define a default value, which can be changed by users for specific projects.
294274

295275
Follow these steps below to add support for settings to your LSP language service extension:
296276

@@ -350,7 +330,7 @@ Diagnostics tracing can be enabled to output all messages between the client and
350330

351331
```json
352332
{
353-
"foo.server.trace": "Off"
333+
"foo.trace.server": "Off"
354334
}
355335
```
356336

0 commit comments

Comments
 (0)