OCaml Changelog

Fixes

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

Added

• Report all parsing errors in Markdown files (#389, @NathanReb)

Changed

• Preserve indentation in multiline OCaml blocks in .mli files (#395, @panglesd)
• Rename the Normal syntax to Markdown to better explain what the syntax is and moved it to Mdx.Syntax (#412, @Leonidas-from-XIV)

Fixed

• Fixed compatibility with Cmdliner 1.1.0 (#371, @Leonidas-from-XIV)
• Report errors and exit codes of toplevel directives (#382, @talex5, @Leonidas-from-XIV)
• Fix block locations in error reporting (#389, @NathanReb)
• Include the content of the line that features the part-end MDX directive in the output, before that line would've been dropped (#374, #387, @Leonidas-from-XIV)
• Handle EINTR signal on waitpid call by restarting the syscall. (#409, @tmcgilchrist)
• Fix parsing of multiline toplevel phrases in .mli files (#394, #397, @Leonidas-from-XIV)

Removed

• Removed warning about missing semicolons added in MDX 1.11.0 and the automatic insertion of semicolons in the corrected files introduced in MDX 2.0.0. (#398, @Leonidas-from-XIV)

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)

• Bump the compatibility to 4.08+ (#393 @emillon)
• Load @toplevel_printer annotated printers for functors (#378 @metavinek)
• Do not display a backtrace when exiting normally (#399 #398 @emillon)

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

Additions

• New unstable option --as-json for the HTML renderer that emits HTML fragments (preamble, content) together with metadata (table of contents, breadcrumbs, whether katex is used) in JSON format. (@sabine, #908)
• New maths support via {m ... } and {math ... } tags. (@giltho, @gpetiot, #886)
• Various optimisations (@jonludlam, #870, #883)
• Better handling of alerts and deprecation notices. (@panglesd, #828)
• Handle language tags on code blocks (@julow, #848)

Bugfixes

• Shadowing issues (@jonludlam, #853)
• Layout fixes and improvements (@panglesd, #832, #839, #847)
• Handle comments on class constraints and inherit (@julow, #844)
• Disable the missing root warning (@jonludlam, #881)

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

• merlin binary
  • Replace custom "holes" AST nodes by extensions. This restores binary compatibility and fixes issues with PPXs when using typed-holes. (#1503)
  • Do not change temporarily Merlin's cwd when starting a PPX (#1521, fixes #1420)
  • Fix a parsing issue when declaring the (??) custom prefix operator. (#1507, fixes #1506)
  • Fix variant constructors' comments grouping (#1516, @mheiber, fixes #1513)
  • Filter-out duplicates from the enclosing command result (#1512)
  • Add a new verbosity=smart mode for type enclosing that only expand modules' types (#1374, @ulugbekna)
  • Improve locate for labels' declarations in the current buffer. (#1505, fixes #1524)
  • Fix locate on module without implementation (#1522, fixes #1519)
  • Allow program name customization when merlin is used as a library. (#1532)
• editor modes
  • vim: load the plugin when necessary if it wasn't loaded before (#1511)
  • emacs: xref works from context menus; better highlighting of xref matches; xref recognises operators and binding operators at the cursor position; bad locations are filtered out (#1385, fixes #1410)
  • emacs: update CI for newer releases and fix some warnings (#1454, @mattiase)
• test suite
  • Add tests for constructors' documentation (#1511)
  • Add test cases for label comment documentation (#1526, @mheiber)
  • Add a test for the enclosing command (#1512)
  • Add tests for interactions between locate and record labels (#1505)
  • Add test showing an issue with locate and implicit transitive deps

• Fix status line enabled when ANSI colors are forced. (#6503, @MisterDA)

• Fix build with MSVC compiler (#6517, @nojb)

• Do not shadow library interface modules (#6549, fixes #6545, @rgrinberg)

dune executable

This lists features of the “dune” executable itself. Upgrading dune will bring in these changes. We consider these changes safe, but it is difficult to define what a breaking change is for a command-line tool (for example, some error messages change). It is important to note that just upgrading the dune executable is not supposed to change how dune interprets existing projects. If just upgrading dune breaks compilation, it is a bug in dune, please report it!

Added

• Introduce a $ dune ocaml top-module subcommand to load modules directly without sealing them behind the signature. (#5940, @rgrinberg)
• Revive $ dune external-lib-deps under $ dune describe external-lib-deps. (#6045, @moyodiallo)
• Extend the promotion CLI to a dune promotion group: dune promote is moved to dune promotion apply (the former still works) and the new dune promotion diff command can be used to just display the promotion without applying it. (#6160, fixes #5368, @emillon)
• Build progress status now shows number of failed jobs (#6242, @Alizter)
• Allow promoting into source directories specified by subdir (#6404, fixes #3502, @rgrinberg)
• Support CLICOLOR and CLICOLOR_FORCE to enable/disable/force ANSI colors. (#6340, fixes #6323, @MisterDA).
• Create a fake socket file _build/.rpc/dune on windows to allow rpc clients to connect using the build directory. (#6329, @rgrinberg)

Fixed

• Forbid multiple instances of dune running concurrently in the same workspace. (#6360, fixes #236, @rgrinberg)
• Make dune describe workspace return the correct root path (#6380, fixes #6379, @esope)
• Fix running inline tests in bytecode mode (#5622, fixes #5515, @dariusf)

(lang dune 3.6)

This lists changes if you opt into the new (lang dune 3.6) version in your dune-project file. For this too, these are changes that we consider safe, but they can require changes to your dune files. For example, sandboxing is enabled in more places, which means that you might have to be more precise in expressing your dependencies. Please reach out on the issue tracker if you have trouble fixing your dune file or if something does not seem to be possible anymore.

Added

• Add (glob_files <glob>) and (glob_files_rec <glob>) terms to the files field of the install stanza (#6250, closes #6018, @gridbugs)
• Allow Byte_complete binaries to be installable (#4837, @AltGr, @rgrinberg)
• Allow :standard in the (modules) field of the coq.pp stanza (#6229, fixes #2414, @Alizter)

Fixed

• Allow absolute build directories to find public executables. For example, those specified with (deps %{bin:...}) (#6326, @anmonteiro)
• [ctypes] do not mangle user written names in the ctypes stanza (#6374, fixes #5561, @rgrinberg)
• Forbid private libraries with (package ..) set from depending on private libraries that don't belong to a package (#6385, fixes #6153, @rgrinberg)
• [ctypes] always re-run pkg-config because we aren't tracking its external dependencies (#6052, @rgrinberg)
• [ctypes] remove dependency on configurator in the generated rules (#6052, @rgrinberg)
• Fix passing of flags to dune coq top (#6369, fixes #6366, @Alizter)
• Prevent crash if absolute paths are used in the install stanza and in recursive globs. These cases now result in a user error. (#6331, @gridbugs)

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)

dune executable

This lists features of the "dune" executable itself. Upgrading dune will bring in these changes. We consider these changes safe, but it is difficult to define what a breaking change is for a command-line tool (for example, some error messages change). It is important to note that just upgrading the dune executable is not supposed to change how dune interprets existing projects. If just upgrading dune breaks compilation, it is a bug in dune, please report it!

Added

• Allow dune describe workspace to accept directories as arguments. The provided directories restrict the worskpace description to those directories. (#6107, fixes #3893, @esope)
• Add a terminal persistence mode that attempts to clear the terminal history. It is enabled by setting terminal persistence to clear-on-rebuild-and-flush-history (#6065, @rgrinberg)

Fixed

• Fix build-info version when used with flambda (#6089, fixes #6075, @jberdine)
• Fix compilation of Dune under esy on Windows (#6109, fixes #6098, @nojb)
• Improve error message when parsing several licenses in (license) (#6114, fixes #6103, @emillon)
• Handle CSI n K code in ANSI escape codes from commands. (#6214, fixes #5528, @emillon)
• Do not ignore rules marked (promote (until-clean)) when --ignore-promoted-rules (or -p) is passed. (#6010, fixes #4401, @emillon)

Changed

• dune install: copy files in an atomic way (#6150, @emillon)
• update vendored copy of cmdliner to 1.1.1. This improves the built-in documentation for command groups such as dune ocaml. (#6038, @emillon, #6169, @shonfeder)
• Extend dune describe to include the root path of the workspace and the relative path to the build directory. (#6136, @reubenrowe)

macOS support

This is technically a subset of above section. For M1 mac users, dune 3.5.0 is the first version which will correctly support dune-build-info.

Added

• on macOS, sign executables produced by artifact substitution (#6137, #6231, fixes #5650, fixes #6226, @emillon)
• Enable file watching on MacOS SDK < 10.13. (#6218, @rgrinberg)

Fixed

• macOS: Handle unknown fsevents without crashing (#6217, @rgrinberg)

(lang dune 3.5)

This lists changes if you opt into the new (lang dune 3.5) version in your dune-project file. For this too, these are changes that we consider safe, but they can require changes to your dune files. For example, sandboxing is enabled in more places, which means that you might have to be more precise in expressing your dependencies. Please reach out on the issue tracker if you have trouble fixing your dune file or if something does not seem to be possible anymore.

Added

• Add a runtime_deps field in the cinaps stanza to specify runtime dependencies for running the cinaps preprocessing action (#6175, @rgrinberg)
• Allow rules producing directory targets to be not sandboxed (#6056, @rgrinberg)
• Introduce a dirs field in the install stanza to install entire directories (#5097, fixes #5059, @rgrinberg)
• Add an (include <file>) term to the include_dirs field for adding directories to the include paths sourced from a file. (#6058, fixes #3993, @gridbugs)
• Support (extra_objects ...) field in (executable ...) and (library ...) stanzas (#6084, fixes #4129, @gridbugs)
• Allow rules producing directory targets to create symlinks (#6077, fixes #5945, @rgrinberg)
• Added an (aliases ...) field to the (rules ...) stanza which allows the specification of multiple aliases per rule (#6194, @Alizter)
• Allow include statement in install stanza (#6139, fixes #256, @gridbugs)
• Add a new experimental feature mode_specific_stubs that allows the specification of different flags and sources for foreign stubs depending on the build mode (#5649, @voodoos)

Changed

• Sandbox running cinaps actions starting from cinaps 1.1 (#6176, @rgrinberg)
• Cinaps actions are now sandboxed by default (#6062, @rgrinberg)
• Menhir rules are now sandboxed by default (#6076, @rgrinberg)
• Inline tests are now sandboxed by default (#6079, @rgrinberg)

Fixed

• Shadow alias module Foo__ when building a library Foo (#6126, @rgrinberg)
• Disallow generating targets in sub direcories in inferred rules. The check to forbid this was accidentally done only for manually specified targets (#6031, @rgrinberg)
• odoc rules now about ODOC_SYNTAX and will rerun accordingly (#6010, fixes #1117, @emillon)

Coq support

These changes, associated with (lang dune 3.5), are specific to coq.

Added

• Add %{coq:...} macro for accessing data about the configuration about Coq. For instance %{coq:version} (#6049, @Alizter)
• Starting with Coq build language 0.6, theories can be built without importing Coq's standard library by including (stdlib no). (#6165 #6164, fixes #6163, @ejgallego @Alizter @LasseBlaauwbroek)

Changed

• Dune no longer considers .aux files as targets during Coq compilation. This means that .aux files are no longer cached. (#6024, fixes #6004, @alizter)
• The test suite for Coq now requires Coq >= 8.16 due to changes in the plugin loading mechanism upstream (which now uses Findlib).
• The (coq.theory ...) stanza will now ensure that for each declared (plugin ...), the META file for it is built before calling coqdep. This enables the use of the new Findlib-based loading method in Coq 8.16; however as of Coq 8.16.0, Coq itself has some bugs preventing this to work yet. (#6167 , workarounds #5767, @ejgallego)

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)

• Fix build on cygwin/i686-w64-mingw32 (#6008, @kit-ty-kate)

• Make dune describe correctly handle overlapping implementations for virtual libraries (#5971, fixes #5747, @esope)

• Building the @check alias should make sure the libraries and executables don't have dependency cycles (#5892, @rgrinberg)

• [ctypes] Add support for the errno parameter using the errno_policy field in the ctypes settings. (#5827, @droyo)

• Fix dune coq top when it is invoked on files from a subdirectory of the directory containing the associated stanza (#5784, fixes #5552, @ejgallego, @rlepigre, @Alizter)

• Fix hint when an invalid module name is found. (#5922, fixes #5273, @emillon)

• The (cat) action now supports several files. (#5928, fixes #5795, @emillon)

• Dune no longer uses shimmed META files for OCaml 5.x, solely using the ones installed by the compiler. (#5916, @dra27)

• Fix handling of the (deps) field in (test) stanzas when there is an .expected file. (#5952, #5951, fixes #5950, @emillon)

• Ignore insignificant filesystem events. This stops RPC in watch mode from flashing errors on insignificant file system events such as changes in the .git/ directory. (#5953, @rgrinberg)

• Fix parsing more error messages emitted by the OCaml compiler. In particular, messages where the excerpt line number started with a blank character were skipped. (#5981, @rgrinberg)

• env stanza: warn if some rules are ignored because they appear after a wildcard rule. (#5898, fixes #5886, @emillon)

• On Windows, XDG_CACHE_HOME is taken to be the FOLDERID_InternetCache if unset, and XDG_CONFIG_HOME and XDG_DATA_HOME are both taken to be FOLDERID_LocalAppData if unset. (#5943, fixes #5808, @nojb)

New features

• Support odoc-parser.2.0.0 (#2123, @gpetiot)
  • Breaking change: incompatible with earlier versions of odoc-parser
  • New inline math elements {m ...} available in doc-comments
  • New block math elements {math ...} available in doc-comments

• 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)

Removed

• bench binary is not distributed anymore to avoid name collisions (#2104, @gpetiot)

Bug fixes

• Preserve comments around object open/close flag (#2097, @trefis, @gpetiot)
• Preserve comments around private/mutable/virtual keywords (#2098, @trefis, @gpetiot)
• Closing parentheses of local open now comply with indicate-multiline-delimiters (#2116, @gpetiot)
• emacs: fix byte-compile warnings (#2119, @syohex)

Changes

• Use the API of ocp-indent to parse the .ocp-indent files (#2103, @gpetiot)
• JaneStreet profile: set max-indent = 2 (#2099, @gpetiot)
• JaneStreet profile: align pattern-matching bar | under keyword instead of parenthesis (#2102, @gpetiot)

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

• Use dependencies compatible with OCaml 5:
  • Use zed 3.2.0, based on uucp, uutf, and uuseg instead of camomile
  • Use logs.lwt instead of lwt_logs

Additions

• New subcommand to resolve references (@panglesd, @lubegasimon, #812)
• Improved rendering of long signatures (@panglesd, #782)
• Handle comments attached to open statement as floating comment, instead of dropping them (@panglesd, #797)
• Empty includes (containing entirely shadowed entries) are now hidden (@panglesd, #798)

Bugs fixed

• Fix a missing Result constructor during compile. This will cause some functor arguments to have different filenames (@jonludlam, #795)
• Better memory/disk space usage when handling module alias chains (@jonludlam, #799)
• Resolving class-type paths (ie., val x : #c) (@jonludlam, #809)
• Skip top-level attributes while extracting the top comment. Fix top-comment extraction with PPX preprocessing (@jorisgio, #819)
• Better handling of @canonical tags (@jonludlam, #820)
• css: improved layout (@jonludlam, @Julow, #822)

• merlin binary
  • make most library public and split merlin in two packages: the merlin-lib package that exposes merlin's internals and the merlin package with the frontend. (#1448, #1455, #1457, #1497, @rgrinberg, @tmattio, @kit-ty-kate)
  • Type printing: use best_module_path for paths from Mty_alias (#1470)
  • Attempt at finding the 'real' capitalization of files on windows (#1462 by @mlasson)
  • Use newer Seq-based API of Yojson 2.0, avoiding the need for the deprecated Stream module (#1475 by @Leonidas-from-XIV)
  • unify parsing of MERLIN_LOG (#1480 by @ulugbekna)
  • Fix type deduplication in type-enclosing results (#1483, fixes #1477)
  • Only weakly reduce the shapes to speed up the new Merlin locate implementation. (#1488)
  • Ignore unknown configuration tags from dune configuration provider but not from dot-merlin-reader (#1486)
  • typing recovery: recover at the granularity of core_type (#1484)
• editor modes
  • add method imenu items for emacs (#1481, @mndrix)
  • emacs: Make the prefix argument to merlin-locate optional, both for consistency with Emacs convention and for backwards compatibility. (#1476, @antalsz)
  • emacs: fix duplicated prefix path in imenu entries (#1495, @bcc32)