Refactor handling of comments #2371
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Define and centralize how comments are interpreted. The new function is also used by normalization, which had inconsistent rules before.
A few regressions
This fixes two instances of unstable formatting but might be a regression when `wrap-comments=false`.
This reverts commit 70e5752b06fdef97e3c729d3bbfed14888ece62a.
The indentation of doc comments is significative for verbatim blocks. The decision of parsing a regular comment as doc must be done before decoding a comment. Regressions are due to test cases previously crashing finally being run.
This reverts commit f5cce1a. No longer the case.
This break was removed in previous commits
Julow
commented
Jun 6, 2023
Allow indented lines with no asterisks and trailing newline in asterisk prefixed comments. A trailing newline results in the star of the closing token to be aligned with the asterisks.
|
Closes #2468 |
|
I had another quick look at this, do I understand correctly that in the current state of this PR there are still a number of regressions where lines are now wrapped before they reach the margin, and a number of regressions where the margin is now exceeded? The plan is to resolve these before merging this, right? |
|
I'm still investigating this issue but I'm now considering merging without it fixed. The issue seems rare and I'm clueless on how to fix it. |
Remove the forced line break before a multi-line comment. The asymmetry of this forced line break allowed comments to be move back and forth between being attached to after `f` or before `a`. This adds regressions.
Consecutive comments with no empty line in between are not formatted.
gpetiot
approved these changes
Nov 8, 2023
|
The unexplained break regression is fixed and the new cases where the margin is exceeded is due to asterisk prefixed comments that do not wrap. This is ready to be merged! |
Julow
added a commit
to Julow/opam-repository
that referenced
this pull request
Nov 29, 2024
….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
added a commit
to Julow/opam-repository
that referenced
this pull request
Nov 29, 2024
….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
added a commit
to Julow/opam-repository
that referenced
this pull request
Dec 2, 2024
….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
added a commit
to Julow/opam-repository
that referenced
this pull request
Dec 2, 2024
….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)
This was referenced Jan 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This rewrite part of the code that parses and formats comments to remove repeated or inconsistent code.
One function interprets comments:
Cmt.decode. It returns a richer type that allow to implement formatting as it was before.The normalization is changed to use that, no more
is_docstringand normalization of indentation is now consistent. This fixes normalization problem for comments parsed as doc and cinaps comments.