CHANGELOG.md

Unreleased

18.0.3 - 2024-11-03

Yet another release to fix regressions present in the 18.0.* series:

• Stop writing temporary files to /tmp on every LSP request since /tmp might not be mounted as tmpfs.
• Work around a case where an unnecessary KakEnd hook in user configuration would cause delay when exiting the editor.
• Fix crash when the language table is used in the kak-lsp.toml file (both of which are deprecated).
• Fix crashes in lsp-selection-range and lsp-show-message-request-next.
• Fix default configuration for Julia.

18.0.2 - 2024-10-18

Breaking changes:

• The -v parameter is now ignored because, it pollutes the *debug* buffer since version 18.0.0. Use the lsp_debug option instead. It's only meant to be set temporarily, for debugging. For the case where kak-lsp is started outside the editor, an equivalent --debug command line flag has been added.

Fixes:

• Fix startup error on HTML files.
• Fix a regression in lsp-workspace-symbol{,-incr} commands.
• Fix crash due to a regression in lsp-highlight-references.
• Demote a number of logs to keep the *debug* buffer clean. Only errors, warnings and occasional info logs should be shown.
• The info box shown by lsp-show-message-{error,warning,info} is no longer created in the toolsclient but in the most recently used client.
• Fix missing error messages when LSP commands are run from either a scratch buffer or a buffer where the server is not installed.

Additions:

• Further reduce the number of shell calls caused by hooks, in addition to the work done on this in version 18.0.0.
• When crashing via a Rust panic, the process is now aborted and creates a coredump. Also, crashes are now shown in an info box.

18.0.1 - 2024-10-14

Fix error parsing a legacy kak-lsp.toml that doesn't have a language_ids section.

18.0.0 - 2024-10-13

The kak-lsp.toml config file has been deprecated, as have been lsp_config, KAK_LSP_PROJECT_ROOT_* and KAK_LSP_FORCE_PROJECT_ROOT as well as commandline flags --config, --log and --timeout. This is in favor of new Kakoune options lsp_servers, lsp_language_id, lsp_semantic_tokens, lsp_timeout, lsp_snippet_support and lsp_file_watch_support. In particular, the lsp_servers option makes it easier to

1. override servers only for specific filetypes, and
2. set server config dynamically (based on project etc.) via Kakoune commands and hooks. For backwards compatibility, the new options are ignored if a kak-lsp.toml exists in the user's config directory (or is provided via --config). By default, lsp_servers and lsp_language_id are populated via the hooks in the lsp-filetype-.* groups, feel free to remove them. See the documentation of the respective options for details. Thanks to Tobias Pisani for designing this config rework.

Breaking changes:

• The --session argument used to allow using a single kakoune-lsp server from multiple Kakoune sessions. This feature has been removed to allow supporting rename-session better; it may be added back if we find a need for it. The --session argument is now ignored, except when kak-lsp is started outside the editor. This means that you probably don't need to override the lsp_cmd option anymore. Additionally, rename-session no longer breaks kakoune-lsp by invalidating the --session argument.
• lsp-stop-on-exit-disable and lsp-stop-on-exit-enable no longer have an effect. Instead, the kakoune-lsp server will always stop running as soon as its associated Kakoune session exits.
• The default server timeout has been increased from 1800 seconds (30 minutes) to 18000 seconds (5 hours), to avoid potential delays from frequent restarts.

Additions:

• Log messages are now written to the *debug* buffer.
• New option lsp_debug to control log verbosity without restarting kak-lsp.
• New command lsp-restart.
• The --kakoune argument is no longer needed and has been deprecated. This simplifies the minimal configuration to eval %sh{kak-lsp}; lsp-enable.
• If the server supports LSP workspaceFolders, a single language server instance will be reused for all projects in a Kakoune session. The file where the language server was originally started from determines the (only) workspaceFolder we send to the language server.
• In language server definitions, the command field is now optional and defaults to the name of the language server.
• New faces DiagnosticTagDeprecated and DiagnosticTagUnnecessary for the LSP's diagnostic tags.

Fixes:

