[new release] ocamlformat (4 packages) (0.29.0)

[Julow]

Auto-formatter for OCaml code

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

CHANGES:

Highlight

• * Support OCaml 5.5 syntax
  (Backport polymorphic parameters ocaml-ppx/ocamlformat#2772, Backport AST changes to Ppat_unpack ocaml-ppx/ocamlformat#2774, 5.5 support: Backport Ptype_external ocaml-ppx/ocamlformat#2775, 5.5 support: Backport Format changes ocaml-ppx/ocamlformat#2777, 5.5 support: Structure item embedded in expressions ocaml-ppx/ocamlformat#2780, 5.5 support: Modular explicits ocaml-ppx/ocamlformat#2781, 5.5 support: Backport parser code changes ocaml-ppx/ocamlformat#2782, Fix invalid syntax generated for let type a = A in ... ocaml-ppx/ocamlformat#2783, @Julow)
  The update brings several tiny changes, they are listed below.

• * Update Odoc's parser to 3.0 (Update the vendored odoc-parser ocaml-ppx/ocamlformat#2757, @Julow)
  The indentation of code-blocks containing OCaml code is reduced by 2 to avoid
  changing the generated documentation. The indentation within code-blocks is
  now significative in Odoc and shows up in generated documentation.

Added

• Added option letop-punning (Add configuration to control whether let-punning is used  ocaml-ppx/ocamlformat#2746, @WardBrian) to control whether
  punning is used in extended binding operators.
  For example, the code let+ x = x in ... can be formatted as
  let+ x in ... when letop-punning=always. With letop-punning=never, it
  becomes let+ x = x in .... The default is preserve, which will
  only use punning when it exists in the source.
  This also applies to let%ext bindings (letop-punning for extension nodes ocaml-ppx/ocamlformat#2747, @WardBrian).

• Support the unnamed functor parameters syntax in module types
  (Support the new functor type syntax MT -> MT ocaml-ppx/ocamlformat#2755, Missing parens in module type (M with type ..) -> N ocaml-ppx/ocamlformat#2759, @Julow)

  module type F = ARG -> S

  The following lines are now formatted as they are in the source file:

  module M : (_ : S) -> (_ : S) -> S = N
  module M : S -> S -> S = N
  (* The preceding two lines are no longer turned into this: *)
  module M : (_ : S) (_ : S) -> S = N

Fixed

• Fix dropped comment in (function _ -> x (* cmt *)) (Fix dropped comment in (function _ -> x (* cmt *)) ocaml-ppx/ocamlformat#2739, @Julow)

• * cases-matching-exp-indent=compact does not impact begin end nodes that
  don't have a match inside. (Improve indentation of end keyword in begin end enclosed submatch ocaml-ppx/ocamlformat#2742, @EmileTrotignon)

  (* before *)
  begin match () with
  | () -> begin
    f x
  end
  end
  (* after *)
  begin match () with
  | () -> begin
      f x
    end
  end

• Ast_mapper now iterates on all locations inside of Longident.t,
  instead of only some.
  (make Ast_mapper iterate over all locations inside Longident.t ocaml-ppx/ocamlformat#2737, @v-gb)

• Remove line break in M with module N = N (* cmt *) (Remove line break in 'M with module N = N (* cmt *)' ocaml-ppx/ocamlformat#2779, @Julow)

Internal

• Added information on writing tests to CONTRIBUTING.md (ocaml-ppx/ocamlformat#2838, @WardBrian)

Changed

• indentation of the end keyword in a match-case is now always at least 2. (Improve indentation of end keyword in begin end enclosed submatch ocaml-ppx/ocamlformat#2742, @EmileTrotignon)

  (* before *)
  begin match () with
  | () -> begin
    match () with
    | () -> ()
  end
  end
  (* after *)
  begin match () with
  | () -> begin
    match () with
    | () -> ()
  

• * use shortcut begin end in match cases and if then else body. (allow shortcut begin end syntax inside match and if then else ocaml-ppx/ocamlformat#2744, @EmileTrotignon)

  (* before *)
  match () with
  | () -> begin
      match () with
      | () ->
    end
  end
  (* after *)
  match () with
  | () ->
    begin match () with
      | () ->
    end
  end

• * Set the ocaml-version to 5.4 by default (ocaml version is set to 5.4.0 by default to allow effects ocaml-ppx/ocamlformat#2750, @EmileTrotignon)
  The main difference is that the effect keyword is recognized without having
  to add ocaml-version=5.3 to the configuration.
  In exchange, code that use effect as an identifier must use
  ocaml-version=5.2.

• The work to support OCaml 5.5 come with several improvements:

  • Improve the indentation of let structure-item with the
    [@ocamlformat "disable"] attribute.
    let structure-item means let module, let open, let include and
    let exception.
  • (let open M in e)[@a] is turned into let[@a] open M in e.
  • Long let open ... in no longer exceed the margin.
  • Improve indentation of let structure-item within parentheses:

    (* before *)
    (let module M = M in
    M.foo)
    (* after *)
    (let module M = M in
     M.foo)

[mseri]

Thanks!

[mseri]

Thanks. The remaining failures seem unrelated.

[Julow]

Thanks for the review :)