1 Star 0 Fork 0

皮豪 / lsp-bridge

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
GPL-3.0

English | 简体中文

lsp-bridge

lsp-bridge 的目标是使用多线程技术实现 Emacs 生态中性能最快的 LSP 客户端。

lsp-bridge 的优势:

  1. 速度超快: 把 LSP 的请求等待和数据分析都隔离到外部进程, 不会因为 LSP Server 返回延迟或大量数据触发 GC 而卡住 Emacs
  2. 远程补全: 内置远程服务器代码补全, 支持密码、 公钥等多种登录方式, 支持 tramp 协议, 支持 SSH 多级堡垒机跳转
  3. 开箱即用: 安装后立即可以使用, 不需要额外的配置, 不需要自己折腾补全前端、 补全后端以及多后端融合等配置
  4. 多服务器融合: 可以同时使用多个 LSP Server 为同一个文件提供服务, 例如 Python, Pyright 提供代码补全, Ruff 提供诊断和格式化
  5. 灵活的自定义: 自定义 LSP Server 选项只需要一个 JSON 文件即可, 简单的几行规则就可以让不同的项目使用不同 JSON 配置

视频讲解 lsp-bridge 的原理

EmacsConf 2022 演讲页面

安装

  1. 安装 Emacs 28 及以上版本
  2. 安装 Python 依赖: pip3 install epc orjson sexpdata six setuptools paramiko rapidfuzz (orjson 是可选的, orjson 基于 Rust, 提供更快的 JSON 解析性能)
  3. 安装 Elisp 依赖: 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)

终端模式请安装 acm-terminal, 需要注意的是, acm-terminal 有可能会因为我修改了 acm.el 代码而导致兼容性破坏, 欢迎反馈 issue 给 acm-terminal 的作者, 他是一个非常好的开发者, 会迅速解决兼容性问题

  • 如果你使用 straight 来安装, 应该用下面的配置来安装:
(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))
  • 如果你使用 doom-emacs

添加下面配置到文件 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))

添加下面配置到文件 config.el

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

并执行命令 doom sync 进行安装。

如果你安装以后不能正常工作, 请先阅读反馈问题

