998dccd8fe
* switch the company-backend used by lsp-mode from company-lsp to company-capf (said to provide better performance and allows us to remove the dependency on company-lsp) * when available (on recent builds of Emacs 27+), lsp-mode buffers will now use a larger than default value of `read-process-output-max`. According to the lsp-mode performance guide, this can also significantly improve lsp-mode performance * flycheck support recently moved into lsp proper; with this commit, the lsp module follows suit and prefers lsp-flycheck over lsp-ui-flycheck * if the new module flag `+no-peek` is set, doom-emacs will now use the xref backend for reference and definition lookup instead of the lsp-ui-peek-* backend offered by lsp-ui-mode
80 lines
5.5 KiB
Org Mode
80 lines
5.5 KiB
Org Mode
#+TITLE: tools/lsp
|
|
#+DATE: March 05, 2019
|
|
#+SINCE: v2.1
|
|
#+STARTUP: inlineimages
|
|
|
|
* Table of Contents :TOC_3:noexport:
|
|
- [[#description][Description]]
|
|
- [[#module-flags][Module Flags]]
|
|
- [[#plugins][Plugins]]
|
|
- [[#prerequisites][Prerequisites]]
|
|
- [[#features][Features]]
|
|
- [[#lsp-powered-project-search][LSP-powered project search]]
|
|
- [[#configuration][Configuration]]
|
|
- [[#troubleshooting][Troubleshooting]]
|
|
|
|
* Description
|
|
This module integrates [[https://langserver.org/][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 [[https://github.com/emacs-lsp/lsp-mode#supported-languages][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/README.org][:lang cc]] | c-mode, c++-mode, objc-mode | ccls |
|
|
| [[../../lang/csharp/README.org][:lang csharp]] | csharp-mode | omnisharp |
|
|
| [[../../lang/elixir/README.org][:lang elixir]] | elixir-mode | elixir-ls |
|
|
| [[../../lang/fsharp/README.org][:lang fsharp]] | fsharp-mode | Mono, .NET core |
|
|
| [[../../lang/go/README.org][:lang go]] | go-mode | go-langserver |
|
|
| [[../../lang/haskell/README.org][:lang haskell]] | haskell-mode | haskell-ide-engine |
|
|
| [[../../lang/java/README.org][:lang java]] | java-mode | lsp-java |
|
|
| [[../../lang/javascript/README.org][:lang javascript]] | js2-mode, rjsx-mode, typescript-mode | typescript-language-server |
|
|
| [[../../lang/ocaml/README.org][:lang ocaml]] | tuareg-mode | ocaml-language-server |
|
|
| [[../../lang/php/README.org][:lang php]] | php-mode | php-language-server |
|
|
| [[../../lang/python/README.org][:lang python]] | python-mode | lsp-python-ms |
|
|
| [[../../lang/ruby/README.org][:lang ruby]] | ruby-mode, enh-ruby-mode | solargraph |
|
|
| [[../../lang/rust/README.org][:lang rust]] | rust-mode | rls |
|
|
| [[../../lang/scala/README.org][:lang scala]] | scala-mode | metals |
|
|
| [[../../lang/sh/README.org][:lang sh]] | sh-mode | bash-language-server |
|
|
| [[../../lang/swift/README.org][:lang swift]] | swift-mode | sourcekit |
|
|
| [[../../lang/web/README.org][:lang web]] | web-mode, css-mode, scss-mode, sass-mode, less-css-mode | vscode-css-languageserver-bin, vscode-html-languageserver-bin |
|
|
|
|
** Module Flags
|
|
+ =+peek= Enables the =lsp-ui-peek= navigation frontend provided by the =lsp-ui= package.
|
|
|
|
** Plugins
|
|
+ [[https://github.com/emacs-lsp/lsp-mode][lsp-mode]]
|
|
+ [[https://github.com/emacs-lsp/lsp-ui][lsp-ui]]
|
|
|
|
* 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 [[https://github.com/emacs-lsp/lsp-mode#supported-languages][in the lsp-mode project README]]. The documentation of the module for your
|
|
targeted language will contain brief instructions as well.
|
|
|
|
* TODO 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 |
|
|
|
|
* TODO Configuration
|
|
|
|
* TODO Troubleshooting
|