Merge branch 'main' into mld-lexing-errors

Author: Julow

.github/workflows/build-dune.yml

@@ -0,0 +1,19 @@
+name: Build on Dune PM
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        runs-on: [ ubuntu-latest, macos-latest ]
+    runs-on: ${{ matrix.runs-on }}
+    continue-on-error: true
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use dune
+        uses: ocaml-dune/[email protected]
+        with:
+          automagic: true

.github/workflows/changelog-check.yml

@@ -8,6 +8,6 @@ on:
 jobs:
   Changelog-Entry-Check:
     name: Check Changelog Action
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: tarides/changelog-check-action@v1

.github/workflows/pr-number.yml

@@ -5,6 +5,6 @@ on: [pull_request_target]
 jobs:
   PR-Number-Update:
     name: Update PR number
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - uses: tarides/[email protected]

CHANGES.md

@@ -6,6 +6,16 @@ profile. This started with version 0.26.0.
 
 ## unreleased
 
+### 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 dbuenzli/cmdliner#200.
+  (#2680, @emillon)
+
 ### Fixed
 
 - Fixed `wrap-comments=true` not working with the janestreet profile (#2645, @Julow)
@@ -33,13 +43,47 @@ profile. This started with version 0.26.0.
 
 - Fix crash due to edge case with asterisk-prefixed comments (#2674, @Julow)
 
+
 - Fix crash when formatting `mld` files that cannot be lexed as ocaml (e.g.
   containing LaTeX or C code) (#2684, @emillon)
+
+- \* Fix double parens around module constraint in functor application :
+  `module M = F ((A : T))` becomes `module M = F (A : T)`. (#2678, @EmileTrotignon)
+
+- Fix misplaced `;;` due to interaction with floating doc comments.
+  (#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. (#2676, @EmileTrotignon)
+
+- `begin%e ... end` and `begin [@a] ... end` nodes are always preserved.
+  (#2676, @EmileTrotignon)
+
+- `begin end` syntax for `()` is now preserved. (#2676, @EmileTrotignon)
+
+- \* 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. (#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]`. (#2676, @EmileTrotignon)
+
+- \* The formatting of`let 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. (#2705, @EmileTrotignon)
+
+- Fix a crash on `type 'a t = A : 'a. {a: 'a} -> 'a t`. (#2710, @EmileTrotignon)
+
 ### Changed
 
-- `begin if`, `lazy begin`, `begin match` and `begin fun` can now be printed on
-  the same line, with one less indentation level for the body of the inner
-  expression. (#2664, #2666, #2671, #2672, @EmileTrotignon) For example :
+- `|> 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.
+  (#2664, #2666, #2671, #2672, #2681, #2685, #2693, @EmileTrotignon)
+  For example :
   ```ocaml
   (* before *)
   begin
@@ -52,6 +96,36 @@ profile. This started with version 0.26.0.
   end
   ```
 
+- \* `break-struct=natural` now also applies to `sig ... end`. (#2682, @EmileTrotignon)
+
+- \* `;;` is added at the of every toplevel-expression, except if its the last
+  thing in the struct (#2683, @EmileTrotignon) For example:
+  ```ocaml
+  (* before *)
+  print_endline "foo"
+  let a = 3
+
+  (* after *)
+  print_endline "foo" ;;
+  let a = 3
+  ```
+
+- \* Infix apply docking behaviour from --ocp-indent-compat is promoted to
+ everyone. The most common effect is that `|> map (fun` is now indented from
+ `|>` and not from `map`:
+  ```ocaml
+  (* before *)
+  v
+  |>>>>>> map (fun x ->
+              x )
+  (* after *)
+  v
+  |>>>>>> map (fun x ->
+      x )
+  ```
+  `@@ match` can now also be on one line.
+  (#2694, @EmileTrotignon)
+
 ## 0.27.0
 
 ### Highlight

bench/bench.ml

@@ -97,14 +97,14 @@ let json_of_ols_results ?name (results : Bechamel.Analyze.OLS.t results) :
   let results =
     metrics_by_test |> Hashtbl.to_seq
     |> Seq.map (fun (test_name, metrics) ->
-           let metrics =
-             metrics |> Hashtbl.to_seq
-             |> Seq.map (fun (metric_name, ols) ->
-                    (metric_name, json_of_ols ols) )
-             |> List.of_seq
-             |> fun bindings -> `Assoc bindings
-           in
-           `Assoc [("name", `String test_name); ("metrics", metrics)] )
+        let metrics =
+          metrics |> Hashtbl.to_seq
+          |> Seq.map (fun (metric_name, ols) ->
+              (metric_name, json_of_ols ols) )
+          |> List.of_seq
+          |> fun bindings -> `Assoc bindings
+        in
+        `Assoc [("name", `String test_name); ("metrics", metrics)] )
     |> List.of_seq
     |> fun items -> `List items
   in

bin/ocamlformat/main.ml

@@ -16,7 +16,7 @@ open Ocamlformat_format ;;
 
 Stdlib.at_exit (Format.pp_print_flush Format.err_formatter) ;;
 
-Stdlib.at_exit (Format_.pp_print_flush Format_.err_formatter)
+Stdlib.at_exit (Format_.pp_print_flush Format_.err_formatter) ;;
 
 let format ?output_file ~kind ~input_name ~source (conf : Conf.t) =
   if conf.opr_opts.disable.v then Ok source

doc/manpage_ocamlformat.mld

@@ -130,9 +130,9 @@ OPTIONS (CODE FORMATTING STYLE)
            expanded. The default value is auto.
 
        --break-struct={force|natural}
-           Break struct-end module items. force will break struct-end phrases
-           unconditionally. natural will break struct-end phrases naturally
-           at the margin. The default value is force.
+           Break struct-end and sig-end items. force will break items
+           unconditionally. natural will break items naturally at the margin.
+           The default value is force.
 
        --cases-exp-indent=COLS
            Indentation of cases expressions (COLS columns). See also the