Skip to content

Latest commit

 

History

History
516 lines (434 loc) · 72.6 KB

README.md

File metadata and controls

516 lines (434 loc) · 72.6 KB
Raw

Installation • Support languages • Keymaps • Customize options • Join development

lsp-bridge

The goal of lsp-bridge is use multi-thread technology to implement the fastest LSP client in the Emacs ecosystem.

Advantages of lsp-bridge:

  1. Blazingly fast: Offload LSP request and data analysis to an external process, preventing Emacs from getting stuck due to delays or large data triggering garbage collection
  2. Remote Completion: Built-in support for remote server code completion, with various login methods such as passwords and public keys, supports tramp protocol and jump server
  3. Out of the box: Ready to use immediately after installation, no additional configuration required, no need to tweak with completion frontend, completion backend and multi-backend mix
  4. Multi-server fusion: A simple JSON is all you need to combine multiple LSP Servers into one file that provides services for example Python which offers code completion with Pyright and diagnostic and formatting capabilities with Ruff
  5. Flexible Customization: Customizing LSP server options is as simple as using a JSON file, allowing different projects to have different JSON configurations with just a few lines of rules

The video explains the principle of lsp-bridge

EmacsConf 2022 talk page

Installation

  1. Install Emacs 28 or higher version

  2. Install Python dependencies: pip3 install epc orjson sexpdata six setuptools paramiko rapidfuzz (orjson is optional, orjson is based on Rust, providing faster JSON parsing performance)

  3. Install Elisp dependencies: markdown-mode, yasnippet

  4. Download this repository using git clone, and replace the load-path path in the configuration below.

  5. Add the following code to your configuration file ~/.emacs:

