OCaml Changelog

Features

• Introduce a configuration option to control Dune diagnostics. The option is called duneDiganostics, and it may be set to { enable: false } to disable diagnostics. (ocaml/ocaml-lsp#1221)

• Support folding of ifthenelse expressions (ocaml/ocaml-lsp#1031)

• Improve hover behavior (ocaml/ocaml-lsp#1245)

  Hovers are no longer displayed on useless parse tree nodes such as keywords, comments, etc.

  Multiline hovers are now filtered away.

  Display expanded PPXs in the hover window.

• Improve document symbols (ocaml/ocaml-lsp#1247)

  Use the parse tree instead of the typed tree. This means that document symbols will work even if the source code doesn't type check.

  Include symbols at arbitrary depth.

  Differentiate functions / types / variants / etc.

  This now includes PPXs like let%expect_test or let%bench in the outline.

• Introduce a destruct-line code action. This is an improved version of the old destruct code action. (ocaml/ocaml-lsp#1283)

• Improve signature inference to only include types for elements that were absent from the signature. Previously, all signature items would always be inserted. (ocaml/ocaml-lsp#1289)

• Add an update-signature code action to update the types of elements that were already present in the signature (ocaml/ocaml-lsp#1289)

• Add custom ocamllsp/merlinCallCompatible request (ocaml/ocaml-lsp#1265)

• Add custom ocamllsp/typeEnclosing request (ocaml/ocaml-lsp#1304)

Fixes

• Detect document kind by looking at Merlin's suffixes config.

  This enables more LSP features for non-.ml/.mli files. Though it still depends on Merlin's support. (ocaml/ocaml-lsp#1237)

• Correctly accept the --clientProcessId flag. (ocaml/ocaml-lsp#1242)

• Disable automatic completion and signature help inside comments (ocaml/ocaml-lsp#1246)

• Includes a new optional/configurable option to toggle syntax documentation. If toggled on, allows display of syntax documentation on hover tooltips. Can be controlled via environment variables and by GUI for VS code. (ocaml/ocaml-lsp#1218)

• For completions on labels that the LSP gets from Merlin, take into account whether the prefix being completed starts with ~ or ?. Change the label completions that start with ? to start with ~ when the prefix being completed starts with ~. (ocaml/ocaml-lsp#1277)

• Fix document syncing (ocaml/ocaml-lsp#1278, ocaml/ocaml-lsp#1280, fixes ocaml/ocaml-lsp#1207)

• Stop generating inlay hints on generated code (ocaml/ocaml-lsp#1290)

• Fix parenthesising of function types in SignatureHelp (ocaml/ocaml-lsp#1296)

• Fix syntax documentation rendering (ocaml/ocaml-lsp#1318)

Fixes

• Fix missing super & subscripts in markdown documentation. (#1170)
• Do not invoke dune at all if --fallback-read-dot-merlin flag is on. (#1173)
• Fix semantic highlighting of infix operators that contain '.'. (#1186)
• Disable highlighting unit as an enum member to fix comment highlighting bug. (#1185)
• Improve type-on-hover and type-annotate efficiency by only formatting the type of the first enclosing. (#1191, #1196)
• Fix the encoding of URI's to match how vscode does it (#1197)
• Fix parsing of completion prefixes (#1181)

Features

• Compatibility with Odoc 2.3.0, with support for the introduced syntax: tables, and "codeblock output" (#1184)
• Display text of references in doc strings (#1166)
• Add mark/remove unused actions for open, types, for loop indexes, modules, match cases, rec, and constructors (#1141)
• Offer auto-completion for the keyword in (#1217)

Fixes

• Fix file permissions used when specifying output files of pp and ppx. (ocaml-lsp#1153)

Features

• Add "Remove type annotation" code action. (#1039)
• Support settings through didChangeConfiguration notification (#1103)
• Add "Extract local" and "Extract function" code actions. (#870)
• Depend directly on merlin-lib 4.9 (#1070)

Fixes

• Support building with OCaml 5.0 and 5.1 (#1150)

• Disable code lens by default. The support can be re-enabled by explicitly setting it in the configuration. (#1134)

• Fix initilization of ocamlformat-rpc in some edge cases when ocamlformat is initialized concurrently (#1132)

• Kill unnecessary $ dune ocaml-merlin with SIGTERM rather than SIGKILL (#1124)

• Refactor comment parsing to use odoc-parser and cmarkit instead of octavius and omd (#1088)

  This allows users who migrated to omd 2.X to install ocaml-lsp-server in the same opam switch.

  We also slightly improved markdown generation support and fixed a couple in the generation of inline heading and module types.

• Allow opening documents that were already open. This is a workaround for neovim's lsp client (#1067)

• Disable type annotation for functions (#1054)

• Respect codeActionLiteralSupport capability (#1046)

• Fix a document syncing issue when utf-16 is the position encoding (#1004)

• Disable "Type-annotate" action for code that is already annotated. (#1037, fixes #1036)

• Fix semantic highlighting of long identifiers when using preprocessors (#1049, fixes #1034)

• Fix the type of DocumentSelector in cram document registration (#1068)

• Accept the --clientProcessId command line argument. (#1074)

• Accept --port as a synonym for --socket. (#1075)

• Fix connecting to dune rpc on Windows. (#1080)

Fixes

• Fix race condition when a document was being edited and dune in watch mode was running (#1005, fixes #941, #1003)

Features

• Enable semantic highlighting support by default (#933)

• Support connecting over pipes and socket. Pipes on Windows aren't yet supported (#946)

  More about communication channels in LSP specification.

• Re-enable ocamlformat-rpc for formatting code snippets (but not files and not on Windows) (#920, #939)

  One needs to have installed either ocamlformat package version > 0.21.0 or, otherwise, ocamlformat-rpc package. Note that previously ocamlformat-rpc came in a standalone OPAM package, but since ocamlformat version > 0.21.0, it comes within ocamlformat package.

• Add custom ocamllsp/hoverExtended request (#561)

• Support utf-8 position encoding clients (#919)

  More about position encoding in LSP specification.

• Show unwrapped module alias types on hovering over module names. This is due to upgrading to merlin 4.7 and using merlin's verbosity=smart by default (#942)

Fixes

• Respect the client's completion item resolve and preSelect capabilities (#925, #936)

• Disable polling for dune's watch mode on Windows and OCaml 4.14.0 (#935)

• Fix semantic highlighting of "long identifiers," e.g., Foo.Bar.x (#932)

• Fix syncing of document contents:

  • For ranges that span an entire line (#927)
  • Previously, whole line edits would incorrectly eat the newline characters (#971)

Oops, we went looking but didn't find the changelog for this release 🙈

Fixes

• Fix random requests failing after switching documents (#904, fixes #898)

• Do not offer related diagnostic information unless the user enables in client capabilities (#905)

• Do not offer diagnostic tags unless the client supports them (#909)

• Do not attach extra data to diagnostics unless the client supports this (#910)

• Use /bin/sh instead of /bin/bash. This fixes ocamllsp on NixOS

Fixes

• Fix various server crashes when opening non OCaml/Reason files. Files such as dune, cram, etc. would cause the server to crash. (#884, fixes #871)

• Ignore unknown tags in merlin configuration to improve forward compatibility with Dune. (#883)

Features

• Code action for inlining let bindings within a module or expression. (#847)

• Tag "unused code" and "deprecated" warnings, allowing clients to better display them. (#848)

• Refresh merlin configuration after every dune build in watch mode (#853)

Fixes

• Respect showDocument capabilities. Do not offer commands or code actions that rely on this request without client support. (#836)

• Fix signatureHelp on .mll files: avoid "Document.dune" exceptions

Oops, we went looking but didn't find the changelog for this release 🙈

Fixes

• Fix cwd when executing ppx (#805)

Features

• Code actions for jumping to related files (.ml, .mli, etc.) (#795)

• Allow cancellation of workspace symbols requests (#777)

• Fix unintentionally interleaved jsonrpc IO that would corrupt the session (#786)

• Ignore SIGPIPE . (#788)

Fixes

• Fix a bad interaction between inferred interfaces and promotion code actions in watch mode (#753)

• Fix URI parsing (#739 fixes #471 and #459)

Fixes

• Fix shutting down an already closed socket (#740)

Fixes

• Fix preprocessing, ppx, and reason support (#735 fixes #696, #706)

• Support include in folding ranges (#730)

Features

• Fix cancellation mechanism for all requests (#707)

• Allow cancellation of formatting requests (#707)

• Add --fallback-read-dot-merlin to the LSP Server (#705). If ocamllsp is started with this new flag, it will fall back to looking for Merlin configuration in .merlin files rather than calling dune ocaml-merlin. (#705)

• Support folding more ranges (#692)

Fixes

• Stop leaking file descriptors like a sieve (#701)

• Fix process termination. Once the lsp server is stepped, the process will gracefully terminate (#697, fixes #694)

• Forward stderr from dune's merlin configuration to the lsp server's stderr (#697)

• Fix bug with large buffers being resized incorrectly in Lev

• Add folding ranges for more AST types (#680)

Fixes

• Enable dune rpc integration by default (#691, fixes #690)

Fixes

• Fix running external processes on Windows

Fixes

• Fix Uri handling on Windows

• Fix build on MSVC 2015

Features

• Add support for dune in watch mode. The lsp server will now display build errors in the diagnostics and offer promotion code actions.

• Re-introduce ocamlformat-rpc (#599, fixes #495)

Fixes

• Fix workspace symbols that could have a wrong path in some cases (#675)

Fixes

• Compatiblity with OCaml 4.14.0

Fixes

• Patch merlin to remove the result module

Fixes

• Fix more debouncing bugs (#629)

Fixes

• Catch merlin desturct exceptions (#626)

• Fix broken debouncing (#627)

Fixes

• Fix executing ppx executables