lsp-mode

lsp-mode 是实现 lsp 的客户端，旨在通过集成 Emacs 最流行的软件包（如 company，flycheck 和 projectile）来提供类似 IDE 的体验。

emacs-cquery，lsp-rust，lsp-haskell 等可以看做是 lsp-mode 的适配器，用来适配对应的 lsp-server。

lsp-mode 主要功能：

• 非阻塞异步调用。
• 实时代码诊断，通过内置的 flymake（Emacs>26）或 flycheck/lsp-ui 。
• 代码补全（Code completion），使用 company-lsp 或内置的 complete-at-point。
• 悬停展示（Hovers）：在代码附近展示相关信息，如函数原型提示等。使用 lsp-ui。
• 代码操作（Code actions）：（参见 code action）使用 lsp-execute-code-action 或 lsp-ui。
• 代码大纲（Code outline）：显示代码文件中定义的函数或变量。通过内置的 imenu 或 helm-imenu。
• 代码导航（Code navigation），使用内置外部 xref。
• 代码感知（Code Lens）(参考/实现)：提供正在使用的源代码的元信息，例如单元测试、更改历史等。使用内置 xref。关于 codelens 参考 what is CodeLens? Find code changes and other history with CodeLens
• 代码高亮（Highlights）
• 代码格式化（Code Format）
• 调试器，使用 dap-mode
• 集成 Ivy
• 集成 Treemacs
• 语义高亮（Semantic highlighting）（目前由 JDT LS 和未发布的 clangd 版本实现，请参见Semantic highlighting spec）

lsp-mode 在 lsp-clients.el 中预定义了几个 lsp-server（typescript,go,vue），这些 lsp-server 不需要额外的依赖。

lsp-mode 有预定义的服务器配置列表（通过 lsp-clients.el 加载），该列表包含 major-mode 到服务器的关联配置，或通过激活使用功能。除了 lsp-clients.el 中的默认服务器配置外，有些语言服务器需要单独的程序包（参见 支持语言种类 ）。当从特定项目中打开文件时，lsp-mode 并调用 lsp 命令，lsp-mode 将查找注册过的、能够处理当前文件的服务器。如果有这样的客户端，lsp-mode 将查找项目根目录。如果是第一次从项目中打开文件，系统将提示定义当前项目的根目录。一旦选择了项目根目录，它将保存在 lsp-session 文件中，并且在下次启动 Emacs 时将被加载，因此从该项目打开文件时不再要求提供项目根目录。以后，如果要更改项目根目录，可以使用 lsp-workspace-folder-remove 删除项目，然后调用 lsp-workspace-folder-add 添加根目录。如果要文件中需要强制启动特定语言服务器，则可以使用 C-u M-x lsp ，它将提示您选择要启动的语言服务器。

以下是注册新语言服务器所需的最小配置。注册时支持的其他设置请参阅 lsp-clients.el 的文档。 必须更新 lsp-language-id-configuration 以包含相应的 language mode->language id 映射关系，例如 (python-mode . "python") ：

(defvar lsp-language-id-configuration
  '(...
   (python-mode . "python")
   ...))
;; if you are adding the support for your language server in separate repo use
;; (add-to-list 'lsp-language-id-configuration '(python-mode . "python"))

(lsp-register-client
 (make-lsp-client :new-connection (lsp-stdio-connection "pyls")
                  :major-modes '(python-mode)
                  :server-id 'pyls))

如果语言服务器支持环境变量来控制其他行为，则可以使用：environment-fn 函数进行注册，就像 Bash 语言客户端所做的那样：

(lsp-register-client
 (make-lsp-client :new-connection (lsp-stdio-connection '("bash-language-server" "start"))
                  :major-modes '(sh-mode)
                  :priority -1
                  :environment-fn (lambda ()
                                    (("EXPLAINSHELL_ENDPOINT" . lsp-bash-explainshell-endpoint)
                                     ("HIGHLIGHT_PARSING_ERRORS" . lsp-bash-highlight-parsing-errors)))
                  :server-id 'bash-ls))

lsp-bash-explainshell-endpoint 和 lsp-bash-highlight-parsing-errors 是语言客户端 defcustom，它们以类型安全的方式公开受支持的服务器环境设置。如果您更改了这些变量中的任何一个，请使用 lsp-restart-workspace 重新启动语言服务器以应用更改。