(add-to-list 'load-path "<path-to-lsp-bridge>")

(require 'yasnippet)
(yas-global-mode 1)

(require 'lsp-bridge)
(global-lsp-bridge-mode)

To use terminal mode, please install acm-terminal. However, it's essential to note that acm-terminal may potentially cause compatibility issues due to modifications made to the acm.el code by me. Should such an occurrence arise, you can report any problems as an issue in the repository of acm-terminal, as its creator is a highly skilled developer who will swiftly address any compatibility issues.

  • If you are using straight to install, you should use the following configuration to install:
(use-package lsp-bridge
  :straight '(lsp-bridge :type git :host github :repo "manateelazycat/lsp-bridge"
            :files (:defaults "*.el" "*.py" "acm" "core" "langserver" "multiserver" "resources")
            :build (:not compile))
  :init
  (global-lsp-bridge-mode))
  • If you are using doom-emacs

add this to your packages.el

(when (package! lsp-bridge
        :recipe (:host github
                 :repo "manateelazycat/lsp-bridge"
                 :branch "master"
                 :files ("*.el" "*.py" "acm" "core" "langserver" "multiserver" "resources")
                 ;; do not perform byte compilation or native compilation for lsp-bridge
                 :build (:not compile)))
  (package! markdown-mode)
  (package! yasnippet))

and add this to your config.el

(use-package! lsp-bridge
  :config
  (setq lsp-bridge-enable-log nil)
  (global-lsp-bridge-mode))

and run doom sync to install it.

If you are unable to use normally after installing it, please read Report bug first

Please note:

  1. When using lsp-bridge, please first disable other completion plugins, such as lsp-mode, eglot, company, corfu, etc. lsp-bridge provides a complete solution from the completion backend, completion frontend to multi-backend integration
  2. In addition to providing LSP completion, lsp-bridge also provides many non-LSP completion backends, including file words, paths, Yas/Tempel, TabNine, Codeium, Copilot, Citre, Tailwind, Ctags, Org roam and other completion backends. If you expect to provide these completions in a certain mode, please add the corresponding mode to lsp-bridge-default-mode-hooks
  3. Please do not perform byte compilation or native compilation for lsp-bridge as it will result in a difference in API and the latest version after upgrading compiling afterwards, Lsp-bridge is designed with multi-threading that does not require compilation to speed it up

Local Usage

Lsp-bridge works out of the box. After installing the corresponding LSP server and mode plugin for the language, you can start coding directly without any additional settings.

It should be noted that lsp-bridge has three scanning modes:

  1. Determine the project's root directory by searching upward for a .git or .dir-locals.el file, thereby providing completion for the entire project directory.
  2. If a .git or .dir-locals.el file is not found, lsp-bridge will only provide single file completion for the opened file.
  3. You can also tell lsp-bridge the root directory of the project by customizing the lsp-bridge-get-project-path-by-filepath function. This function takes the path string of the opened file as the input parameter and outputs the project directory path.

Remote Usage

lsp-bridge can perform code syntax completion on files on a remote server, similar to VSCode. The configuration steps are as follows:

  1. Install lsp-bridge and the corresponding LSP Server on the remote server.
  2. Start lsp-bridge: python3 lsp-bridge/lsp_bridge.py.
  3. Use the lsp-bridge-open-remote-file command to open files, entering the username, IP, SSH port (default 22), and path, such as user@ip:[ssh_port]:/path/file
  4. Enabling the lsp-bridge-enable-with-tramp option allows direct opening of tramp files, using the efficient algorithm of lsp-bridge instead of tramp, achieving smooth completion. If the host in tramp is defined in ~/.ssh/config, lsp-bridge can synchronize the following options for remote connection:
    • HostName (must be in IP format, domain format may cause issues)
    • User
    • Port
    • GSSAPIAuthentication
    • ProxyCommand (currently only supports ProxyCommand option, does not support ProxyJump option)
  5. (setq lsp-bridge-remote-start-automatically t) can automatically start the lsp_bridge.py process on the remote host (which needs to support bash) when opening a tramp file, and it will also automatically close the process when quitting emacs. When using this feature, the following options need to be correctly set:
    • lsp-bridge-remote-python-command: the name of the python command on the remote host
    • lsp-bridge-remote-python-file: the full path of lsp_bridge.py on the remote host
    • lsp-bridge-remote-log: the full path for log output of lsp_bridge.py on the remote host

Principle of remote completion:

  1. Log in to the server with SSH authentication, access and edit files.
  2. When editing a replica of a remote file, real-time diff sequences will be sent to lsp-bridge, and the server side will use these sequences to rebuild the file and calculate the completion data by the remote LSP Server.
  3. The remote LSP Server will send back the completion data to the local side, and Emacs will display the completion menu.

Note:

  1. If the completion menu is not displayed, check the output of lsp_bridge.py on the remote server, it may be that the LSP Server is not fully installed.
  2. lsp-bridge will use the first *.pub file in ~/.ssh as a login credential. If public key login fails, you will be asked to enter a password. lsp-bridge will not store the password, it is recommended to use public key login to avoid repeated password entry.
  3. To run lsp_bridge.py successfully you need to completely download the entire git repository of lsp-bridge on a remote server, and switch into its directory, lsp_bridge.py requires other files to function properly, so copying only the lsp_bridge.py file can't work
  4. If a tramp file encounters an lsp-bridge connection error, you can execute the lsp-bridge-tramp-show-hostnames function and then check if the output of the host configuration options meets expectations

Keymap

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 + v acm-select-next-page Select next page candidate
Alt + v acm-select-prev-page Select previous page 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 + u acm-filter Performing second-level filtering on candidate words, similar to the fuzzy search feature in other auto-complete frontends
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
Alt + Number acm-complete-quick-access Selecting candidate quickly, need to enable acm-enable-quick-access first
Number acm-complete-quick-access Selecting candidate (even more) quickly, need both acm-enable-quick-access and acm-quick-access-use-number-select enabled

Commands

  • lsp-bridge-find-def: jump to the definition
  • lsp-bridge-find-def-other-window: jump to the definition in other-window
  • lsp-bridge-find-def-return: return to the location before calling lsp-bridge-find-def
  • lsp-bridge-find-type-def: Jump to the position of type definition.
  • lsp-bridge-find-type-def-other-window: Jump to the position of type definition in another window.
  • lsp-bridge-find-impl: jump to the implementation
  • lsp-bridge-find-impl-other-window: jump to the implementation in other-window
  • lsp-bridge-find-references: traverse across code references (forked from color-rg.el)
  • lsp-bridge-popup-documentation: lookup documentation of symbol under the cursor
  • lsp-bridge-popup-documentation-scroll-up: scroll up popup document.
  • lsp-bridge-popup-documentation-scroll-down: scroll down popup document.
  • lsp-bridge-show-documentation: lookup documentation of symbol under the cursor, but using a buffer instead
  • lsp-bridge-rename: rename symbol under the cursor
  • lsp-bridge-diagnostic-jump-next: Jump to the next diagnostic position
  • lsp-bridge-diagnostic-jump-prev: Jump to the previous diagnostic position
  • lsp-bridge-diagnostic-list: List all diagnostic information
  • lsp-bridge-diagnostic-copy: Copy the current diagnostic information to the clipboard
  • lsp-bridge-code-action: Popup code action menu, you can pass special actin-kind to fix, action-kind can use one of "quickfix", "refactor", "refactor.extract", "refactor.inline", "refactor.rewrite", "source", "source.organizeImports", "source.fixAll"
  • lsp-bridge-workspace-list-symbol-at-point: Finds the definition of a symbol at the cursor point
  • lsp-bridge-workspace-list-symbols: List all symbols in workspace and jump to the symbol definition
  • lsp-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 option lsp-bridge-complete-manually
  • lsp-bridge-restart-process: restart lsp-bridge process (only used for development)
  • lsp-bridge-toggle-sdcv-helper: Switch dictionary completion assistant
  • lsp-bridge-peek-abort: Close peek window (default binding to C-g)
  • lsp-bridge-peek-list-next-line: Select the next definition or reference (default binding to M-S-n)
  • lsp-bridge-peek-list-prev-line: Select the previous definition or reference (default binding to M-S-p)
  • lsp-bridge-peek-file-content-next-line: Scroll down one line in the peek window file content (default binding to M-n)
  • lsp-bridge-peek-file-content-prev-line: Scroll up one line in the peek window file content (default binding to M-p)
  • lsp-bridge-peek-jump: Jump to the location of the definition or reference (default binding to M-l j)
  • lsp-bridge-peek-jump-back: Jump back to the original position (default bound to M-l b)
  • lsp-bridge-peek-through: View one symbol in the peek window
  • lsp-bridge-peek-tree-previous-branch: Select the previous branch at the same level in the browsing history (default binding to <up>)
  • lsp-bridge-peek-tree-next-branch: Select the next branch at the same level in the browsing history (default binding to <down>)
  • lsp-bridge-peek-tree-previous-node: Select the previous higher-level node in the browsing history (default binding to <left>)
  • lsp-bridge-peek-tree-next-node: Select the next lower-level node in the browsing history (default binding to <right>)
  • lsp-bridge-indent-left: Indents the pasted text to the left according to the indent values defined in lsp-bridge-formatting-indent-alist
  • lsp-bridge-indent-right: Indents the pasted text to the right according to the indent values defined in lsp-bridge-formatting-indent-alist
  • lsp-bridge-semantic-tokens-mode: Enables or disables semantic token highlighting, please ref to Semantic Tokens Wiki

Customize language server configuration

The configuration for the LSP server of each language in lsp-bridge is stored in lsp-bridge/langserver.

In most cases, you can customize the server configuration according to the following priority order:

  1. lsp-bridge-get-single-lang-server-by-project: A user-defined function that takes project-path and file-path as input parameters and returns the corresponding LSP server string. You can query the names of all LSP servers in the lsp-bridge-single-lang-server-mode-list list. By default, this function returns nil.
  2. lsp-bridge-single-lang-server-extension-list: Returns the server based on the file extension, for example, when opening a *.wxml file, we will use the wxml LSP server for completion.
  3. lsp-bridge-single-lang-server-mode-list: Returns the corresponding server based on Emacs’s major-mode.

If you are writing JavaScript code, you may need to customize multiple server configurations:

  1. lsp-bridge-get-multi-lang-server-by-project: A user-defined function that takes project-path and file-path as input parameters and returns the multiple server configuration names. You can search for them in the subdirectory lsp-bridge/multiserver.
  2. lsp-bridge-multi-lang-server-extension-list: Returns multiple server configuration names based on the file extension. For example, when opening a *.vue file, we will use volar_emmet to simultaneously utilize volar and emmet-ls for completion.
  3. lsp-bridge-multi-lang-server-mode-list: Returns the corresponding multiple server configuration names based on Emacs’s major-mode.

For example, we can enable the Deno LSP server for Deno scripts with the following configuration:

(setq lsp-bridge-get-multi-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")))))))))

Customize language server configuration file

Copy the configuration files in lsp-bridge/langserver or lsp-bridge/multiserver to lsp-bridge-user-langserver-dir or lsp-bridge-user-multiserver-dir for customization. Lsp-bridge will prioritize reading the configuration files in lsp-bridge-user-langserver-dir or lsp-bridge-user-multiserver-dir.

We can set the value of lsp-bridge-user-langserver-dir or lsp-bridge-user-multiserver-dir before starting lsp-bridge-mode to achieve different project-specific configuration files.

(defun enable-lsp-bridge()
  (when-let* ((project (project-current))
              (project-root (nth 2 project)))
    (setq-local lsp-bridge-user-langserver-dir project-root
                lsp-bridge-user-multiserver-dir project-root))
  (lsp-bridge-mode))

LSP server options

lsp-bridge provides support for more than two language servers for many languages. You can customize the following options to choose the language server you prefer:

  • lsp-bridge-c-lsp-server: C language server, you can choose clangd orccls
  • lsp-bridge-elixir-lsp-server: Elixir language server, you can choose elixirLS(default) orlexical
  • lsp-bridge-python-lsp-server: Python language server, you can choose pyright, jedi, python-ms, pylsp, ruff, it's important to note that lsp-bridge-multi-lang-server-mode-list has a higher priority than lsp-bridge-single-lang-server-mode-list. If you only want to use a single server, please first remove the python-mode setting from lsp-bridge-multi-lang-server-mode-list.
  • lsp-bridge-php-lsp-server: PHP language server, you can choose intelephense or phpactor
  • lsp-bridge-tex-lsp-server: LaTeX language server, you can choose texlab ordigestif
  • lsp-bridge-csharp-lsp-server: C# language server, you can choose omnisharp-mono oromnisharp-dotnet, note that you need to give execute permissions to the OmniSharp file
  • lsp-bridge-python-multi-lsp-server: Python multi-language servers, you can choose pyright_ruff, jedi_ruff, python-ms_ruff, pylsp_ruff
  • lsp-bridge-nix-lsp-server: Nix language server, you can choose rnix-lsp or nil
  • lsp-bridge-markdown-lsp-server: Markdown language server, you can choose vale-ls or nil

Options

  • lsp-bridge-python-command: The path of the python command, if you use conda, you may customize this option. Windows platform using python.exe rather than python3, if lsp-bridge can’t work, try set to python3
  • lsp-bridge-complete-manually: Only popup completion menu when user call lsp-bridge-popup-complete-menu command, default is nil
  • lsp-bridge-enable-with-tramp: When this option is enabled, lsp-bridge provides remote autocompletion support for files opened by tramp. It requires the lsp_bridge.py to be installed and started on the server side in advance. Note that this option only uses tramp to open files, it does not use tramp technology to implement autocompletion, because the implementation principle of tramp has serious performance issues. 'One should note that if you usually use the command lsp-bridge-open-remote-file, you need to disable the option lsp-bridge-enable-with-tramp to ensure that the file opened by the command can correctly jump to the definitions or references.
  • lsp-bridge-remote-save-password: Saves the password for remote editing to the netrc file, disabled by default
  • lsp-bridge-remote-heartbeat-interval: Interval for sending heartbeat to server in seconds, disabled by default, set it to a suitable value for your server sshd if you want to keep the connection alive after a long idle time.
  • lsp-bridge-get-workspace-folder: You need to put multiple project in a workspace directory in Java before you can jump function defintion normally. This function can be customized, the function input is the project path and returns the workspace directory corresponding
  • lsp-bridge-default-mode-hooks: The list of modes that automatically start lsp-bridge, you can customize this option to control the scope of starting lsp-bridge
  • lsp-bridge-org-babel-lang-list: list of language to support org-mode code block completion, nil enable all languages, default is nil
  • lsp-bridge-find-def-fallback-function: When LSP cannot find a definition, you can customize this function for candidate jumping, such as binding the citre function
  • lsp-bridge-find-ref-fallback-function: When LSP cannot find a reference, you can customize this function for candidate jumping, such as binding the citre function
  • lsp-bridge-find-def-select-in-open-windows: If this option is turned on, when searching for function definitions, already open windows will be selected instead of switching buffers. disable by default
  • lsp-bridge-enable-completion-in-string: Enable completion pop-up within strings, default is off
  • lsp-bridge-enable-completion-in-minibuffer: Enable pop-completion up in Minibuffer, disabled by default
  • lsp-bridge-enable-diagnostics: code diagnostic, enable by default
  • lsp-bridge-enable-inlay-hint: inlay hint, disable by default, this option is use for strong type language, such as, Rust
  • lsp-bridge-enable-hover-diagnostic: show diagnostic tooltip when cursor hover diagnostic place, disable by default
  • lsp-bridge-enable-search-words: index the word of the file, enable by default
  • lsp-bridge-enable-auto-format-code: automatic format code, disable by default
  • lsp-bridge-enable-signature-help: show function parameter in minibufer, enable by default
  • lsp-bridge-enable-log: enable LSP message log, disable by default, only enable this option for development purposes, usually do not turn on this option to avoid affecting performance
  • lsp-bridge-enable-debug: enable program debugging, disable by default
  • lsp-bridge-disable-backup: forbidden version manage of emacs, enable by default
  • lsp-bridge-code-action-enable-popup-menu: enable code action popup menu, enable by default
  • lsp-bridge-diagnostic-fetch-idle: diagnostic delay, start pulling diagnostic information 0.5 second after stopping typing
  • lsp-bridge-signature-show-function: The function used for displaying signature info, default show message in minibuffer, set lsp-bridge-signature-show-with-frame to show signature info in frame
  • lsp-bridge-signature-show-with-frame-position: When using lsp-bridge-signature-show-with-frame to display signature information, this option defines the position of the pop-up signature information, the default is "bottom-right", you can also choose "top-left", "top-right", "bottom-left", "point"
  • lsp-bridge-completion-popup-predicates: the predicate function for completion menu, completion menu popup after all the functions pass
  • lsp-bridge-completion-stop-commands: completion menu will not popup if these commands are executed
  • lsp-bridge-completion-hide-characters: The default value is ‘(":" ";" "(" ")" "[" "]" "{" "}" ", " "\""), the completion menu does not pop up when the cursor is behind these characters. You can customize this option to remove this restriction, or call the lsp-bridge-popup-complete-menu command to force the menu to pop up. To make this option works, you need to set lsp-bridge-completion-obey-trigger-characters-p to nil.
  • lsp-bridge-user-langserver-dir: the dir where user place langserver configuration file, if the configuration file name in the dir is the same as that in lsp-bridge/langserver , lsp-bridge will use the configuration file in this dir
  • lsp-bridge-user-multiserver-dir: the dir where user place multiserver configuration file, if the configuration file name in the dir is the same as that in lsp-bridge/multiserver , lsp-bridge will use the configuration file in this dir
  • lsp-bridge-symbols-enable-which-func: Using lsp backend for which-func, disable by default
  • lsp-bridge-enable-org-babel: Use lsp completion in org babel, disable by default
  • lsp-bridge-peek-file-content-height: Display how many lines of file content in peek windows
  • lsp-bridge-peek-file-content-scroll-margin: Set how many lines of file content should be scroll up and down.
  • lsp-bridge-peek-list-height: Select the next option for definition and reference
  • lsp-bridge-peek-ace-keys: Keys to press when performing lsp-bridge-peek-through
  • lsp-bridge-peek-ace-cancel-keys: Keys to exit lsp-bridge-peek-through
  • acm-frame-background-dark-color: Menu background color in dark theme
  • acm-frame-background-light-color: Menu background color in light theme
  • acm-enable-doc: Whether the complete menu display the help document
  • acm-enable-doc-markdown-render: Richly render Markdown for completion popups, you can choose 'async, t or nil. When set to 'async, styles are applied asynchronously, choose t, styles are applied synchronously and will slow down the completion speed, default is 'async
  • acm-enable-icon: Whether the completion menu displays icons (Many macOS users have reported that emacs-plus28 cannot display icons properly, showing colored squares instead. There are two ways to solve this: install Emacs Mac Port or add the --with-rsvg option to the brew command when compiling Emacs yourself)
  • acm-enable-tabnine: Enable tabnine support， enable by default， when enable need execute lsp-bridge-install-tabnine command 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 option
  • acm-enable-codeium: Enable Codeium support, when enable need execute lsp-bridge-install-update-codeium command to install Codeium, then execute lsp-bridge-codeium-auth command to get auth token and execute lsp-bridge-codeium-input-auth-token command to get API Key, and it can be used.
  • acm-enable-copilot: Enable copilot support, firstly, purchase the Copilot service by https://github.com/features/copilot , when enable need install agent first npm install -g copilot-node-server, then execute lsp-bridge-copilot-login, lsp-bridge will display User Code in the Minibuffer, copy the User Code to the opened Copilot page to complete the login.
  • acm-enable-search-file-words: Whether the complete menu display the word of the file, enable by default
  • acm-enable-quick-access: Whether to display an index after the icon, quickly select candidate words using Alt + Number, default is off
  • acm-quick-access-use-number-select: Whether to use number keys for quick selection of candidate words, default is off, turning on this option may sometimes interfere with number input or accidentally select candidate words
  • acm-enable-yas: yasnippet completion, enable by default
  • acm-enable-citre: Integration with citre(ctags). Enable this to add citre (ctags) backend (disabled by default)
  • acm-doc-frame-max-lines: Max line number of help documentation, default is 20
  • acm-candidate-match-function: lsp-bridge frontend filter algorithm for candidates, options include 'regexp-quote, 'orderless-flex, 'orderless-literal, 'orderless-prefixes, 'orderless-regexp, 'orderless-initialism, default is regexp-quote, orderless-* started algorithms require additional installation of orderless
  • acm-completion-backend-merge-order: Customize the order of the completion backends, default order is: first part of mode candidate, first part of template candidates, tabnine/copilot/codeium, second part of template candidates, second part of mode candidates, set acm-completion-mode-candidates-merge-order customize mode candidates order
  • acm-completion-mode-candidates-merge-order: Customize the order of the mode candidates, the display order for mode candidates, default order: Elisp、 LSP、 Jupyter、 Ctags、 Citre、 ROAM、 Word、 Telegra
  • acm-backend-lsp-candidate-min-length: The minimum characters to trigger lsp completion, default is 0
  • acm-backend-lsp-block-kind-list: Filters certain types of LSP completion candidates. By default, it's a empty list. When the value is set to '(Snippet Enum), this means that Snippet and Enum completions will not be shown.
  • acm-backend-elisp-candidate-min-length: The minimum characters to trigger elisp completion, default is 0
  • acm-backend-yas-candidate-min-length: The minimum characters to trigger yasnippet completion, default is 0
  • acm-backend-search-file-words-candidate-min-length: The minimum characters to trigger search file words completion, default is 0
  • acm-backend-search-file-words-max-number: Search Words completion candidate limit, default is 10
  • acm-backend-search-file-words-enable-fuzzy-match: Search Words completion candidate fuzzy match, disable by default
  • acm-backend-search-file-words-enable-fuzzy-match-threshold: Search Words completion candidate fuzzy match threshold, Filter out words with a ratio lower than the threshold, default is 50
  • acm-backend-codeium-candidate-min-length: The minimum characters to trigger codeium completion, default is 0
  • acm-backend-lsp-enable-auto-import: Automatic insert import code, enable by default
  • acm-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 list
  • acm-backend-yas-candidates-number: yasnippet display number， 2 by default
  • acm-backend-citre-keyword-complete: Completion is performed according to the keywords of each mode defined by acm-backend-citre-keywords-alist, which takes effect only after citre is enabled.
  • acm-backend-search-sdcv-words-dictionary: StarDict dictionary for word completion, default is kdic-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 .ifo extension.
  • acm-backend-lsp-match-mode: The filtering mode for candidates in LSP backend, there are three options: "prefix", "prefixCaseSensitive", and "fuzzy". By default it is "fuzzy"
  • acm-backend-lsp-frontend-filter-p: Since LSP candidates have been filtered in the Python backend, it's not necessary to perform an additional filter on the frontend (refer to option acm-candidate-match-function), disable by default, when set to t, this option will call the acm-candidate-match-function function on the frontend to filter LSP candidates again
  • acm-backend-lsp-show-progress: show working progress, disable by default
  • acm-enable-preview: enable Tab-and-Go completion, commands like acm-select-* will select and preview other candidate and further input will then commit this candidate, disable by default

Add support for new language?

  1. Create a configuration file in the lsp-bridge/langserver directory. For example, pyright.json is the configuration file for the pyright server (use pyright_windows.json for Windows and pyright_darwin.json for macOS).
  2. Add (mode . server_name) to the lsp-bridge-single-lang-server-mode-list option in the lsp-bridge.el file, for example, (python-mode . "pyright").
  3. Add a new mode-hook to the lsp-bridge-default-mode-hooks option in the lsp-bridge.el file.
  4. Add a new indentation variable to the lsp-bridge-formatting-indent-alist option in the lsp-bridge.el file.

We welcome patches to help us support more LSP servers. Thank you for your help!

Supported language servers

You need to install the LSP server corresponding to each programming language, then lsp-bridge can provide code completion service.

If your language supports mixed multi-language servers, it is recommended to check the multi-language server definition under multiserver, and install multiple LSP servers to get a more complete experience. For example, for the Python language, according to the default pyright-background-analysis_ruff.json definition, you should install pyright and ruff.

Language LSP Server Note
Ansible ansible-language-server Ansible uses YAML as source code, you’ll need to customize lsp-bridge-get-single-lang-server-by-project to return "ansible-language-server".
Astro astro npm i -g @astrojs/language-server
Bash bash-language-server
Beancount beancount-language-server cargo install beancount-language-server
Clojure clojure-lsp If you use homebrew , please ensure install clojure-lsp/brew/clojure-lsp-native clojure-lsp-native
Cmake cmake-language-server pip install cmake-language-server
CSS emmet-ls npm install -g emmet-ls
vscode-css-language-server npm i -g vscode-langservers-extracted
C# omnisharp-dotnet OmniSharp is a .NET development platform based on Roslyn workspaces. use M-x lsp-bridge-install-omnisharp to install it. lsp-bridge-csharp-lsp-server set to omnisharp-dotnet (6.0)
omnisharp-mono OmniSharp is a .NET development platform based on Roslyn workspaces. use M-x lsp-bridge-install-omnisharp to install it. lsp-bridge-csharp-lsp-server set to omnisharp-mono
C++ clangd You need to configure compile_commandsjson or CMakeListstxt files in root directory of project
ccls lsp-bridge-c-lsp-server set to ccls, you need to configure compile_commands.json first
C clangd You need to configure compile_commandsjson or CMakeListstxt files in root directory of project
ccls lsp-bridge-c-lsp-server set to ccls, you need to configure compile_commands.json first
D serve-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
Dart dart-analysis-server
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.
Dockerfiles docker-language-server
Elixir elixirLS Please ensure that the elixir-ls release directory is in your system PATH at first
lexical Kindly make sure that the lexical release directory is included in your system’s PATH and that lexical has been compiled using the same version of Elixir/Erlang as your project.
Elm elm-language-server
Erlang erlang-ls
Fortran fortls
F# fsautocomplete
Go gopls Make sure install go-mode and gopls in PATH, please do ln -s ~/go/bin/gopls ~/.local/bin, and do go mod init first
GraphQL graphql-lsp
Groovy groovy-language-server Create a script "groovy-language-server" in PATH, with $JAVA_HOME/bin/java -jar <path>/groovy-language-server-all.jar
Haskell hls
HTML emmet-ls npm install -g emmet-ls
vscode-html-language-server npm i -g vscode-langservers-extracted
Java eclipse.jdt.ls Please ensure that org.eclipse.jdt.ls.product/target/repository/bin is in your system PATH at first, please see the details at Wiki
Javascript typescript
vscode-eslint-language-server npm i -g vscode-langservers-extracted
JSON vscode-json-language-server npm i -g vscode-langservers-extracted
Julia julials
Kotlin kotlin-language-server If you want Inlay Hints feature, you need build with source code to return Inlay Hint information
Latex digestif lsp-bridge-tex-lsp-server set to digestif
texlab lsp-bridge-tex-lsp-server set to texlab
LESS emmet-ls npm install -g emmet-ls
Lua sumneko Please ensure bin under sumneko installation is in your system PATH at first
Markdown vale-ls Install vale first, then use cargo build and install vale-ls from github, and make sure vale-ls in PATH
Mojo mojo modular install mojo-lsp-server
Move move-analyzer The move-analyzer is included in the move language repository
Nickel nls cargo add nickel-lang-lsp
Nix nil lsp-bridge-nix-lsp-server set to nil
rnix-lsp lsp-bridge-nix-lsp-server set to rnix-lsp
Object-C clangd You need to configure compile_commandsjson or CMakeListstxt files in root directory of project
ccls lsp-bridge-c-lsp-server set to ccls, you need to configure compile_commands.json first
Ocaml ocamllsp
Org-mode ds-pinyin cargo install ds-pinyin-lsp, download dict.db3 of ds-pinyin, and save to ~/.emacs.d/ds-pinyin/ directory, then turn on option lsp-bridge-use-ds-pinyin-in-org-mode
Wen pip install pygls pypinyin, then turn on option lsp-bridge-use-wenls-in-org-mode
PHP intelephense npm i intelephense -g
Phpactor lsp-bridge-php-lsp-server set to phpactor
Python jedi lsp-bridge-python-lsp-server set to jedi
pylsp lsp-bridge-python-lsp-server set to pylsp
pyright lsp-bridge-python-lsp-server set to pyright, pyright-background-analysis is faster sometimes, but it can’t response diagnostic informations
python-ms Legacy language server for Python2
ruff pip install ruff-lsp, lsp-bridge-python-lsp-server is set to ruff, which only has the function of linter. If you need to complete the functions, install other Python language servers, and set the lsp-bridge-python-multi-lsp-server to [LSP NAME]_ruff
QML qmlls The qmlls binary should be part of the normal Qt packages since Qt 6.3.0 Ensure that the directory of qmlls binary file is in PATH
R rlanguageserver
Racket racket-langserver
Ruby solargraph
Rust rust-analyzer
SASS emmet-ls npm install -g emmet-ls
Scala metals
SCSS emmet-ls npm install -g emmet-ls
Svelte svelte
Swift sourcekit-lsp The SourceKit-LSP server is included with the Swift toolchain.
Tailwindcss tailwindcss-language-server npm install -g @tailwindcss/language-server , and need config tailwind.config.js follow install manual
Typescript typescript
Typst typst-lsp
Verilog verible
VHDL vhdl-tool
Vue volar npm install -g typescript @vue/language-server
Wxml wxml-language-server
Yaml yaml-language-server npm install -g yaml-language-server
Zig zls Execute zls config to generate configuration for zls. see Configuration Options

Join development

The following is the framework of lsp-bridge:

The following is the directory structure of the lsp-bridge project:

Filename Purpose
lsp-bridge.el The main Elisp logic part of lsp-bridge, providing custom options and Elisp functions for the python subprocess, such as code jump, rename, etc.
lsp-bridge-epc.el Code for communicating with the lsp-bridge python subprocess, mainly implementing Elisp IPC to dock with Python EPC, realizing data serialization, sending, receiving, and deserialization
lsp-bridge-call-hierarchy.el Display the call order relationship of the code in the pop-up Frame
lsp-bridge-code-action.el Code related to code correction
lsp-bridge-diagnostic.el Diagnostic information related code
lsp-bridge-ref.el Code reference viewing framework, providing reference viewing, batch renaming, reference result regular filtering, etc., core code forked from color-rg.el
lsp-bridge-inlay-hint.el Provides code type hints, more useful for static languages, such as Rust or Haskell
lsp-bridge-jdtls.el Provides third-party library jump function for Java language
lsp-bridge-dart.el Provides support for Dart's private protocols, such as Dart's Closing Labels protocol
lsp-bridge-semantic-tokens.el Flexible display of certain semantic symbols is especially useful for static languages such as C or C++.
lsp-bridge-lsp-installer.el Install TabNine and Omnisharp
lsp-bridge-peek.el Use peek windows to view definitions and references, similar to the experience of Code Lens in VSCode
lsp-bridge.py The main Python logic part of lsp-bridge, providing event loops, message scheduling, and status management
acm/acm.el Asynchronous completion menu, designed specifically for the lsp-bridge backend, supporting lsp, elisp, words, TabNine and other backends
core/fileaction.py Mainly records the status of each file, processes LSP response messages, and calls Emacs Elisp functions
core/lspserver.py LSP message processing module, mainly for parsing, sending and receiving LSP messages, and ensuring that LSP requests are in order according to LSP protocol specifications
core/remote_file.py Used to handle remote server file access and synchronization
core/utils.py Some global utility functions, convenient for various modules to call
core/mergedeep.py JSON information merging, mainly used to send custom options to the LSP server
core/handler/ Implementation of LSP message sending and receiving, where __init__.py is the base class
core/tabnine.py TabNine backend search and completion
core/codeium.py Codeium backend search and completion
core/copilot.py Copilot backend search and completion
core/search_file_words.py Asynchronous backend for file word search
core/search_paths.py Asynchronous backend for file path search
core/search_sdcv_words.py English word search backend, can be replaced with StarDict dictionaries of other languages
core/search_list.py Asynchronous search framework, can be used to write your own asynchronous search backend
langserver Mainly places the configuration of the LSP server, each server has a json file, defining the server's name, language ID, startup command, and setting options, etc.
multiserver Mainly places the configuration of multiple LSP servers
resources English dictionary data, mainly serving Chinese users

Please read below articles first:

Then turn on develop option lsp-bridge-enable-log and happy hacking! ;)

Report bug

For some common problems, please read Wiki first.

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:

  1. Turn on option lsp-bridge-enable-log
  2. Use lsp-bridge-restart-process to restart the LSP-BRIDGE process
  3. Report issue 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:

  1. Install gdb and turn on option lsp-bridge-enable-debug
  2. Use the command lsp-bridge-restart-process to restart the LSP-BRIDGE process
  3. Send issue with *lsp-bridge* buffer content when next crash

Contributor

lsp-bridge's rapid development couldn't have been possible without the strong support and selfless contributions from the community's experts. Without the community’s support, lsp-bridge wouldn’t be where it is today. Thank you to the loveliest people in the world, happy hacking ;)