请注意:

  1. 使用 lsp-bridge 时, 请先关闭其他补全插件, 比如 lsp-mode, eglot, company, corfu 等等, lsp-bridge 提供从补全后端、 补全前端到多后端融合的全套解决方案。
  2. lsp-bridge 除了提供 LSP 补全以外, 也提供了很多非 LSP 的补全后端, 包括文件单词、 路径、 Yas/Tempel、 TabNine、 Codeium、 Copilot、 Citre、 Tailwind、 Ctags, Org roam 等补全后端, 如果你期望在某个模式提供这些补全, 请把对应的模式添加到 lsp-bridge-default-mode-hooks
  3. 请不要对 lsp-bridge 执行 byte compile 或者 ```native comp``, 会导致升级后, compile 后的版本 API 和最新版不一样, lsp-bridge 多线程设计, 不需要 compile 来加速

本地使用

lsp-bridge 开箱即用, 安装好语言对应的 LSP 服务器和模式插件以后, 直接写代码即可, 不需要额外的设置。

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

  1. 通过向上搜索 .git.dir-locals.el 文件来确定项目的 root 目录, 从而对整个项目目录提供补全
  2. 没有找到 .git.dir-locals.el 文件时, lsp-bridge 只会对打开的文件提供单文件补全
  3. 也可以通过自定义 lsp-bridge-get-project-path-by-filepath 函数来告诉 lsp-bridge 项目的根目录, 这个函数输入参数是打开文件的路径字符串, 输出参数是项目目录路径

远程使用

lsp-bridge能像 VSCode 一样在远程服务器文件上进行代码语法补全。 配置步骤如下:

  1. 在远程服务器安装 lsp-bridge 和相应的 LSP Server
  2. 启动 lsp-bridge: python3 lsp-bridge/lsp_bridge.py
  3. lsp-bridge-open-remote-file命令打开文件, 输入用户名、 IP、 SSH 端口(默认 22) 和路径, 例如user@ip:[ssh_port]:/path/file
  4. 启用lsp-bridge-enable-with-tramp选项可以直接打开 tramp 文件, 并用 lsp-bridge 的高效算法代替 tramp, 实现流畅补全。 如果 tramp 中 host 是在 ~/.ssh/config 定义的, 那么 lsp-birdge 可以同步下列选项用于远程连接:
    • HostName(必须是 ip 形式的 hostname, domain 形式的 hostname 会导致问题)
    • User
    • Port
    • GSSAPIAuthentication
    • ProxyCommand(当前只支持用 ProxyCommand 选项, 不支持 ProxyJump 选项)
  5. (setq lsp-bridge-remote-start-automatically t) 可以在打开 tramp 文件时自动启动远程机器(需要支持 bash)上的 lsp_bridge.py 进程, 退出 emacs 时也会自动关闭。 使用该功能时需要正确设置下列选项:
    • lsp-bridge-remote-python-command: 远程机器上的 python 命令名
    • lsp-bridge-remote-python-file: 远程机器上 lsp_bridge.py 的路经
    • lsp-bridge-remote-log: 远程机器上 lsp_bridge.py 的 log 输出路经

远程补全原理:

  1. 通过 SSH 认证登录服务器, 访问和编辑文件
  2. 编辑远程文件副本时, 会实时发送 diff 序列到 lsp-bridge, 服务端用这些序列重建文件, 并由远端的 LSP Server 计算补全数据
  3. 远端 LSP Server 将补全数据回传本地由 Emacs 显示补全菜单

注意:

  1. 若补全菜单未显示, 检查远程服务器的lsp_bridge.py输出, 可能是 LSP Server 未完全安装
  2. lsp-bridge 会用~/.ssh的第一个 *.pub 文件作为登录凭证。 如果公钥登录失败, 会要求输入密码。 lsp-bridge 不会存储密码, 建议用公钥登录以避免重复输入密码
  3. 你需要在远程服务器完整的下载整个 lsp-bridge git 仓库, 并切换到 lsp-bridge 目录来启动 lsp_bridge.pylsp_bridge.py 需要其他文件来保证正常工作, 不能只把 lsp_bridge.py 文件拷贝到其他目录来启动
  4. 如果 tramp 文件出现 lsp-bridge 连接错误, 可以执行 lsp-bridge-tramp-show-hostnames 函数, 然后检查输出的 host 配置选项是否符合预期

按键

按键 命令 备注
Alt + n acm-select-next 选择下一个候选词
Down acm-select-next 选择下一个候选词
Alt + p acm-select-prev 选择上一个候选词
Up acm-select-prev 选择上一个候选词
Alt + , acm-select-last 选择最后一个候选词
Alt + . acm-select-first 选择第一个候选词
Ctrl + v acm-select-next-page 向下滚动候选菜单
Alt + v acm-select-prev-page 向上滚动候选菜单
Ctrl + m acm-complete 完成补全
Return acm-complete 完成补全
Tab acm-complete 完成补全
Alt + h acm-complete 完成补全
Alt + H acm-insert-common 插入候选词共有部分
Alt + u acm-filter 对候选词做二次过滤, 提升候选词的选择效率
Alt + d acm-doc-toggle 开启或关闭候选词文档
Alt + j acm-doc-scroll-up 向下滚动候选词文档
Alt + k acm-doc-scroll-down 向上滚动候选词文档
Alt + l acm-hide 隐藏补全窗口
Ctrl + g acm-hide 隐藏补全窗口
Alt + 数字键 acm-complete-quick-access 快速选择候选词, 需要开启 acm-enable-quick-access 选项
数字键 acm-complete-quick-access (更加)快速选择候选词, 需要同时开启 acm-enable-quick-accessacm-quick-access-use-number-select

命令

  • 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-type-def: 跳转到类型定义位置
  • lsp-bridge-find-type-def-other-window: 在其他窗口跳转到类型定义位置
  • lsp-bridge-find-references: 查看代码引用
  • lsp-bridge-popup-documentation: 查看光标处的文档
  • lsp-bridge-popup-documentation-scroll-up: 文档窗口向上滚动
  • lsp-bridge-popup-documentation-scroll-down: 文档窗口向下滚动
  • lsp-bridge-show-documentation: 查看光标处的文档, 但是是用 Buffer 来显示
  • lsp-bridge-rename: 重命名
  • lsp-bridge-diagnostic-jump-next: 跳转到下一个诊断位置
  • lsp-bridge-diagnostic-jump-prev: 跳转到上一个诊断位置
  • lsp-bridge-diagnostic-list: 列出所有诊断信息
  • lsp-bridge-diagnostic-copy: 拷贝当前诊断信息到剪切板
  • lsp-bridge-code-action: 弹出代码修复菜单, 也可以指需要修复的代码动作类型: "quickfix", "refactor", "refactor.extract", "refactor.inline", "refactor.rewrite", "source", "source.organizeImports", "source.fixAll"
  • lsp-bridge-workspace-list-symbol-at-point: 查找光标下符号的定义
  • 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 进程 (一般只有开发者才需要这个功能)
  • lsp-bridge-toggle-sdcv-helper: 切换字典助手补全
  • lsp-bridge-peek: 在 peek window 中展示光标处的定义和引用
  • lsp-bridge-peek-abort: 关闭 peek window (默认绑定到 C-g)
  • lsp-bridge-peek-list-next-line: 选择下一个定义或引用 (默认绑定到 M-S-n )
  • lsp-bridge-peek-list-prev-line: 选择上一个定义或引用 (默认绑定到 M-S-p )
  • lsp-bridge-peek-file-content-next-line: 将 peek window 中的文件内容向下滚动一行 (默认绑定到 M-n )
  • lsp-bridge-peek-file-content-prev-line: 将 peek window 中的文件内容向上滚动一行 (默认绑定到 M-p )
  • lsp-bridge-peek-jump: 跳转到定义或引用所在处 (默认绑定到 M-l j )
  • lsp-bridge-peek-jump-back: 跳转到原来的位置 (默认绑定到 M-l b )
  • lsp-bridge-peek-through: 选择 peek window 中的一个符号进行查看
  • lsp-bridge-peek-tree-previous-branch: 选择上一个浏览历史上同级的分支 (默认绑定到 <up> )
  • lsp-bridge-peek-tree-next-branch: 选择下一个浏览历史上同级的分支 (默认绑定到 <down> )
  • lsp-bridge-peek-tree-previous-node: 选择浏览历史上一级节点 (默认绑定到 <left> )
  • lsp-bridge-peek-tree-next-node: 选择浏览历史上下一级节点 (默认绑定到 <right> )
  • lsp-bridge-indent-left: 根据 lsp-bridge-formatting-indent-alist 定义的缩进值, 向左缩进刚刚粘贴的文本
  • lsp-bridge-indent-right: 根据 lsp-bridge-formatting-indent-alist 定义的缩进值, 向右缩进刚刚粘贴的文本
  • lsp-bridge-semantic-tokens-mode: 开启或者关闭语义符号高亮, 详细用法请看 Semantic Tokens Wiki

LSP 服务器选项

lsp-bridge 针对许多语言都提供 2 个以上的语言服务器支持, 您可以通过定制下面的选项来选择你喜欢的语言服务器:

  • lsp-bridge-c-lsp-server: C 语言的服务器, 可以选择clangd或者ccls
  • lsp-bridge-elixir-lsp-server: Elixir 语言的服务器, 可以选择elixirLS或者lexical
  • lsp-bridge-python-lsp-server: Python 语言的服务器, 可以选择 pyright, jedi, python-ms, pylsp, ruff, 需要注意的是, lsp-bridge-multi-lang-server-mode-list 的优先级高于 lsp-bridge-single-lang-server-mode-list, 如果你只想使用单服务器, 请先去掉 lsp-bridge-multi-lang-server-mode-list 中 python-mode 的设置
  • lsp-bridge-php-lsp-server: PHP 语言的服务器, 可以选择intelephense或者phpactor
  • lsp-bridge-tex-lsp-server: LaTeX 语言的服务器, 可以选择texlab或者digestif
  • lsp-bridge-csharp-lsp-server: C#语言的服务器, 可以选择omnisharp-mono 或者 omnisharp-dotnet, 注意你需要给 OmniSharp 文件执行权限才能正常工作
  • lsp-bridge-python-multi-lsp-server: Python 多语言服务器, 可以选择 pyright_ruff, jedi_ruff, python-ms_ruff, pylsp_ruff
  • lsp-bridge-nix-lsp-server: Nix 语言的服务器, 可以选择 rnix-lsp 或者 nil
  • lsp-bridge-markdown-lsp-server: Markdown 语言的服务器, 可以选择 vale-ls 或者 nil

选项

  • lsp-bridge-python-command: Python 命令的路径, 如果你用 conda, 你也许会定制这个选项。 Windows 平台用的是 python.exe 而不是 python3, 如果 lsp-bridge 不能工作, 可以尝试改成 python3
  • lsp-bridge-complete-manually: 只有当用户手动调用 lsp-bridge-popup-complete-menu 命令的时候才弹出补全菜单, 默认关闭
  • lsp-bridge-enable-with-tramp: 打开这个选项后, lsp-bridge 会对 tramp 打开的文件提供远程补全支持, 需要提前在服务端安装并启动 lsp_bridge.py, 注意的是这个选项只是用 tramp 打开文件, 并不会用 tramp 技术来实现补全, 因为 tramp 的实现原理有严重的性能问题
  • lsp-bridge-remote-save-password: 远程编辑时, 把密码保存到 netrc 文件, 默认关闭
  • lsp-bridge-remote-heartbeat-interval: 远程编辑时, 可以定期(以秒为单位)给远程服务器发送心跳包, 默认关闭, 如果你会长时间让 emacs 处于闲置状态, 你可以尝试配置该选项来保持 lsp-bridge 连接不会被关闭
  • lsp-bridge-get-workspace-folder: 在 Java 中需要把多个项目放到一个 Workspace 目录下, 才能正常进行定义跳转, 可以自定义这个函数, 函数输入是项目路径, 返回对应的 Workspace 目录
  • lsp-bridge-default-mode-hooks: 自动开启 lsp-bridge 的模式列表, 你可以定制这个选项来控制开启 lsp-bridge 的范围
  • lsp-bridge-org-babel-lang-list: 支持 org-mode 代码块补全的语言列表, 默认 nil 对于所有语言使用
  • lsp-bridge-find-def-fallback-function: 当 LSP 没有找到定义时, 可以通过定制这个函数来进行候选跳转, 比如绑定 citre 函数
  • lsp-bridge-find-ref-fallback-function: 当 LSP 没有找到引用时, 可以通过定制这个函数来进行候选跳转, 比如绑定 citre 函数
  • lsp-bridge-find-def-select-in-open-windows: 当打开这个选项时, 查找定义命令会尽量选择已经打开窗口去跳转定义, 而不是在当前窗口切换 Buffer, 默认关闭
  • lsp-bridge-enable-completion-in-string: 支持在字符串中弹出补全, 默认关闭
  • lsp-bridge-enable-completion-in-minibuffer: 支持在 Minibuffer 中弹出补全, 默认关闭
  • lsp-bridge-enable-diagnostics: 代码诊断, 默认打开
  • lsp-bridge-enable-inlay-hint: 类型嵌入提示, 默认打开, 这个选项对于那些严重依赖类型提示的语言比较有用, 比如 Rust
  • lsp-bridge-enable-hover-diagnostic: 光标移动到错误位置弹出诊断信息, 默认关闭
  • 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-code-action-enable-popup-menu: 启用 code action 菜单, 默认打开
  • lsp-bridge-diagnostic-fetch-idle: 诊断延迟, 默认是停止敲键盘后 0.5 秒开始拉取诊断信息
  • lsp-bridge-signature-show-function: 用于显示签名信息的函数, 默认是在 minibuffer 显示, 设置成 lsp-bridge-signature-show-with-frame 后可以用 frame 来显示函数的签名信息
  • lsp-bridge-signature-show-with-frame-position: 当使用 lsp-bridge-signature-show-with-frame 来显示签名信息时, 这个选项定义弹出签名信息的位置, 默认是 "bottom-right", 你还可以选择 "top-left", "top-right", "bottom-left", "point"
  • lsp-bridge-completion-popup-predicates: 补全菜单显示的检查函数, 这个选项包括的所有函数都检查过以后, 补全菜单才能显示
  • lsp-bridge-completion-stop-commands: 这些命令执行以后, 不再弹出补全菜单
  • lsp-bridge-completion-hide-characters: 默认值为 '(":" ";" "(" ")" "[" "]" "{" "}" ", " "\"") , 光标在这些字符的后面时不弹出补全菜单, 你可以定制这个选项以解除这个限制, 或者调用 lsp-bridge-popup-complete-menu 命令强制弹出菜单。 为了让这个选项生效, 你需要先把 lsp-bridge-completion-obey-trigger-characters-p 选项设置为 nil
  • lsp-bridge-user-langserver-dir: 用户 langserver 配置文件目录, 如果目录下的配置文件和 lsp-bridge/langserver 里的配置文件同名, lsp-bridge 会使用这个目录下的配置文件
  • lsp-bridge-user-multiserver-dir: 用户 multiserver 配置文件目录, 如果目录下的配置文件和 lsp-bridge/multiserver 里的配置文件同名, lsp-bridge 会使用这个目录下的配置文件
  • lsp-bridge-symbols-enable-which-func: 在which-func使用 lsp 后端, 默认关闭
  • lsp-bridge-enable-org-babel: 在 Org Babel 里使用 LSP 补全, 默认关闭, 如果没法补全
  • lsp-bridge-peek-file-content-height: 在 peek window 中显示多少行的文件内容
  • lsp-bridge-peek-file-content-scroll-margin: peek window 中内容滚动的行数
  • lsp-bridge-peek-list-height: 选择下一个定义和引用的备选项
  • lsp-bridge-peek-ace-keys: 进行 lsp-bridge-peek-through 时待按的按键
  • lsp-bridge-peek-ace-cancel-keys: 退出 lsp-bridge-peek-through 的按键
  • acm-frame-background-dark-color: 暗色主题下的菜单背景颜色
  • acm-frame-background-light-color: 亮色主题下的菜单背景颜色
  • acm-enable-doc: 补全菜单是否显示帮助文档
  • acm-enable-icon: 补全菜单是否显示图标 (有很多 macOS 用户反馈 emacs-plus28 无法正常显示图标, 显示的是彩色方块, 有两种方法可以解决, 安装 Emacs Mac Port 或者自己编译 Emacs 的时候给 brew 命令增加选项 --with-rsvg ) , 重新编译了之后好像也没有用, 后来重新装了 emacs mac port
  • acm-enable-doc-markdown-render: 对补全文档中的 Markdown 内容进行语法着色, 你可以选择'async, t 或者 nil. 当选择'async 时, lsp-bridge 会采用异步渲, 当选择 t 时, lsp-bridge 会采用同步渲染, 同步渲染会降低补全速度, 默认是 async 选项
  • acm-enable-tabnine: 是否打开 tabnine 补全支持, 默认打开, 打开后需要运行命令 lsp-bridge-install-tabnine 来安装 tabnine 后就可以使用了。 TabNine 会消耗巨大的 CPU, 导致你整个电脑都卡顿, 如果电脑性能不好, 不建议开启此选项
  • acm-enable-codeium: 是否打开 Codeium 补全支持, 打开后需要运行命令 lsp-bridge-install-update-codeium 来安装 Codeium, 再运行命令 lsp-bridge-codeium-auth 来获取 auth token 再运行命令 lsp-bridge-codeium-input-auth-token 获取 API Key 后就可以使用了。
  • acm-enable-copilot: 是否打开 Copilot 补全支持. 首先购买 Copilot 的服务 https://github.com/features/copilot , 打开后需要运行终端命令 npm install -g copilot-node-server 来安装 Copilot, 再运行命令 lsp-bridge-copilot-login, lsp-bridge 会在 Minibuffer 显示 User Code, 复制 User Code 到打开的 Copilot 页面完成登录。
  • acm-enable-search-file-words: 补全菜单是否显示打开文件的单词, 默认打开
  • acm-enable-quick-access: 是否在图标后面显示索引, 通过 Alt + Number 来快速选择候选词, 默认关闭
  • acm-quick-access-use-number-select: 是否用数字键快速选择候选词, 默认关闭, 打开这个选项会导致有时候干扰数字输入或误选候选词
  • acm-enable-yas: yasnippet 补全, 默认打开
  • acm-enable-citre: citre(ctags) 补全, 默认关闭
  • acm-doc-frame-max-lines: 帮助窗口的最大行数, 默认是 20
  • acm-candidate-match-function: 补全菜单匹配算法, orderless-* 开头的算法需要额外安装 orderless
  • acm-completion-backend-merge-order: 补全后端的显示顺序, 默认是按照 LSP、 模板、 TabNine 顺序合并多个补全后端后, 再显示剩下的模板和 LSP 补全选项, 你可以根据你的需求调整补全后端合并顺序
  • acm-backend-lsp-candidate-min-length: LSP 补全最小的触发字符数, 默认是 0
  • acm-backend-elisp-candidate-min-length: Elisp 补全最小的触发字符数, 默认是 0
  • acm-backend-yas-candidate-min-length: YaSnippet 补全最小的触发字符数, 默认是 0
  • acm-backend-search-file-words-candidate-min-length: Search Words 补全最小的触发字符数, 默认是 0
  • acm-backend-search-file-words-max-number: Search Words 补全候选词限制, 默认是 10
  • acm-backend-search-file-words-enable-fuzzy-match: Search Words 补全候选词启用模糊匹配, 默认关闭
  • acm-backend-search-file-words-enable-fuzzy-match-threshold: Search Words 补全候选词过滤, 过滤掉相似度小于阈值的候选词, 默认是 50
  • acm-backend-codeium-candidate-min-length: Codeium 补全最小的触发字符数, 默认是 0
  • acm-backend-lsp-enable-auto-import: 支持自动导入, 默认打开
  • acm-backend-lsp-candidate-max-length: LSP 候选词最大长度, 一些语言参数较长, 可以适当增加这个选项的值以看清楚参数列表
  • acm-backend-yas-candidates-number: yasnippet 显示个数, 默认 2 个
  • acm-backend-citre-keyword-complete: 根据acm-backend-citre-keywords-alist定义的各个模式的关键字进行补全, 需要使能 citre 后才生效
  • acm-backend-search-sdcv-words-dictionary: 用于单词补全的 StarDict 词典, 默认是 kdic-ec-11w, 可以自定义为其他 StarDict 词典, 如果你的系统存在词典 /usr/share/stardict/dic/stardict-oxford-gb-formated-2.4.2/oxford-gb-formated.ifo, 你需要设置这个选项为 /usr/share/stardict/dic/stardict-oxford-gb-formated-2.4.2/oxford-gb-formated, 不需要包括 .ifo 扩展
  • acm-backend-lsp-match-mode: LSP 后端候选词过滤模式, 有 "normal", "prefix", "prefixCaseSensitive", "fuzzy" 三个选项, 默认是 "normal", 不对 LSP Server 返回候选词进行过滤
  • acm-enable-preview: 开启 Tab-and-Go completion, 当改变当前候选时, 可以预览候选, 并且后续输入会选择预览候选, 默认关闭

自定义语言服务器配置

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

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

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

举例, 我们可以通过如下配置, 对 Deno 脚本开启 Deno LSP 服务器:

(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")))))))))

自定义语言服务器配置文件

拷贝 lsp-bridge/langserverlsp-bridge/multiserver 中的配置文件到 lsp-bridge-user-langserver-dirlsp-bridge-user-multiserver-dir 中进行自定义, lsp-bridge 会优先读取 lsp-bridge-user-langserver-dirlsp-bridge-user-multiserver-dir 里的配置文件。

我们可以在启动 lsp-bridge-mode 之前设置 lsp-bridge-user-langserver-dirlsp-bridge-user-multiserver-dir 的值, 实现不同的工程用不同的配置文件

(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))

添加新的编程语言支持?

  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 才能提供代码补全服务。

如果你的语言支持混合多语言服务器, 建议查看 multiserver 下的多语言服务器定义, 安装多个 LSP 服务器以获取更完整的体验, 比如 Python 语言, 按照默认的 pyright-background-analysis_ruff.json 定义, 就应该安装 pyrightruff

LSP 服务器 语言 备注
clangd C, C++, Object-C 需要在项目根目录配置好 compile_commands.json 或 CMakeLists.txt 文件
ccls C, C++, Object-C lsp-bridge-c-lsp-server 设置成 ccls, 需要在项目根目录配置好 compile_commands.json
pyright Python pip install pyright, lsp-bridge-python-lsp-server 设置成 pyright, pyright-background-analysis 更快, 但是无法返回诊断信息
jedi Python lsp-bridge-python-lsp-server 设置成 jedi
python-ms Python 支持 Python2 的 lsp
pylsp Python lsp-bridge-python-lsp-server 设置成 pylsp
ruff Python pip install ruff-lsplsp-bridge-python-lsp-server 设置成 ruff, 只具备 linter 的功能。 如需补全等功能, 安装其他的 Python 语言服务器, 并把 lsp-bridge-python-multi-lsp-server 设置成 [相应的语言服务器名称]_ruff
solargraph Ruby
rust-analyzer Rust
elixirLS Elixir 请确保导出 elixir-ls 目录到你系统的 PATH 路径
lexical Elixir 请确保导出 lexical 目录到你系统的 PATH 路径, 且 lexical 和被补全的项目使用同样版本的 erlang/elixir 编译
gopls Go 确保安装 go-mode, 同时确保 gopls 在 PATH 环境变量中, 执行命令 ln -s ~/go/bin/gopls ~/.local/bin, 还要在补全之前执行 go mod init 命令
hls Haskell
dart-analysis-server Dart
metals Scala
typescript Typescript, javascript
svelte Svelte
ocamllsp Ocaml
erlang-ls Erlang
texlab Latex
eclipse.jdt.ls Java 请确保导出 org.eclipse.jdt.ls.product/target/repository/bin 到你系统的 PATH 路径, 具体请看 Wiki
clojure-lsp Clojure 如果使用 homebrew 安装的, 请确保安装的是 clojure-lsp/brew/clojure-lsp-native clojure-lsp-native
bash-language-server Bash
volar Vue npm install -g typescript @vue/language-server
sumneko Lua 请确保导出 sumneko 的 bin 目录到你系统的 PATH 路径
wxml-language-server Wxml
vscode-html-language-server HTML npm i -g vscode-langservers-extracted
vscode-css-language-server CSS npm i -g vscode-langservers-extracted
vscode-eslint-language-server JavaScript npm i -g vscode-langservers-extracted
vscode-json-language-server JSON npm i -g vscode-langservers-extracted
elm-language-server Elm
intelephense PHP npm i intelephense -g
Phpactor PHP lsp-bridge-php-lsp-server 设置成 phpactor
yaml-language-server Yaml npm install -g yaml-language-server
zls Zig 运行 zls config 来生成 zls 的配置。 参考 Configuration Options
groovy-language-server Groovy 在 PATH 中创建一个名为 "groovy-language-server" 的脚本, 内容为 $JAVA_HOME/bin/java -jar <path>/groovy-language-server-all.jar
docker-language-server Dockerfiles
serve-d D serve-d 不支持单文件模式, 使用前请先在项目目录下初始 git 仓库或者自定义 lsp-bridge-get-project-path-by-filepath 返回项目目录
fortls Fortran
emmet-ls HTML, JavaScript, CSS, SASS, SCSS, LESS npm install -g emmet-ls
rnix-lsp Nix lsp-bridge-nix-lsp-server 设置成 rnix-lsp
nil Nix lsp-bridge-nix-lsp-server 设置成 nil
texlab Latex lsp-bridge-tex-lsp-server 设置成 texlab
digestif Latex lsp-bridge-tex-lsp-server 设置成 digestif
rlanguageserver R
graphql-lsp GraphQL
cmake-language-server Cmake pip install cmake-language-server
ds-pinyin Org-mode cargo install ds-pinyin-lsp, 下载 ds-pinyin 的 dict.db3 文件, 并保存到目录 ~/.emacs.d/ds-pinyin/ , 最后开启选项 lsp-bridge-use-ds-pinyin-in-org-mode
Wen Org-mode pip install pygls pypinyin, 开启选项 lsp-bridge-use-wenls-in-org-mode
sourcekit-lsp Swift Sourcekit-lsp 包含在 swift toolchain 中。
omnisharp-mono C# OmniSharp 是 .NET 开发平台, 使用命令 M-x lsp-bridge-install-omnisharp 来安 OmniSharp, 默认是 omnisharp-mono. lsp-bridge-csharp-lsp-server 设置成 omnisharp-mono
omnisharp-dotnet C# OmniSharp 是 .NET 开发平台, 使用命令 M-x lsp-bridge-install-omnisharp 来安 OmniSharp, 默认是 omnisharp-mono. lsp-bridge-csharp-lsp-server 设置成 omnisharp-dotnet
fsautocomplete F#
deno Deno Deno 使用 TypeScript 来编程, 你需要定制选项 lsp-bridge-get-single-lang-server-by-project 当工程是 Deno 项目的路径时, 返回 "deno" 字符串
ansible-language-server Ansible Ansible 使用 YAML 来编程, 你需要定制选项 lsp-bridge-get-single-lang-server-by-project 当工程是 Ansible 项目的路径时, 返回 "ansible-language-server" 字符串
astro Astro npm i -g @astrojs/language-server
qmlls QML QT 6.3.0 之后的版本自带 qmlls, 将 qmlls 所在目录加到 PATH 中
kotlin-language-server Kotlin Inlay Hint 功能需要自己编译源码的版本才能返回 Inlay Hint 信息
vhdl-tool VHDL
julials Julia
typst-lsp Typst
verible Verilog
move-analyzer Move move-analyzer 包含在 move 语言仓库里
nls Nickel cargo add nickel-lang-lsp
vale-ls Markdown 先安装 vale, 并在 vale-ls git 仓库中用 cargo 来构建 vale-ls, 并确保 vale-ls 添加到 PATH 中
beancount-language-server Beancount cargo install beancount-language-server
racket-langserver Racket

加入开发

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

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

文件名 作用
lsp-bridge.el lsp-bridge 的 Elisp 主逻辑部分, 提供自定义选项和 Elisp 函数供 python 子进程调用, 比如代码跳转、 重命名等
lsp-bridge-epc.el 和 lsp-bridge python 子进程通讯的代码, 主要实现 Elisp IPC 来对接 Python EPC, 实现数据序列化、 发送、 接收和反序列化
lsp-bridge-call-hierarchy.el 在弹出 Frame 中显示代码的调用顺序关系
lsp-bridge-code-action.el 代码修复相关代码
lsp-bridge-diagnostic.el 诊断信息相关代码
lsp-bridge-ref.el 代码引用查看框架, 提供引用查看、 批量重命名、 引用结果正则过滤等, 核心代码 fork 自 color-rg.el
lsp-bridge-inlay-hint.el 提供代码类型提示, 对于静态语言, 比如 Rust 或 Haskell 比较有用
lsp-bridge-jdtls.el 提供 Java 语言第三方库跳转功能
lsp-bridge-dart.el 提供对 Dart 私有协议的支持, 比如 Dart 的 Closing Labels 协议
lsp-bridge-semantic-tokens.el 灵活显示某些语义符号, 对于静态语言, 比如 C 或 C++ 比较有用
lsp-bridge-lsp-installer.el 安装 TabNine 和 Omnisharp
lsp-bridge-peek.el 用 peek windows 来查看定义和引用
lsp-bridge.py lsp-bridge 的 Python 主逻辑部分, 提供事件循环、 消息调度和状态管理
acm/acm.el 异步补全菜单, 专门为 lsp-bridge 后端而设计, 支持 lsp, elisp, words, TabNine 等后端
core/fileaction.py 主要记录每个文件状态, 处理 LSP 响应消息, 调用 Emacs Elisp 函数
core/lspserver.py LSP 消息处理模块, 主要是解析、 发送和接受 LSP 消息, 并保证 LSP 请求顺序符合 LSP 协议规范
core/remote_file.py 用于处理远程服务器文件访问和同步
core/utils.py 一些全局工具函数, 方便各模块调用
core/mergedeep.py JSON 信息合并, 主要用于发送自定义选项给 LSP 服务器
core/hanlder/ LSP 消息发送和接受的实现, 其中 __init__.py 是基类
core/tabnine.py TabNine 后端搜索和补全
core/codeium.py Codeium 后端搜索和补全
core/copilot.py Copilot 后端搜索和补全
core/search_file_words.py 文件单词异步搜索后端
core/search_paths.py 文件路径异步搜索后端
core/search_sdcv_words.py 英文单词搜索后端, 可更换为其他语言的 StarDict 词典
core/search_tailwindcss_keywords.py TailwindCSS 关键词搜索后端, 开启这个后端, 需要保证项目 root 目录存在 tailwind.config.js 文件
core/search_list.py 异步搜索框架, 可用于编写自己的异步搜索后端
langserver 主要放置 LSP 服务器的配置, 每一个服务器一个 json 文件, 分别定义服务器的名称、 语言 ID、 启动命令和设置选项等
multiserver 主要放置多 LSP 服务器的配置
resources 英文词典数据, 主要是服务中国用户

请先阅读下面的文章:

接着打开开发选项 lsp-bridge-enable-log , happy hacking! ;)

反馈问题

关于一些常用问题, 请先阅读 Wiki

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

如果emacs -q环境下问题依旧

  1. 打开选项 (setq lsp-bridge-enable-log t)
  2. 使用命令 lsp-bridge-restart-process 重启 LSP-BRIDGE 进程
  3. 在 issue 中发送*lsp-bridge*中的内容, 那里面有很多线索可以帮助我们排查问题

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

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

贡献者

lsp-bridge 的快速发展离不开社区各位大佬的鼎力支持和无私奉献, 没有社区的支持, lsp-bridge 不可能发展到今天, 感谢世界上最可爱的你们, happy hacking ;)

GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. <one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: <program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <http://www.gnu.org/licenses/>. The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.

简介

懒猫的lsp-bridge 展开 收起
Emacs Lisp 等 2 种语言
GPL-3.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/pphboy/lsp-bridge.git
git@gitee.com:pphboy/lsp-bridge.git
pphboy
lsp-bridge
lsp-bridge
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891