OCaml Changelog

• Fix compilation on MacOS SDK < 10.13. The native watch mode is disabled in such instances (#5431 fix #5430, @rgrinberg)

• Do no add workspace_root to BUILD_PATH_PREFIX_MAP for projects before 3.0 (5448, @rgrinberg)

• Fix performance regression in incremental builds (#5439, @snowleopard)

• Fix digest computation bug introduced in 3.0.1 (#5451, @rgrinberg)

Fixes

• Fix executing ppx executables

Features

• Add better support for code folding: more folds and more precise folds

Fixes

• Fix infer interface code action crash when implementation source does not exist (#597)

• Improve error message when the reason plugin for merlin is absent (#608)

• Fix chdir races when running ppx (#550)

• More accurate completion kinds. New completion kinds for variants and fields. Removed inaccurate completion kinds for constructors and types. (#510)

• Fix handling request cancellation (#616)

• Remove uchar and seq dummy ocamlfind libraries from dune's builtin library database (#5260, @kit-ty-kate)

• Add a DUNE_DIFF_COMMAND environment variable to match --diff-command command-line parameter (@raphael-proust, fix #5369, #5375)

• Add support for odoc-link rules (#5045, @jonludlam, @lubegasimon)

• Dune will no longer generate documentation for hidden modules (#5045, @jonludlam, @lubegasimon)

• Parse the native_pack_linker field of ocamlc -config (#5281, @TheLortex)

• Fix plugins with dot in the name (#5182, @bobot, review @rgrinberg)

• Don't generate the dune-site build part when not needed (#4861, @bobot, review @kit-ty-kate)

• Fix installation of implementations of virtual libraries (#5150, fix #3636, @rgrinberg)

• Run tests in all modes defined. Previously, jsoo was excluded. (@hhugo, #5049, fix #4951)

• Allow to configure the alias to run the jsoo tests (@hhugo, #5049, #4999)

• Set jsoo compilation flags in the env stanza (@hhugo, #5049, #1613)

• Allow to configure jsoo separate compilation in the env stanza. Previously, it was hard coded to always be enabled in the dev profile. (@hhugo, #5049, fix #970)

• Fix build-info version in jsoo executables (@hhugo, #5049, fix #4444)

• Pass -no-check-prims when building bytecode for jsoo (@hhugo, #5049, #4027)

• Fix jsoo builds when dynamically linked foreign archives are disabled (@hhugo, #5049)

• Disallow empty packages starting from 3.0. Empty packages may be re-enabled by adding the (allow_empty) to the package stanza in the dune-project file. (#4867, fix #2882, @kit-ty-kate, @rgrinberg)

• Add link_flags field to the executable field of inline_tests (#5088, fix #1530, @jvillard)

• In watch mode, use fsevents instead of fswatch on OSX (#4937, #4990, fixes #4896 @rgrinberg)

• Remove inotifywait watch mode backend on Linux. We now use the inotify API exclusively (#4941, @rgrinberg)

• Report cycles between virtual libraries and their implementation (#5050, fixes #2896, @rgrinberg)

• Warn when lang versions have an ignored suffix. (lang dune 2.3.4) or (lang dune 2.3suffix) were silently parsed as 2.3 and we know suggest to remove the prefix. (#5040, @emillon)

• Allow users to specify dynamic dependencies in rules. For example (deps %{read:foo.gen}) (#4662, fixes #4089, @jeremiedimino)

• Sandbox infer rules for menhir. Fixes possible "inconsistent assumptions" errors (#5015, @rgrinberg)

• Experimental support for ctypes stubs (#3905, fixes #135, @mbacarella)

• Fix interpretation of binaries defined in the env stanza. Binaries defined in x/dune wouldn't be visible in `x/*/**/dune. (#4975, fixes #4976, @Leonidas-from-XIV, @rgrinberg)

• Do not list private libraries in package listings (#4945, fixes #4799, @rgrinberg)

• Allow spaces in cram test paths (#4980, fixes #4162, @rgrinberg)

• Improve error handling of misbehaving cram scripts. (#4981, fix #4230, @rgrinberg)

• Fix foreign_stubs inside a tests stanza. Previously, dune would crash when this field was present (#4942, fix #4946, @rgrinberg)

• Add the enabled_if field to inline_tests within the library stanza. This allows us to disable executing the inline tests while still allowing for compilation (#4939, @rgrinberg)

• Generate a dune-project when initializing projects with dune init proj ... (#4881, closes #4367, @shonfeder)

• Allow spaces in the directory argument of the subdir stanza (#4943, fixes #4907, @rgrinberg)

• Add a %{toolchain} expansion variable (#4899, fixes #3949, @rgrinberg)

• Include dependencies of executables when creating toplevels (either dune top or dune utop) (#4882, fixes #4872, @Gopiancode)

• Fixes opam META file requires entry for private libs (#4841, fixes #4839, @toots)

• Fixes dune exec not adding .exe on Windows (#4371, fixes #3322, @MisterDA)

• Allow multiple cinaps stanzas in the same directory (#4460, @rgrinberg)

• Fix $ dune subst in empty git repositories (#4441, fixes #3619, @rgrinberg)

• Improve interpretation of ansi escape sequence when spawning processes (#4408, fixes #2665, @rgrinberg)

• Allow (package pkg) in dependencies even if pkg is an installed package (#4170, @bobot)

• Allow %{version:pkg} to work for external packages (#4104, @kit-ty-kate)

• Add (glob_files_rec <dir>/<glob>) for globbing files recursively (#4176, @jeremiedimino)

• Automatically generate empty .mli files for executables and tests (#3768, fixes #3745, @CraigFe)

• Add ocaml command subgroup for OCaml related commands such as utop, top, and merlin (#3936, @rgrinberg).

• Detect unknown variables more eagerly (#4184, @jeremiedimino)

• Improve location of variables and macros in error messages (#4205, @jeremiedimino)

• Auto-detect dune-project files as dune files in Emacs (#4222, @shonfeder)

• Dune no longer automatically create or edit dune-project files (#4239, fixes #4108, @jeremiedimino)

• Warn if dune-project is not found (fatal in release mode) (#5343, @emillon)

• Cleanup temporary files after running $ dune exec. (#4260, fixes #4243, @rgrinberg)

• Add a new subcommand dune ocaml dump-dot-merlin that prints a mix of all the merlin configuration of a directory (defaulting to the current directory) in the Merlin configuration syntax. (#4250, @voodoos)

• Enable cram tests by default (#4262, @rgrinberg)

• Drop support for opam 1.x (#4280, @jeremiedimino)

• Stop calling ocamlfind to determine the library search path or library installation directory. This makes the behavior of Dune simpler and more reproducible (#4281, @jeremiedimino)

• Remove the external-lib-deps command. This command was only approximative and the cost of maintainance was getting too high. We removed it to make room for new more important features (#4298, @jeremiedimino)

• It is now possible to define action dependencies through a chain of aliases. (#4303, @aalekseyev)

• If an .ml file is not used by an executable, Dune no longer report parsing error in this file (#4330, @jeremiedimino)

• Add support for sandboxing using hard links (#4360, Andrey Mokhov)

• Fix dune crash when subdir is an absolute path (#4366, @anmonteiro)

• Changed the implementation of actions attached to aliases, as in (rule (alias runtest) (action (run ./test))). A visible result for users is that such actions are now memoized for longer. For instance:

  $ echo '(rule (alias runtest) (action (echo "X=%{env:X=0}\n")))` > dune
  $ X=1 dune runtest
  X=1
  $ X=2 dune runtest
  X=2
  $ X=1 dune runtest
  

  Previously, Dune would have re-executed the action again at the last line. Now it remembers the result of the first execution.

• Fix a bug where dune would always re-run all actions that produce symlinks, even if their dependencies did not change. (#4405, @aalekseyev)

• Fix a bug that was causing Dune to re-hash generated files more often than necessary (#4419, @jeremiedimino)

• Fields allowed in the config file are now also allowed in the workspace file (#4426, @jeremiedimino)

• Add options to control how Dune should handle stdout and stderr of actions when then succeed. It is now possible to ask Dune to ignore the stdout of actions when they succeed or to request that the stderr of actions must be empty. This allows to reduce the noise of large builds (#4422, #4515, @jeremiedimino)

• The @all alias no longer depends directly on copies of files from the source directory (#4461, @nojb)

• Allow dune-file as an alternative file name for dune files (needs to be enabled in the dune-project file) (#4428, @nojb)

• Drop support for upgrading jbuilder projects (#4473, @jeremiedimino)

• Extend the environment variable BUILD_PATH_PREFIX_MAP to rewrite the root of the build dir (or sandbox) to /workspace_root (#4466, @jeremiedimino)

• Simplify the implementation of build cache. We stop using the cache daemon to access the cache and instead write to and read from it directly. The new cache implementation is based on Jenga's cache library, which was thoroughly tested on large-scale builds. Using Jenga's cache library will also make it easier for us to port Jenga's cloud cache to Dune. (#4443, #4465, Andrey Mokhov)

• More informative error message when Dune can't read a target that's supposed to be produced by the action. Old message is still produced on ENOENT, but other errors deserve a more detailed report. (#4501, @aalekseyev)

• Fixed a bug where a sandboxed action would fail if it declares no dependencies in its initial working directory or any directory it chdirs into. (#4509, @aalekseyev)

• Fix a crash when clearing temporary directories (#4489, #4529, Andrey Mokhov)

• Dune now memoizes all errors when running in the file-watching mode. This speeds up incremental rebuilds but may be inconvenient in rare cases, e.g. if a build action fails due to a spurious error, such as running out of memory. Right now, the only way to force such actions to be rebuilt is to restart Dune, which clears all memoized errors. In future, we would like to provide a way to rerun all actions failed due to errors without restarting the build, e.g. via a Dune RPC call. (#4522, Andrey Mokhov)

• Remove dune compute. It was broken and unused (#4540, @jeremiedimino)

• No longer generate an approximate merlin files when computing the ocaml flags fails, for instance because they include the contents of a file that failed to build. This was a niche feature and it was getting in the way of making Dune's core better. (#4607, @jeremiedimino)

• Make Dune display the progress indicator in all output modes except quiet (#4618, @aalekseyev)

• Report accurate process timing information in trace mode (enabled with --trace-file) (#4517, @rgrinberg)

• Do not log live_words and free_words in trace file. This allows using Gc.quick_stat which does not scan the heap. (#4643, @emillon)

• Don't let command run by Dune observe the environment variable INSIDE_EMACS in order to improve reproducibility (#4680, @jeremiedimino)

• Fix root_module when used in public libraries (#4685, fixes #4684, @rgrinberg, @CraigFe)

• Fix root_module when used with preprocessing (#4683, fixes #4682, @rgrinberg, @CraigFe)

• Display Coq profile flags in dune printenv (#4767, @ejgallego)

• Introduce mdx stanza 0.2, requiring mdx >= 1.9.0, with a new generic deps field and the possibility to statically link libraries in the test executable. (#3956, #5391, fixes #3955)

• Improve lookup of optional or disabled binaries. Previously, we'd treat every executable with missing libraries as optional. Now, we treat make sure to look at the library's optional or enabled_if status (#4786).

• Always use 7 char hash prefix in build info version (#4857, @jberdine, fixes #4855)

• Allow to explicitly disable/enable the use of dune subst by adding a new (subst <disable|enable>) stanza to the dune-project file. (#4864, @kit-ty-kate)

• Simplify the way dune discovers the root of the workspace. It now stops at the first dune-workspace file it encounters, and fails if it finds neither a dune-workspace nor a dune-project file (#4921, fixes #4459, @jeremiedimino)

• Dune no longer reads installed META files for libraries distributed with the compiler, instead using its own internal database. (#4946, @nojb)

• Add support for (empty_module_interface_if_absent) in executable and library stanzas. (#4955, @nojb)

• Add support for %{bin-available:...} (#4995, @jeremiedimino)

• Make sure running git or hg in a sandboxed action, such as a cram test cannot escape the sandbox and pick up some random git or mercurial repository on the file system (#4996, @jeremiedimino)

• Allow %{read:...} in more places such as (enabled_if ...) (#4994, @jeremiedimino)

• Run each action in its own process group so that we don't leave stray processes behind when killing actions (#4998, @jeremiedimino)

• Add an option expand_aliases_in_sandbox (#5003, @jeremiedimino)

• Allow to cancel the initial scan via Control+C (#4460, fixes #4364 @jeremiedimino)

• Add experimental support for directory targets (#3316, #5025, Andrey Mokhov), enabled via (using directory-targets 0.1) in dune-project.

• Delete old promote-into, promote-until-clean and promote-until-clean-into syntax (#5091, Andrey Mokhov).

• Add link_flags in the env stanza (#5215)

• Bootstrap: ignore errors when trying to remove generated files. (#5407, @damiendoligez)

Added

• Add --skip-lint, --skip-build, --skip-test and --keep-build-dir to the main command (#419, @NathanReb)
• Added support for parsing changelogs written in the style of keepachangelog.com (#421, @ifazk)

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)

Added

• Add support for adding language tags and metadata labels in mli files. (#339, #357, @julow, @Leonidas-from-XIV)
• Add support for running non-deterministic tests in dune MDX 0.2 stanza by setting the MDX_RUN_NON_DETERMINISTIC environment variable. (#365, #366, @Leonidas-from-XIV)

• Disable warning for deprecated Toploop functions used in dune files written in OCaml syntax. Restores 4.02 compatibility. (#5381, @nojb)

• Fix missing -linkall flag when linking library dune-sites.plugin ( #4348, @kakadu, @bobot, reported by @kakadu)

• No longer reference deprecated Toploop functions when using dune files in OCaml syntax. (#4834, fixes #4830, @nojb)

• Use the stag format API to be compatible with OCaml 5.0 (#5351, @emillon).

• Fix post-processing of dune-package (fix #4389, @strub)

Added

• Add trailing ;; to the output of toplevel phrases that were missing it. (#346, @Leonidas-from-XIV)
• Make MDX compatible with OCaml 4.14 (#356, @NathanReb)

Fixed

• Use the same output as the normal toplevel. Mdx used to carry an unsafe patch to work around a bug fixed in OCaml 4.06 and that patch would change the printed types in some corner cases. (#322, @emillon)

Removed

• Dropped compatibility with older OCaml versions. The minimal supported range is 4.08 to 4.13 now (#345, @Leonidas-from-XIV)
• Do not install deprecated mdx binary anymore (#274, @gpetiot)
• Remove deprecated rule command (#312, @gpetiot)
• Remove support for require-package label, use the mdx stanza in dune instead. This label was only used for the rule command and can now be safely removed. (#363, @Leonidas-from-XIV)

New features

• Update to odoc-parser 1.0.0 (#1843, @Julow). New syntax: code blocks can carry metadata, e.g.: {@ocaml kind=toplevel env=e1[ code ]}

• Add support for OCaml 4.14 (#360 @kit-ty-kate)
• Document options in utop(1) manpage (#364 #365 @lindig)

Changed

• Use odoc-parser.0.9.0 (#333, @julow)

Deprecated

• Add a deprecation warning for toplevel blocks that are not terminated with ;; (#342, @Leonidas-from-XIV)

Fixed

• Fix accidental redirect of stderr to stdout (#343, @Leonidas-from-XIV)
• Remove trailing whitespaces that were added to indent empty lines (#341, @gpetiot)

Deprecated

• Profiles compact and sparse are now deprecated and will be removed by version 1.0 (#1803, @gpetiot)
• Options that are not set by the preset profiles are now deprecated and will be removed by version 1.0:
  • align-cases, align-constructors-decl and align-variants-decl (#1793, @gpetiot)
  • disambiguate-non-breaking-match (#1805, @gpetiot)
  • break-before-in (#1888, @gpetiot)
  • break-cases={toplevel,all} (#1890, @gpetiot)
  • break-collection-expressions (#1891, @gpetiot)
  • break-fun-decl=smart (#1892, @gpetiot)
  • break-fun-sig=smart (#1893, @gpetiot)
  • break-string-literals (#1894, @gpetiot)
  • break-struct (#1895, @gpetiot)
  • extension-indent (#1896, @gpetiot)
  • function-indent (#1897, @gpetiot)
  • function-indent-nested (#1898, @gpetiot)
  • if-then-else={fit-or-vertical,k-r} (#1899, @gpetiot)
  • indicate-multiline-delimiters=closing-on-separate-line (#1900, @gpetiot)
  • indent-after-in (#1901, @gpetiot)
  • let-binding-indent (#1902, @gpetiot)
  • let-binding-spacing=sparse (#1903, @gpetiot)
  • match-indent (#1904, @gpetiot)
  • match-indent-nested (#1905, @gpetiot)
  • module-item-spacing=preserve (#1906, @gpetiot)
  • nested-match (#1907, @gpetiot)
  • parens-tuple-patterns (#1908, @gpetiot)
  • sequence-style=before (#1909, @gpetiot)
  • stritem-extension-indent (#1910, @gpetiot)
  • type-decl-indent (#1911, @gpetiot)

Bug fixes

• Fix normalization of sequences of expressions (#1731, @gpetiot)
• Type constrained patterns are now always parenthesized, parentheses were missing in a class context (#1734, @gpetiot)
• Support sugared form of coercions in let bindings (#1739, @gpetiot)
• Add missing parentheses around constructor used as indexing op (#1740, @gpetiot)
• Honour .ocamlformat-ignore on Windows (#1752, @nojb)
• Avoid normalizing newlines inside quoted strings {|...|} (#1754, @nojb, @hhugo)
• Fix quadratic behavior when certain constructs are nested. This corresponds to the cases where a partial layout is triggered to determine if a construct fits on a single line for example. (#1750, #1766, @emillon)
• Fix non stabilizing comments after infix operators (*, %, #-ops) (#1776, @gpetiot)
• Fix excessive break and wrong indentation after a short-open when indicate-multiline-delimiters=closing-on-separate-line (#1786, @gpetiot)
• Add parentheses around type alias used as type constraint (#1801, @gpetiot)
• Fix alignment of comments inside a tuple pattern and remove incorrect linebreak. Fix formatting of labelled arguments containing comments. (#1797, @gpetiot)
• Emacs: only hook ocamlformat mode on tuareg/caml modes when ocamlformat is not disabled (#1814, @gpetiot)
• Fix boxing of labelled arguments, avoid having a linebreak after a label when the argument has a comment attached (#1830, #1885, @gpetiot)
• Add missing parentheses around application of prefix op when applied to other operands (#1825, @gpetiot)
• Fix application of a monadic binding when 'break-infix-before-func=false' (#1849, @gpetiot)
• Fix dropped comments attached to a sequence in a sugared extension node (#1853, @gpetiot)
• Fix formatting of exception types, and add missing parentheses (#1873, @gpetiot)
• Fix indentation of with-type constraints (#1883, @gpetiot)
• Preserve sugared syntax of extension points with attributes (#1913, @gpetiot)
• Improve comment attachment when followed but not preceded by a linebreak (#1926, @gpetiot)
• Fix position of comments preceding Pmod_ident (#1939, @gpetiot)
• Make the formatting of attributes and docstrings more consistent (#1929, @gpetiot)
• Fix stabilization of comments inside attributes (#1942, @gpetiot)

Changes

• Set 'module-item-spacing=compact' in the default/conventional profile (#1848, @gpetiot)
• Preserve bracketed lists in the Parsetree (#1694, #1876, #1914, @gpetiot)
• Line directives now cause OCamlFormat to emit an error, they were previously silently ignored (#1845, @gpetiot)
• Apply option 'module-item-spacing' on mutually recursive type declarations for more consistency (#1854, @gpetiot)

New features

• Handle merlin typed holes (#1698, @gpetiot)
• Handle punned labelled arguments with type constraint in function applications. For example, function application of the form foo ~(x:int) instead of the explicit foo ~x:(x:int). (ocaml#10434) (#1756, #1759, @gpetiot). This syntax is only produced when the output syntax is at least OCaml 4.14.
• Allow explicit binders for type variables (ocaml#10437) (#1757, @gpetiot)
• Add a new ocaml-version option to select the version of OCaml syntax of the output (#1759, @gpetiot)
• Allow disambiguated global identifiers (like t/2) so they can be formatted by tools like OCaml-LSP (#1716, @let-def)
• Handle let operator punning uniformly with other punning forms. Normalizes let operator to the punned form where possible, if output syntax version is at least OCaml 4.13.0. (#1834, #1846, @jberdine)
• Remove unnecessary surrounding parentheses for immediate objects. This syntax is only produced when the output syntax is at least OCaml 4.14. (#1934, @gpetiot)

Additions

• Compatibility with OCaml 4.14 (@patricoferris, @kit-ty-kate, #788)

Bugs fixed

• Man page renderer fails to output pages that have children (@jonludlam, @Julow, #766)
• Fix resolution of unprefixed references to pages (@Julow, #755)
• Fix reporting of ambiguous labels (@Julow, @jonludlam, #773, #781)
• Allow referencing of labels in the top comment (@jonludlam, #771)

Additions

• Strip unquoted spaces in identifiers for a more flexible reference syntax (@lubegasimon, @panglesd, #783)
• Add context to messages raised in expansions of includes (@Julow, #780)

Fixes

• Disable functionality reliant on ocamlformat-rpc for now (#555)

• 4.13 compatiblity

• ocaml support
  • add support for 4.13
  • stopped actively supporting version older than 4.12
• merlin binary
  • Mbrowse.select_leaf: correctly ignore merlin.hide (#1376)
  • enable occurences to work when looking for locally abstract types (#1382)
  • handle -alert compiler flag (#1401)
  • avoid a race condition when the process started to read a configuration file crashes/is not found (#1378, @antalsz)
  • log the backtrace even when the exception is a Failure (#1377, @antalsz)
  • ignore -error-style compiler flag (#1402, @nojb)
  • fix handling of record field expressions (#1375)
  • allow -pp to return an AST (#1394)
  • fix merlin crashing due to short-paths (#1334, fixes #1322)
• editor modes
  • update quick setup instructions for emacs (#1380, @ScriptDevil)
• test suite
  • improve record field destruction testing (#1375)

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

Fixes

• Ppx processes are now executed correctly (#513)

Breaking Change

• ocamllsp drops support for .merlin files, and as a consequence no longer depends on dot-merlin-reader. (#523)

Features

• New code action to automatically remove values, types, opens (#502)

• Fix typo in error message for opam var [#4786 @kit-ty-kate - fix #4785]
• Run the sandbox check in the temporary directory [#4787 @dra27 - fix #4783]
• OpamSystem: avoid calling Unix.environment at top level [#4789 @hannesm]
• Homebrew: Add support for casks and full-names [#4801 @kit-ty-kate]
• Fix the cold target in presence of an older OCaml compiler version on macOS [#4802 @kit-ty-kate - fix #4801]
• Archlinux: handle virtual package detection [#4833 @rjbou - partial fix #4759]
• Disable the detection of available packages on RHEL-based distributions. This fixes an issue on RHEL-based distributions where yum list used to detect available and installed packages would wait for user input without showing any output and/or fail in some cases [#4791 @kit-ty-kate - fixes #4790]
• Handle empty environment variable updates - missed cherry-pick from 2.0 [#4840 @dra27]
• Fix vendored build on mingw-w64 with g++ 11.2 [#4835 @dra27]
• Put back support for switch creation with packages argument and --packages option with cli 2.0, and a specific error message for cli 2.1 [#4853 @rjbou - fix #4843]
• Fix reverting environment additions to PATH-like variables when several dirs added at once [#4861 @dra27]
• Fix dose3 download url since gforge is gone [#4870 @avsm]
• Ensure setenv can use package variables defined during the build [#4841 @dra27]
• Fix `set-invariant: default repos were loaded instead of switch repos [#4866 @rjbou]

• Fix reverting environment additions to PATH-like variables when several dirs added at once [#4861 @dra27]
• Ensure setenv can use package variables defined during the build [#4841 @dra27]

Fixed

• Fixed the release asset URL for projects with multiple opam packages. Before, the packages would attempt to infer their URL and fail in rare cases where the project uses v as prefix for tags but the project version omits it. Now they share the same URL. (#402, #404, @Leonidas-from-XIV)

Added

• Added support for creating releases from unannotated Git tags. dune-release supported unannotated tags in a few places already, now it supports using them for creating a release. (#383, @Leonidas-from-XIV)

Fixed

• Change the ---V command option to be -V (#388, @Leonidas-from-XIV)
• Infer release versions are inferred from VCS tags. This change allows using dune-release on projects that do not use the changelog or have it in a different format. (#381, #383 @Leonidas-from-XIV)
• Fix a bug where dune-release couldn't retrieve a release on GitHub if the tag and project version don't match (e.g. v1.0 vs 1.0). dune-release would in such case believe the release doesn't exist, attempt to create it and subsequently fail. (#387, #395, @Leonidas-from-XIV)

Breaking changes

• Refactor the comment parser in preparation for it to be octavius 2 (@jonludlam, #621)
• Remove odoc-parser into a separate repository (@jonludlam, #700)

Additions

• New model for expanding and cross referencing (@jonludlam, @Julow, @lubegasimon)
• New document output layer, supporting HTML, LaTeX and man page output (@Drup, @Octachron, @jonludlam, @Julow, @lubegasimon)
• Experimental parent/child support for structured output (@jonludlam)
• Add the ability to specifiy canonical paths for types and module types (@jonludlam, #596)
• Several improvements to the HTML tree (@dbuenzli, #600, #605, #589, @Drup, #579)
• Render module synopses in {!modules:...} (@Julow, #597)
• Better HTML rendering (@dbuenzli, #607, #612, #615)
• Better handling of signature comments (@Julow, #627, #629, #640, #643, #647, #654)
• Centre, left and right alignment constructs now parse correctly (@lubegasimon, #624)
• Allow reference to pages that contain hyphens and dots (@lubegasimon, #622)
• Allow type definitions to be copied and pasted with correct syntax (@Drup, #626)
• Install Ocamlary as a library for testing (@dbuenzli, #639)
• Handle @canonical tags on compilation units (@Julow, #649)
• Alias more when strengthening (@jonludlam, #653)
• Light theme fixes (@xvw, #660)
• Handle @canonical tags in the top-comment of modules (@Julow, #662)
• Simplify paths referring to Stdlib (@jonludlam, #677)
• New odoc command to report warnings encountered during compilation/linking (@Julow, #667)
• Anchors on type extensions (@Julow, #684)
• OCaml 4.13 support (@octachron, #687, #689)
• Better errors/warnings (@Julow, #692, #717, #720, #732)
• ModuleType 'Alias' support (@jonludlam, #703)
• Improved test suite (@lubegasimon, #697)
• Improved documentation (@lubegasimon, @jonludlam, #702, #733)
• Strengthen module types (@jonludlam, #731)

Bugs fixed

• Fix for resolving references in mld files (@jonludlam, #611)
• Fix placement of documentation in module aliases (@Julow, #606)
• Fix breakage involving includes and shadowing (@jonludlam, #603)
• Don't link to hidden items (@lubegasimon, #583)
• Don't remove docs of inlined includes (@Julow, #595)
• Don't render shadowed values (@lubegasimon, #580)
• Fix unresolved references in the first comment of a file (@Julow, #592)
• LaTeX: Hardened description environments (@Octachron, #608)
• Resolve references in module synopses (@Julow, #658)
• Fix reference resolution in the presence of shadowing (@Julow, #682)
• uwt now can be documented (@jonludlam, #708)
• Fix resolution involving deeply nested substitutions (@jonludlam, #727)
• Fix off-by-one error in error reporting (@asavahista, #736)

• Fix debouncing of document updates. It was essentially completely broken in all but the most trivial cases. (#509 fixes #504)

• Fix completion when passing named and functional arguments (#512)

• Disable experimental dune support. It was accidentally left enabled.

Features

• Add a new code action Add missing rec keyword, which is available when adding a rec keyword can fix Unbound value ... error, e.g.,

  let fact n = if n = 0 then 1 else n * fact (n - 1)
                                    (* ^^^^ Unbound value fact *)
  

  Adding rec to the definition of fact will fix the problem. The new code action offers adding rec.

• Use ocamlformat to properly format type snippets. This feature requires the ocamlformat-rpc opam package to be installed. (#386)

• Add completion support for polymorphic variants, when it is possible to pin down the precise type. Examples (<|> stands for the cursor) when completion will work (#473)

  Function application:

  let foo (a: [`Alpha | `Beta]) = ()
  
  foo `A<|>
  

  Type explicitly shown:

  let a : [`Alpha | `Beta] = `B<|>
  

  Note: this is actually a bug fix, since we were ignoring the backtick when constructing the prefix for completion.

• Parse merlin errors (best effort) into a more structured form. This allows reporting all locations as "related information" (#475)

• Add support for Merlin Construct command as completion suggestions, i.e., show complex expressions that could complete the typed hole. (#472)

• Add a code action Construct an expression that is shown when the cursor is at the end of the typed hole, i.e., _|, where | is the cursor. The code action simply triggers the client (currently only VS Code is supported) to show completion suggestions. (#472)

• Change the formatting-on-save error notification to a warning notification (#472)

• Code action to qualify ("put module name in identifiers") and unqualify ("remove module name from identifiers") module names in identifiers (#399)

  Starting from:

  open Unix
  
  let times = Unix.times ()
  let f x = x.Unix.tms_stime, x.Unix.tms_utime
  

  Calling "remove module name from identifiers" with the cursor on the open statement will produce:

  open Unix
  
  let times = times ()
  let f x = x.tms_stime, x.tms_utime
  

  Calling "put module name in identifiers" will restore:

  open Unix
  
  let times = Unix.times ()
  let f x = x.Unix.tms_stime, x.Unix.tms_utime
  

Fixes

• Handle workspace change notifications. Previously, the server would only use the set of workspaces given at startup to search for workspace symbols. After this change, workspace folders that are added later will also be considered. (#498)

• Do not show "random" documentation on hover

  • fixed by merlin#1364
  • fixes duplicate:
    • ocaml-lsp#344
    • vscode-ocaml-platform#111

• Correctly rename a variable used as a named/optional argument (#478)

• When reporting an error at the beginning of the file, use the first line not the second (#489)

Changed

• Use odoc-parser.0.9.0 (#333, @julow)

Deprecated

• Add a deprecation warning for toplevel blocks that are not terminated with ;; (#342, @Leonidas-from-XIV)

Fixed

• Fix accidental redirect of stderr to stdout (#343, @Leonidas-from-XIV)
• Remove trailing whitespaces that were added to indent empty lines (#341, @gpetiot)