中文文档 | English

This is a C# LSP plugin for Sublime Text. Unlike LSP-OmniSharp, LSP-Roslyn directly uses Microsoft's Roslyn as the backend, which is the same backend used by the current Visual Studio Code C# Extension and C# Dev Kit.

Compared to the OmniSharp solution, it offers more modern feature design and better performance.

• Sublime Text 4 (Build 4107 or later)
  • Build 4107 : 20 May 2021
• LSP Package Installed via Package Control
• .NET SDK 9.0 or higher installed (at least you need dotnet 9.0 runtime to make Roslyn work)

1. First, ensure that the LSP plugin is installed in Sublime Text
2. Install the LSP-Roslyn plugin through Package Control

Clone the plugin repository to your Sublime Text Packages directory:

# macOS
cd "~/Library/Application Support/Sublime Text/Packages"
# Windows (PowerShell)
cd "$env:APPDATA\Sublime Text\Packages"
# Linux
cd "~/.config/sublime-text/Packages"
# Install by git
git clone https://github.com/ownself/LSP-Roslyn.git

Under normal circumstances, when you open a .cs file with Sublime Text, it will automatically search for .sln and .csproj files and enable LSP-Roslyn.

When enabled for the first time, the plugin will attempt to automatically download the corresponding Roslyn executable based on your operating system and extract it to the plugin directory.

Therefore, simply wait a moment. After the download completes, it will automatically extract and start Roslyn, and Sublime Text's C# LSP functionality will automatically take effect.

Current automatic download Roslyn version:

• Pre-Release : 5.3.0-1.25517.107

Supported system platforms for automatic download:

• win-x86
• win-x64
• win-arm64
• osx-x64
• osx-arm64
• linux-x64
• linux-arm64

If automatic download doesn't work, or if your platform is not in the plugin's default supported list, you may need to manually download Roslyn and extract it to the Microsoft.CodeAnalysis.LanguageServer directory within the plugin directory under Sublime Text's Packages.

For more information about downloading Roslyn executable files, please refer to roslyn-packages

You can configure settings through Preferences: LSP-Roslyn Settings in the Command Palette:

{
    "settings": {
        // Plugin settings
        "roslyn.defaultLaunchSolution": "MyProject.sln",
        "roslyn.loggingLevel": "Information",
        "roslyn.debug": false
    },

    // Roslyn language server options (sent via workspace/configuration)
    // Structure: roslyn.{group}.{option_name}
    "roslyn": {
        "background_analysis": {
            "dotnet_analyzer_diagnostics_scope": "openFiles",
            "dotnet_compiler_diagnostics_scope": "openFiles"
        },
        "inlay_hints": {
            "csharp_enable_inlay_hints_for_implicit_variable_types": true,
            "dotnet_enable_inlay_hints_for_parameters": true
        },
        "code_lens": {
            "dotnet_enable_references_code_lens": true,
            "dotnet_enable_tests_code_lens": true
        },
        "projects": {
            // Keep null to disable design-time build binlogs
            "dotnet_binary_log_path": null,
            "dotnet_enable_automatic_restore": true
        }
    }
}

Core Features

• Code Completion - IntelliSense and auto-completion suggestions
• Signature Help - Parameter information for methods
• Hover Information - Documentation and type information
• Go to Definition - Jump to function definitions
• Find References - List all references
• Rename - Rename across projects

Advanced Features

• Code Actions - Quick fixes and refactoring
• Code Lens - Inline reference count indicators
• Inlay Hints - Type and parameter hints
• Diagnostics - Real-time error and warning notifications
• Formatting - Automatic code formatting
• Symbol Search - Project-wide function definition search
• Source Generators - Source file generation support

Roslyn Analyzers

• Built-in Analyzers - Code quality and style analysis
• Custom Analyzers - Support for third-party analyzers
• EditorConfig - Support for .editorconfig settings

Commands available in the Command Palette:

• LSP-Roslyn: Restart Server - Restart LSP-Roslyn
• LSP-Roslyn: Select Solution - Switch projects
• Preferences: LSP-Roslyn Settings - Open LSP-Roslyn configuration

MIT License. See LICENSE for details

I have loved this elegant and high-performance code editor since Sublime Text 2, and for 3-4 years it was my primary editor at work. Although I now use more modern editors like Neovim and Rider in my daily work, Sublime Text remains my trusty companion when handling JSON or text data. Contributing to this community has always been my wish.

Plugin inspiration comes from LSP-OmniSharp

Another Sublime Text plugin I wrote: CursorWordHighlighter