English | 简体中文
Lsp-bridge's goal is to become the fastest LSP client in Emacs.
Lsp-bridge uses python's threading technology to build caches that bridge Emacs and LSP server. Lsp-bridge will provide smooth completion experience without compromise to slow down emacs' performance.
- Install Emacs 28 and above versions
- Install Python dependencies:
pip3 install epc orjson six - Install Elisp dependencies:
- Clone or download this repository (path of the folder is the
<path-to-lsp-bridge>used below). - Add following code in your ~/.emacs:
(add-to-list 'load-path "<path-to-lsp-bridge>")
(require 'yasnippet)
(yas-global-mode 1)
(require 'lsp-bridge)
(global-lsp-bridge-mode)lsp-bridge is design for out the box. After installing the LSP server and mode plugin corresponding to the open file, you can write the code directly without additional settings.
It should be noted that there are three scan modes of lsp-bridge:
- When detecting the
.gitdirectory (check by commandgit rev-parse-is-inside-work-tree), lsp-bridge scan the entire directory file to provide completion - When the
.gitdirectory was not detected, lsp-bridge only scan opened file to provide completion - Custom
lsp-bridge-get-project-path-by-filepathfunction, the input parameter is the path string of opened file, the output parameter is the project directory path, lsp-bridge will scan project directory path to provide provide completion
| Key | Command | Description |
|---|---|---|
| Alt + n | acm-select-next | Select next candidate |
| Down | acm-select-next | Select next candidate |
| Alt + p | acm-select-prev | Select previous candidate |
| Up | acm-select-prev | Select previous candidate |
| Alt + . | acm-select-last | Select last candidate |
| Alt + , | acm-select-first | Select first candidate |
| Ctrl + m | acm-complete | Complete completion |
| Return | acm-complete | Complete completion |
| Tab | acm-complete | Complete completion |
| Alt + h | acm-complete | Complete completion |
| Alt + H | acm-insert-common | Insert common part of candidates |
| Alt + d | acm-doc-toggle | Enable or disable candidate documentation |
| Alt + j | acm-doc-scroll-up | Scroll up candidate documentation |
| Alt + k | acm-doc-scroll-down | Scroll down candidate documentation |
| Alt + l | acm-hide | Hide completion menu |
| Ctrl + g | acm-hide | Hide completion menu |
| Number | acm-complete-quick-access | Selecting candidate quickly, you need enable acm-enable-quick-access first |
lsp-bridge-find-def: jump to the definitionlsp-bridge-find-def-other-window: jump to the definition in other-windowlsp-bridge-find-def-return: return to the location before callinglsp-bridge-find-deflsp-bridge-find-impl: jump to the implementationlsp-bridge-find-impl-other-window: jump to the implementation in other-windowlsp-bridge-find-references: traverse across code references (forked from color-rg.el)lsp-bridge-popup-documentation: lookup documentation of symbol under the cursorlsp-bridge-popup-documentation-scroll-up: scroll up popup document.lsp-bridge-popup-documentation-scroll-down: scroll down popup document.lsp-bridge-rename: rename symbol under the cursorlsp-bridge-diagnostic-jump-next: Jump to the next diagnostic positionlsp-bridge-diagnostic-jump-prev: Jump to the previous diagnostic positionlsp-bridge-diagnostic-list: List all diagnostic informationlsp-bridge-diagnostic-copy: Copy the current diagnostic information to the clipboardlsp-bridge-diagnostic-ignore: Insert comment to ignore the current diagnosislsp-bridge-workspace-list-symbols: List all symbols in workspace and jump to the symbol definitionlsp-bridge-signature-help-fetch: show signature help in minibuffer manually (move cursor to parameters area will show signature help automatically)lsp-bridge-popup-complete-menu: Manually popup the completion menu, you only need this command when turn on optionlsp-bride-complete-manuallylsp-bridge-restart-process: restart lsp-bridge process (only used for development)lsp-bridge-toggle-sdcv-helper: Switch dictionary completion assistantacm-insert-common: insert common prefix of candidatesacm-doc-scroll-up: API document window scroll upacm-doc-scroll-down: API document window scroll down
lsp-bridge-c-lsp-server: C language server, you can chooseclangdorcclslsp-bridge-python-lsp-server: Python language server, you can choosepyright,jedi,python-ms,pylsplsp-bridge-php-lsp-server: PHP language server, you can chooseintelephenseorphpactorlsp-bridge-tex-lsp-server: LaTeX language server, you can choosetaxlabordigestif
lsp-bridge-python-command: The path of the python command, if you useconda, you may customize this option. Windows platform usingpython.exerather thanpython3, if lsp-bridge can't work, try set topython3lsp-bridge-complete-manually: Only popup completion menu when user calllsp-bridge-popup-complete-menucommand, default is nillsp-bridge-get-workspace-folder: You need to put multiple project in aworkspacedirectory in Java before you can jump function defintion normally. This function can be customized, the function input is the project path and returns theworkspacedirectory correspondinglsp-bridge-org-babel-lang-list: list of language to support org-mode code block completion, need move cursor to code block and execute commandorg-edit-special, then lsp-bridge can show completion menu in popup windowlsp-bridge-enable-diagnostics: code diagnostic, enable by defaultlsp-bridge-enable-search-words: index the word of the file, enable by defaultlsp-bridge-enable-auto-format-code: automatic format code, disable by defaultlsp-bridge-enable-signature-help: show function parameter in minibufer, enable by defaultlsp-bridge-enable-log: enable the LSP message log, disable by defaultlsp-bridge-enable-debug: enable program debugging, disable by defaultlsp-bridge-disable-backup: forbidden version manage of emacs, enable by defaultlsp-bridge-diagnostic-fetch-idle: diagnostic delay, start pulling diagnostic information 0.5 second after stopping typinglsp-bridge-signature-show-function: The function used for displaying signature info, default show message in minibuffer, setlsp-bridge-signature-posframeto show signature info in framelsp-bridge-completion-popup-predicates: the predicate function for completion menu, completion menu popup after all the functions passlsp-bridge-completion-stop-commands: completion menu will not popup if these commands are executedlsp-bridge-completion-hide-characters: completion menu will not popup when cursor after those characterslsp-bridge-lookup-doc-tooltip-font-height: The font height of function documentation, default is 130acm-enable-doc: Whether the complete menu display the help documentacm-enable-icon: Whether the complete menu shows the icon, macOS users need to add option--with-rsvgto the brew command to install emacs to display SVG iconacm-enable-tabnine: Enable tabnine support， enable by default，when enable need executelsp-bridge-install-tabninecommand to install TabNine, and it can be used. TabNine will consume huge CPUs, causing your entire computer to be slow. If the computer performance is not good, it is not recommended to enable this optionacm-enable-search-file-words: Whether the complete menu display the word of the file, enable by defaultacm-enable-quick-access: Whether the index is displayed behind the icon, you can quickly select the candidate through Alt + Number, disable by defaultacm-enable-yas: yasnippet completion, enable by defaultacm-enable-citre: citre completion, disable by defaultacm-doc-frame-max-lines: Max line number of help documentation, default is 20acm-snippet-insert-index: The display position of snippet candidate in the complementary menuacm-candidate-match-function: The complete menu matching algorithm, the algorithm prefix of orderless-* needs to be installed additional orderlessacm-backend-lsp-candidate-min-length: The minimum characters to trigger completion, default is 0acm-backend-lsp-enable-auto-import: automatic insert import code, enable by defaultacm-backend-lsp-candidate-max-length: Maximum length of LSP candidate, some language, such as Java, argument list is very long, you can increase the value of this option to see clear argument listacm-backend-yas-candidates-number: yasnippet display number，2 by defaultacm-backend-citre-keyword-complete: Completion is performed according to the keywords of each mode defined byacm-backend-citre-keywords-alist, which takes effect only after citre is enabled.acm-backend-search-sdcv-words-dictionary: StarDict dictionary for word completion, default iskdic-ec-11w, you can replace it with StarDict dictionary path, example, if you have dictionary/usr/share/stardict/dic/stardict-oxford-gb-formated-2.4.2/oxford-gb-formated.ifo, you need set this value to/usr/share/stardict/dic/stardict-oxford-gb-formated-2.4.2/oxford-gb-formated, not include.ifoextension.
The default configuration of for each language server is stored at lsp-bridge/langserver.
In most cases, you can customize server configuration with the following priority:
lsp-bridge-get-single-lang-server-by-project: The user custom function, the input parameter isproject-pathandfile-path, return the corresponding LSP server string, you can query all LSP servers in the list oflsp-bridge-single-lang-server-mode-listoption, this function return nil defaultlsp-bridge-single-lang-server-extension-list: load server configuration based on file extension, such as, we launchwxmlserver when open *.wxml filelsp-bridge-single-lang-server-mode-list: load server configuration based on major-mode
If you are writing JavaScript code, you may need to customize multi-server configuration:
lsp-bridge-get-multi-lang-server-by-project: The user custom function, the input parameter isproject-pathandfile-path, return the multi-server configuration name, you can find configuration name in the subdirectory lsp-bridge/multiserverlsp-bridge-multi-lang-server-extension-list: Return multi-server configuration name according to the expansion of the file, for example, when opening the *.vue file, we will use thevolarandemmet-lsto provide completion servicelsp-bridge-multi-lang-server-mode-list: Return the corresponding multi-server configuration name according to Emacs's major-mode
For example, we can enable the Deno LSP server for the Deno script with the following configuration:
(setq lsp-bridge-get-single-lang-server-by-project
(lambda (project-path filepath)
;; If typescript file include deno.land url, then use Deno LSP server.
(save-excursion
(when (string-equal (file-name-extension filepath) "ts")
(dolist (buf (buffer-list))
(when (string-equal (buffer-file-name buf) filepath)
(with-current-buffer buf
(goto-char (point-min))
(when (search-forward-regexp (regexp-quote "from \"https://deno.land") nil t)
(return "deno")))))))))- Create configuration file under lsp-bridge/langserver, such as
pyright.jsonfor pyright (windows user please usespyright_windows.json, macOS user please usespyright_darwin.json). - Add
(mode . server_name)tolsp-bridge-single-lang-server-mode-listinlsp-bridge.el, such as(python-mode . "pyright"). - Add new mode-hook to
lsp-bridge-default-mode-hooksinlsp-bridge.el. - Add new mode indent to
lsp-bridge-formatting-indent-alistinlsp-bridge.el.
Welcome to send PR to help us improve support for LSP servers, thanks for your contribution!
You need to install the LSP server corresponding to each programming language, then lsp-bridge can provide code completion service.
| Index | LSP Server | Language | Note |
|---|---|---|---|
| 1 | clangd | c, c++, object-c | |
| 2 | pyright | python | pip install pyright |
| 3 | solargraph | ruby | |
| 4 | rust-analyzer | rust | |
| 5 | elixirLS | elixir | please ensure that the elixir-ls release directory is in your system PATH at first |
| 6 | gopls | go | make sure install go-mode and gopls in PATH, please do ln -s ~/go/bin/gopls ~/.local/bin, and do go mod init first |
| 7 | hls | haskell | |
| 8 | dart-analysis-server | dart | |
| 9 | metals | scala | |
| 10 | typescript | typescript, javascript | |
| 11 | ocamllsp | ocaml | |
| 12 | erlang-ls | erlang | |
| 13 | texlab | latex | |
| 14 | eclipse.jdt.ls | java | please ensure that org.eclipse.jdt.ls.product/target/repository/bin is in your system PATH at first |
| 15 | clojure-lsp | clojure | if you use homebrew , please ensure install clojure-lsp/brew/clojure-lsp-native clojure-lsp-native |
| 16 | bash-language-server | bash | |
| 17 | volar | vue | npm install -g typescript @volar/vue-language-server -g |
| 18 | sumneko | lua | please ensure bin under sumneko installation is in your system PATH at first |
| 19 | wxml-language-server | wxml | |
| 20 | vscode-html-language-server | html | |
| 21 | vscode-css-language-server | css | |
| 22 | elm-language-server | elm | |
| 23 | intelephense | php | |
| 24 | yaml-language-server | yaml | npm install -g yaml-language-server |
| 25 | zls | zig | execute zls config to generate configuration for zls. see Configuration Options |
| 26 | groovy-language-server | groovy | Create a script "groovy-language-server" in PATH, with $JAVA_HOME/bin/java -jar <path>/groovy-language-server-all.jar |
| 27 | docker-language-server | Dockerfiles | |
| 28 | serve-d | d | serve-d does not support single file mode, please init .git repository under project root at first or custom lsp-bridge-get-project-path-by-filepath function |
| 29 | fortls | Fortran | |
| 30 | ccls | c, c++, object-c | lsp-bridge-c-lsp-server set to ccls |
| 31 | jedi | python | lsp-bridge-python-lsp-server set to jedi |
| 32 | emmet-ls | html, js, css, sass, scss, less | |
| 33 | rnix-lsp | nix | |
| 34 | digestif | latex | lsp-bridge-tex-lsp-server set to digestif |
| 35 | rlanguageserver | R | |
| 36 | graphql-lsp | GraphQL | |
| 37 | microsoft-python-language-server | Python | legacy language server for Python2 |
| 38 | cmake-language-server | cmake | pip install cmake-language-server |
| 39 | Wen | org-mode | pip install pygls pypinyin |
| 40 | sourcekit-lsp | swift | The SourceKit-LSP server is included with the Swift toolchain. |
| 41 | omnisharp | c# | OmniSharp is a .NET development platform based on Roslyn workspaces. use M-x lsp-bridge-install-omnisharp to install it |
| 42 | deno | Deno | Deno runtime use TypeScript as source code, you need customize option lsp-bridge-get-single-lang-server-by-project that return result "deno" when project-path match Deno project. |
| 43 | Phpactor | php | lsp-brige-php-lsp-server set to phpactor |
| 44 | pylsp | python | lsp-bridge-python-lsp-server set to pylsp |
The goal of lsp-bridge is to become the fastest LSP client in Emacs, not a complete implementation of LSP protocol.
Emacs can do better for the following tasks, we will not reinvent the wheel in lsp-bridge:
- Syntax highlighting: Tree-sitter is a wonderful incremental parsing library for syntax highlighting.
- Xref: Xref's mechanism is synchronous, but lsp-bridge is completely asynchronous. Please use the
lsp-bridge-find-referencesto view the code references.
The following is the framework of lsp-bridge:
The following is the directory structure of the lsp-bridge project:
| File | Explanation |
|---|---|
| lsp-bridge.el | Elisp main logic part that provides custom options and elisp functions for python sub-process calls like code jumping, renaming, etc. |
| lsp-bridge-epc.el | Communicating with lsp-bridge python sub-process, which mainly implements elisp IPC to connect to python EPC for data serialization, sending, receiving, and deserialization |
| lsp-bridge-ref.el | Framework of code referencing, providing references viewing, batch renames, regex filtering of reference results, etc. The core code is forked from color-rg.el |
| lsp-bridge-jdtls.el | Provide java language third-party library jumping function |
| lsp-bridge-lsp-installer.el | Install TabNine and Omnisharp |
| lsp-bridge.py | Python main logic part that provides event loop, message scheduling and status management |
| acm/acm.el | Asynchronous completion menu, specially designed for lsp-bridge backend, supports LSP, elisp, words, TabNine and other backend |
| core/fileaction.py | Tracking the status of each file, processing LSP response messages, calling Emacs elisp function |
| core/lspserver.py | LSP message processing module, mainly to analyze, send and receive LSP messages, and ensure that the sequence of LSP requests conforms with the LSP protocol specification |
| core/utils.py | Utility functions of convenience for each module call |
| core/mergedeep.py | JSON information merger is mainly used to send custom options to LSP server |
| core/hanlder/ | The implementation of sending and receiving LSP message, where init.py is a base class |
| langserver | The configurations of the LSP servers, each server corresponding to a JSON file that defines the name of the server, language ID, starting command, options, etc. |
Please read below articles first:
Then turn on develop option lsp-bridge-enable-log and happy hacking! ;)
Please use emacs -q and load a minimal setup with only lsp-bridge to verify that the bug is reproducible. If emacs -q works fine, probably something is wrong with your Emacs config.
If the problem still exists, please report it here with *lsp-bridge* buffer content, it contains many clues that can help us locate the problem faster.
If you get a segfault error, please use the following way to collect crash information:
- Install gdb and turn on option
lsp-bridge-enable-debug - Use the command
lsp-bridge-stop-processto stop the current process - Restart lsp-bridge, send issue with
*lsp-bridge*buffer content when next crash
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent