[new release] ocamlformat and ocamlformat-rpc-lib (0.24.0)

[gpetiot]

Auto-formatter for OCaml code

• Project page: https://github.com/ocaml-ppx/ocamlformat

CHANGES:

New features

• Support odoc-parser.2.0.0 (Support odoc-parser.2.0.0 ocaml-ppx/ocamlformat#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

[kit-ty-kate]

Is that still the case?

[gpetiot]

Oh we can loosen up this one indeed!

[kit-ty-kate]

Mmh, it seems to still be incompatible, do you know why?

#=== ERROR while compiling ocamlformat.0.24.0 =================================#
# context              2.1.2 | linux/x86_64 | ocaml-base-compiler.4.08.1 | pinned(https://github.com/ocaml-ppx/ocamlformat/releases/download/0.24.0/ocamlformat-0.24.0.tbz)
# path                 ~/.opam/4.08/.opam-switch/build/ocamlformat.0.24.0
# command              ~/.opam/opam-init/hooks/sandbox.sh build dune build -p ocamlformat -j 31 @install @runtest
# exit-code            1
# env-file             ~/.opam/log/ocamlformat-546-62cdfe.env
# output-file          ~/.opam/log/ocamlformat-546-62cdfe.out
### output ###
# File "test/cli/repl_file_errors.t/run.t", line 1, characters 0-0:
# /usr/bin/git --no-pager diff --no-index --color=always -u _build/.sandbox/4e1e10bf7ae57bd1e6d8a0835a6c5dae/default/test/cli/repl_file_errors.t/run.t _build/.sandbox/4e1e10bf7ae57bd1e6d8a0835a6c5dae/default/test/cli/repl_file_errors.t/run.t.corrected
# diff --git a/_build/.sandbox/4e1e10bf7ae57bd1e6d8a0835a6c5dae/default/test/cli/repl_file_errors.t/run.t b/_build/.sandbox/4e1e10bf7ae57bd1e6d8a0835a6c5dae/default/test/cli/repl_file_errors.t/run.t.corrected
# index 28981c4..d2d4e3f 100644
# --- a/_build/.sandbox/4e1e10bf7ae57bd1e6d8a0835a6c5dae/default/test/cli/repl_file_errors.t/run.t
# +++ b/_build/.sandbox/4e1e10bf7ae57bd1e6d8a0835a6c5dae/default/test/cli/repl_file_errors.t/run.t.corrected
# @@ -27,5 +27,5 @@ Make sure the locations of errors in repl files are right.
#    [1]
#  
#    $ ocamlformat --repl-file empty_line_begin.repl
# -  # foo bar ;;
# +  # foo bar;;
#    - : 0
# (cd _build/default/test/unit && ./test_unit.exe)

[gpetiot]

No it shouldn't depend on the odoc-parser version. It looks like the only thing that changed in the test env is dune being 3.3.1, and I'm not a fan of having tests depending on the dune version. @emillon do you know if dune is the culprit here? (a few things changed for cram tests in 3.0.0)

[emillon]

Not super easy to determine with just this diff, it would be useful to try to pinpoint exactly which release introduces the diff (and determine which ). If that's 2.9.3 -> 3.0.0, one thing that comes to mind is ocaml/dune#4975, in which case the ocamlformat binary you're using in the tests would be the wrong one. Related: this stanza probably needs a (applies_to :whole_subtree) option.

[gpetiot]

I confirm this is fine with 2.9.3 and broken with 3.0.2., but the (applies_to :whole_subtree) doesn't fix the issue.

[emillon]

fixed in ocaml-ppx/ocamlformat#2124

[gpetiot]

Replaced by #21830