OCaml Changelog

• Fix compatibility with OCaml 4.12 (#3585, fixes #3583, @ejgallego)

Changes

• No functional changes from 0.14.2. The goal of this release is to be compatible with base and stdio v0.14.0.
• Backport the following PRs:
  • Update opam metadata (#1386)
  • Add compatibility with base.v0.14.0 (#1396)
  • Allow stdio.v0.14 (#1399)

Added

• HTML comments can carry block labels (#234, @gpetiot) The syntax is: <!-- $MDX labels -->, where labels is a list of valid labels separated by a comma. This line has to immediately precede the block it is attached to. The legacy syntax is preserved and will be deprecated in a later release.
• Add support for toplevel blocks in .mli files' doc comments (#206, @jsomers)
• Add support for OCaml 4.11 (#261, @kit-ty-kate)

Changed

• Apply unnamed preludes to all environments (#271, @gpetiot) New behavior:
  • env_and_file "a:f" associates f to the environment named a
  • env_and_file " :f" associates f to the default environment
  • env_and_file "f" associates f to all environments.
• Errors in non toplevel OCaml blocks are now printed to a seperate mdx-error code block following the ocaml block instead of crashing the mdx process. Those mdx-error blocks are recognized and checked by mdx and can be intentionally used to show case specific compile errors. (#238, @gpetiot)
• Improve error reporting for invalid (* $MDX part-... *) delimiters (#250, @gpetiot)

Deprecated

• The command 'mdx rule' is deprecated and will be removed in 2.0.0 (#251, @gpetiot)

Fixed

• Fix the environment selection for preludes and slightly improve quality of type names in evaluations of toplevel phrases in certain cases. (#225, @gpetiot)
• Fix toplevel parsing when phrases contain tabs (#240, @gpetiot)
• Avoid adding newlines to empty blocks (#253, @gpetiot)
• Preserve the indentation of included files (#259, @gpetiot)
• Preserve the header in shell blocks (#249, @craigfe)
• Support underscores in environment variables in set- and unset- labels (#257, @shonfeder)
• Fix mdx on Windows which was looking for the ocaml-mdx-test binary at the wrong place (#263, @hcarty)
• Properly report mdx parsing errors instead of crashing with an uncaught exception (#267, @gpetiot)

Added

• Add a dune-release config subcommand to display and edit the global configuration (#220, @NathanReb).
• Add command delegate-info to print information needed by external release scripts (#221, @pitag-ha)
• Use Curly instead of Cmd to interact with github (#202, @gpetiot)
• Add x-commit-hash field to the opam file when releasing (#224, @gpetiot)
• Add support for common alternative names for the license and ChangeLog file (#204, @paurkedal)

Changed

• Command tag: improve error and log messages by comparing the provided commit with the commit correspondent to the provided tag (#226, @pitag-ha)
• Error logs: when an external command fails, include its error message in the error message posted by dune-release (#231, @pitag-ha)
• Error log formatting: avoid unnecessary line-breaks; indent only slightly in multi-lines (#234, @pitag-ha)
• Linting step of dune-release distrib does not fail when opam's doc field is missing. Do not try to generate nor publish the documentation when opam's doc field is missing. (#235, @gpetiot)

Deprecated

• Deprecate opam 1.x (#195, @gpetiot)

Fixed

• Separate packages names by spaces in publish logs (#171, @hannesm)
• Fix uncaught exceptions in distrib subcommand and replace them with proper error messages (#176, @gpetiot)
• Use the 'user' field in the configuration before inferring it from repo URI and handles HTTPS URIs (#183, @gpetiot)
• Ignore backup files when looking for README, CHANGES and LICENSE files (#194, @gpetiot)
• Do not echo input characters when reading token (#199, @gpetiot)
• Improve the output of VCS command errors (#193, @gpetiot)
• Better error handling when checking opam version (#195, @gpetiot)
• Do not write 'version' and 'name' fields in opam file (#200, @gpetiot)
• Use Yojson to parse github json response and avoid parsing bugs. (#177, @gpetiot)
• The git command used in publish doc should check DUNE_RELEASE_GIT (even if deprecated) before PATH. (#242, @gpetiot)
• Adapt the docs to the removal of the log subcommand (#196, @gpetiot)

• Bump ppxlib's AST to 4.10 (#130, @NathanReb)
• Remove omp_config from Expansion_context and replace it with tool_name (#149, @NathanReb)
• Change undocumented Ppxlib.Driver.map_structure to return a ppxlib's structure instead of a Migrate_parsetree.Driver.some_structure. (#153, @NathanReb)

• Fix crash when caching is enabled (@rgrinberg, #3581, fixes #3580)

• Do not use -output-complete-exe until 4.10.1 as it is broken in 4.10.0 (@jeremiedimino, #3187)

• Fix crash when an unknown pform is found (such as %{unknown}) (#3560, @emillon)

• Improve error message when invalid package names (such as the empty string) are passed to dune build -p. (#3561, @emillon)

• Fix a stack overflow when displaying large outputs (including diffs) (#3537, fixes #2767, #3490, @emillon)

• Pass -g when compiling ppx preprocessors (#3671, @rgrinberg)

Additions

• Compatibility with OCaml 4.11 (#434, @kit-ty-kate)

• merlin binary
  • dune: remove duplicated rules for profile=release (#1143)
• test suite
  • fix a test that required Dune 2.5 (#1146)
  • fix another test that lacked reproducibility (#1146)

• ocaml support
  • alerts are no-more ignored and are reported as warnings (#1138)
• merlin binary
  • fix completion of names containing - (#1142)
  • fix several type-enclosing bugs by performing context-analysis (#1108)
  • lsp: add deprecation flag to outline items (#1087)
  • lsp: add go-to typedef (Locate_type) (#1067)

• Fix a bug where valid lib names in dune init exec --libs=lib1,lib2 results in an error. (#3444, fix #3443, @bikallem)

• Add and enabled_ if field to the install stanza. Enforce the same variable restrictions for enabled_if fields in the executable and install stanzas than in the library stanza. When using dune lang < 2.6, the usage of forbidden variables in executables stanzas with only trigger a warning to maintain compatibility. (#3408 and #3496, fixes #3354, @voodoos)

• Insert a constraint one the version of dune when the user explicitly specify the dependency on dune in the dune-project file (#3434 , fixes #3427, @diml)

• Generate correct META files for sub-libraries (of the form lib.foo) that contain .js runtime files. (#3445, @hhugo)

• Add a (no-infer ...) action that prevents inference of targets and dependencies in actions. (#3456, fixes #2006, @roddyyaga)

• Correctly infer targets for the diff? action. (#3457, fixes #2990, @greedy)

• Fix $ dune print-rules crashing (#3459, fixes #3440, @rgrinberg)

• Simplify js_of_ocaml rules using js_of_ocaml.3.6 (#3375, @hhugo)

• Add a new ocaml-merlin subcommand that can be used by Merlin to get configuration directly from dune instead of using .merlin files. (#3395, @voodoos)

• Remove experimental variants feature and make default implementations part of the language (#3491, fixes #3483, @rgrinberg)

• compatible with OCaml 4.11 (@kit-ty-kate, #322)
• switch to the new parser exposed since 4.11
• Vi edit mode: register support

Changes

• Merge doc-comments-val option with doc-comments. The placement of documentation comments on val and external items is now controled by doc-comments.
  • doc-comments=after becomes doc-comments=after-when-possible to take into account the technical limitations of ocamlformat;
  • doc-comments=before is unchanged;
  • doc-comments-val is now replaced with doc-comments. To reproduce the former behaviors
    • doc-comments=before + doc-comments-val=before: now use doc-comments=before;
    • doc-comments=before + doc-comments-val=after: now use doc-comments=before-except-val;
    • doc-comments=after + doc-comments-val=before: this behavior did not make much sense and is not available anymore;
    • doc-comments=after + doc-comments-val=after: now use doc-comments=after-when-possible. (#1358, @jberdine, @Julow, @gpetiot). This reverts changes introduced in 0.14.1 (#1335) and 0.14.0 (#1012).

• Fix magic numbers for the 4.11 ast (#96, @hhugo)

Additions

• add #edit_mode_vi and #edit_mode_default mode to set the editing mode(@kandu)
• Backport the #use_output directive (@diml, #313)

General

• Load init file from ~/.config/utop/init.ml as per XDG conventions (@copy, #144)
• Add OCaml 4.09 and 4.10 to the CI matrix (@kit-ty-kate, #310)
• Add documentation for dune utop usage in emacs (@samarthkishor, #307)

• Remove toplevel Option module accidentally added in 1.7.0

• [coq] Fix install .v files for Coq theories (#3384, @lthms)

• [coq] Fix install path for theory names with level greater than 1 (#3358, @ejgallego)

• Fix a bug introduced in 2.0.0 where the [locks] field in rules with no targets had no effect. (@aalekseyev, report by @craigfe)

• Add 'metaquot.' prefix to disambiguate metaquote extensions (#121, @ceastlund)
• Bump dune language to 1.11 since the cinaps extension requires at least Dune 1.11 (#126, @diml)

• Fix build with OCaml < 4.08

From 1.7.0:

• Add support for 4.11 (#92, @diml)

• ocaml support
  • full support from OCaml 4.02 to OCaml 4.10 (#1117, #1127)
  • fix desynchronized cache (#1120)
  • short path for OCaml 4.09 and OCaml 4.10 (#1082, #1117)
  • catch and test environment initialization errors (#1083, #1130)
  • restore type levels after recovery (#1092)
• merlin binary
  • fix syntax errors in 4.08 and 4.09 (#1081)
  • complete-prefix command accepts -kind option to filter results (#1071)
  • code cleanup (#1093, #1079, #1112)
  • better handling of expression and pattern extra nodes during browse tree traversal (#1091, #1121)
  • improve context detection (e.g. appropriate namespace for lookup) for various queries (#1104, #1110)
  • add stdlib to locate source path (#1085)
• editor modes
  • vim: tweak heuristic to select python version (#1111)
  • emacs: marlin/call
  • lsp: move server to its own repository (#1069), https://github.com/ocaml/ocaml-lsp
• test suite
  • dune rules for the test suite are now generated, deterministic and can be run individually (#1068, #1070, #1072)
  • fix incorrect command-line arguments in tests (#1073)
  • better coverage of frontend features (#1075, #1078, #1088, #1089, #1126)
• Build no longer relies on implicit transitive_deps (#1065).

Changes

• The default for doc-comments is changed to after (#1335, @Julow). This reverts a change introduced in 0.14.0 (#1012).
• Revert deprecation of the doc-comments option (#1331, @Julow). This reverts a change introduced in 0.14.0 (#1293).

• Add a --release option meaning the same as -p but without the package filtering. This is useful for custom dune invocation in opam files where we don't want -p (#3260, @jeremiedimino)

• Fix a bug introduced in 2.4.0 causing .bc programs to be built with -custom by default (#3269, fixes #3262, @jeremiedimino)

• Allow contexts to be defined with local switches in workspace files (#3265, fix #3264, @rgrinberg)

• Delay expansion errors until the rule is used to build something (#3261, fix #3252, @rgrinberg, @jeremiedimino)

• [coq] Support for theory dependencies and compositional builds using new field (theories ...) (#2053, @ejgallego, @rgrinberg)

• From now on, each version of a syntax extension must be explicitely tied to a minimum version of the dune language. Inconsistent versions in a dune-project will trigger a warning for version <=2.4 and an error for versions >2.4 of the dune language. (#3270, fixes #2957, @voodoos)

• [coq] Bump coq lang version to 0.2. New coq features presented this release require this version of the coq lang. (#3283, @ejgallego)

• Prevent installation of public executables disabled using the enabled_if field. Installation will now simply skip such executables instead of raising an error. (#3195, @voodoos)

• dune upgrade will now try to upgrade projects using versions <2.0 to version 2.0 of the dune language. (#3174, @voodoos)

• Add a top command to integrate dune with any toplevel, not just utop. It is meant to be used with the new #use_output directive of OCaml 4.11 (#2952, @mbernat, @jeremiedimino)

• Allow per-package version in generated opam files (#3287, @toots)

• [coq] Introduce the coq.extraction stanza. It can be used to extract OCaml sources (#3299, fixes #2178, @rgrinberg)

• Load ppx rewriters in dune utop and add pps field to toplevel stanza. Ppx extensions will now be usable in the toplevel (#3266, fixes #346, @stephanieyou)

• Add a (subdir ..) stanza to allow evaluating stanzas in sub directories. (#3268, @rgrinberg)

• Fix a bug preventing one from running inline tests in multiple modes (#3352, @jeremiedimino)

• Allow the use of the %{profile} variable in the enabled_if field of the library stanza. (#3344, @mrmr1993)

• Allow the use of %{ocaml_version} variable in enabled_if field of the library stanza. (#3339, @voodoos)

• Fix dune build freezing on MacOS when cache is enabled. (#3249, fixes ##2973, @artempyanykh)

New features

• Add an option --format-invalid-files to print unparsable parts of the input as verbatim text. This feature is still experimental. (#1026, @gpetiot)
• Support multi-indices extended indexing operators (#1279, #1277, @Julow, @gpetiot). This feature has been added in OCaml 4.10.0
• Handle OCaml 4.10.0 AST (#1276, @gpetiot)
• Preserve functor syntax for consistency (#1312, @gpetiot). Previously both functor syntax: module M = functor (K : S) -> struct end and module M (K : S) = struct end would be formatted as the latter, the original syntax is now preserved.

Changes

• Add the option doc-comments-val=before|after (#1012, @Julow). This option set the placement of documentation comment on val and external only. It is set to after by default.
• The default for doc-comments is changed from after to before (#1012, #1325, @Julow). This affects both conventional (default) and ocamlformat profiles.
• Some options are now deprecated:
  • doc-comments (#1293, #1012). This option depends on a flawed heuristic. It is replaced by doc-comments-val for val and external declarations. There is no equivalent to this option in the general case.
  • escape-chars, escape-strings and extension-sugar (#1293). These options are rarely used and their default behavior is considered to be the right behavior.
• Add space between row_field attributes and the label or arguments, to be consistent with the non-polymorphic case. (#1299, @CraigFe)

Bug fixes

• Fix missing parentheses around let open (#1229, @Julow). eg. M.f (M.(x) [@attr]) would be formatted to M.f M.(x) [@attr], which would crash OCamlformat
• Remove unecessary parentheses with attributes in some structure items:
  • extensions and eval items (#1230, @Julow). eg. the expression [%ext (() [@attr])] or the structure item (() [@attr]) ;;
  • let _ = ... constructs (#1244, @emillon)
• Fix some bugs related to comments:
  • after a function on the rhs of an infix (#1231, @Julow). eg. the comment in (x >>= fun y -> y (* A *)) would be dropped
  • in module unpack (#1309, @Julow). eg. in the module expression module M = (val x : S (* A *))
• Fix formatting of empty signature payload [%a:] (#1236, @emillon)
• Fix parenthesizing when accessing field of construct application (#1247, @gpetiot)
• Fix formatting of attributes on object overrides {< >} (#1238, @emillon)
• Fix attributes on coercion (#1239, @emillon)
• Fix formatting of attributes on packed modules (#1243, @emillon)
• Fix parens around binop operations with attributes (#1252, #1306, @gpetiot, @CraigFe)
• Remove unecessary parentheses in the argument of indexing operators (#1280, @Julow)
• Retain attributes on various AST nodes:
  • field set expressions, e.g. (a.x <- b) [@a] (#1284, @CraigFe)
  • instance variable set expressions, e.g. (a <- b) [@a] (#1288, @CraigFe)
  • indexing operators, e.g. (a.(b)) [@a] (#1300, @CraigFe)
  • sequences, e.g. (a; b) [@a] (#1291, @CraigFe)
• Avoid unnecessary spacing after object types inside records and polymorphic variants, e.g. {foo : < .. > [@a]} and { foo : < .. > } (#1296, @CraigFe)
• Fix missing parentheses around tuples with attributes. (#1301, @CraigFe). Previously, f ((0, 0) [@a]) would be formatted to f (0, 0) [@a], crashing OCamlformat.
• Avoid emitting >] when an object type is contained in an extension point or attribute payload (#1298, @CraigFe)
• Fix crash on the expression (0).*(0) (#1304, @Julow). It was formatting to 0.*(0) which parses as an other expression.
• Preserve empty doc-comments syntax. (#1311, @gpetiot). Previously (**) would be formatted to (***).
• Do not crash when a comment contains just a newline (#1290, @emillon)
• Handle lazy patterns as arguments to class (#1289, @emillon)
• Preserve cinaps comments containing unparsable code (#1303, @Julow). Previously, OCamlformat would fallback to the "wrapping" logic, making the comment unreadable and crashing in some cases.
• Fix normalization of attributes, fixing the docstrings in attributes (#1314, @gpetiot)
• Add missing parentheses around OR-patterns with attributes (#1317, @gpetiot)
• Fix spacing inside parens for symbols when the spacing was handled by the englobing exp (#1316, @gpetiot)
• Fix invalid (unparsable) docstrings (#1315, @gpetiot). When parsing a comment raises an error in odoc, it is printed as-is.
• Fix parenthesizing of optional arguments rebound to non-variables, e.g. let f ?a:(A) = () rather than the unparsable let f ?a:A = () (#1305, @CraigFe)

• Add mdx extension and stanza version 0.1 (#3094, @NathanReb)

• Allow to make Odoc warnings fatal. This is configured from the (env ...) stanza. (#3029, @Julow)

• Fix separate compilation of JS when findlib is not installed. (#3177, @nojb)

• Add a dune describe command to obtain the topology of a dune workspace, for projects such as ROTOR. (#3128, @jeremiedimino)

• Add plugin linking mode for executables and the (embed_in_plugin_libraries ...) field. (#3141, @nojb)

• Add an %{ext_plugin} variable (#3141, @nojb)

• Dune will no longer build shared objects for stubs if supports_shared_libraries is false (#3225, fixes #3222, @rgrinberg)

• Fix a memory leak in the file-watching mode (dune build -w) (#3220, @snowleopard and @aalekseyev)

• Fix versioning of artifact variables (eg %{cmxa:...}), which were introduced in 2.0, not 1.11. (#3149, @nojb)

• Fix a bug introduced in 2.3.0 where dune insists on using fswatch on linux (even when inotifywait is available). (#3162, @aalekseyev)

• Fix a bug causing all executables to be considered as optional (#3163, @diml)

Added

• Add a --duniverse-mode to ocaml-mdx rule so that the generated rules work within a duniverse
• Allow to import arbitrary files (not only .ml/.mli ones) into code blocks using the file label. (#203, #207, @voodoos)
• Allow to set the --non-deterministic option through the MDX_RUN_NON_DETERMINISTIC env variables (#208, @NathanReb)
• Add support for OCaml 4.10 (#204, @kit-ty-kate)
• Infer syntax kind when --syntax is not set, and add 'markdown' as an alias to 'normal' (#222, @gpetiot)
• Add ocaml-mdx deps command to be used by dune to compute file and dir dependencies of an mdx file. (#217, @voodoos)
• Add new delimiters syntax using comments for partial OCaml files include (#212, @voodoos).

Changed

• Do not unset INSIDE_DUNE when executing shell commands by default (#224, @NathanReb)

Fixed

• Fix a bug that could cause ocaml-mdx test to crash on some include in toplevel code blocks (#202, @trefis)

Removed

• Remove the direction option, only synchronize from .ml to .md files (#214, @gpetiot)

• Improve validation and error handling of arguments to dune init (#3103, fixes #3046, @shonfeder)

• dune init exec NAME now uses the NAME argument for private modules (#3103, fixes #3088, @shonfeder)

• Avoid linear walk to detect children, this should greatly improve performance when a target has a large number of dependencies (#2959, @ejgallego, @aalekseyev, @Armael)

• [coq] Add (boot) option to (coq.theories) to enable bootstrap of Coq's stdlib (#3096, @ejgallego)

• [coq] Deprecate public_name field in favour of package (#2087, @ejgallego)

• Better error reporting for "data only" and "vendored" dirs. Using these with anything else than a strict subdirectory or * will raise an error. The previous behavior was to just do nothing (#3056, fixes #3019, @voodoos)

• Fix bootstrap on bytecode only switches on windows or where -j1 is set. (#3112, @xclerc, @rgrinberg)

• Allow enabled_if fields in executable(s) stanzas (#3137, fixes #1690 @voodoos)

• Do not fail if ocamldep, ocamlmklib, or ocaml are absent. Wait for them to be used to fail (#3138, @rgrinberg)

• Introduce a strict_package_deps mode that verifies that dependencies between packages in the workspace are specified correctly. (@rgrinberg, #3117)

• Make sure the @all alias is defined when no dune file is present in a directory (#2946, fix #2927, @jeremiedimino)

• Preserve compiler version of binary ASTs across transformation (#79, @aantron)
• Allow not exiting on error (#83, @aantron)

• dune test is now a command alias for dune runtest. This is to make the CLI less idiosyncratic (#3006, @shonfeder)

• Allow to set menhir flags in the env stanza using the menhir_flags field. (#2960, fix #2924, @bschommer)

• By default, do not show the full command line of commands executed by dune when dune is executed inside dune. This is to make integration tests more reproducible (#3042, @diml)

• dune subst now works even without opam files (#2955, fixes #2910, @fangyi-zhou and @diml)

• Hint when trying to execute an executable defined in the current directory without using the ./ prefix (#3041, fixes #1094, @voodoos).

• Extend the list of modifiers that can be nested under with-accepted-exit-codes with chdir, setenv, ignore-<outputs>, with-stdin-from and with-<outputs>-to (#3027, fixes #3014, @voodoos)

• It is now an error to have a preprocessing dependency on a ppx rewriter library that is not marked as (kind ppx_rewriter) (#3039, @snowleopard).

• Fix permissions of files promoted to the source tree when using the shared cache. In particular, make them writable by the user (#3043, fixes #3026, @diml)

• Only detect internal OCaml tools with .opt extensions. Previously, this detection applied to other binaries as well (@kit-ty-kate, @rgrinberg, #3051).

• Give the user a proper error message when they try to promote into a source directory that doesn't exist. (#3073, fix #3069, @rgrinberg)

• Correctly build vendored packages in -p mode. These packages were incorrectly filtered out before. (#3075, @diml)

• Do not install vendored packages (#3074, @diml)

• make now prints a message explaining the main targets available (#3085, fix #3078, @diml)

• Add a byte_complete executable mode to build programs as self-contained bytecode programs (#3076, fixes #1519, @diml)

Additions

• Add option to turn warnings into errors (#398, Jules Aguillon)

Bugs fixed

• Emit quote before identifier in alias type expr (Fixes #391, Anton Bachin)
• Handle generalized open statements introduced in 4.08 (#393, Jon Ludlam)
• Refactor error reporting to avoid exiting the program in library code (#400, Jules Aguillon)
• Build on OCaml 4.10 (#408, Jon Ludlam)

New features

• Add an option --margin-check to emit a warning if the formatted output exceeds the margin (#1110, @gpetiot)
• Preserve comment indentation when wrap-comments is unset (#1138, #1159, @Julow)
• Improve error messages (#1147, @Julow)
• Display standard output in the emacs plugin even when ocamlformat does not fail (#1189, @gpetiot)

Removed

• Remove ocamlformat_reason (#254, #1185, @emillon). This tool has never been released to opam, has no known users, and overlaps with what refmt can do.
• Remove ocamlformat-diff (#1205, @gpetiot). This tool has never been released to opam, has no known users, and overlaps with what merge-fmt can do.

Packaging

• Work with base v0.13.0 (#1163, @Julow)

Bug fixes

• Fix placement of comments just before a '|' (#1203, @Julow)
• Fix build version detection when building in the absence of a git root (#1198, @avsm)
• Fix wrapping of or-patterns in presence of comments with break-cases=fit (#1167, @Julow). This also fixes an unstable comment bug in or-patterns
• Fix an unstable comment bug in variant declarations (#1108, @Julow)
• Fix: break multiline comments (#1122, @gpetiot)
• Fix: types on named arguments were wrapped incorrectly when preceding comments (#1124, @gpetiot)
• Fix the indentation produced by max-indent (#1118, @gpetiot)
• Fix break after Psig_include depending on presence of docstring (#1125, @gpetiot)
• Remove some calls to if_newline and break_unless_newline and fix break before closing brackets (#1168, @gpetiot)
• Fix unstable cmt in or-pattern (#1173, @gpetiot)
• Fix location of comment attached to the underscore of an open record (#1208, @gpetiot)
• Fix parentheses around optional module parameter (#1212, @cbarcenas)
• Fix grouping of horizontally aligned comments (#1209, @gpetiot)
• Fix dropped comments around module pack expressions (#1214, @Julow)
• Fix regression of comment position in list patterns (#1141, @jberdine)
• Fix: adjust definition of Location.is_single_line to reflect margin (#1102, @jberdine)

Documentation

• Fix documentation of option version-check (#1135, @Wilfred)
• Fix hint when using break-separators=after-and-docked (#1130, @gretay-js)

• Fix building the OCaml compiler with Dune (#3038, fixes #2974, @diml)

• Fix a bug in the Fiber.finalize function of the concurrency monad of Dune, causing a race condition at the user level (#3009, fix #2958, @diml)

• Support for OCaml 4.10 (#109, @xclerc)

• Invariant check on locations (#107, @trefis)

• Attach cinaps stanza actions to both @runtest and @cinaps aliases (#2831, @NathanReb)

• Add variables %{lib-private...} and %{libexec-private...} for finding build paths of files in public and private libraries within the same project. (#2901, @snowleopard)

• Add --mandir option to $ dune install. This option allows to override the installation directory for man pages. (#2915, fixes #2670, @rgrinberg)

• Fix dune --version. The bootstrap didn't compute the version correctly. (#2929, fixes #2911, @diml)

• Do not open the log file in dune clean. (#2965, fixes #2964 and #2921, @diml)

• Support passing two arguments to =, <>, ... operators in package dependencies so that we can have things such as (<> :os win32) (#2965, @diml)

• Guess foreign archives & native archives for libraries defined using the META format. (#2994, @rgrinberg, @anmonteiro)

• Fix generation of .merlin files when depending on local libraries with more than one source directory. (#2983, @rgrinberg)

• add support for OCaml 4.10

• Delay errors raised by invalid dune-package files. The error is now raised only if the invalid package is treated as a library and used to build something. (#2972, @rgrinberg)

• git related fixes:
  • github remote detection
  • not a git repository error
• New option --packages-directory to indicate where package descriptions are stored

Added

• Add a --output/-o option to the test subcommand to allow specifying a different output file to write the corrected to, or to write it to the standard output (#194, @NathanReb)
• Migrate to OCaml 4.08 AST to add support for let* bindings (#190, @gpetiot)
• Add --syntax option to rule subcommand to allow generating rules for cram tests (#177, @craigfe)
• Add a require-package label to explicitly declare dune package dependencies of a code block (#149, @Julow)
• Add an unset- label to unset env variables in shell blocks (#132, @clecat)

Changed

• Format rules generated by ocaml-mdx rule using dune format-dune-file (#184, @NathanReb)
• Run promotion of markdown files before .ml files in generated dune rules (#140, @clecat)

Fixed

• Use module_presence information on Env.summary to prevent fetching absent modules from the toplevel env (#186, @clecat)
• Remove trailing whitespaces at the end of toplevel or bash evaluation lines (#166, @clecat)
• Improve error reporting of ocaml-mdx test (#172, @Julow)
• Rule: Pass the --section option to test (#176, @Julow)
• Remove trailing whitespaces from shell outputs and toplevel evals (#166, @clecat)
• Remove inappropriate empty lines in generated dune rules (#163, @Julow)
• Fix ignored skip label in ocaml-mdx pp (#1561, @CraigFe)
• Fix synchronization of new parts from markdown to .ml (#156, @Julow)
• Fix ignored [@@@parts ...] markers within module definitions (#155, @Julow)
• Fix a bug in internal OCaml version comparison that lead to crashes in some cases (#145, @gpetiot)
• Promote to empty .ml file when using to-ml direction (#139, @clecat)
• Apply --force-output to .ml file as well (#137, @clecat)
• Fix a bug preventing .corrected files to be written in some cases (#136, @clecat)
• Add compatibility with 4.09.0 (#133, @xclerc)

Removed

• Remove the output subcommand as it was very specific to RealWorldOCaml needs (#195, @NathanReb)
• Remove the infer-timestamp direction (#171 @Julow)

• Do not produce a suprious empty correction when deriving_inline expands into an extension that undergoes further expansion (#86, @aalekseyev)
• Add Ppxlib.Quoter. This module allows to generate hygienic code fragments in the spirit of ppx_deriving. (#92, @rgrinberg)
• Allow for registering derivers on module type declarations. (#94, fix #83, @rgrinberg)
• Fix parsing long idenitifiers. (#98, @NathanReb)

• backend
  • support OCaml 4.09 (#1055)
  • fix parse errors in 4.08 (#1037)
  • update 4.08 support to OCaml 4.08.1 (#1053)
  • support without_cmis
  • separate reading from caching in file-cache, use caching in Env.check_state_consistency (#1044)
  • simplify compiler state management (#1056, #1059)
  • fix creation of initial environment, improve compatibility with upstream 4.08 (#1052)
• frontend
  • code re-organization (#1042)
  • error command: select which kind of errors to show (#995)
  • print value types in outline (#1014)
  • fix process handling in windows (#1005)
• editor modes
  • emacs
    • bugfixes in merlin-imenu, merlin-xref (#1000, #1021, #1001)
    • show types in merlin-imenu (#1013)
    • reset buffer local configurations when resetting server (#1004)
    • remove merlin-use-tuareg-imenu
    • fix stack overflow (#1024)
    • fix merlin-occurrence (#1043)
  • vim
    • display warn-error warnings as errors (#1009)
• testsuite
  • cover file-cache and check_state_consistency (#1044)
  • check inconsistent assumptions, test server versus single modes (#1047)

• Remove existing destination files in install before installing the new ones. (#2885, fixes #2883, @bschommer)

• The action field in the alias stanza is not available starting lang dune 2.0. The alias field in the rule stanza is a replacement. (#2846, fixes 2681, @rgrinberg)

• Introduce alias and package fields to the rule stanza. This is the preferred way of attaching rules to aliases. (#2744, @rgrinberg)

• Add field (optional) for executable stanzas (#2463, fixes #2433, @bobot)

• Infer targets for rule stanzas expressed in long form (#2494, fixes #2469, @NathanReb)

• Indicate the progress of the initial file tree loading (#2459, fixes #2374, @bobot)

• Build .cm[ox] files for executables more eagerly. This speeds up builds at the cost of building unnecessary artifacts in some cases. Some of these extra artifacts can fail to built, so this is a breaking change. (#2268, @rgrinberg)

• Do not put the <package>.install files in the source tree unless -p or --promote-install-files is passed on the command line (#2329, @jeremiedimino)

• Compilation units of user defined executables are now mangled by default. This is done to prevent the accidental collision with library dependencies of the executable. (#2364, fixes #2292, @rgrinberg)

• Enable (explicit_js_mode) by default. (#1941, @nojb)

• Add an option to clear the console in-between builds with --terminal-persistence=clear-on-rebuild

• Stop symlinking object files to main directory for stanzas defined jbuild files (#2440, @rgrinberg)

• Library names are now validated in a strict fashion. Previously, invalid names would be allowed for unwrapped libraries (#2442, @rgrinberg)

• mli only modules must now be explicitly declared. This was previously a warning and is now an error. (#2442, @rgrinberg)

• Modules filtered out from the module list via the Ordered Set Language must now be actual modules. (#2442, @rgrinberg)

• Actions which introduce targets where new targets are forbidden (e.g. preprocessing) are now an error instead of a warning. (#2442, @rgrinberg)

• No longer install a jbuilder binary. (#2441, @jeremiedimino)

• Stub names are no longer allowed relative paths. This was previously a warning and is now an error (#2443, @rgrinberg).

• Define (paths ...) fields in (context ...) definitions in order to set or extend any PATH-like variable in the context environment. (#2426, @nojb)

• The diff action will always normalize newlines before diffing. Perviousy, it would not do this normalization for rules defined in jbuild files. (#2457, @rgrinberg)

• Modules may no longer belong to more than one stanza. This was previously allowed only in stanzas defined in jbuild files. (#2458, @rgrinberg)

• Remove support for jbuild-ignore files. They have been replaced by the the dirs stanza in dune files. (#2456, @rgrinberg)

• Add a new config option sandboxing_preference, the cli argument --sandbox, and the dep spec sandbox in dune language. These let the user control the level of sandboxing done by dune per rule and globally. The rule specification takes precedence. The global configuration merely specifies the default. (#2213, @aalekseyev, @jeremiedimino)

• Remove support for old style subsystems. Dune will now emit a warning to reinstall the library with the old style subsystem. (#2480, @rgrinberg)

• Add action (with-stdin-from ) to redirect input from when performing . (#2487, @nojb)

• Change the automatically generated odoc index to only list public modules. This only affects unwrapped libraries (#2479, @rgrinberg)

• Set up formatting rules by default. They can be configured through a new (formatting) stanza in dune-project (#2347, fixes #2315, @emillon)

• Change default target from @install to @all. (#2449, fixes #1220, @rgrinberg)

• Include building stubs in @check rules. (@rgrinberg, #2530)

• Get rid of ad-hoc rules for guessing the version. Dune now only relies on the version written in the dune-project file and no longer read VERSION or similar files (#2541, @jeremiedimino)

• In (diff? x y) action, require x to exist and register a dependency on that file. (#2486, @aalekseyev)

• On Windows, an .exe suffix is no longer added implicitly to binary names that already end in .exe. Second, when resolving binary names, .opt variants are no longer chosen automatically. (#2543, @nojb)

• Make (diff? x y) move the correction file (y) away from the build directory to promotion staging area. This makes corrections work with sandboxing and in general reduces build directory pollution. (#2486, @aalekseyev, fixes #2482)

• c_flags, c_names and cxx_names are now supported in executable and executables stanzas. (#2562, @nojb) Note: this feature has been subsequently extended into a separate foreign_stubs field. (#2659, RFC #2650, @snowleopard)

• Remove git integration from $ dune upgrade (#2565, @rgrinberg)

• Add a --disable-promotion to disable all modification to the source directory. There's also a corresponding DUNE_DISABLE_PROMOTION environment variable. (#2588, fix #2568, @rgrinberg)

• Add a forbidden_libraries field to prevent some library from being linked in an executable. This help detecting who accidently pulls in unix for instance (#2570, @jeremiedimino)

• Fix incorrect error message when a variable is expanded in static context: %{lib:lib:..} when the library does not exist. (#2597, fix #1541, @rgrinberg)

• Add --sections option to $ dune install to install subsections of .install files. This is useful for installing only the binaries in a workspace for example. (#2609, fixes #2554, @rgrinberg)

• Drop support for jbuild and jbuild-ignore files (#2607, @jeremiedimino)

• Add a dune-action-plugin library for describing dependencies direcly in the executable source. Programs that use this feature can be run by a new action (dynamic-run ...). (#2635, @staronj, @aalekseyev)

• Stop installing the ocaml-syntax-shims binary. In order to use future_syntax, one now need to depend on the ocaml-syntax-shims package (#2654, @jeremiedimino)

• Add support for dependencies that are re-exported. Such dependencies are marked withre_export and will automatically be provided to users of a library (#2605, @rgrinberg)

• Add a deprecated_library_name stanza to redirect old names after a library has been renamed (#2528, @jeremiedimino)

• Error out when a preprocessor_deps field is present but not preprocess field is. It is a warning with Dune 1.x projects (#2660, @Julow)

• Dune will use -output-complete-exe instead of -custom when compiling self-contained bytecode executables whenever this options is available (OCaml version >= 4.10) (#2692, @nojb)

• Add action (with-accepted-exit-codes <pred> <action>) to specify the set of successful exit codes of <action>. <pred> is specified using the predicate language. (#2699, @nojb)

• Do not setup rules for disabled libraries (#2491, fixes #2272, @bobot)

• Configurator: filter out empty flags from pkg-config (#2716, @AltGr)

• no_keep_locs is a no-op for projects that use lang dune older than 2.0. In projects where the language is at least 2.0, the field is now forbidden. (#2752, fixes #2747, @rgrinberg)

• Extend support for foreign sources and archives via the (foreign_library ...) stanza as well as the (foreign_stubs ...) and (foreign_archives ...) fields. (#2659, RFC #2650, @snowleopard)

• Add (deprecated_package_names) field to (package) declaration in dune-project. The names declared here can be used in the (old_public_name) field of (deprecated_library_name) stanza. These names are interpreted as library names (not prefixed by a package name) and appropiate redirections are setup in their META files. This feaure is meant to migrate old libraries which do not follow Dune's convention of prefixing libraries with the package name. (#2696, @nojb)

• The fields license, authors, maintainers, source, bug_reports, homepage, and documentation of dune-project can now be overriden on a per-package basis. (#2774, @nojb)

• Change the default modes field of executables to (mode exe). If one wants to build a bytecode program, it now needs to be explicitly requested via (modes byte exe). (#2851, @jeremiedimino)

• Allow ccomp_type as a variable for evaluating enabled_if. (#2855, @dra27, @rgrinberg)

• Stricter validation of file names in select. The file names of conditional sources must match the prefix and the extension of the resultant filename. (#2867, @rgrinberg)

• Add flag disable_dynamically_linked_foreign_archives to the workspace file. If the flag is set to true then: (i) when installing libraries, we do not install dynamic foreign archives dll*.so; (ii) when building executables in the byte mode, we statically link in foreign archives into the runtime system; (iii) we do not generate any dll*.so rules. (#2864, @snowleopard)

• Reimplement the bootstrap procedure. The new procedure is faster and should no longer stack overflow (#2854, @dra27, @jeremiedimino)

• Allow .opam.template files to be generated using rules (#2866, @rgrinberg)

• Add support for 4.10 (#86, @diml)
• Infer file kind (interface or implementation) for binary ASTs that have no extension (#80, @aantron)
• Add ?argv argument to Driver.run_main (#82, @aantron)

Changes

• Set "conventional" as the default profile (#1060, @gpetiot). This new profile is made to better match the most used style and is encouraged. To continue using the previous default, use profile = ocamlformat in your .ocamlformat.
• CLI: Allow both values of boolean options (#1062, @Julow). Now, both --opt and --no-opt` are available on the CLI for any boolean option "opt". Previously, only one of them were available depending on the default value.
• Auto mode for break-string-literals (#1057, @gpetiot). wrap, newlines and newlines-and-wrap values of break-string-literals are removed. auto replaces them, it is equivalent to newlines-and-wrap.
• Dock collection brackets (#1014, @gpetiot). after-and-docked value of break-separators is removed and is replaced by a new dock-collection-brackets option.
• Preserve begin and end keywords in if-then-else (#978, @Julow). Previously, begin/end keywords around if-then-else branches were turned into parentheses.

New features

• Give a hint when warning 50 is raised (#1111, @gpetiot)
• Add a message when a config value is removed (#1089, @emillon). Explain what replaces removed options and avoid printing a parsing error.
• Implement sequence-blank-line=preserve-one for let bindings (#1077, @Julow). Preserve a blank line after let .. in when sequence-blank-line set to preserve-one. Previously, only blank lines after ; could be preserved.
• Parse toplevel directives (#1020, @Julow). Allow #directives in .ml files. Previously, files containing a directive needed to be parsed as "use file". The "use file" mode is removed and --use-file is now the same as --impl.
• Don't require --name, require kind, forbid --inplace, allow --check, make --enable-outside-detected-project implicit when reading from stdin (#1018, @gpetiot)
• Parse code in docstrings (#941, @gpetiot). Format OCaml code in cinaps-style comments (*$ code *) and code blocks in documentation comments (** {[ code ]} *).
• Parse documentation comments with Odoc (#721, @Julow). Formatting of documentation comments is more robust and support newer Odoc syntaxes. Internally, Odoc replaces Octavius as the documentation parser.

Bug fixes

• Fix unstabilizing comments on assignments (#1093, @gpetiot)
• Fix the default value documentation for max-indent (#1105, @gpetiot)
• Fix closing parenthesis exceeding the margin in function application (#1098, @Julow)
• Missing break before attributes of Pmty_with (#1103, @jberdine)
• Fix closing quote exceeding the margin (#1096, @Julow)
• Fix break before the closing bracket of collections (exceeding the margin) (#1073, @gpetiot)
• Fix precedence of Dot wrt Hash (#1058, @gpetiot)
• Fix break in variant type definition to not exceed the margin (#1064, @gpetiot)
• Fix newlines and indentation in toplevel extension points (#1054, @gpetiot)
• Fix placement of doc comments around extensions (#1052, @Julow)
• Inline extensions that do not break (#1050, @gpetiot)
• Add missing cut before attributes in type declarations (#1051, @gpetiot)
• Fix alignment of cases (#1046, @gpetiot)
• Fix blank line after comments at the end of lists (#1045, @gpetiot)
• Fix indexing operators precedence (#1039, @Julow)
• Fix dropped comment after infix op (#1030, @gpetiot)
• No newline if the input is empty (#1031, @gpetiot)
• Fix unstable comments around attributes (#1029, @gpetiot)
• Fix extra blank line in sequence (#1021, @Julow)
• Check functor arguments when computing placement of doc comments (#1013, @Julow)
• Fix indentation of labelled args (#1006, @gpetiot)
• Fix linebreak between or-cases with comments when break-cases=all (#1002, @gpetiot)
• Fix unstable unattached doc comment in records (#998, @Julow)
• Fix string literal changed (#995, @Julow)
• Fix type variable (#996, @Julow)
• Fix crash on extension sequence (#992, @gpetiot)
• Fix position of expressions regarding of comments in infix-op expressions (#986, @gpetiot)
• Escape special characters in external declaration (#988, @Julow)
• Fix parens around constrained expr with attrs (#987, @gpetiot)
• Fix the margin, and correctly breaks comments (#957, @gpetiot)
• Fix formatting of custom indexing operators (#975, @gpetiot)
• Fix position of comments of labelled arrow types (#976, @gpetiot)
• No box around inline odoc styles (#971, @gpetiot)
• Fix boxing of collection expressions/patterns (#960, @gpetiot)
• Fix crash on record expr with pack fields (#963, @Julow)
• Fix letop in subexpr (#956, @hhugo)

Internal

• Take file kind from --name when formatting stdin (#1119, @Julow)
• Make Fmt.t abstract (#1109, @Julow)
• Future-proof Fmt API in case Fmt.t goes abstract (#1106, @emillon)
• Future-proof Fmt API in case Fmt.t goes abstract (#1106, @emillon)
• Optional names for formatting boxes in debug output (#1083, @gpetiot)
• Check ocamlformat error codes in the testsuite (#1084, @emillon)
• Clean Translation_unit (#1078, @gpetiot)
• Use dune file generation in test/passing/dune (#1082, @emillon)
• CI: factorize tests and check reason build (#1079, @gpetiot)
• Use short form for action in src/dune (#1076, @emillon)
• Cleanup sequence_blank_line (#1075, @Julow)
• CI: use a script travis-ci.sh to simplify .travis.yml (#1063, @gpetiot)
• Remove utility functions from Fmt_ast (#1059, @gpetiot)
• CI: use opam-2.0.5 in Travis (#1044, @XVilka)
• CI: check the build with OCaml 4.07.1 and 4.08.0 (#1036, @Julow)
• Use the same sets of options for both branches by default in test_branch.sh (#1033, @gpetiot)
• Fix test_branch.sh and CI checking of CHANGES.md (#1032, #1034, @Julow)
• Fix flag of git-worktree in test_branch.sh and bisect.sh (#1027, @gpetiot)
• Remove the bisect_ppx dependency and clean the Makefile (#1005, @Julow)
• Use a CHANGES.md log file again (#1023, @gpetiot)
• Support OCaml 4.09.0 (add the odoc.1.4.2 dependency) (#1024, @gpetiot)
• Update labels of issue templates (#1017, @gpetiot)
• Update labels in CONTRIBUTING.md (#1007, @gpetiot)
• Allow to ignore invalid options (#984, @hhugo). The --ignore-invalid-option flag is added to ignore invalid options in .ocamlformat files.
• Improve the documentation of --doc-comments (#982, @Julow)
• Remove symbolic links and change naming convention of tests (#980, @gpetiot)
• Change the type of fmt_code (#974, @gpetiot)
• Simplify Makefile (#973, @hhugo)
• Dune should not be flagged as a build dep anymore (#954, @gpetiot)

• tiny API change to help with the detection of top-level phrase boundaries
• fixed a bug with end of comment detection in some cases (esp. related to cinaps)
• tweaks for better indentation within cinaps comments
• lowered priority of algebraic attributes in expressions ([@...]) to better match the actual meaning.

• Allow to mark directories as data_only_dirs without including them as dirs (#2619, fix #2584, @rgrinberg)

• Fix reading .install files generated with an external --build-dir. (#2638, fix #2629, @rgrinberg)