README.org

tools/lsp

Table of Contents

• Description
  • Module Flags
  • Plugins
  • Hacks
• Prerequisites
• Features
  • LSP-powered project search
• Configuration
• Troubleshooting

Description

This module integrates language servers into Doom Emacs. They provide features you’d expect from IDEs, like code completion, realtime linting, language-aware imenu/xref integration, jump-to-definition/references support, and more.

To get LSP working, you’ll need to do three things:

1. Enable this module,
2. Install a language server appropriate for your targeted language(s) (you’ll find a table mapping languages to available servers in the lsp-mode project README).
3. Enable the +lsp flag on the :lang modules you want to enable LSP support for. If your language’s module doesn’t have LSP support, and you know it can (or should), please let us know! In the meantime, you must configure it yourself (described in the Configuration section).

As of this writing, this is the state of LSP support in Doom Emacs:

Module	Major modes	Default language server
:lang cc	c-mode, c++-mode, objc-mode	ccls
:lang csharp	csharp-mode	omnisharp
:lang elixir	elixir-mode	elixir-ls
:lang fsharp	fsharp-mode	Mono, .NET core
:lang go	go-mode	go-langserver
:lang haskell	haskell-mode	haskell-ide-engine
:lang java	java-mode	lsp-java
:lang javascript	js2-mode, rjsx-mode, typescript-mode	typescript-language-server
:lang ocaml	tuareg-mode	ocaml-language-server
:lang php	php-mode	php-language-server
:lang python	python-mode	lsp-python-ms
:lang ruby	ruby-mode	solargraph
:lang rust	rust-mode	rls
:lang scala	scala-mode	metals
:lang sh	sh-mode	bash-language-server
:lang swift	swift-mode	sourcekit
:lang web	web-mode, css-mode, scss-mode, sass-mode, less-css-mode	vscode-css-languageserver-bin, vscode-html-languageserver-bin
:lang purescript	purescript-mode	purescript-language-server

Module Flags

• +peek Use lsp-ui-peek when looking up definitions and references with functionality from the :tools lookup module.

Plugins

• lsp-mode
• lsp-ui

Hacks

• lsp-mode has been modified not to automatically install missing LSP servers. This is done to adhere to our “Your system, your rules” mantra, which insist that it is better etiquette to let the user decide when their development environment is modified. Use M-x lsp-install-server to install LSP servers manually.

Prerequisites

This module has no direct prerequisites, but major-modes require you to install language servers.

You’ll find a table that lists available language servers and how to install them in the lsp-mode project README. The documentation of the module for your targeted language will contain brief instructions as well.

Features

LSP-powered project search

When :completion ivy or :completion helm is active, LSP is used to search a symbol indexed by the LSP server :

Keybind	Description
SPC c j	Jump to symbol in current workspace
SPC c J	Jump to symbol in any workspace

Configuration

Troubleshooting