[new release] ocamlformat, ocamlformat-rpc-lib and ocamlformat-lib (0.25.0)

[gpetiot]

Auto-formatter for OCaml code

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

CHANGES:

Library

• The declaration of options is a regular module instead of a functor. (Make the declaration of options into a regular module instead of a functor ocaml-ppx/ocamlformat#2193, @EmileTrotignon)

Bug fixes

• Fix indentation when ocamlformat is disabled on an expression (Fix indentation when ocamlformat is disabled on an expression ocaml-ppx/ocamlformat#2129, @gpetiot)
• Reset max-indent when the max-indent option is not set (Reset max-indent when 'max-indent' is not set ocaml-ppx/ocamlformat#2131, @hhugo, @gpetiot)
• Add missing parentheses around immediate objects having attributes attached in 4.14 (Add missing parens around immediate objects having attributes attached in 4.14 ocaml-ppx/ocamlformat#2144, @gpetiot)
• Fix dropped comment attached to the identifier of an open-expression (Fix dropped comment attached to the identifier of an open-expression ocaml-ppx/ocamlformat#2155, @gpetiot)
• Correctly format chunks of file in presence of enable/disable floating attributes (Correctly format chunks of file in presence of enable/disable floating attributes ocaml-ppx/ocamlformat#2156, @gpetiot)
• Remove abusive normalization in docstrings references (Remove abusive normalization in docstrings references ocaml-ppx/ocamlformat#2159, Remove abusive normalization in docstrings references ocaml-ppx/ocamlformat#2162, @EmileTrotignon)
• Fix parentheses around symbols in if-then-else branches (Fix parentheses around symbols in if-then-else branches ocaml-ppx/ocamlformat#2169, @gpetiot)
• Preserve position of comments around variant identifiers (Preserve position of comments around variant identifiers ocaml-ppx/ocamlformat#2179, @gpetiot)
• Fix parentheses around symbol identifiers (Fix parens around symbol identifiers ocaml-ppx/ocamlformat#2185, @gpetiot)
• Fix alignment inconsistency between let-binding and let-open (Fix alignment inconsistency between let-binding and let-open ocaml-ppx/ocamlformat#2187, @gpetiot)
• Fix reporting of operational settings origin in presence of profiles (Fix reporting of operational settings origin in presence of profiles ocaml-ppx/ocamlformat#2188, @EmileTrotignon)
• Fix alignment inconsistency of if-then-else in apply (Fix alignment inconsistency of if-then-else in apply ocaml-ppx/ocamlformat#2203, @gpetiot)
• Fix automated Windows build (Fix mingw64 build script, automate Windows release asset ocaml-ppx/ocamlformat#2205, @nojb)
• Fix spacing between recursive module bindings and recursive module declarations (Fix spacing between recursive module bindings and recursive module declarations ocaml-ppx/ocamlformat#2217, @gpetiot)
• ocamlformat-rpc: use binary mode for stdin/stdout (ocamlformat-rpc: use binary mode for stdin/stdout ocaml-ppx/ocamlformat#2218, @rgrinberg)
• Fix interpretation of glob pattern in .ocamlformat-ignore under Windows (Fix interpretation of glob patterns in .ocamlformat-ignore under Windows ocaml-ppx/ocamlformat#2206, @nojb)
• Remove conf mutability, and correctly display the conventional profile when using print-config (Remove conf mutability, and correctly display the conventional profile when using print-config ocaml-ppx/ocamlformat#2233, @EmileTrotignon)
• Preserve position of comments around type alias (Add location to ptyp_alias ocaml-ppx/ocamlformat#2239, @EmileTrotignon)
• Preserve position of comments around constructor record (Add location to pcstr_record ocaml-ppx/ocamlformat#2237, @EmileTrotignon)
• Preserve position of comments around external declaration strings (Add locations to pval_prim strings ocaml-ppx/ocamlformat#2238, @EmileTrotignon, @gpetiot)
• Preserve position of comments around module pack expressions (Add optional package_type to pexp_pack ocaml-ppx/ocamlformat#2234, @EmileTrotignon, @gpetiot)
• Correctly parenthesize array literals with attributes in argument positions (Fix parens on array literals with attrs when used as function args ocaml-ppx/ocamlformat#2250, @ccasin)

Changes

• Indent 2 columns after initializer keyword (Indent 2 columns after 'initializer' keyword ocaml-ppx/ocamlformat#2145, @gpetiot)
• Preserve syntax of generative modules ((struct end) vs ()) (Preserve syntax of generative modules '(struct end)' vs '()' ocaml-ppx/ocamlformat#2135, Fix non-stabilization of comment in generative module when the line breaks ocaml-ppx/ocamlformat#2146, @trefis, @gpetiot)
• Preserve syntax of module unpack with type constraint (((module X) : (module Y)) vs (module X : Y)) (Preserve syntax of module unpack with type constraint ('((module X) : (module Y))' vs '(module X : Y)') ocaml-ppx/ocamlformat#2136, @trefis, @gpetiot)
• Normalize location format for warning and error messages (Normalize location format for warning and error messages ocaml-ppx/ocamlformat#2139, @gpetiot)
• Preserve syntax and improve readability of indexop-access expressions (Simplify parsing and formatting of indexop-access expressions ocaml-ppx/ocamlformat#2150, @trefis, @gpetiot)
  • Break sequences containing indexop-access assignments
  • Remove unnecessary parentheses around indices
• Mute warnings for odoc code blocks whose syntax is not specified (Mute warnings for odoc code blocks whose syntax is not specified ocaml-ppx/ocamlformat#2151, @gpetiot)
• Improve formatting of odoc links (Improve formatting of odoc links ocaml-ppx/ocamlformat#2152, @gpetiot)
• Preserve sugared extension node attached to an if carrying attributes (Preserve sugared extension node attached to an 'if' carrying attributes ocaml-ppx/ocamlformat#2167, @trefis, @gpetiot)
• Remove unnecessary parentheses around partially applied infix operators with attributes (Remove unnecessary parentheses around partially applied infix operators with attributes ocaml-ppx/ocamlformat#2198, @gpetiot)
• JaneStreet profile: doesn't align infix ops with open paren (JaneStreet profile: doesn't align infix ops with open paren ocaml-ppx/ocamlformat#2204, @gpetiot)
• Re-use the type let_binding from the parser instead of value_binding, improve the spacing of let-bindings regarding of having extension or comments (Re-use the type let_binding from the parser instead of value_binding, improve the spacing of let-bindings regarding of having extension or comments ocaml-ppx/ocamlformat#2219, @gpetiot)
• The ocamlformat package now only contains the binary, the library is available through the ocamlformat-lib package (Distribute the library in a separate ocamlformat-lib package ocaml-ppx/ocamlformat#2230, @gpetiot)

New features

• Add a break-colon option to decide whether to break before or after the : symbol in value binding declarations and type constraints. This behavior is no longer ensured by ocp-indent-compat. (Add a 'break-colon' option to decide whether to break before or after the colon in value binding declarations and type constraints ocaml-ppx/ocamlformat#2149, @gpetiot)
• Format .mld files as odoc documentation files (Format .mld files as odoc documentation files ocaml-ppx/ocamlformat#2008, @gpetiot)
• New value vertical for option if-then-else (New value 'vertical' for option 'if-then-else' ocaml-ppx/ocamlformat#2174, @gpetiot)
• New value vertical for option break-cases (New value 'vertical' for option 'break-cases' ocaml-ppx/ocamlformat#2176, @gpetiot)
• New value wrap-or-vertical for option break-infix that only wraps high precedence infix ops (Define 'break-infix=wrap-or-vertical' that only wraps high precedence infix ops ocaml-ppx/ocamlformat#1865, @gpetiot)

[kit-ty-kate]

The tests for all three packages fail with:

#=== ERROR while compiling ocamlformat.0.25.0 =================================#
# context              2.2.0~alpha~dev | linux/x86_64 | ocaml-base-compiler.4.08.1 | pinned(https://github.com/ocaml-ppx/ocamlformat/releases/download/0.25.0/ocamlformat-0.25.0.tbz)
# path                 ~/.opam/4.08/.opam-switch/build/ocamlformat.0.25.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-7-ed8c29.env
# output-file          ~/.opam/log/ocamlformat-7-ed8c29.out
### output ###
# File "vendor/parser-recovery/lib/dune", line 14, characters 0-194:
# 14 | (rule
# 15 |  (targets parser_recover.ml)
# 16 |  (deps parser.cmly)
# 17 |  (action
# 18 |   (with-stdout-to
# 19 |    %{targets}
# 20 |    (with-stderr-to
# 21 |     recovery_parser.stderr
# 22 |     (run ../menhir-recover/main.exe parser.cmly)))))
# Error: No rule found for vendor/parser-recovery/lib/parser.cmly
# File "test/rpc/dune", line 17, characters 12-31:
# 17 |  (libraries ocamlformat-rpc-lib unix)
#                  ^^^^^^^^^^^^^^^^^^^
# Error: Library "ocamlformat-rpc-lib" not found.
# -> required by _build/default/test/rpc/rpc_test_fail.exe
# -> required by _build/default/test/rpc/rpc_test_fail.output
# -> required by alias test/rpc/runtest in test/rpc/dune:16
# File "test/rpc/dune", line 3, characters 12-31:
# 3 |  (libraries ocamlformat-rpc-lib unix)
#                 ^^^^^^^^^^^^^^^^^^^
# Error: Library "ocamlformat-rpc-lib" not found.
# -> required by _build/default/test/rpc/rpc_test.exe
# -> required by _build/default/test/rpc/rpc_test.output
# -> required by alias test/rpc/runtest in test/rpc/dune:2

[kit-ty-kate]

The tests are still failing

[kit-ty-kate]

I'm guessing this is a work in progress for a future re-release? I would be personally against the inclusion of a patch this big in opam-repository.

[gpetiot]

Yes sorry, I converted as a draft. It's taking more time than I expected (and would like) to get right.
At this point I wish I could release the package without the tests.

[kit-ty-kate]

Superseded by #23464