Nim 语言服务器协议

这是一个用 Nim 实现的 Nim 语言服务器协议（Language Server Protocol）。它基于 nimsuggest，这意味着所有支持 LSP 的编辑器现在都能获得与之前仅在受支持编辑器中才有的同等质量的建议。

安装 `nimlsp`

如果你通过 choosenim 安装了 Nim（推荐方式），安装 nimlsp 最简单的方法是使用 nimble：

.. code:: bash

nimble install nimlsp

这将编译并将其安装在 nimble 二进制目录中，如果你正确设置了 nimble，该目录应该在你的路径中。在编译和使用 nimlsp 时，它需要能够访问 Nim 的源代码才能工作。如果通过 choosenim 安装 Nim，这些文件应该已经在你的系统上，nimlsp 应该能够自动找到并使用它们。但是，如果你以其他方式安装了 nimlsp，你可能会遇到在编译/运行时找不到某些文件的问题。要解决这个问题，你需要获取一份 Nim 源代码的副本，然后在编译时通过使用 -d:explicitSourcePath=PATH 指向它们，其中 PATH 是你的 Nim 源代码所在的位置。你也可以在运行时传递它们（例如，如果你正在使用自定义的标准库副本），方法是将其作为参数传递给 nimlsp。具体如何做将取决于 LSP 客户端。

编译 `nimlsp`

如果你想更好地控制编译过程，可以随意克隆仓库。nimlsp 依赖于主 Nim 仓库中的 nimsuggest 源代码，所以确保你在某处有一份副本。以这种方式手动获取 Nim 副本意味着默认源路径将不起作用，所以你需要在编译时使用 -d:explicitSourcePath=PATH 显式设置它，并在运行时指向它（严格来说，运行时应该只需要标准库，所以省略它将使 nimlsp 尝试从你的 Nim 安装中找到它）。从 Nim 2.0.0 开始，你必须先在 Nim 仓库中运行 'build_all' 脚本（nimsuggest 需要导入一个原本不存在的文件）。

要进行标准构建，运行：

.. code:: bash

nimble build

或者如果你想在 nimlsp 运行时输出调试信息：

.. code:: bash

nimble debug

或者如果你想从 LSP 格式获得更多调试输出：

.. code:: bash

nimble debug -d:debugLogging

支持的协议功能

====== ================================ 状态 LSP 命令 ====== ================================ ☑ 完成 textDocument/didChange ☑ 完成 textDocument/didClose ☑ 完成 textDocument/didOpen ☑ 完成 textDocument/didSave ☐ 待办 textDocument/codeAction ☑ 完成 textDocument/completion ☑ 完成 textDocument/definition ☐ 待办 textDocument/documentHighlight ☑ 完成 textDocument/documentSymbol ☐ 待办 textDocument/executeCommand ☐ 待办 textDocument/format ☑ 完成 textDocument/hover ☑ 完成 textDocument/rename ☑ 完成 textDocument/references ☑ 完成 textDocument/signatureHelp ☑ 完成 textDocument/publishDiagnostics ☐ 待办 workspace/symbol ====== ================================

设置 `nimlsp`

Sublime Text :::::::::::: 安装 LSP 插件 <https://packagecontrol.io/packages/LSP>。安装 Nim 插件 <https://packagecontrol.io/packages/Nim> 用于语法高亮。

要设置 LSP，从命令面板运行 Preferences: LSP settings 并添加以下内容：

.. code:: js

{ "clients": { "nimlsp": { "command": ["nimlsp"], "enabled": true,

        // 仅适用于 ST4
        "selector": "source.nim",

        // 仅适用于 ST3
        "languageId": "nim",
        "scopes": ["source.nim"],
        "syntaxes": ["Packages/Nim/Syntaxes/Nim.sublime-syntax"]
     }
  }

}

注意：确保 <path/to>/.nimble/bin 已添加到你的 PATH 中。

要在弹出窗口中启用语法高亮，运行 Preferences: settings 并添加以下内容：

.. code:: js

"mdpopups.use_sublime_highlighter": true, "mdpopups.sublime_user_lang_map": { "nim": [ [ "nim" ], [ "Nim/Syntaxes/Nim" ] ] }

Vim :::::::::: 要在 Vim 中使用 nimlsp，安装 prabirshrestha/vim-lsp 插件及其依赖：

.. code:: vim

Plugin 'prabirshrestha/asyncomplete.vim' Plugin 'prabirshrestha/async.vim' Plugin 'prabirshrestha/vim-lsp' Plugin 'prabirshrestha/asyncomplete-lsp.vim'

然后设置它为 Nim 文件使用 nimlsp：

.. code:: vim