• On rename-session, the kakoune-lsp server for the old session will be shut down. This only works with Kakoune version >= v2024.05.09.
• lsp-* commands that require lsp-enable/lsp-enable-window now fail more explicitly.
• Fix a crash when requesting code actions from rust-analyzer.
• Fix a crash when running Rust unit tests via rust-analyzer's lsp-code-lens.
• lsp-goto-document-symbol now uses qualified names, to make sure that it shows all symbols in the current buffer.

17.1.2 - 2024-08-17

Additions:

• Experimental LSP client capabilities can now be enabled via kak-lsp.toml.

Fixes:

• Fix crash on multiple language servers when one server doesn't support code actions.
• For consistency with our root_path project detection mechanism, the default config for Julia no longer supports the JULIA_PROJECT environment variable nor falls back on the global Julia environment.
• Fix build on Rust 1.80.

17.1.1 - 2024-06-27

Additions:

• Default configuration for Svelte via svelte-language-server.
• The language server stderr is logged eagerly instead of only after server exit; (useful for when servers like rust-analyzer crash).
• Support dynamic for registration semantic tokens via textDocument/semanticTokens.
• lsp-code-actions has learned to filter by code action kind. This should obsolete the lsp-code-action command which has been hidden and deprecated.
• lsp-code-actions learned the -auto-single switch to instantly run if there is only one matching code action.
• The default config now enables inlay hints also for recent version of Scala Metals.

Fixes:

• Fixed a case where a legacy kak-lsp.toml specifying the same server for multiple languages would drop all but one language.
• Some hover info had extra trailing whitespace, which is now trimmed properly.
• Hover info containing ASCII-art tables as popular in some flavors of Markdown is now rendered properly.

17.0.1 - 2024-04-06

Small patch release to fix a regression.

Fixes:

• Fix startup error when both lsp.kak and Kakoune's jump.kak are autoloaded.

17.0.0 - 2024-04-04

Breaking changes:

• New default server for Nix, nil, replacing rnix-lsp.
• Our gopls usePlaceholders setting now defaults to true in the default config, make sure to either add a mapping for lsp-snippets-select-next-placeholders or disable snippets.
• gopls default config has been changed so inlay (type) hints require no gopls-specific knobs to turn on. As with other servers, inlay hints are only requested when lsp-inlay-hints-enabled is used.
• The default config for HTML/CSS/JSON has been updated to use vscode-{html,css,json}-language-server as server command instead of vscode-{html,css,json}-languageserver.
• Support for watching files (workspace/didChangeWatchedFiles) is now disabled by default to avoid performance problems.
• Inlay code lenses (used by OCaml and Haskell language servers) are now shown after the referenced line. This requires Kakoune version >= 2024.
• lsp-auto-hover-enable no longer takes an argument; that functionality has been moved to lsp-auto-hover-buffer-enable, and it no longer magically spawns a client.
• Removed lsp-connect experimental command.

Additions:

• New commands jump-{next,previous} (which have also been added to Kakoune) replace and deprecate lsp-{next,previous}.
• lsp-document-symbol no longer renders the same filename in every single line. Commands like jump-next and <ret> still work as before.
• New option lsp_hover_max_info_lines replaces and deprecates lsp_hover_max_lines which now defaults to -1 which means lsp_hover_max_info_lines is used to control lines of information in the hover box.
• New option lsp_hover_max_diagnostic_lines to limit the lines for diagnostics in the hover box.

Fixes:

• Fix gopls code actions like "Extract function".
• Various improvements to compatibility with old Kakoune.

16.0.0 - 2024-02-20

Both the kak-lsp project and GitHub organization have been renamed to kakoune-lsp. The binary and config file paths are unchanged. Distributors are encouraged to update the package name.

Breaking changes:

• kakoune-lsp now requires Kakoune version >= v2022.10.31 for commands that use a menu, like code actions.

Additions:

