emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
doomemacs/modules/tools/lsp
History
Henrik Lissner acae9f9acb
bump: :tools lsp 
emacs-lsp/lsp-mode@6b6afc00de -> emacs-lsp/lsp-mode@3fa645c039
joaotavora/eglot@e835996e16 -> joaotavora/eglot@bd970be047

- There are multiple issues in the lsp-mode
  repo (emacs-lsp/lsp-mode#2722), lsp-julia repo (gdkrmr/lsp-julia#23
  and gdkrmr/lsp-julia#35), and the LanguageServer.jl
  repo (julia-vscode/LanguageServer.jl#844) about crashes of the Julia
  LSP with lsp-mode due to errors caused by the folding capabilities
  announced by the client. One can work around these issues by enabling
  folding (see gdkrmr/lsp-julia#23) but that is only a hack and does not
  fix the underlying issue. The problem is caused by a violation of the
  LSP specs in lsp-mode which was fixed in emacs-lsp/lsp-mode#3593. The
  PR updates lsp-mode to the latest commit on the master branch which
  contains this fix (and some other unrelated fixes, CI passes
  successfully again), and hence the workaround for lsp-julia can be
  removed.

Ref: emacs-lsp/lsp-mode#3593
Ref: emacs-lsp/lsp-mode#2722
Ref: gdkrmr/lsp-julia#35
Ref: gdkrmr/lsp-julia#23
Ref: julia-vscode/LanguageServer.jl#844
Close: #6516
Co-authored-by: devmotion <devmotion@users.noreply.github.com>
2022-07-05 01:35:06 +02:00
..
autoload fix(lsp,tree-sitter): void-function lsp!/tree-sitter! errors 2022-06-22 20:35:52 +02:00
+eglot.el feat(lsp,vertico): add consult-eglot 2021-09-15 01:03:11 +03:00
+lsp.el bump: :tools lsp 2022-01-03 16:51:51 +01:00
config.el refactor(lsp): remove emacs 26 workarounds 2022-05-05 02:19:52 +02:00
doctor.el docs(lsp): add warning for missing npm 2022-05-26 23:38:50 +02:00
packages.el bump: :tools lsp 2022-07-05 01:35:06 +02:00
README.org completion/selectrum -> completion/vertico, part 2 2021-07-25 02:51:15 +03:00

README.org

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:

  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 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

  • +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.

Plugins

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)