Wishlist for the 1.0 release

[gpetiot]

Default profile

• make the conventional profile the default profile (currently it is the ocamlformat profile) (Improve: set conventional as the default profile #1060)
• currently no profile is selected by default, it would contradict the default values of options, instead we need to specify whether an option-value belongs to a profile (wrong)

Sanitize options

• reduce the number of options
  • break-string-literals=newlines-and-wrap should be the default (Improve: remove option break-string-literals #932, Improve: auto mode for break-string-literals instead of {wrap,newlines,newlines-and-wrap} #1057)
• reduce the number of values for options
• organize the options better (group them together by purpose: ocp-indent, indentation, readability, etc.)
• make the options discoverable in the terminal when hitting <TAB> (not done for major ocaml tools, and ocamlformat is mainly used with .ocamlformat files anyway)

OCaml ecosystem

• dunify the tests (Improve: dunify testsuite #881)
• dunify the release process
• use odoc instead of octavius (Improve: parse doc comments with Odoc #721)
• do not fail on incorrect files (use error-resilient parser from merlin) (Do not fail on incorrect files #906)

Other improvements

• improve the dock-collection-brackets for bindings and pattern-matching (Improve: extend option sequence-blank-line to let-bindings #1056)
• improve the formatting of pattern-matchings (option break-cases should be split into smaller options) (break-cases=all less consistent in version 0.10 #914)
• improve the comment placement algorithm

[vphantom]

(Redacted: it turns out that 0.11 changed break-separators = after-and-docked which now puts opening and closing on separate lines, minimizing editing and diffs. I hadn't seen that 0.11 was released when I wrote my initial comment.)

[gpetiot]

Ocamlformat 0.11 has only been released this morning, I didn't have time to publish an official announcement yet.

[Wilfred]

I've left feedback on #932 regarding removal of options: I'm not sure if you just want to change the default or remove the option entirely.

[gpetiot]

I've left feedback on #932 regarding removal of options: I'm not sure if you just want to change the default or remove the option entirely.

I submitted #1057 to address this.

[rbjorklin]

I'm all for reducing the number of options but do want to leave my 2 cents before things get cemented. I'm not sure what's the right way of leaving feedback so I'm leaving a note here.

In a professional setting where one or more people review your code I've found it very helpful to have a more vertical style as it helps a lot with making it easier to spot the relevant part of a changed line during review.

I'm currently using this as my starting point:

break-cases = fit-or-vertical
break-infix = fit-or-vertical
break-fun-decl = fit-or-vertical
type-decl = sparse

[gpetiot]

The roadmap is being rewritten, instead of having this meta-issue I will open issues with the remaining points for the 1.0 release and add them to the 1.0 milestone.
I'm closing this one.