ℹ️ You are reading the README of the st4000-exploration branch. This branch targets ST4. If you are looking for the ST3 version, switch to the master branch.

LSP

Language Server Protocol support for Sublime Text that gives you IDE features.

Installation

Stable Version

Open the command palette and run Package Control: Install Package, then select LSP.

Development Version

Clone this repository into your Packages directory. Open the command palette and run Package Control: Satisfy Dependencies.

Getting started

Follow the installation steps for a specific language server.

Open a document supported by the language server. LSP should report the language server starting in the status bar.

See more information in the documentation 📖.

Customisation of the popups

LSP uses mdpopups to display the popup. You can override its style by creating a Packages/User/mdpopups.css file. See the mdpopups documentation for more details.

Getting help

If you have any problems, see the troubleshooting guide for tips and known limitations. If the documentation cannot solve your problem, you can look for help in:

• The #lsp channel (join the SublimeHQ Discord first!)
• By searching or creating a new issue

LSP specification implementation status

Text Document Capabilities

• ✅ synchronization
  • ✅ didOpen
  • ✅ didChange
    • ✅ Full text sync
    • ✅ Incremental text sync
  • ✅ willSave
  • ✅ willSaveWaitUntil
  • ✅ didSave
    • ✅ Include text
  • ✅ didClose
• ✅ completion
  • ✅ insertText
  • ✅ textEdit
  • ❌ prefix filter textEdit
  • ✅ documentation (both static and from completionItem/resolve)
  • ✅ Run command after inserting completion
  • ❌ insertReplaceEdit variant
• ✅ hover
• ✅ signatureHelp
  • ❌ context
• ✅ declaration
  • ✅ link support
• ✅ definition
  • ✅ link support
• ✅ typeDefinition
  • ✅ link support
• ✅ implementation
  • ✅ link support
• ✅ references
• ✅ documentHighlight
• ✅ documentSymbol
• ✅ codeAction
  • ✅ resolve
• ✅ codeLens (only when backed by a helper package)
• ❌ documentLink
• ✅ colorProvider
  • ❌ color picker #1291
• ✅ formatting
• ✅ rangeFormatting
• ❌ onTypeFormatting
• ✅ rename
• ✅ publishDiagnostics
• ❌ foldingRange sublimehq/sublime_text#3389
• ✅ selectionRange
• ❌ semanticHighlighting #887, sublimehq/sublime_text#817
• ❌ callHierarchy

Workspace Capabilities

• ✅ applyEdit
• ✅ workspaceEdit
  • ✅ documentChanges
  • ❌ resourceOperations
  • ❌ failureHandling
• ✅ didChangeConfiguration
• ❌ didChangeWatchedFiles #892, sublimehq/sublime_text#2669
• ✅ symbol
• ✅ executeCommand

Window Capabilities

• ✅ workDoneProgress
  • ✅ create
  • ❌ cancel
• ✅ showMessage request additionalPropertiesSupport

Dynamic Registration

✅ Fully implemented