config

package

v1.0.0-beta.4 Latest Latest Go to latest Published: Nov 4, 2025 License: Apache-2.0 Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/znkr/diff

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config provides shared configuration mechanisms for packages this module.

This package is an implementation detail, the configuration surface for users is provided via diff.Option.

Index ¶

Variables
type ColorConfig
type Config
- func FromOptions(opts []Option, allowed Flag) Config
type Flag
type Mode
type Option

Constants ¶

This section is empty.

Variables ¶

View Source

var Default = Config{
	Context:                 3,
	Mode:                    ModeDefault,
	IndentHeuristic:         false,
	ForceAnchoringHeuristic: false,
}

Default is the default configuration.

Functions ¶

This section is empty.

Types ¶

type ColorConfig ¶

type ColorConfig struct {
	Reset                 string
	HunkHeader            string
	Match, Delete, Insert string
}

type Config ¶

type Config struct {
	// Context is the number of matches to include as a prefix and postfix for hunks returned.
	Context int

	// Diff algorithm mode.
	Mode Mode

	// If set, textdiff will apply ident heuristics.
	IndentHeuristic bool

	// If not nil, textdiff.Unify will use this to color the output.
	Colors *ColorConfig

	// If set, internal/myers will always use the anchoring heuristic. This configuration is not
	// exposed via an option API, it's main use is for testing.
	ForceAnchoringHeuristic bool
}

Config collects all configurable parameters for comparison functions in this module.

func FromOptions ¶

func FromOptions(opts []Option, allowed Flag) Config

FromOptions creates a configuration from a set of options.

type Flag ¶

type Flag int

Flag describes a single config entry. This is used to detect if configurations are being set that are not

const (
	Context Flag = 1 << iota
	Minimal
	Fast
	IndentHeuristic
	TerminalColors
)

type Mode ¶

type Mode int

Mode describes the mode of the diff algorithm.

const (
	// Limit the cost for large inputs with many differences by applying heuristics that reduce the
	// time complexity at the cost of non-minimal diffs.
	ModeDefault Mode = iota

	// Find a minimal diff irrespective of the cost.
	ModeMinimal

	// Find a diff as fast as possible.
	ModeFast
)

type Option ¶

type Option func(*Config) Flag

Option is the mechanism used to expose the configuration to users.

Source Files ¶

View all Source files

config.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL