Skip to content

Remove ocamlformat-diff#1205

Merged
gpetiot merged 2 commits intoocaml-ppx:masterfrom
gpetiot:remove-ocamlformat-diff
Jan 14, 2020
Merged

Remove ocamlformat-diff#1205
gpetiot merged 2 commits intoocaml-ppx:masterfrom
gpetiot:remove-ocamlformat-diff

Conversation

@gpetiot
Copy link
Copy Markdown
Collaborator

@gpetiot gpetiot commented Jan 13, 2020

Next step is adding a documentation for merge-fmt.

@gpetiot gpetiot requested a review from Julow January 13, 2020 15:22
@gpetiot gpetiot changed the title Remove unreleased ocamlformat-diff tool Remove ocamlformat-diff Jan 13, 2020
Copy link
Copy Markdown
Collaborator

@Julow Julow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove it !

@gpetiot gpetiot merged commit c737684 into ocaml-ppx:master Jan 14, 2020
@gpetiot gpetiot deleted the remove-ocamlformat-diff branch January 14, 2020 09:57
Julow added a commit to Julow/opam-repository that referenced this pull request Jan 28, 2020
CHANGES:

#### New features

  + Add an option `--margin-check` to emit a warning if the formatted output exceeds the margin (ocaml-ppx/ocamlformat#1110) (Guillaume Petiot)
  + Preserve comment indentation when `wrap-comments` is unset (ocaml-ppx/ocamlformat#1138, ocaml-ppx/ocamlformat#1159) (Jules Aguillon)
  + Improve error messages (ocaml-ppx/ocamlformat#1147) (Jules Aguillon)
  + Display standard output in the emacs plugin even when ocamlformat does not fail (ocaml-ppx/ocamlformat#1189) (Guillaume Petiot)

#### Removed

  + Remove `ocamlformat_reason` (ocaml-ppx/ocamlformat#254, ocaml-ppx/ocamlformat#1185) (Etienne Millon).
    This tool has never been released to opam, has no known users, and overlaps
    with what `refmt` can do.
  + Remove `ocamlformat-diff` (ocaml-ppx/ocamlformat#1205) (Guillaume Petiot)
    This tool has never been released to opam, has no known users, and overlaps
    with what `merge-fmt` can do.

#### Packaging

  + Work with base v0.13.0 (ocaml-ppx/ocamlformat#1163) (Jules Aguillon)

#### Bug fixes

  + Fix placement of comments just before a '|' (ocaml-ppx/ocamlformat#1203) (Jules Aguillon)
  + Fix build version detection when building in the absence of a git root (ocaml-ppx/ocamlformat#1198) (Anil Madhavapeddy)
  + Fix wrapping of or-patterns in presence of comments with `break-cases=fit` (ocaml-ppx/ocamlformat#1167) (Jules Aguillon)
    This also fixes an unstable comment bug in or-patterns
  + Fix an unstable comment bug in variant declarations (ocaml-ppx/ocamlformat#1108) (Jules Aguillon)
  + Fix: break multiline comments (ocaml-ppx/ocamlformat#1122) (Guillaume Petiot)
  + Fix: types on named arguments were wrapped incorrectly when preceding comments (ocaml-ppx/ocamlformat#1124) (Guillaume Petiot)
  + Fix the indentation produced by max-indent (ocaml-ppx/ocamlformat#1118) (Guillaume Petiot)
  + Fix break after Psig_include depending on presence of docstring (ocaml-ppx/ocamlformat#1125) (Guillaume Petiot)
  + Remove some calls to if_newline and break_unless_newline and fix break before closing brackets (ocaml-ppx/ocamlformat#1168) (Guillaume Petiot)
  + Fix unstable cmt in or-pattern (ocaml-ppx/ocamlformat#1173) (Guillaume Petiot)
  + Fix location of comment attached to the underscore of an open record (ocaml-ppx/ocamlformat#1208) (Guillaume Petiot)
  + Fix parentheses around optional module parameter (ocaml-ppx/ocamlformat#1212) (Christian Barcenas)
  + Fix grouping of horizontally aligned comments (ocaml-ppx/ocamlformat#1209) (Guillaume Petiot)
  + Fix dropped comments around module pack expressions (ocaml-ppx/ocamlformat#1214) (Jules Aguillon)
  + Fix regression of comment position in list patterns (ocaml-ppx/ocamlformat#1141) (Josh Berdine)
  + Fix: adjust definition of Location.is_single_line to reflect margin (ocaml-ppx/ocamlformat#1102) (Josh Berdine)

#### Documentation

  + Fix documentation of option `version-check` (ocaml-ppx/ocamlformat#1135) (Wilfred Hughes)
  + Fix hint when using `break-separators=after-and-docked` (ocaml-ppx/ocamlformat#1130) (Greta Yorsh)
@JasonGross
Copy link
Copy Markdown

JasonGross commented Mar 25, 2020

I don't see a way to use merge-fmt as a difftool for git (so that git diff is only up to ocamlformat). Is there a way to do this? Or a chance of getting ocamlformat-diff back into ocamlformat?

@Julow
Copy link
Copy Markdown
Collaborator

Julow commented Mar 26, 2020

merge-fmt cannot be used as a difftool, indeed.
I thought we could use diff.*.textconv for that:

  • .gitconfig

    [diff "ocamlformat"]
      textconv = ocamlformat --name "./$1"
    
  • .gitattributes

    *.ml diff=ocamlformat
    *.mli diff=ocamlformat
    

But that's not working correctly. The --name "./$1" part is needed so OCamlformat can find its config file and also decide between parsing .ml or .mli files, this is concatenating ./ with /tmp/.... It seems that Git doesn't give the path in the repository to textconv programs, so this won't work with nested .ocamlformat files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants