# README

go-diff

Library for generating Git-style diff patchsets in Go.

Built to be used in the pure-Go implementation of the Git backend for sourcegraph's go-vcs.

Status: Prototyping. None of the backends produce complete output yet, but the difflib one is closest and least broken.

Git-style patch headers for each file (are there other styles to support?).
Bring your own diff algorithm by implementing the Differ interface.
Includes a few diffing backends:
- pmezard/go-difflib (default)
- sergi/go-diff/diffmatchpatch (offsets produced are inconsistent with git diff)
- mb0/diff (incomplete backend)

MIT.

This package implements the diff.Differ interface using github.com/mb0/diff as a backend.

This package implements the diff.Differ interface using diffmatchpatch as a backend.

This package implements the diff.Differ interface using github.com/mb0/diff as a backend.

DefaultDiffer returns a diffmatchpatch-based differ.

EmptyObject can be used when there is no corresponding src or dst entry, such as during deletions or creations.

ErrEmptyComparison is used when both src and dst are EmptyObjects.

Object is the minimum representation for generating diffs with git-style headers.

Writer writes diffs using a given Differ including git-style headers between each patch.

Differ supplies a stream-based diffing algorithm implementation.