• The modeline shows breadcrumbs like somemodule > someclass > somefunction to indicate the symbol around the main cursor.
• lsp-document-symbols now renders symbols in a tree.
• lsp_auto_show_code_actions (which renders a lightbulb in the modeline) now defaults to true.
• lsp-code-lens can now run the test at cursor with rust-analyzer. Fixes:
• lsp-inlay-diagnostics no longer jump around when the cursor is moved over the diagnostics. To use this feature, use Kakoune version >= 2024 (not yet release, consider building from source).
• When LSP integration is enabled, then disabled and enabled again, the KakEnd hook failed to ask the server to exit, which has been fixed.
• lsp-auto-hover-enable now only re-renders hover info when the main selection changes. This means that :info is no longer shadowed immediately by auto hover.
• Completion snippets (accessed via lsp-snippets-select-next-placeholders) can now be nested, making it possible to cycle through the arguments of nested function calls.
• In some cases, selecting completions provided by rust-analyzer would labels with extra characters (like self.some_method(…)) which has been fixed.
• completionItem.additionalTextEdits are now applied also when the server does not support completionItem/resolve.
• Snippet metacharacters are now properly escaped, removing spurious backslashes from inserted completions.

15.0.1 - 2023-12-11

Additions:

• Default configuration for Markdown via marksman.
• Default configuration for Java via jdtls.

Fixes:

• Fix regression in "lsp-show-message-error" and friends.

15.0.0 - 2023-11-15

Additions:

