Add README to roslyn-language-server NuGet package#82201
Conversation
Co-authored-by: dibarbet <5749229+dibarbet@users.noreply.github.com>
Co-authored-by: dibarbet <5749229+dibarbet@users.noreply.github.com>
Co-authored-by: dibarbet <5749229+dibarbet@users.noreply.github.com>
|
|
||
| ## Overview | ||
|
|
||
| The `roslyn-language-server` is a .NET global tool that provides rich language features for C# and Visual Basic through the Language Server Protocol. It powers editor integrations including the [C# extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) and C# Dev Kit. |
| Install the language server as a .NET global tool: | ||
|
|
||
| ```bash | ||
| dotnet tool install --global roslyn-language-server |
|
|
||
| - [Roslyn GitHub Repository](https://github.com/dotnet/roslyn) | ||
| - [Language Server Protocol Specification](https://microsoft.github.io/language-server-protocol/) | ||
| - [Common Language Server Protocol Framework (CLaSP)](https://github.com/dotnet/roslyn/tree/main/src/LanguageServer/Microsoft.CommonLanguageServerProtocol.Framework) |
|
|
||
| ## Overview | ||
|
|
||
| The `roslyn-language-server` is a .NET global tool that provides rich language features for C# and Visual Basic through the Language Server Protocol. It powers editor integrations including the [C# extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) and C# Dev Kit. |
… up sections Co-authored-by: dibarbet <5749229+dibarbet@users.noreply.github.com>
|
|
||
| The language server is designed to be launched by editor clients and typically should not be run directly by end users. It communicates via standard input/output or named pipes. | ||
|
|
||
| ### Command-line Options |
There was a problem hiding this comment.
May be good to show which options are required and what the defaults are for optional options
There was a problem hiding this comment.
Updated the command-line options section to clarify that all options are optional and show default values for options that have them. Also added a note that one of --stdio or --pipe should typically be specified. (d88db68)
…E.md Co-authored-by: Joey Robichaud <jorobich@microsoft.com>
Co-authored-by: dibarbet <5749229+dibarbet@users.noreply.github.com>
Co-authored-by: dibarbet <5749229+dibarbet@users.noreply.github.com>
| All options are optional. One of `--stdio` or `--pipe` should typically be specified for communication. | ||
|
|
||
| - `--stdio` - Use standard I/O for communication with the client (default: false) | ||
| - `--pipe <name>` - Use a named pipe for communication |
There was a problem hiding this comment.
Is this how the pipe works? I thought we do the dance where the server allocates the pipe?
|
|
||
| The language server is designed to be launched by editor clients and typically should not be run directly by end users. It communicates via standard input/output or named pipes. | ||
|
|
||
| ### Command-line Options |
There was a problem hiding this comment.
Not sure if we should have some sort of "command line switches are subject to change", since we haven't necessarily given any sort of compat thought to some of these.
There was a problem hiding this comment.
@copilot can you add that the command line options could potentially change in the future?
There was a problem hiding this comment.
Added a note that command-line options are subject to change in future versions. (1834492)
Co-authored-by: dibarbet <5749229+dibarbet@users.noreply.github.com>
Add README to roslyn-language-server .NET tool package
--prereleaseflag to installation commandOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.