nimlsp

Nim Language Server Protocol (nimlsp)

Nim Language Server Protocol (nimlsp) is a specialized implementation of the Language Server Protocol (LSP) specifically designed for the Nim programming language. Leveraging the capabilities of nimsuggest, nimlsp provides enhanced code suggestion features that were previously exclusive to certain editors. By offering a standardized language server for Nim, nimlsp enhances the coding experience across various text editors that support LSP.

Installation of nimlsp

For users who have installed Nim using the choosenim tool, the recommended and simplest method to install nimlsp is through nimble:

nimble install nimlsp

This command compiles and installs nimlsp into the nimble binary directory. It’s important that Nim's source files are accessible for nimlsp to work properly, which choosenim typically manages automatically. If nimlsp is installed differently and faces file-finding issues, users might need to manually specify the path to Nim sources using the -d:explicitSourcePath=PATH during compilation.

Compilation of nimlsp

For those seeking deeper control over nimlsp's compilation, cloning the repository is an option. Since nimlsp depends on nimsuggest, users must have a local copy of the Nim repository available. Users must set the source path explicitly with -d:explicitSourcePath=PATH for both compiling and running if the default path settings are insufficient.

Supported Features

Nimlsp supports a variety of LSP features, giving users an enriched development experience. The features currently implemented include:

• Text Document Management: Opening, closing, saving, and changing documents.
• Code Navigation: Completion, definition, hover, references, and signature help.
• Diagnostics: Publishing diagnostic information and renaming capabilities.

Future updates aim to include additional functionalities such as code action execution, document formatting, and symbol management in the workspace.

Setting up nimlsp in Different Editors

Sublime Text:
Utilize the LSP and Nim plugins to enable nimlsp. Customize settings to ensure nimlsp is recognized as the LSP client for Nim files.

Vim:
Use relevant plugins like vim-lsp, and configure Vim to recognize nimlsp for Nim files. Custom key mappings can support code completion and other nimlsp features.

Emacs:
Integrate nimlsp using lsp-mode or Eglot with nim-mode to seamlessly work with Nim in Emacs.

IntelliJ:
Install the LSP support and Nim plugins, then configure the server settings to link nimlsp executable path with the IntelliJ environment for Nim development.

Kate:
Enable the LSP plugin in Kate and configure it accordingly for nimlsp, ensuring Kate utilizes it for Nim syntax.

VS Code:
Choose between two available extensions to support nimlsp, configuring settings to ensure the correct execution path for nimlsp is set.

Testing and Debugging

Testing of nimlsp can be performed using the following command, although current tests are limited in number:

nimble test

For debugging, the nimlsp_debug executable provides extensive logging capabilities, capturing input/output data in specified log files. Further system call tracing can be performed using tools like strace for more detailed troubleshooting insights.

By providing a comprehensive and consistent coding environment for Nim across various editors, nimlsp fosters ease of development, thereby enhancing the overall productivity and experience for Nim programmers.