• Support multiple language servers per filetype (#17).
• The kak-lsp.toml format for specifying language servers has changed. The old format is still supported (#686).
• lsp-goto-document-symbol learned to show a preview of the jump target.
• Default configuration for PureScript and Scala.

Fixes:

• A regression broke resolving completion item documentation when cycling through completion candidates, which has been fixed (#674).
• New command lsp-declaration, implementing textDocument/declaration.

14.2.0 - 2023-02-13

Additions:

• Default configuration for CMake.
• If there are no code actions in the main selection, lsp-code-actions will show code actions from anywhere on a selected line, to make it easier to perform quick-fixes.
• If requested by the language server, kakoune-lsp will recursively watch the entire root directory for file changes and forward them to the server via workspace/didChangeWatchedFiles (#649).
• kakoune-lsp now asks the server to cancel stale requests (#666).
• lsp-did-change is async again, which can improve performance (#667).
• kakoune-lsp is published to crates.io for easy installation (#660).

Fixes:

• Fix race conditions when spinning up a new server in "kak-lsp --request" (#654), and in "lsp-hover-buffer" (#664).
• Send inlay hints and semantic tokens only after buffer changes (#663).

14.1.0 - 2022-10-26

Additions:

• Default language server for protobuf.
• Added support for codeAction/resolve, which allows to use code actions sent by Deno for example.
• The recommended mappings have been augmented by new command lsp-diagnostic-object to jump to next/previous diagnostics.
• lsp-auto-signature-help-enable now shows an info box by default, and formats the active parameter in a bold font.
• lsp-definition and friends now select the symbol name instead of merely placing the cursor at symbol start. Same for lsp-find-error.
• lsp-highlight-references now selects all references in the current buffer.
• New lsp-inlay-code-lenses-enable command allows to render code lenses as virtual text (#623).
• The support for filterText in completions no longer depends on an out-of-tree Kakoune feature.

Fixes:

• Fix lags due to rust-analyzer sending a ton of progress reports.
• lsp-rename will now write hidden buffers that are affected by the rename, to give the language server and other external tools a more consistent view of affected files.
• Suppress "language server not initialized" errors that originate from hooks.
• Fix a glitch when a line has both a code lens and an inline diagnostic.
• When talking to servers that don't support UTF-8 byte-offsets, kakoune-lsp now adheres to the LSP specification by treating column-offsets as UTF-16 Code Units instead of Unicode Code Points.

14.0.0 - 2022-08-29

This is a small bug fix release but it also includes updates to the default config.

Breaking changes:

• typescript-language-server replaces flow as default language server for JavaScript.
• crystalline replaces scry as default language server for Crystal.
• The user mode mapping for s now runs lsp-goto-document-symbol instead of lsp-signature-help. The old mapping (<c-o>) has been removed.

Fixes:

• lsp-find-error and code lenses were broken in 13.0.0, which has been fixed.
• The server-specific configuration for the solargraph Ruby language server has been fixed.
• The new command lsp-goto-document-symbol (which replaced the old <c-o> binding) can now handle nested symbols.

13.0.0 - 2022-08-11

Here are some notable changes. See the git log for a full list of changes.

Breaking changes:

• Completion snippet support is now enabled again in the default config.
• The default object mode mappings have been removed. Users are expected to add their preferred mappings. The README now has a section with recommended mappings.

Additions:

• Default configuration for Elvish and Clojure.
• On macOS, the config file is now read from $XDG_CONFIG_HOME/kak-lsp/kak-lsp.toml. The old location (~/Library/Preferences/kak-lsp/kak-lsp.toml) is used as a fallback (#293).
• Added shim support for workspace/WorkspaceFolders, which fixes interaction with bash-language-server.
• Some errors are shown directly in the editor, unless the error was triggered by a hook.
• lsp-document-symbol now indents nested symbols.

Fixes:

• Completions with snippets now interact properly with Kakoune's completion engine (#616).
• Fixed default configuration for HTML/CSS/JSON following the upstream renaming of the binaries.
• lsp-enable-window no longer adds a redundant global NormalKey hook (introduced in 12.1.0)
• kakoune-lsp now avoids sending unsupported requests to the server.

12.2.1 - 2022-05-08

Fixes:

• lsp-code-lens failed to run code lenses which has been fixed.

12.2.0 - 2022-05-03

Deprecations:

• rust-analyzer-inlay-hints is deprecated in favor of lsp-inlay-hints-enable. Inlay hints now requires rust-analyzer version >= 2022-04-18. (#602, #613).

Additions:

• Support LSP Code Lenses (#490).
• Support the new textDocument/inlayHint request from LSP v3.17 (#600).
• New command lsp-inlay-hints-enable simplifies inlay hints configuration (#602).
• Completion item documentation can now be resolved lazily if required by the language server (6bee0a13).
• lsp-hover now shows diagnostics from anywhere on a line touched by the main selection, instead of just diagnostics whose range contains the cursor (5461c141).
• lsp_hover_max_lines now defaults to 20 which limits the size of the info box spawned by lsp-hover (#615).

Fixes:

• lsp-formatting with pylsp now preserves cursor positions again (regressed in 12.1.0).
• Inlay diagnostics are now disabled in insert mode, to avoid diagnotsics jumping around while typing (#605).
• The default config for typescript-language-server now supports TSX files (#211).
• lsp-object (]a etc.) can now jump past the symbols sent by pylsp.
• texlab-forward-search's SyncTeX inverse search now works in more scenarios (#603).
• Support server specific configuration servers like pylsp that don't use initializationOptions for configuration (#611).

12.1.0 - 2022-03-28

Additions:

• New mappings for Kakoune's object mode allow to select adjacent/surrounding symbols like functions or types (#598).
• New mapping for the lsp user mode, <c-o>, spawns a menu to jump to buffer symbol (#584).
• lsp-formatting used to spawn several shell processes for each modification, which caused noticable delays when formatting many lines. This has been remedied by avoiding shell calls (88f52f0c).
• kakoune-lsp is now compatible with the proposed changes to P and (see Kakoune's breaking-cleanups branch).
• The documentation now communicates that kakoune-lsp appends to the global modeline at load time (eb54d378).
• New experimental command lsp-connect allows to handle certain LSP responses messages with a custom command (#584).

Bug fixes:

• lsp_auto_show_code_actions has been fixed to actually hide the lightbulb when no code action is available (76cff5f2).
• Loading kakoune-lsp no longer leaves around a scratch buffer (#593).
• Code actions are now offered for the main selection's range, instead of just the cursor position. This unlocks an "extract to function" refactoring from rust-analyzer. (#594).
• The *-sync commands now automatically restart the server instead of showing an error if the server is down (b54ec807).

12.0.1 - 2022-01-29

Bug fixes:

• Fix regression in 12.0.0 where kakoune-lsp would panic when applying text edits that span until the buffer end, such as from lsp-formatting with zls (#589).
• Diagnostics no longer break when a diagnostic's message contains % (#590).

12.0.0 - 2022-01-26

Breaking changes:

• python-lsp-server replaces python-language-server as default language server for Python.
• rust-analyzer replaces rls as default language server for Rust (#578).

Additions:

• lsp-handle-progress gained a default implementation that shows an hourglass (⌛) in the modeline when a language server is busy (f8a8cf8).
• The code action menu now provides fuzzy (subsequence) filtering but no longer provides <c-n>/<c-p> due to implementation reasons (b4ee2a3).
• When accepting a completion, any additionalTextEdits are now applied. For example, rust-analyzer adds import statements this way (2637b26).
• New command lsp-code-action-sync is the synchronous variant of lsp-code-action, suitable for use in BufWritePre hooks (#582).
• The default configuration for semantic_tokens now uses a more condensed syntax (#587).
• Some systems' C libraries ship old Unicode databases, but terminals often bundle newer versions. To avoid graphical glitches, emoji are only used if they are assigned display width 2 by the C library's wcwidth(3) (73c2d1a, c3aeb0d).
• The clangd protocol extension for offset encoding negotiation is now supported, which means kakoune-lsp now uses UTF-8 offsets if the server supports them (#485).

Bug fixes:

• lsp-formatting-sync now works again with texlab instead of blocking forever (regressed in 11.0.0) (a12831a).
• Certain text edits (such as some code actions from rust-analyzer) were not applied correctly, which has been fixed (35ba8de).

11.1.0 - 2021-12-08

Additions:

• Default configuration for Erlang (#548), R (#555) and Racket (#568).
• Goto/get hover info of next/previous function with new lsp-next-function/lsp-hover-next-function (#557).
• Allow to show hover info in the *hover* buffer (instead of the info box) with new lsp-hover-buffer (#564, #257).
• Show lightbulb in modeline when code actions are available and lsp_auto_show_code_actions is set (#538).
• Run specific code actions with new lsp-code-action (#566).
• Support LSP's Call Hierarchy, to show callers/callees of the function at cursor with lsp-incoming-calls/lsp-outgoing-calls (#554).
• Support LSP's Selection Range, to quickly select interesting ranges around cursors with lsp-selection-range (#288).
• Create just one undo entry for sequences of text edits (like from lsp-code-actions or lsp-formatting) (#533).
• Set new environment variable KAK_LSP_FORCE_PROJECT_ROOT to use the same project root even for files outside a project, to reuse a single language server (#542).
• Support server progress notifications via $/progress, removing support for the non-standard window/progress (#545).
• Support for filterText in completions, which depends on a proposed Kakoune feature (#551).
• Allow multiple characters and spaces in diagnostic gutter via lsp_diagnostic_line_error_sign and friends (#571).
• Support LaTeX language server texlab's custom commands with texlab-build and texlab-forward-search (SyncTeX support) (#573).

Bug fixes:

• Honor extra_word_chars for completions, fixing completion of Lisps (#568).
• Fix go-to-definition for files containing invalid UTF-8 (#535).
• Fix default server-specific configuration for pyls (regressed in 11.0.0).
• Use the LineNumbers face for the flag-lines highlighter that shows diagnostics, to work better with non-default backgrounds (#524).
• Fix applying sequences of text edits, like from lsp-code-actions or lsp-formatting (#527).
  • Also, do not drop trailing newline from text edits (e9af1aa).
• Quoting/escaping fixes for diagnostics and hover info.

11.0.1 - 2021-09-17

This is mostly a bug fix release but also includes Markdown rendering and enhanced inlay diagnostics.

Breaking changes:

• The face LineFlagErrors has been renamed to LineFlagError, for consistency with other faces (#516).

Bug fixes:

• Fix example server configuration for lua-language-server.
• Fix completion of tokens containing non-word-characters, such as Ruby attributes, Ruby symbols and Rust lifetimes (#378, #510).
• lsp-highlight-references clears highlights on failure, improving the behavior when %opt{lsp_auto_highlight_references} is set to true (#457).
• Fix jumping to locations when Kakoune working directory is different from project root (#517).
• Fix jumping to locations with absolute paths (#519).
• Diagnostics of level "info" and "hint" are no longer shown as "warning", and are given distinct faces (#516).
  • find-next-error will skip over "info" and "hint" diagnostics.
• Fix adjacent insertion text edits, for example as sent by rust-analyzer as code actions (#512).
• The default kak-lsp.toml recognizes .git and .hg as project root markers for C/C++ files. This makes lsp-references work better out-of-the-box for projects like Kakoune that don't need a compile_commands.json.

Additions:

• Render Markdown from hover and from completions in info box. You can set custom faces to highlight different syntax elements (#73, #513).
  • Some servers like pyls send that info in plaintext but label it as Markdown. Work around this with a new configuration option workaround_server_sends_plaintext_labeled_as_markdown in the default kak-lsp.toml to force plaintext rendering.
• Multiple inlay diagnostics on a single line are coalesced (#515).

11.0.0 - 2021-09-01

Breaking changes:

• Two incompatible changes to the configuration format - see the updated kak-lsp.toml for examples.
  • semantic_tokens syntax has changed, allowing for more fine-grained face configuration (#488)
  • settings replaces initialization_options for server-specific settings (#511)
• Snippet support has been disabled by default, as a workaround for conflicts with Kakoune's built-in completion (#282).
• lsp-show-message, which handles window/showMessage requests from the server has been removed. See below for the replacement.
• Hidden commands lsp-next-match and lsp-previous-match were removed in favor of lsp-next-location and lsp-previous-location (#466).
• haskell-language-server is the new default language server for Haskell, replacing haskell-ide-engine.

Additions:

• Finish support for workspace/configuration (#234).
• %opt{lsp_config} allows to set server-specific settings dynamically (#500).
• Default configuration for Julia (#502).
• lsp-show-message has been replaced by four separate commands lsp-show-message-{error,warning,info,log}. The new default implementations log the given messages from the language server to the debug buffer. Important messages are shown in %opt{toolsclient}.
• The new command lsp-show-code-actions can be overridden to customize the default menu behavior of lsp-code-actions (#367).
• New commands lsp-{next,previous}-location generalize grep-next-match, lsp-next-match and friends (#466).
• New option lsp_location_format to customize the ":"-style location patterns that lsp-{next,previous}-location can match (#466).

Bug fixes:

• Fix renaming of Rust lifetimes (#474).
• The suggested config for rust-analyzer was fixed for the case that rustup is installed but rust-analyzer is not installed via rustup.
• Fix spurious cursor movement on lsp-rename and lsp-rename-prompt (#504).
• Fix responses to workspace/configuration in case there are no initialization options set (#509).

Deprecations:

• %opt{lsp_server_initialization_options} and %opt{lsp_server_configuration} are deprecated in favor of setting [language.<filetype>.settings] in %opt{lsp_config}(#500).
• lsp-{goto,symbols}-{next,previous}-match are deprecated in favor of commands like lsp-next-location *goto* and similar (#466).

10.0.0 - 2021-06-03

This is a small release with a useful fix to lsp-rename (#481).

Breaking changes:

• The semantic highlighting feature has been removed. It is superseded by semantic tokens which are officially part of LSP 3.16.
• Buffers *goto*, *symbols*, *diagnostics* are given the lsp-goto filetype instead of grep or make (#454).
• ocamllsp replaces the discontinued ocaml-language-server as default language server for OCaml (#471).

Additions:

• lsp-rename-prompt is added to to the lsp user mode, mapped to R (#441).
• Default configuration for CSS variants "less" and "scss" (#473).
• kakoune-lsp sends the configured offset encoding to the language server (see https://clangd.llvm.org/extensions.html#utf-8-offsets), which still defaults to utf-16.
• lua-language-server was added as default language server for Lua.

Bug fixes:

• Fix edits (by lsp-rename and friends) to files that were not opened as Kakoune buffers (#481).
• lsp-show-{diagnostics,goto-choices,document-symbols} no longer cd to the project root (#454).
• Fix error when the documentation part of a completion item starts with a dash (-) (#460).
• Fix completions of non-ASCII characters for some textEdit completions (#455).
• Fix lsp-rename with pyright (#468).
• Treat snippets containing < literally, instead of as Kakoune key names (#470)
• Nested entries in lsp_server_initialization_options like a.b=1 are sent to language servers as {"a":{"b":1}} instead of {"a.b":1}, matching the treatment of lsp_server_configuration (#480).
• Fix a case where lua-language-server would hang (#479) because kakoune-lsp didn't support workspace/configuration; basic support has been added.

For release notes on v9.0.0 and older see https://github.com/kakoune-lsp/kakoune-lsp/releases.