Fix cinaps comment formatting to not change multiline string contents. #2463

tdelvecchio-jsc · 2023-10-06T16:08:15Z

Rather than formatting comment code blocks into a string, and then converting that string back into an Fmt.t, we instead just generate the Fmt.t directly, which allows the styling to know about current indentation without needing to manually indent/unindent the formatted text.

This change has some rough edges to it (with the addition of set_margin as an argument to fmt_code, in particular), so any feedback would be greatly appreciated!

gpetiot

I added an entry in the changelog.

Everything looks good to me, thanks! Before merging, @Julow let's just confirm there is nothing conflictual with what you had planned for Jane Street in #2314 or #2371

Julow

I have a question but otherwise good to go in :)

Julow · 2023-10-10T08:43:36Z

CHANGES.md

@@ -19,6 +19,7 @@ profile. This started with version 0.26.0.
 - \* Consistent break after string constant argument (#2453, @Julow)
 - Fix invalid syntax generated with `ocp-indent-compat` (#2445, @Julow)
 - Fixed bug with attributes on sub-expressions of infix operators (#2459, @tdelvecchio-jsc)
+- \* Fix cinaps comment formatting to not change multiline string contents (#2463, @tdelvecchio-jsc)


Not a breaking change.

I mean this PR changed the formatting of cinaps comments

I don't think so. The new output looks more like the input. I don't think this patch would change already formatted code.

Julow · 2023-10-10T09:29:20Z

lib/Fmt_odoc.ml

-  Conf.t -> offset:int -> string -> (string, [`Msg of string]) Result.t
+     Conf.t
+  -> offset:int
+  -> set_margin:bool


We might get rid of the set_margin by not using Fmt.eval when formatting code blocks in docstrings. That might require some time so I suggest to do it later and not to block this PR. The extra argument is not too bad as a temporary solution.

Julow · 2023-10-10T09:36:44Z

test/passing/tests/cinaps.ml.ref

@@ -22,7 +22,7 @@ let y = 2
  #use "import.cinaps" ;;

  List.iter all_fields ~f:(fun (name, type_) ->
-      printf "\nexternal get_%s\n: unit -> %s = \"get_%s\"" name type_ name )
+      printf "\nexternal get_%s\n  : unit -> %s = \"get_%s\"" name type_ name )


This might be intended but I'd like confirmation. The original comment is:

(*$ ;; #use "import.cinaps" ;; List.iter all_fields ~f:(fun (name, type_) -> printf "\nexternal get_%s : unit -> %s = \"get_%s\"" name type_ name) *)

Are the two spaces on the last line part of the string constant ?
It was my understanding that cinaps would strip any indentation before parsing the code (like Odoc does with code blocks).

Yes, they are part of the string constant:

(*$ ;; open! Core ;; let all_fields = ["a", "b"; "c", "d"] ;; List.iter all_fields ~f:(fun (name, type_) -> printf "\nexternal get_%s : unit -> %s = \"get_%s\"" name type_ name) *) external get_a : unit -> b = "get_a" external get_c : unit -> d = "get_c"(*$*)

Thanks for confirming, I'll merge then!

@Julow

….27.0) CHANGES: ### Highlight - \* Support OCaml 5.2 syntax (ocaml-ppx/ocamlformat#2519, ocaml-ppx/ocamlformat#2544, ocaml-ppx/ocamlformat#2590, ocaml-ppx/ocamlformat#2596, ocaml-ppx/ocamlformat#2621, ocaml-ppx/ocamlformat#2628, @Julow, @EmileTrotignon, @hhugo) This includes local open in types, raw identifiers, and the new representation for functions. This might change the formatting of some functions due to the formatting code being completely rewritten. - Support OCaml 5.3 syntax (ocaml-ppx/ocamlformat#2609, ocaml-ppx/ocamlformat#2610, ocaml-ppx/ocamlformat#2611, ocaml-ppx/ocamlformat#2622, ocaml-ppx/ocamlformat#2623, ocaml-ppx/ocamlformat#2562, ocaml-ppx/ocamlformat#2624, ocaml-ppx/ocamlformat#2625, ocaml-ppx/ocamlformat#2627, @Julow, @Zeta611) This adds support for effect patterns, short functor type arguments and utf8 identifiers. To format code using the new `effect` syntax, add this option to your `.ocamlformat`: ``` ocaml-version = 5.3 ``` - Documentation comments are now formatted by default (ocaml-ppx/ocamlformat#2390, @Julow) Use the option `parse-docstrings = false` to restore the previous behavior. - \* Consistent indentation of polymorphic variant arguments (ocaml-ppx/ocamlformat#2427, @Julow) Increases the indentation by one to make the formatting consistent with normal variants. For example: ``` ... (* before *) (`Msg (foo bar)) (* after *) (`Msg (foo bar)) ``` - Build on OCaml 5.3 (ocaml-ppx/ocamlformat#2603, @adamchol, @Julow) ### Added - Improve the emacs plugin (ocaml-ppx/ocamlformat#2577, ocaml-ppx/ocamlformat#2600, @gridbugs, @thibautbenjamin) Allow a custom command to be used to run ocamlformat and add compatibility with emacs ocaml tree-sitter modes. - Added option `let-binding-deindent-fun` (ocaml-ppx/ocamlformat#2521, @henrytill) to control the indentation of the `fun` in: ``` let f = fun foo -> bar ``` - Added back the flag `--disable-outside-detected-project` (ocaml-ppx/ocamlformat#2439, @gpetiot) It was removed in version 0.22. - Support newer Odoc syntax (ocaml-ppx/ocamlformat#2631, ocaml-ppx/ocamlformat#2632, ocaml-ppx/ocamlformat#2633, @Julow) ### Changed - \* Consistent formatting of comments (ocaml-ppx/ocamlformat#2371, ocaml-ppx/ocamlformat#2550, @Julow) This is mostly an internal change but some comments might be formatted differently. - \* Improve formatting of type constraints with type variables (ocaml-ppx/ocamlformat#2437, @gpetiot) For example: ``` let f : type a b c. a -> b -> c = ... ``` - \* Improve formatting of functor arguments (ocaml-ppx/ocamlformat#2505, @Julow) This also reduce the indentation of functor arguments with long signatures. - Improvements to the Janestreet profile (ocaml-ppx/ocamlformat#2445, ocaml-ppx/ocamlformat#2314, ocaml-ppx/ocamlformat#2460, ocaml-ppx/ocamlformat#2593, ocaml-ppx/ocamlformat#2612, @Julow, @tdelvecchio-jsc) - \* Undo let-bindings and methods normalizations (ocaml-ppx/ocamlformat#2523, ocaml-ppx/ocamlformat#2529, @gpetiot) This remove the rewriting of some forms of let-bindings and methods: + `let f x = (x : int)` is no longer rewritten into `let f x : int = x` + `let f (type a) (type b) ...` is no longer rewritten into `let f (type a b) ...` + `let f = fun x -> ...` is no longer rewritten into `let f x = ...` - \* The `break-colon` option is now taken into account for method type constraints (ocaml-ppx/ocamlformat#2529, @gpetiot) - \* Force a break around comments following an infix operator (fix non-stabilizing comments) (ocaml-ppx/ocamlformat#2478, @gpetiot) This adds a line break: ``` a || (* this comment is now on its own line *) b ``` ### Fixed - Fix placement of comments in some cases (ocaml-ppx/ocamlformat#2471, ocaml-ppx/ocamlformat#2503, ocaml-ppx/ocamlformat#2506, ocaml-ppx/ocamlformat#2540, ocaml-ppx/ocamlformat#2541, ocaml-ppx/ocamlformat#2592, ocaml-ppx/ocamlformat#2617, @gpetiot, @Julow) Some comments were being moved or causing OCamlformat to crash. OCamlformat refuses to format if a comment would be missing in its output, to avoid loosing code. - Fix attributes being dropped or moved (ocaml-ppx/ocamlformat#2247, ocaml-ppx/ocamlformat#2459, ocaml-ppx/ocamlformat#2551, ocaml-ppx/ocamlformat#2564, ocaml-ppx/ocamlformat#2602, @EmileTrotignon, @tdelvecchio-jsc, @Julow) OCamlformat refuses to format if the formatted code has a different meaning than the original code, for example, if an attribute is removed. We also try to avoid moving attributes even if that doesn't change the original code, for example we no longer format `open[@attr] M` as `open M [@@attr]`. - Remove trailing space inside a wrapping empty signature (ocaml-ppx/ocamlformat#2443, @Julow) - Fix extension-point spacing in structures (ocaml-ppx/ocamlformat#2450, @Julow) - \* Consistent break after string constant argument (ocaml-ppx/ocamlformat#2453, @Julow) - \* Fix cinaps comment formatting to not change multiline string contents (ocaml-ppx/ocamlformat#2463, @tdelvecchio-jsc) - \* Fix the indentation of tuples in attributes and extensions (ocaml-ppx/ocamlformat#2488, @Julow) - \* Fix weird indentation and line breaks after comments (ocaml-ppx/ocamlformat#2507, ocaml-ppx/ocamlformat#2589, ocaml-ppx/ocamlformat#2606, @Julow) - \* Fix unwanted alignment in if-then-else (ocaml-ppx/ocamlformat#2511, @Julow) - Fix missing parentheses around constraint expressions with attributes (ocaml-ppx/ocamlformat#2513, @alanechang) - Fix formatting of type vars in GADT constructors (ocaml-ppx/ocamlformat#2518, @Julow) - Fix `[@ocamlformat "disable"]` in some cases (ocaml-ppx/ocamlformat#2242, ocaml-ppx/ocamlformat#2525, @EmileTrotignon) This caused a bug inside `class type` constructs and when attached to a `let ... in` - Display `a##b` instead of `a ## b` and similarly for operators that start with # (ocaml-ppx/ocamlformat#2580, @v-gb) - \* Fix arrow type indentation with `break-separators=before` (ocaml-ppx/ocamlformat#2598, @Julow) - Fix missing parentheses around a let in class expressions (ocaml-ppx/ocamlformat#2599, @Julow) - Fix formatting of paragraphs in lists in documentation (ocaml-ppx/ocamlformat#2607, @Julow) - Avoid unwanted space in references and links text in documentation (ocaml-ppx/ocamlformat#2608, @Julow) - \* Improve the indentation of attributes in patterns (ocaml-ppx/ocamlformat#2613, @Julow) - \* Avoid large indentation in patterns after `let%ext` (ocaml-ppx/ocamlformat#2615, @Julow)

@Julow

….27.0) CHANGES: ### Highlight - \* Support OCaml 5.2 syntax (ocaml-ppx/ocamlformat#2519, ocaml-ppx/ocamlformat#2544, ocaml-ppx/ocamlformat#2590, ocaml-ppx/ocamlformat#2596, ocaml-ppx/ocamlformat#2621, ocaml-ppx/ocamlformat#2628, @Julow, @EmileTrotignon, @hhugo) This includes local open in types, raw identifiers, and the new representation for functions. This might change the formatting of some functions due to the formatting code being completely rewritten. - Support OCaml 5.3 syntax (ocaml-ppx/ocamlformat#2609, ocaml-ppx/ocamlformat#2610, ocaml-ppx/ocamlformat#2611, ocaml-ppx/ocamlformat#2622, ocaml-ppx/ocamlformat#2623, ocaml-ppx/ocamlformat#2562, ocaml-ppx/ocamlformat#2624, ocaml-ppx/ocamlformat#2625, ocaml-ppx/ocamlformat#2627, @Julow, @Zeta611) This adds support for effect patterns, short functor type arguments and utf8 identifiers. To format code using the new `effect` syntax, add this option to your `.ocamlformat`: ``` ocaml-version = 5.3 ``` - Documentation comments are now formatted by default (ocaml-ppx/ocamlformat#2390, @Julow) Use the option `parse-docstrings = false` to restore the previous behavior. - \* Consistent indentation of polymorphic variant arguments (ocaml-ppx/ocamlformat#2427, @Julow) Increases the indentation by one to make the formatting consistent with normal variants. For example: ``` ... (* before *) (`Msg (foo bar)) (* after *) (`Msg (foo bar)) ``` - Build on OCaml 5.3 (ocaml-ppx/ocamlformat#2603, @adamchol, @Julow) ### Added - Improve the emacs plugin (ocaml-ppx/ocamlformat#2577, ocaml-ppx/ocamlformat#2600, @gridbugs, @thibautbenjamin) Allow a custom command to be used to run ocamlformat and add compatibility with emacs ocaml tree-sitter modes. - Added option `let-binding-deindent-fun` (ocaml-ppx/ocamlformat#2521, @henrytill) to control the indentation of the `fun` in: ``` let f = fun foo -> bar ``` - Added back the flag `--disable-outside-detected-project` (ocaml-ppx/ocamlformat#2439, @gpetiot) It was removed in version 0.22. - Support newer Odoc syntax (ocaml-ppx/ocamlformat#2631, ocaml-ppx/ocamlformat#2632, ocaml-ppx/ocamlformat#2633, @Julow) ### Changed - \* Consistent formatting of comments (ocaml-ppx/ocamlformat#2371, ocaml-ppx/ocamlformat#2550, @Julow) This is mostly an internal change but some comments might be formatted differently. - \* Improve formatting of type constraints with type variables (ocaml-ppx/ocamlformat#2437, @gpetiot) For example: ``` let f : type a b c. a -> b -> c = ... ``` - \* Improve formatting of functor arguments (ocaml-ppx/ocamlformat#2505, @Julow) This also reduce the indentation of functor arguments with long signatures. - Improvements to the Janestreet profile (ocaml-ppx/ocamlformat#2445, ocaml-ppx/ocamlformat#2314, ocaml-ppx/ocamlformat#2460, ocaml-ppx/ocamlformat#2593, ocaml-ppx/ocamlformat#2612, @Julow, @tdelvecchio-jsc) - \* Undo let-bindings and methods normalizations (ocaml-ppx/ocamlformat#2523, ocaml-ppx/ocamlformat#2529, @gpetiot) This remove the rewriting of some forms of let-bindings and methods: + `let f x = (x : int)` is no longer rewritten into `let f x : int = x` + `let f (type a) (type b) ...` is no longer rewritten into `let f (type a b) ...` + `let f = fun x -> ...` is no longer rewritten into `let f x = ...` - \* The `break-colon` option is now taken into account for method type constraints (ocaml-ppx/ocamlformat#2529, @gpetiot) - \* Force a break around comments following an infix operator (fix non-stabilizing comments) (ocaml-ppx/ocamlformat#2478, @gpetiot) This adds a line break: ``` a || (* this comment is now on its own line *) b ``` ### Fixed - Fix placement of comments in some cases (ocaml-ppx/ocamlformat#2471, ocaml-ppx/ocamlformat#2503, ocaml-ppx/ocamlformat#2506, ocaml-ppx/ocamlformat#2540, ocaml-ppx/ocamlformat#2541, ocaml-ppx/ocamlformat#2592, ocaml-ppx/ocamlformat#2617, @gpetiot, @Julow) Some comments were being moved or causing OCamlformat to crash. OCamlformat refuses to format if a comment would be missing in its output, to avoid loosing code. - Fix attributes being dropped or moved (ocaml-ppx/ocamlformat#2247, ocaml-ppx/ocamlformat#2459, ocaml-ppx/ocamlformat#2551, ocaml-ppx/ocamlformat#2564, ocaml-ppx/ocamlformat#2602, @EmileTrotignon, @tdelvecchio-jsc, @Julow) OCamlformat refuses to format if the formatted code has a different meaning than the original code, for example, if an attribute is removed. We also try to avoid moving attributes even if that doesn't change the original code, for example we no longer format `open[@attr] M` as `open M [@@attr]`. - Remove trailing space inside a wrapping empty signature (ocaml-ppx/ocamlformat#2443, @Julow) - Fix extension-point spacing in structures (ocaml-ppx/ocamlformat#2450, @Julow) - \* Consistent break after string constant argument (ocaml-ppx/ocamlformat#2453, @Julow) - \* Fix cinaps comment formatting to not change multiline string contents (ocaml-ppx/ocamlformat#2463, @tdelvecchio-jsc) - \* Fix the indentation of tuples in attributes and extensions (ocaml-ppx/ocamlformat#2488, @Julow) - \* Fix weird indentation and line breaks after comments (ocaml-ppx/ocamlformat#2507, ocaml-ppx/ocamlformat#2589, ocaml-ppx/ocamlformat#2606, @Julow) - \* Fix unwanted alignment in if-then-else (ocaml-ppx/ocamlformat#2511, @Julow) - Fix missing parentheses around constraint expressions with attributes (ocaml-ppx/ocamlformat#2513, @alanechang) - Fix formatting of type vars in GADT constructors (ocaml-ppx/ocamlformat#2518, @Julow) - Fix `[@ocamlformat "disable"]` in some cases (ocaml-ppx/ocamlformat#2242, ocaml-ppx/ocamlformat#2525, @EmileTrotignon) This caused a bug inside `class type` constructs and when attached to a `let ... in` - Display `a##b` instead of `a ## b` and similarly for operators that start with # (ocaml-ppx/ocamlformat#2580, @v-gb) - \* Fix arrow type indentation with `break-separators=before` (ocaml-ppx/ocamlformat#2598, @Julow) - Fix missing parentheses around a let in class expressions (ocaml-ppx/ocamlformat#2599, @Julow) - Fix formatting of paragraphs in lists in documentation (ocaml-ppx/ocamlformat#2607, @Julow) - Avoid unwanted space in references and links text in documentation (ocaml-ppx/ocamlformat#2608, @Julow) - \* Improve the indentation of attributes in patterns (ocaml-ppx/ocamlformat#2613, @Julow) - \* Avoid large indentation in patterns after `let%ext` (ocaml-ppx/ocamlformat#2615, @Julow)

@Julow

….27.0) CHANGES: ### Highlight - \* Support OCaml 5.2 syntax (ocaml-ppx/ocamlformat#2519, ocaml-ppx/ocamlformat#2544, ocaml-ppx/ocamlformat#2590, ocaml-ppx/ocamlformat#2596, ocaml-ppx/ocamlformat#2621, ocaml-ppx/ocamlformat#2628, @Julow, @EmileTrotignon, @hhugo) This includes local open in types, raw identifiers, and the new representation for functions. This might change the formatting of some functions due to the formatting code being completely rewritten. - Support OCaml 5.3 syntax (ocaml-ppx/ocamlformat#2609, ocaml-ppx/ocamlformat#2610, ocaml-ppx/ocamlformat#2611, ocaml-ppx/ocamlformat#2622, ocaml-ppx/ocamlformat#2623, ocaml-ppx/ocamlformat#2562, ocaml-ppx/ocamlformat#2624, ocaml-ppx/ocamlformat#2625, ocaml-ppx/ocamlformat#2627, @Julow, @Zeta611) This adds support for effect patterns, short functor type arguments and utf8 identifiers. To format code using the new `effect` syntax, add this option to your `.ocamlformat`: ``` ocaml-version = 5.3 ``` - Documentation comments are now formatted by default (ocaml-ppx/ocamlformat#2390, @Julow) Use the option `parse-docstrings = false` to restore the previous behavior. - \* Consistent indentation of polymorphic variant arguments (ocaml-ppx/ocamlformat#2427, @Julow) Increases the indentation by one to make the formatting consistent with normal variants. For example: ``` ... (* before *) (`Msg (foo bar)) (* after *) (`Msg (foo bar)) ``` - Build on OCaml 5.3 (ocaml-ppx/ocamlformat#2603, @adamchol, @Julow) ### Added - Improve the emacs plugin (ocaml-ppx/ocamlformat#2577, ocaml-ppx/ocamlformat#2600, @gridbugs, @thibautbenjamin) Allow a custom command to be used to run ocamlformat and add compatibility with emacs ocaml tree-sitter modes. - Added option `let-binding-deindent-fun` (ocaml-ppx/ocamlformat#2521, @henrytill) to control the indentation of the `fun` in: ``` let f = fun foo -> bar ``` - Added back the flag `--disable-outside-detected-project` (ocaml-ppx/ocamlformat#2439, @gpetiot) It was removed in version 0.22. - Support newer Odoc syntax (ocaml-ppx/ocamlformat#2631, ocaml-ppx/ocamlformat#2632, ocaml-ppx/ocamlformat#2633, @Julow) ### Changed - \* Consistent formatting of comments (ocaml-ppx/ocamlformat#2371, ocaml-ppx/ocamlformat#2550, @Julow) This is mostly an internal change but some comments might be formatted differently. - \* Improve formatting of type constraints with type variables (ocaml-ppx/ocamlformat#2437, @gpetiot) For example: ``` let f : type a b c. a -> b -> c = ... ``` - \* Improve formatting of functor arguments (ocaml-ppx/ocamlformat#2505, @Julow) This also reduce the indentation of functor arguments with long signatures. - Improvements to the Janestreet profile (ocaml-ppx/ocamlformat#2445, ocaml-ppx/ocamlformat#2314, ocaml-ppx/ocamlformat#2460, ocaml-ppx/ocamlformat#2593, ocaml-ppx/ocamlformat#2612, @Julow, @tdelvecchio-jsc) - \* Undo let-bindings and methods normalizations (ocaml-ppx/ocamlformat#2523, ocaml-ppx/ocamlformat#2529, @gpetiot) This remove the rewriting of some forms of let-bindings and methods: + `let f x = (x : int)` is no longer rewritten into `let f x : int = x` + `let f (type a) (type b) ...` is no longer rewritten into `let f (type a b) ...` + `let f = fun x -> ...` is no longer rewritten into `let f x = ...` - \* The `break-colon` option is now taken into account for method type constraints (ocaml-ppx/ocamlformat#2529, @gpetiot) - \* Force a break around comments following an infix operator (fix non-stabilizing comments) (ocaml-ppx/ocamlformat#2478, @gpetiot) This adds a line break: ``` a || (* this comment is now on its own line *) b ``` ### Fixed - Fix placement of comments in some cases (ocaml-ppx/ocamlformat#2471, ocaml-ppx/ocamlformat#2503, ocaml-ppx/ocamlformat#2506, ocaml-ppx/ocamlformat#2540, ocaml-ppx/ocamlformat#2541, ocaml-ppx/ocamlformat#2592, ocaml-ppx/ocamlformat#2617, @gpetiot, @Julow) Some comments were being moved or causing OCamlformat to crash. OCamlformat refuses to format if a comment would be missing in its output, to avoid loosing code. - Fix attributes being dropped or moved (ocaml-ppx/ocamlformat#2247, ocaml-ppx/ocamlformat#2459, ocaml-ppx/ocamlformat#2551, ocaml-ppx/ocamlformat#2564, ocaml-ppx/ocamlformat#2602, @EmileTrotignon, @tdelvecchio-jsc, @Julow) OCamlformat refuses to format if the formatted code has a different meaning than the original code, for example, if an attribute is removed. We also try to avoid moving attributes even if that doesn't change the original code, for example we no longer format `open[@attr] M` as `open M [@@attr]`. - Remove trailing space inside a wrapping empty signature (ocaml-ppx/ocamlformat#2443, @Julow) - Fix extension-point spacing in structures (ocaml-ppx/ocamlformat#2450, @Julow) - \* Consistent break after string constant argument (ocaml-ppx/ocamlformat#2453, @Julow) - \* Fix cinaps comment formatting to not change multiline string contents (ocaml-ppx/ocamlformat#2463, @tdelvecchio-jsc) - \* Fix the indentation of tuples in attributes and extensions (ocaml-ppx/ocamlformat#2488, @Julow) - \* Fix weird indentation and line breaks after comments (ocaml-ppx/ocamlformat#2507, ocaml-ppx/ocamlformat#2589, ocaml-ppx/ocamlformat#2606, @Julow) - \* Fix unwanted alignment in if-then-else (ocaml-ppx/ocamlformat#2511, @Julow) - Fix missing parentheses around constraint expressions with attributes (ocaml-ppx/ocamlformat#2513, @alanechang) - Fix formatting of type vars in GADT constructors (ocaml-ppx/ocamlformat#2518, @Julow) - Fix `[@ocamlformat "disable"]` in some cases (ocaml-ppx/ocamlformat#2242, ocaml-ppx/ocamlformat#2525, @EmileTrotignon) This caused a bug inside `class type` constructs and when attached to a `let ... in` - Display `a##b` instead of `a ## b` and similarly for operators that start with # (ocaml-ppx/ocamlformat#2580, @v-gb) - \* Fix arrow type indentation with `break-separators=before` (ocaml-ppx/ocamlformat#2598, @Julow) - Fix missing parentheses around a let in class expressions (ocaml-ppx/ocamlformat#2599, @Julow) - Fix formatting of paragraphs in lists in documentation (ocaml-ppx/ocamlformat#2607, @Julow) - Avoid unwanted space in references and links text in documentation (ocaml-ppx/ocamlformat#2608, @Julow) - \* Improve the indentation of attributes in patterns (ocaml-ppx/ocamlformat#2613, @Julow) - \* Avoid large indentation in patterns after `let%ext` (ocaml-ppx/ocamlformat#2615, @Julow)

@Julow

….27.0) CHANGES: ### Highlight - \* Support OCaml 5.2 syntax (ocaml-ppx/ocamlformat#2519, ocaml-ppx/ocamlformat#2544, ocaml-ppx/ocamlformat#2590, ocaml-ppx/ocamlformat#2596, ocaml-ppx/ocamlformat#2621, ocaml-ppx/ocamlformat#2628, @Julow, @EmileTrotignon, @hhugo) This includes local open in types, raw identifiers, and the new representation for functions. This might change the formatting of some functions due to the formatting code being completely rewritten. - Support OCaml 5.3 syntax (ocaml-ppx/ocamlformat#2609, ocaml-ppx/ocamlformat#2610, ocaml-ppx/ocamlformat#2611, ocaml-ppx/ocamlformat#2622, ocaml-ppx/ocamlformat#2623, ocaml-ppx/ocamlformat#2562, ocaml-ppx/ocamlformat#2624, ocaml-ppx/ocamlformat#2625, ocaml-ppx/ocamlformat#2627, @Julow, @Zeta611) This adds support for effect patterns, short functor type arguments and utf8 identifiers. To format code using the new `effect` syntax, add this option to your `.ocamlformat`: ``` ocaml-version = 5.3 ``` - Documentation comments are now formatted by default (ocaml-ppx/ocamlformat#2390, @Julow) Use the option `parse-docstrings = false` to restore the previous behavior. - \* Consistent indentation of polymorphic variant arguments (ocaml-ppx/ocamlformat#2427, @Julow) Increases the indentation by one to make the formatting consistent with normal variants. For example: ``` ... (* before *) (`Msg (foo bar)) (* after *) (`Msg (foo bar)) ``` - Build on OCaml 5.3 (ocaml-ppx/ocamlformat#2603, @adamchol, @Julow) ### Added - Improve the emacs plugin (ocaml-ppx/ocamlformat#2577, ocaml-ppx/ocamlformat#2600, @gridbugs, @thibautbenjamin) Allow a custom command to be used to run ocamlformat and add compatibility with emacs ocaml tree-sitter modes. - Added option `let-binding-deindent-fun` (ocaml-ppx/ocamlformat#2521, @henrytill) to control the indentation of the `fun` in: ``` let f = fun foo -> bar ``` - Added back the flag `--disable-outside-detected-project` (ocaml-ppx/ocamlformat#2439, @gpetiot) It was removed in version 0.22. - Support newer Odoc syntax (ocaml-ppx/ocamlformat#2631, ocaml-ppx/ocamlformat#2632, ocaml-ppx/ocamlformat#2633, @Julow) ### Changed - \* Consistent formatting of comments (ocaml-ppx/ocamlformat#2371, ocaml-ppx/ocamlformat#2550, @Julow) This is mostly an internal change but some comments might be formatted differently. - \* Improve formatting of type constraints with type variables (ocaml-ppx/ocamlformat#2437, @gpetiot) For example: ``` let f : type a b c. a -> b -> c = ... ``` - \* Improve formatting of functor arguments (ocaml-ppx/ocamlformat#2505, @Julow) This also reduce the indentation of functor arguments with long signatures. - Improvements to the Janestreet profile (ocaml-ppx/ocamlformat#2445, ocaml-ppx/ocamlformat#2314, ocaml-ppx/ocamlformat#2460, ocaml-ppx/ocamlformat#2593, ocaml-ppx/ocamlformat#2612, @Julow, @tdelvecchio-jsc) - \* Undo let-bindings and methods normalizations (ocaml-ppx/ocamlformat#2523, ocaml-ppx/ocamlformat#2529, @gpetiot) This remove the rewriting of some forms of let-bindings and methods: + `let f x = (x : int)` is no longer rewritten into `let f x : int = x` + `let f (type a) (type b) ...` is no longer rewritten into `let f (type a b) ...` + `let f = fun x -> ...` is no longer rewritten into `let f x = ...` - \* The `break-colon` option is now taken into account for method type constraints (ocaml-ppx/ocamlformat#2529, @gpetiot) - \* Force a break around comments following an infix operator (fix non-stabilizing comments) (ocaml-ppx/ocamlformat#2478, @gpetiot) This adds a line break: ``` a || (* this comment is now on its own line *) b ``` ### Fixed - Fix placement of comments in some cases (ocaml-ppx/ocamlformat#2471, ocaml-ppx/ocamlformat#2503, ocaml-ppx/ocamlformat#2506, ocaml-ppx/ocamlformat#2540, ocaml-ppx/ocamlformat#2541, ocaml-ppx/ocamlformat#2592, ocaml-ppx/ocamlformat#2617, @gpetiot, @Julow) Some comments were being moved or causing OCamlformat to crash. OCamlformat refuses to format if a comment would be missing in its output, to avoid loosing code. - Fix attributes being dropped or moved (ocaml-ppx/ocamlformat#2247, ocaml-ppx/ocamlformat#2459, ocaml-ppx/ocamlformat#2551, ocaml-ppx/ocamlformat#2564, ocaml-ppx/ocamlformat#2602, @EmileTrotignon, @tdelvecchio-jsc, @Julow) OCamlformat refuses to format if the formatted code has a different meaning than the original code, for example, if an attribute is removed. We also try to avoid moving attributes even if that doesn't change the original code, for example we no longer format `open[@attr] M` as `open M [@@attr]`. - Remove trailing space inside a wrapping empty signature (ocaml-ppx/ocamlformat#2443, @Julow) - Fix extension-point spacing in structures (ocaml-ppx/ocamlformat#2450, @Julow) - \* Consistent break after string constant argument (ocaml-ppx/ocamlformat#2453, @Julow) - \* Fix cinaps comment formatting to not change multiline string contents (ocaml-ppx/ocamlformat#2463, @tdelvecchio-jsc) - \* Fix the indentation of tuples in attributes and extensions (ocaml-ppx/ocamlformat#2488, @Julow) - \* Fix weird indentation and line breaks after comments (ocaml-ppx/ocamlformat#2507, ocaml-ppx/ocamlformat#2589, ocaml-ppx/ocamlformat#2606, @Julow) - \* Fix unwanted alignment in if-then-else (ocaml-ppx/ocamlformat#2511, @Julow) - Fix missing parentheses around constraint expressions with attributes (ocaml-ppx/ocamlformat#2513, @alanechang) - Fix formatting of type vars in GADT constructors (ocaml-ppx/ocamlformat#2518, @Julow) - Fix `[@ocamlformat "disable"]` in some cases (ocaml-ppx/ocamlformat#2242, ocaml-ppx/ocamlformat#2525, @EmileTrotignon) This caused a bug inside `class type` constructs and when attached to a `let ... in` - Display `a##b` instead of `a ## b` and similarly for operators that start with # (ocaml-ppx/ocamlformat#2580, @v-gb) - \* Fix arrow type indentation with `break-separators=before` (ocaml-ppx/ocamlformat#2598, @Julow) - Fix missing parentheses around a let in class expressions (ocaml-ppx/ocamlformat#2599, @Julow) - Fix formatting of paragraphs in lists in documentation (ocaml-ppx/ocamlformat#2607, @Julow) - Avoid unwanted space in references and links text in documentation (ocaml-ppx/ocamlformat#2608, @Julow) - \* Improve the indentation of attributes in patterns (ocaml-ppx/ocamlformat#2613, @Julow) - \* Avoid large indentation in patterns after `let%ext` (ocaml-ppx/ocamlformat#2615, @Julow)

tdelvecchio-jsc marked this pull request as ready for review October 6, 2023 16:52

tdelvecchio-jsc force-pushed the fix-cinaps-multiline-string-bug branch from c96715a to 984067d Compare October 6, 2023 16:54

Fix cinaps comment formatting to not change multiline string contents.

2feaab1

tdelvecchio-jsc force-pushed the fix-cinaps-multiline-string-bug branch from 984067d to 2feaab1 Compare October 6, 2023 17:06

gpetiot added 3 commits October 10, 2023 13:52

simplify

1e3be04

changelog

c62f4eb

Merge branch 'main' into fix-cinaps-multiline-string-bug

5853b9b

gpetiot approved these changes Oct 10, 2023

View reviewed changes

Julow approved these changes Oct 10, 2023

View reviewed changes

Julow merged commit 12efce8 into ocaml-ppx:main Oct 10, 2023

Julow mentioned this pull request Nov 29, 2024

[new release] ocamlformat-lib, ocamlformat and ocamlformat-rpc-lib (0.27.0) ocaml/opam-repository#26998

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix cinaps comment formatting to not change multiline string contents. #2463

Fix cinaps comment formatting to not change multiline string contents. #2463

tdelvecchio-jsc commented Oct 6, 2023 •

edited

Loading

gpetiot left a comment

Julow left a comment

Julow Oct 10, 2023

gpetiot Oct 10, 2023

Julow Oct 10, 2023

Julow Oct 10, 2023

Julow Oct 10, 2023

tdelvecchio-jsc Oct 10, 2023

Julow Oct 10, 2023

Fix cinaps comment formatting to not change multiline string contents. #2463

Fix cinaps comment formatting to not change multiline string contents. #2463

Conversation

tdelvecchio-jsc commented Oct 6, 2023 • edited Loading

gpetiot left a comment

Choose a reason for hiding this comment

Julow left a comment

Choose a reason for hiding this comment

Julow Oct 10, 2023

Choose a reason for hiding this comment

gpetiot Oct 10, 2023

Choose a reason for hiding this comment

Julow Oct 10, 2023

Choose a reason for hiding this comment

Julow Oct 10, 2023

Choose a reason for hiding this comment

Julow Oct 10, 2023

Choose a reason for hiding this comment

tdelvecchio-jsc Oct 10, 2023

Choose a reason for hiding this comment

Julow Oct 10, 2023

Choose a reason for hiding this comment

tdelvecchio-jsc commented Oct 6, 2023 •

edited

Loading