package patdiff

  1. Overview
  2. Docs
File Diff using the Patience Diff algorithm

Install

Dune Dependency

Authors

Maintainers

Sources

patdiff-v0.16.0.tar.gz
sha256=60661ffca35e4726c40c42901774976f2634ac6a4f993a5a13f2fa458571cf16

Description

Published: 14 Jun 2023

README

Patdiff - colored patience diffs with word-level refinement

Patdiff is an OCaml implementation of Bram Cohen's patience diff algorithm, with a few extra conveniences for comparing code and config files:

outputs plain ASCII, ANSI color codes, or HTML

optional semantic diffing of numbers

good word-level diffing out of the box

And of course all the usual features:

  • recursive diffing of directories

  • extensively configurable output (markers, colors, location format, context)

  • whitespace-aware diffing

Installation

opam install patdiff

See here for Patdiff's opam package file.

Compiling from source

To build patdiff for local development, install its dependencies:

git clone https://github.com/janestreet/patdiff
cd patdiff
opam install --deps-only .

To compile, and optionally install, patdiff:

make
make install

Usage

patdiff old-file new-file

If you don't supply any arguments to patdiff, it will read diff-like text from stdin and color it in the normal patdiff way.

The file ~/.patdiff is used as a config file if it exists. You can write a sample config with the -make-config flag.

patdiff-git-wrapper

A simple wrapper is provided for using patdiff as git's "external diff" tool. You can enable it with:

export GIT_EXTERNAL_DIFF=$(command -v patdiff-git-wrapper)

or

git config --global diff.external $(command -v patdiff-git-wrapper)

Documentation

More docs, including detailed API docs, are available here.

Dependencies (10)

  1. re >= "1.8.0"
  2. pcre
  3. dune >= "2.0.0"
  4. ppx_jane >= "v0.16" & < "v0.17"
  5. patience_diff >= "v0.16" & < "v0.17"
  6. expect_test_helpers_core >= "v0.16" & < "v0.17"
  7. core_unix >= "v0.16" & < "v0.17"
  8. core_kernel >= "v0.16" & < "v0.17"
  9. core >= "v0.16" & < "v0.17"
  10. ocaml >= "4.14.0"

Dev Dependencies

None

Used by (3)

  1. bonsai = "v0.16.0"
  2. neural_nets_lib >= "0.4.0"
  3. osnap < "0.3.0"

Conflicts

None

OCaml

Innovation. Community. Security.