:tools lsp

M-x vscode

1. 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) (a table mapping languages to supported servers can be found in lsp-mode’s 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 clojure clojure-mode clojure-lsp
: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-language-server
:lang java java-mode lsp-java
:lang javascript js2-mode, rjsx-mode, typescript-mode typescript-language-server
:lang julia julia-mode LanguageServer.jl
: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
:lang zig zig-mode zls

1.1. Maintainers

1.2. Module flags

+peek
Use lsp-ui-peek when looking up definitions and references with functionality from the :tools lookup module.
+eglot
Use eglot instead of lsp-mode to implement the LSP client in Emacs.

1.4. Hacks

No hacks documented for this module.

2. Prerequisites

This module has no direct prerequisites, but different languages will need different language servers, which lsp-mode will prompt you to auto-install. eglot will not.

A table that lists available language servers and how to install them can be found on the lsp-mode project README. The documentation of the module for your targeted language will contain brief instructions as well.

For eglot users, a list of default servers supported is on Eglot’s README, including instructions to register your own.

3. TODO Usage

This module’s usage documentation is incomplete. Complete it?

3.2. Differences between eglot and lsp-mode

Entering the debate about which one to use would be useless. Doom provides an easy way to switch out lsp client implementations so you can test for yourself which one you prefer.

Mainly, from a code point of view, lsp-mode has a lot of custom code for UI (lsp-ui-peek, lsp-ui-sideline, …), while eglot is more barebones with a closer integration with “more basic” emacs packages (eldoc, xref, …).

4. TODO Configuration

This module has no configuration documentation yet. Write some?

5. Troubleshooting

5.1. My language server is not found

Check the entry in the FAQ about “Doom can’t find my executables/doesn’t inherit the correct $PATH”.

5.2. LSP/Eglot is not started automatically in my buffer

Make sure that you added the +lsp flag to the language you’re using too in your init.el:

:lang
-python
+(python +lsp)

6. TODO Appendix

This module has no appendix yet. Write one?