doomemacs/modules/tools/lsp/README.org
2019-04-08 23:03:19 -04:00

4.2 KiB

tools/lsp

Description

This module integrate 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 two things:

  1. To install a language server appropriate for your targeted language (you'll find a table mapping languages to available servers in the lsp-mode project README).
  2. To enable this module and the LSP capabilities of the appropriate :lang module with the +lsp flag. If your language's module doesn't have LSP support, you'll have to configure your own (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 go go-mode go-langserver
:lang haskell haskell-mode haskell-ide-engine
:lang javascript js2-mode, rjsx-mode, typescript-mode typescript-language-server
:lang java java-mode lsp-java
:lang ocaml taureg-mode ocaml-language-server
:lang php php-mode php-language-server
:lang python python-mode lsp-python-ms
:lang ruby ruby-mode, enh-ruby-mode solargraph
:lang rust rust-mode rls
:lang sh sh-mode bash-language-server
:lang web web-mode, css-mode, scss-mode, sass-mode, less-css-mode vscode-css-languageserver-bin, vscode-html-languageserver-bin

Module Flags

This module provides no flags.

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.

TODO Features

TODO Configuration

TODO Troubleshooting