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

[Julow]

Auto-formatter for OCaml code

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

CHANGES:

Highlight

• * Support for OCaml 5.4 (Build with OCaml 5.4 ocaml-ppx/ocamlformat#2717, OCaml 5.4 syntax support ocaml-ppx/ocamlformat#2720, @Julow, @Octachron)
  OCamlformat now supports OCaml 5.4 syntax.
  Module packing of the form ((module M) : (module S)) are no longer
  rewritten to (module M : S) because these are now two different syntaxes.

• * Reduce indentation after |> map (fun (promote ocp docking for infix apply. ocaml-ppx/ocamlformat#2694, @EmileTrotignon)
  Notably, the indentation no longer depends on the length of the infix
  operator, for example:

  (* before *)
  v
  |>>>>>> map (fun x ->
              x )
  (* after *)
  v
  |>>>>>> map (fun x ->
      x )

  @@ match can now also be on one line.

Added

• Added option module-indent option (Add module indent option ocaml-ppx/ocamlformat#2711, @HPRIOR) to control the indentation
  of items within modules. This affects modules and signatures. For example,
  module-indent=4:

  module type M = sig
      type t
  
      val f : (string * int) list -> int
  end

• exp-grouping=preserve is now the default in default and ocamlformat
  profiles. This means that its now possible to use begin ... end without
  tweaking ocamlformat. (makes exp-grouping=preserve the default ocaml-ppx/ocamlformat#2716, @EmileTrotignon)

Deprecated

• Starting in this release, ocamlformat can use cmdliner >= 2.0.0. When that is
  the case, the tool no longer accepts unambiguous option names prefixes. For
  example, --max-iter is not accepted anymore, you have to pass the full
  option --max-iters. This does not apply to the keys in the .ocamlformat
  configuration files, which have always required the full name.
  See Remove the ability to specify command and option name prefixes dbuenzli/cmdliner#200.
  (Cmdliner 2.0.0 compat ocaml-ppx/ocamlformat#2680, @emillon)

Changed

• * The formatting of infix extensions is now consistent with regular
  formatting by construction. This reduces indentation in f @@ match%e
  expressions to the level of indentation in f @@ match. Other unknown
  inconsistencies might also be fixed. (infix attrs and expression are encoded in the AST ocaml-ppx/ocamlformat#2676, @EmileTrotignon)

• * The spacing of infix attributes is now consistent across keywords. Every
  keyword but begin function, and fun had attributes stuck to the keyword:
  match[@a], but fun [@a]. Now its also fun[@a]. (infix attrs and expression are encoded in the AST ocaml-ppx/ocamlformat#2676, @EmileTrotignon)

• * The formatting oflet a = b in fun ... is now consistent with other
  contexts like a ; fun .... A check for the syntax let a = fun ... in ...
  was made more precise. (fun after let-in is now consistent ocaml-ppx/ocamlformat#2705, @EmileTrotignon)

• * |> begin, ~arg:begin, begin if, lazy begin, begin match,
  begin fun and map li begin fun can now be printed on the same line, with
  one less indentation level for the body of the inner expression.
  (begin fun x -> now can be printed on a single line ocaml-ppx/ocamlformat#2664, overhaul begin match formatting ocaml-ppx/ocamlformat#2666, display lazy begin on one line. ocaml-ppx/ocamlformat#2671, format begin if on one line ocaml-ppx/ocamlformat#2672, Label arg begin ocaml-ppx/ocamlformat#2681, |> begin is now printed on a single line ocaml-ppx/ocamlformat#2685, map begin fun on one line, second attempt ocaml-ppx/ocamlformat#2693, @EmileTrotignon)
  For example :

  (* before *)
  begin
    fun x ->
      some code
  end
  (* after *)
  begin fun x ->
    some code
  end

• * break-struct=natural now also applies to sig ... end. (break-struct apply on sig ocaml-ppx/ocamlformat#2682, @EmileTrotignon)

Fixed

• Fixed wrap-comments=true not working with the janestreet profile (Fix 'wrap-comments' not working with the janestreet profile ocaml-ppx/ocamlformat#2645, @Julow)
  Asterisk-prefixed comments are also now formatted the same way as with the
  default profile.

• Fixed nested-match=align not working with match%ext (nest-match=align now works with match%ext. ocaml-ppx/ocamlformat#2648, @EmileTrotignon)

• Fixed the AST generated for bindings of the form let pattern : type = function ...
  (generate better asts for function bindings ocaml-ppx/ocamlformat#2651, @v-gb)

• Print valid syntax for the corner case (1).a (print valid syntax for the corner case (1).a ocaml-ppx/ocamlformat#2653, @v-gb)

• Ast_mapper.default_mapper now iterates on the location of in in let+ .. in ..
  (fix Ast_mapper not mapping over in location in let+ .. in .. ocaml-ppx/ocamlformat#2658, @v-gb)

• Fix missing parentheses in let+ (Cstr _) : _ = _ (Add missing parens in pattern in 'let+ (Cstr _) : t = ...' ocaml-ppx/ocamlformat#2661, @Julow)
  This caused a crash as the generated code wasn't valid syntax.

• Fix bad indentation of let%ext { ... (fix issue 2660 ocaml-ppx/ocamlformat#2663, @EmileTrotignon)
  with dock-collection-brackets enabled.

• ocamlformat is now more robust when used as a library to print modified ASTs
  (fix a few failures when printing a modified AST ocaml-ppx/ocamlformat#2659, @v-gb)

• Fix crash due to edge case with asterisk-prefixed comments (Fix error when asterisk prefixed comment looses its asterisks ocaml-ppx/ocamlformat#2674, @Julow)

• Fix crash when formatting mld files that cannot be lexed as ocaml (e.g.
  containing LaTeX or C code) (fix: handle case where doc does not lex as ocaml ocaml-ppx/ocamlformat#2684, @emillon)

• * Fix double parens around module constraint in functor application :
  module M = F ((A : T)) becomes module M = F (A : T). (bugfix : Double parens functor constraint ocaml-ppx/ocamlformat#2678, @EmileTrotignon)

• Fix misplaced ;; due to interaction with floating doc comments.
  (fix doc comment interaction with ;; ocaml-ppx/ocamlformat#2691, @EmileTrotignon)

• The formatting of attributes of expression is now aware of the attributes
  infix or postix positions: ((fun [@a] x -> y) [@b]) is formatted without
  moving attributes. (infix attrs and expression are encoded in the AST ocaml-ppx/ocamlformat#2676, @EmileTrotignon)

• begin%e ... end and begin [@a] ... end nodes are always preserved.
  (infix attrs and expression are encoded in the AST ocaml-ppx/ocamlformat#2676, @EmileTrotignon)

• begin end syntax for () is now preserved. (infix attrs and expression are encoded in the AST ocaml-ppx/ocamlformat#2676, @EmileTrotignon)

• Fix a crash on type 'a t = A : 'a. {a: 'a} -> 'a t. ([bugfix] fix crash with inline record type variable ocaml-ppx/ocamlformat#2710, @EmileTrotignon)

• Fix a crash where type%e nonrec t = t was formatted as type nonrec%e t = t,
  which is invalid syntax. (type nonrec infix ext bugfix ocaml-ppx/ocamlformat#2712, @EmileTrotignon)

• Fix commandline parsing being quadratic in the number of arguments
  (Fix quadratic command-line parsing ocaml-ppx/ocamlformat#2724, @let-def)

• * Fix ;; being added after a documentation comment (fix floating doc comments interaction with ;; expressions ocaml-ppx/ocamlformat#2683, @EmileTrotignon)
  This results in more ;; being inserted, for example:

  (* before *)
  print_endline "foo"
  let a = 3
  
  (* after *)
  print_endline "foo" ;;
  let a = 3

[Julow]

The failing Windows check fails with a findlib related error. Is this unrelated to the release ?

[jmid]

Yes, it is unrelated: #28636 with a fix in ocaml/ocamlfind#112

[jmid]

I've created #28753 to silence the diskuvbox revdeps failures.

[smorimoto]

The issues with awsm-async and js_of_ocaml-webidl are unrelated to this release.

[EmileTrotignon]

A few issues have been opened regarding this release:

• Bug: labeled tuples with infix operators cannot be formatted ocaml-ppx/ocamlformat#2731
• Last fn arguments shifted to the right with js profile (0.28 change) ocaml-ppx/ocamlformat#2729

The first one is a crash inducing bug, the other a style-bug.

I am not sure if this should be delayed so fixes can be included, or if fixes should come in 0.28.1

[Julow]

We have a patch for one of these issues, so I would like to release again with the patches merged. Thanks!

[Julow]

New release: #28774