Alexander-Miller/treemacs@a6f9e9f1ce -> Alexander-Miller/treemacs@63e2bc207a Silex/docker.el@9bcefbe54d -> Silex/docker.el@4fc69969b1 akermu/emacs-libvterm@2b1392cb2b -> akermu/emacs-libvterm@2681120b77 bdarcus/bibtex-actions@6e3a194c3a -> bdarcus/bibtex-actions@08c6ca0e5b dash-docs-el/dash-docs@dafc8fc9f1 -> dash-docs-el/dash-docs@29848b6b34 dgutov/diff-hl@992559f98a -> dgutov/diff-hl@40c89a7b0d dimitri/switch-window@2801d9b3a9 -> dimitri/switch-window@8d9fe251d8 editorconfig/editorconfig-emacs@e10fa22b13 -> editorconfig/editorconfig-emacs@2ab86dc9a8 ema2159/centaur-tabs@9c7c936e4e -> ema2159/centaur-tabs@8b4249c405 emacs-circe/circe@d6f1fa1864 -> emacs-circe/circe@77e16de3b9 emacs-lsp/lsp-treemacs@905cc74726 -> emacs-lsp/lsp-treemacs@d82df44d63 emacsorphanage/osx-trash@0f1dc052d0 -> emacsorphanage/osx-trash@af74a2055a emacsorphanage/quickrun@35e91f4b6c -> emacsorphanage/quickrun@78317951cd flycheck/flycheck@21d52264aa -> flycheck/flycheck@784f184cdd hlissner/emacs-doom-themes@9e2680b918 -> hlissner/emacs-doom-themes@65fb964f36 https://git.savannah.gnu.org/git/emms.git@6e0aaaf4c559 -> https://git.savannah.gnu.org/git/emms.git@c42fab572846 ideasman42/emacs-spell-fu@1abcb5594e -> ideasman42/emacs-spell-fu@10823ae58f ideasman42/emacs-undo-fu@e0ad06b5ef -> ideasman42/emacs-undo-fu@34b27c01da joostkremers/writeroom-mode@b648b34017 -> joostkremers/writeroom-mode@7f4ec92404 kidd/org-gcal.el@4c2616a4f8 -> kidd/org-gcal.el@80e6f9501f magnars/expand-region.el@4b8322774d -> magnars/expand-region.el@95a773bd8f millejoh/emacs-ipython-notebook@09af85821e -> millejoh/emacs-ipython-notebook@0600c286bd mohkale/consult-eglot@a6aeb6fa07 -> mohkale/consult-eglot@28a09cc839 noctuid/link-hint.el@09ba5727d8 -> noctuid/link-hint.el@d3c5bacc9c rolandwalker/nav-flash@55786c9582 -> rolandwalker/nav-flash@2e31f32085 skeeto/elfeed@243add9e74 -> skeeto/elfeed@162d7d545e szermatt/emacs-bash-completion@65e54c6f9c -> szermatt/emacs-bash-completion@c5eaeed156 tarsius/hl-todo@5ac0076cfe -> tarsius/hl-todo@42f744ffb5 tecosaur/emacs-everywhere@64ba2e3f30 -> tecosaur/emacs-everywhere@da88fa2d04 tkf/emacs-request@f3a5b4352e -> tkf/emacs-request@2b68b3ca54 tmalsburg/helm-bibtex@a0d32ab167 -> tmalsburg/helm-bibtex@b85662081d yoshiki/yaml-mode@3a57058468 -> yoshiki/yaml-mode@63b637f846 yqrashawn/fd-dired@c223aee30a -> yqrashawn/fd-dired@458464771b
tools/lsp
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:
- Enable this module,
- 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).
- 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 |
Module Flags
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.
TODO Features
LSP-powered project search
Without the +eglot
flag, and when :completion ivy
, :completion helm
or
:completion vertico
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 |
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
, …).
TODO Configuration
TODO Troubleshooting
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
"
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)