let s:nimlspexecutable = "nimlsp" let g:lsp_log_verbose = 1 let g:lsp_log_file = expand('/tmp/vim-lsp.log') " 用于 asyncomplete.vim 日志 let g:asyncomplete_log_file = expand('/tmp/asyncomplete.log')

let g:asyncomplete_auto_popup = 0

if has('win32') let s:nimlspexecutable = "nimlsp.cmd" " Windows 没有 /tmp 目录，但有 $TEMP 环境变量 let g:lsp_log_file = expand('$TEMP/vim-lsp.log') let g:asyncomplete_log_file = expand('$TEMP/asyncomplete.log') endif if executable(s:nimlspexecutable) au User lsp_setup call lsp#register_server({ \ 'name': 'nimlsp', \ 'cmd': {server_info->[s:nimlspexecutable]}, \ 'whitelist': ['nim'], \ }) endif

function! s:check_back_space() abort let col = col('.') - 1 return !col || getline('.')[col - 1] =~ '\s' endfunction inoremap <silent><expr> <TAB> \ pumvisible() ? "<C-n>" : \ <SID>check_back_space() ? "<TAB>" : \ asyncomplete#force_refresh() inoremap <expr><S-TAB> pumvisible() ? "<C-p>" : "<C-h>"

这个配置允许你按Tab键获取自动完成，并调用各种函数来重命名和获取定义。当然，你可以随意配置这些设置。

Emacs ::::::::

使用lsp-mode和use-package:

.. code:: emacs-lisp

(use-package nim-mode :ensure t :hook (nim-mode . lsp))

或者使用Eglot

.. code:: emacs-lisp

(add-to-list 'eglot-server-programs '(nim-mode "nimlsp"))

Intellij :::::::: 你需要安装LSP支持插件 <https://plugins.jetbrains.com/plugin/10209-lsp-support>。对于语法高亮，我推荐"官方"的nim插件 <https://plugins.jetbrains.com/plugin/15128-nim> （虽然不是严格意义上的官方，但由一位Intellij开发者开发）。该插件最终将使用nimsuggest并支持所有这些功能，甚至更多，但由于它仍然非常新，大多数功能尚未实现，所以LSP是一个不错的解决方案（实际上是唯一的选择）。

使用方法：

安装LSP和nim插件。
进入 设置 > 语言和框架 > 语言服务器协议 > 服务器定义。
将LSP模式设置为 可执行文件，扩展名设置为 nim，在路径中填入nimlsp可执行文件的路径。
点击应用，现在一切应该都能正常工作了。

Kate :::::::: 需要在Kate（版本 >= 19.12.0）的插件菜单中启用LSP插件：

在 设置 > 配置Kate > 应用程序 > 插件 中，勾选 LSP客户端 旁边的复选框以启用LSP功能。
进入现在可用的LSP客户端菜单（设置 > 配置Kate > 应用程序），在用户服务器设置标签中输入以下内容：

.. code:: json

{ "servers": { "nim": { "command": [".nimble/bin/nimlsp"], "url": "https://github.com/PMunch/nimlsp", "highlightingModeRegex": "^Nim$" } } }

这假设nimlsp是通过nimble安装的。 注意：即使nimlsp在系统的 PATH 中，如果在 "command" 条目下没有指定从主目录开始的完整路径，服务器初始化可能会失败。

VS Code ::::::: 安装支持NimLSP的VS Code扩展（目前有2个可用）：

将 nimlsp.path 扩展设置设为 nimlsp 的二进制路径。如果你使用nimble安装了 nimlsp，它应该已经在系统的 PATH 中了。

nimlsp 进程的 stderr 将在 输出 > nim|nimlsp 终端中可见。

运行测试

目前测试不是很多，但可以通过以下命令运行：

.. code:: bash

nimble test

调试

使用 nimlsp_debug 可执行文件代替 nimlsp，它与 nimlsp 一起安装，应该已经在你的路径中可用。

包含stdin/out的日志文件将生成在 getTempDir() / "nimlsp-" & $getCurrentProcessId() / "nimlsp.log" 文件夹中，其中 getCurrentProcessId() 是由IDE/扩展执行的 nimlsp_debug 实例的运行pid，可以使用 pgrep -a nimlsp_debug 读取。崩溃可能会在stderr中打印堆栈跟踪，这不包含在日志中，但可能被LSP客户端捕获。

当stdin/out/err不够时，可以通过 sudo strace -p<pid> -s9999 > strace.log 2>&1 跟踪 nimlsp[_debug] 的所有系统调用。

test/logrunner 可用于重放存储在nimlsp.log中提交给 nimlsp 的查询：

.. code::

NimLSP测试运行器，运行方式为 runner <nimlsp二进制文件> <日志文件> 日志文件必须由启用-d:debugCommunication的nimlsp实例生成。被测试的nimlsp二进制文件不需要此标志。