package merge-fmt

All checked builds pass
  1. Overview
  2. Docs
Git mergetool leveraging code formatters

Install

dune-project
 Dependency

Authors

Maintainers

Sources

merge-fmt-0.4.tbz
sha256=48f104bf49166e055a6221d8875107e3b3de60a9a1f7bed96363830a99a3ac58
sha512=cfd5bca5bd0813085e0cd4443907086079f4d5c165b582ea0cc88adbf60a8f3237b31a72141f3c72d557f7215af6b5cba9b9f04298e62a76b56936432c975106

Description

merge-fmt is a small wrapper on top git commands to help resolve conflicts by leveraging code formatters.

Added to opam-repository:

README

Merge-fmt - git mergetool leveraging code formatters

WARNING: This tool is still experimental.

merge-fmt is a small wrapper on top git commands to help resolve conflicts by leveraging code formatters.

merge-fmt currently only knows about the following formatters:

Note that supporting new code formatters is trivial.

Getting started

There are three ways to use merge-fmt.

Standalone

Just call merge-fmt while there are unresolved conflicts. merge-fmt will try resolve conflicts automatically.

As a Git mergetool

merge-fmt can act as a git mergetool. First configure the current git repository with

merge-fmt setup-mergetool
git config --local mergetool.mergefmt.cmd 'merge-fmt mergetool --base=$BASE --current=$LOCAL --other=$REMOTE -o $MERGED'
git config --local mergetool.mergefmt.trustExitCode true

Then, use git mergetool to resolve conflicts with git mergetool -t mergefmt

As a git merge driver

merge-fmt can act as a git merge driver. Configure the current git repository to use merge-fmt as the default merge driver.

$ merge-fmt setup-merge
git config --local merge.mergefmt.name 'merge-fmt driver'
git config --local merge.mergefmt.driver 'merge-fmt mergetool --base=%O --current=%A --other=%B -o %A --name=%P'
git config --local merge.tool 'mergefmt'
git config --local merge.default 'mergefmt'

Install

$ opam pin add merge-fmt git@github.com:hhugo/merge-fmt.git

Dependencies (5)

  1. stdio
  2. base
  3. cmdliner >= "1.1.0"
  4. ocaml >= "4.8"
  5. dune >= "3.0"

Dev Dependencies (4)

  1. odoc with-doc
  2. ocamlformat = "0.27.0" & with-test
  3. core_unix with-test
  4. ppx_expect with-test

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building merge-fmt with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.4 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure