English | 简体中文

lsp-bridge

lsp-bridge 的目标是实现 Emacs 生态中性能最快的 LSP 客户端。

lsp-bridge 使用 Python 多线程技术在 Emacs 和 LSP 服务器之间构建高速缓存，在提供行云流水的代码补全体验的前提下，保证永远不会卡住 Emacs。

安装

1. 安装 Emacs 28 及以上版本
2. 安装 Python 依赖:

• python-epc
• orjson

3. 安装 Elisp 依赖:

• posframe
• markdown-mode
• yasnippet

4. 用 git clone 下载此仓库，并替换下面配置中的 load-path 路径
5. 把下面代码加入到你的配置文件 ~/.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 开箱即用， 安装好语言对应的LSP 服务器和模式插件以后， 直接写代码即可， 不需要额外的设置。

需要注意的是 lsp-bridge 有三种扫描模式：

1. 检测到 .git 目录时(通过命令 git rev-parse --is-inside-work-tree 来判断)， lsp-bridge 会扫描整个目录文件来提供补全
2. 没有检测到 .git 目录时， lsp-bridge 只会对打开的文件提供单文件补全
3. 自定义 lsp-bridge-get-project-path-by-filepath 函数， 输入参数是打开文件的路径字符串， 输出参数是项目目录路径， lsp-bridge 会根据输出目录路径来提供补全

按键

命令列表

• lsp-bridge-find-def: 跳转到定义位置
• lsp-bridge-find-def-other-window: 在其他窗口跳转到定义位置
• lsp-bridge-find-def-return: 返回跳转之前的位置
• lsp-bridge-find-impl: 跳转到接口实现位置
• lsp-bridge-find-impl-other-window: 在其他窗口跳转到接口实现位置
• lsp-bridge-find-references: 查看代码引用
• lsp-bridge-popup-documentation: 查看光标处的文档
• lsp-bridge-popup-documentation-scroll-up: 文档窗口向上滚动
• lsp-bridge-popup-documentation-scroll-down: 文档窗口向下滚动
• lsp-bridge-rename: 重命名
• lsp-bridge-diagnostic-jump-next: 跳转到下一个诊断位置
• lsp-bridge-diagnostic-jump-prev: 跳转到上一个诊断位置
• lsp-bridge-diagnostic-list: 列出所有诊断信息
• lsp-bridge-diagnostic-ignore: 插入注视忽略当前诊断
• lsp-bridge-workspace-list-symbols: 列出工作区所有符号，并跳转到符号定义
• lsp-bridge-signature-help-fetch: 在 minibuffer 显示参数信息
• lsp-bridge-popup-complete-menu: 手动弹出补全菜单， 只有当打开 lsp-bridge-complete-manually 选项才需要使用这个命令
• lsp-bridge-restart-process: 重启 lsp-bridge 进程 (一般只有开发者才需要这个功能)
• acm-insert-common: 插入补全后选词的公共前缀
• acm-doc-scroll-up: API 文档窗口向上滚动
• acm-doc-scroll-down: API 文档窗口向下滚动

选项

• lsp-bridge-python-command: Python 命令的路径, 如果你用 conda， 你也许会定制这个选项
• lsp-bridge-complete-manually: 只有当用户手动调用 lsp-bridge-popup-complete-menu 命令的时候才弹出补全菜单， 默认关闭
• lsp-bridge-get-workspace-folder: 在 Java 中需要把多个项目放到一个 Workspace 目录下， 才能正常进行定义跳转， 可以自定义这个函数， 函数输入是项目路径， 返回对应的 Workspace 目录
• lsp-bridge-c-lsp-server: C 语言的服务器，可以选择clangd或者ccls
• lsp-bridge-python-lsp-server: Python 语言的服务器，可以选择pyright或者jedi
• lsp-bridge-tex-lsp-server: LaTeX 语言的服务器，可以选择texlab或者digestif
• lsp-bridge-org-babel-lang-list: 支持 org-mode 代码块补全的语言列表
• lsp-bridge-enable-diagnostics: 代码诊断， 默认打开
• lsp-bridge-enable-search-words: 索引打开文件的单词， 默认打开
• lsp-bridge-enable-auto-format-code: 自动格式化代码, 默认关闭
• lsp-bridge-enable-signature-help: 支持函数参数显示， 默认打开
• lsp-bridge-enable-log: 启用 LSP 消息日志， 默认关闭
• lsp-bridge-enable-debug: 启用程序调试， 默认关闭
• lsp-bridge-disable-backup: 禁止 emacs 对文件做版本管理， 默认打开
• lsp-bridge-diagnostic-fetch-idle： 诊断延迟，默认是停止敲键盘后 0.5 秒开始拉取诊断信息
• lsp-bridge-signature-show-function: 用于显示签名信息的函数
• lsp-bridge-completion-popup-predicates: 补全菜单显示的检查函数， 这个选项包括的所有函数都检查过以后， 补全菜单才能显示
• lsp-bridge-completion-stop-commands: 这些命令执行以后，不再弹出补全菜单
• lsp-bridge-completion-hide-characters: 这些字符的后面不再弹出补全菜单
• acm-enable-doc: 补全菜单是否显示帮助文档
• acm-enable-icon: 补全菜单是否显示图标, macOS 用户需要给 brew 命令增加选项 --with-rsvg 来安装 Emacs 才能显示 SVG 图片
• acm-enable-tabnine: 是否打开 tabnine 补全支持，默认打开，打开后需要运行命令 lsp-bridge-install-tabnine 来安装 tabnine 后就可以使用了。 TabNine 会消耗巨大的 CPU， 导致你整个电脑都卡顿， 如果电脑性能不好， 不建议开启此选项
• acm-enable-search-words: 补全菜单是否显示打开文件的单词， 默认打开
• acm-enable-quick-access: 是否在图标后面显示索引， 可以通过 Alt + Number 来快速选择后选词， 默认关闭
• acm-enable-yas: yasnippet 补全，默认打开
• acm-enable-citre: citre 补全，默认关闭
• acm-doc-frame-max-lines: 帮助窗口的最大行数， 默认是 20
• acm-snippet-insert-index: 代码模板候选词在补全菜单中的显示位置
• acm-candidate-match-function: 补全菜单匹配算法， orderless-* 开头的算法需要额外安装 orderless
• acm-backend-lsp-enable-auto-import: 支持自动导入， 默认打开
• acm-backend-yas-candidates-number: yasnippet 显示个数，默认 2 个
• acm-backend-citre-keyword-complete: 根据acm-backend-citre-keywords-alist定义的各个模式的关键字进行补全，需要使能 citre 后才生效

自定义语言服务器配置

lsp-bridge 每种语言的服务器配置存储在lsp-bridge/langserver.

大多数情况， 你可以根据以下优先级顺序来自定义服务器配置：

1. lsp-bridge-get-single-lang-server-by-project: 用户自定义函数， 输入参数是 project-path 和 file-path, 返回对应的 LSP 服务器字符串， 可以在 lsp-bridge-single-lang-server-mode-list 列表中查询所有 LSP 服务器的名称， 默认这个函数返回 nil
2. lsp-bridge-single-lang-server-extension-list: 根据文件的扩展名来返回服务器，比如打开*.wxml 文件时，我们会使用 wxml LSP 服务器提供补全
3. lsp-bridge-single-lang-server-mode-list: 根据 Emacs 的 major-mode 来返回对应的服务器

如果你在编写 JavaScript 代码， 你可能需要自定义多服务器配置：

1. lsp-bridge-get-multi-lang-server-by-project: 用户自定义函数， 输入参数是 project-path 和 file-path, 返回多服务器配置名， 可以在子目录 lsp-bridge/multiserver 中查找
2. lsp-bridge-multi-lang-server-extension-list: 根据文件的扩展名来返回多服务器配置名， 比如打开*.vue 文件时，我们会使用 volar_emmet 来同时利用 volar 和 emmet-ls 两种 LSP 服务器提供补全
3. lsp-bridge-multi-lang-server-mode-list: 根据 Emacs 的 major-mode 来返回对应的多服务器配置名

添加新的编程语言支持?

1. 在 lsp-bridge/langserver 目录下创建配置文件， 比如pyright.json就是 pyright 服务器的配置文件 (windows 平台用pyright_windows.json, macOS 平台用pyright_darwin.json)。
2. 添加 (mode . server_name) 到 lsp-bridge.el 文件中的 lsp-bridge-single-lang-server-mode-list 选项中, 比如 (python-mode . "pyright")。
3. 添加新的 mode-hook 到 lsp-bridge.el 文件中的 lsp-bridge-default-mode-hooks 选项中。
4. 添加新的缩进变量到 lsp-bridge.el 文件中的 lsp-bridge-formatting-indent-alist 选项中。

欢迎发送补丁帮助我们支持更多的 LSP 服务器，感谢你的帮助！

已经支持的语言服务器

你需要安装每个编程语言对应的 LSP 服务器， lsp-bridge 才能提供代码补全服务。

不会支持的特性：

lsp-bridge 的目标是实现 Emacs 生态中性能最快的 LSP 客户端, 但不是实现 LSP 协议最全的 LSP 客户端。

下面的功能用 Emacs 现有生态做更好：

1. 语法高亮: Tree-sitter 是一个静态高性能的语法分析库，比 LSP 更适合完成语法高亮
2. Xref: Xref 的机制是同步等待， lsp-bridge 是完全异步的， 两个机制无法融合， 请使用 lsp-bridge-find-references 来查看代码引用。

加入开发

下图是 lsp-bridge 的架构设计:

下面是 lsp-bridge 项目的目录结构：

请先阅读下面的文章:

• LSP 协议规范
• lsp-bridge 架构设计
• 为什么 lsp-bridge 不用 capf

接着打开开发选项 lsp-bridge-enable-log ， happy hacking!

反馈问题

请用命令 emacs -q 并只添加 lsp-bridge 配置做一个对比测试，如果 emacs -q 可以正常工作，请检查你个人的配置文件。

如果emacs -q环境下问题依旧，请到这里反馈, 并附带 *lsp-bridge* 窗口的内容给我们提交 issue，那里面有很多线索可以帮助我们排查问题。。

如果你遇到崩溃的问题, 请用下面的方式来收集崩溃信息:

1. 先安装 gdb 并打开选项 (setq lsp-bridge-enable-debug t)
2. 使用命令 lsp-bridge-stop-process 停止 LSP-BRIDGE 进程
3. 重新打开 lsp-bridge, 并在下次崩溃时发送 *lsp-bridge* 的内容

贡献者