README
¶
This is a copy of the Go text diffing packages that the official Go language server gopls uses internally to generate unified diffs. https://pkg.go.dev/golang.org/x/tools/internal/lsp/diff
Documentation
¶
Overview ¶
Package diff computes differences between text files or strings.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Apply ¶
Apply applies a sequence of edits to the src buffer and returns the result. Edits are applied in order of start offset; edits with the same start offset are applied in they order they were provided.
Apply returns an error if any edit is out of bounds, or if any pair of edits is overlapping.
func ApplyBytes ¶
ApplyBytes is like Apply, but it accepts a byte slice. The result is always a new array.
func SortEdits ¶
func SortEdits(edits []Edit)
SortEdits orders a slice of Edits by (start, end) offset. This ordering puts insertions (end = start) before deletions (end > start) at the same point, but uses a stable sort to preserve the order of multiple insertions at the same point. (Apply detects multiple deletions at the same point as an error.)
Types ¶
type Diffs ¶
type Diffs struct {
// From is the name of the original file.
From string
// To is the name of the modified file.
To string
// Hunks is the set of edit hunks needed to transform the file content.
Hunks []*hunk
}
Diffs represents a set of edits as a unified diff.
func ToUnified ¶
ToUnified applies the edits to content and returns a unified diff. The old and new labels are the names of the content and result files. It returns an error if the edits are inconsistent; see ApplyEdits.
type Edit ¶
type Edit struct {
Start, End int // byte offsets of the region to replace
New string // the replacement
}
An Edit describes the replacement of a portion of a text file.
func Bytes ¶
Bytes computes the differences between two byte slices. The resulting edits respect rune boundaries.
type OpKind ¶
type OpKind int
OpKind is used to denote the type of operation a line represents. TODO(adonovan): hide this once the myers package no longer references it.
const ( // Delete is the operation kind for a line that is present in the input // but not in the output. Delete OpKind = iota // Insert is the operation kind for a line that is new in the output. Insert // Equal is the operation kind for a line that is the same in the input and // output, often used to provide context around edited lines. Equal )
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package difftest supplies a set of tests that will operate on any implementation of a diff algorithm as exposed by "golang.org/x/tools/internal/diff"
|
Package difftest supplies a set of tests that will operate on any implementation of a diff algorithm as exposed by "golang.org/x/tools/internal/diff" |
|
package lcs contains code to find longest-common-subsequences (and diffs)
|
package lcs contains code to find longest-common-subsequences (and diffs) |
|
Package myers implements the Myers diff algorithm.
|
Package myers implements the Myers diff algorithm. |