filediff

package

v0.0.2 Latest Latest Go to latest Published: Oct 17, 2023 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Diff struct {
	Old string
	New string
}

Diff represents the diff between two files.

func (diff Diff) Pretty(w io.Writer)

Pretty will print the diff.

type Files map[string]string

func ReadFiles(root string) (Files, error)

ReadFiles reads all files under the specified directory.

func (files Files) Save() error

Save saves the outputs to the specified directory.

type Result struct {
	Created   []string
	Deleted   []string
	Unchanged []string
	Diffs     map[string]Diff
}

Result represents the diff result.

func FileDiff(sources Files, targets Files) (*Result, error)

FileDiff compare the actual outputs with the snapshot.

func (r Result) HasChanged() bool

HasChanged returns true if the result has any changes.

func (r Result) Pretty(w io.Writer)

Pretty will print the diff result.