µlsp

LSP client for micro-editor. Note that this is a work in progress and has not yet been tested extensively – expect there to be some bugs. Please open an issue if you run into any!

Demo

https://asciinema.org/a/610761

Installation

Simply clone the repository to your micro plugins directory:

git clone https://github.com/Andriamanitra/mlsp ~/.config/micro/plug/mlsp

You will also need to install language servers for the programming languages you want to use.

The plugin currently provides following commands:

• lsp start deno lsp starts a language server by executing command deno lsp. Without arguments the lsp start command will try to guess the right server by looking at the currently open filetype.
• lsp stop deno stops the language server with name deno. Without arguments the lsp stop command will stop all currently running language servers.
• lsp hover shows hover information for the code under cursor.
• lsp format formats the buffer that is currently open.
• lsp autocomplete for code completion suggestions. PROTIP: If you wish to use the same key as micro's autocompletion (tab by default), enable tabAutocomplete in config.lua instead of binding command:lsp autocomplete to a key!
• lsp goto-definition – open the definition for the symbol under cursor
• lsp goto-declaration – open the declaration for the symbol under cursor
• lsp goto-typedefinition – open the type definition for the symbol under cursor
• lsp goto-implementation – open the implementation for the symbol under cursor
• lsp find-references - find all references to the symbol under cursor (shows the results in a new pane)
• lsp document-symbols - list all symbols in the current document
• lsp diagnostic-info - show more information about a diagnostic on the current line (useful for multiline diagnostic messages)
• lsp rename new_name - renames the symbol under cursor to new_name. Without arguments the lsp rename command will prompt for a new name.

You can type the commands on micro command prompt or bind them to keys by adding something like this to your bindings.json:

{
  "F7": "command:lsp start",
  "F8": "command:lsp format",
  "Alt-h": "command:lsp hover",
  "Alt-d": "command:lsp goto-definition",
  "Alt-r": "command:lsp find-references"
}

Supported features

• get hover information
• show diagnostics (disabled by default, edit config.lua to enable)
• autocomplete using tab (disabled by default, edit config.lua to enable)
• format document
• format selection
• go to definition
• go to declaration
• go to implementation
• go to type definition
• find references
• list document symbols
• list workspace symbols
• rename symbol
• code actions
• workspace commands
• incremental document synchronization (better performance when editing large files)
• suggest a feature

Showing LSP information on statusline

The plugin provides a function mlsp.status that can be used in the status line format. Here is an example configuration (~/.config/micro/settings.json) that uses it:

{
    "statusformatl": "$(filename) $(modified)($(line),$(col)) | ft:$(opt:filetype) | µlsp:$(mlsp.status)"
}

See micro documentation and the built-in status plugin for more information on customizing the statusline.

Known issues

• Document synchronization for language servers that don't support incremental text document synchronization (eg. metals) does not work properly on micro versions older than 2.0.14
• Unicode characters that require more than one UTF-16 code unit (such as emojis) are not handled properly (#34)

Other similar projects

• AndCake/micro-plugin-lsp is another LSP plugin for micro-editor.