diff

package

v0.0.6 Latest Latest Go to latest Published: Jun 13, 2026 License: MIT Imports: 8 Imported by: 1

Details

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

Repository

github.com/nikhilsbhat/common

Links

Open Source Insights

Documentation ¶

Overview ¶

Package diff provides helpers to compare JSON and YAML data.

Index ¶

type Config
- func NewDiff(format string, noColor bool, log *logrus.Logger) *Config
- func (cfg *Config) Diff(oldData, newData string) (bool, string, error)
- func (cfg *Config) String(input any) (string, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	NoColor      bool   `json:"no_color,omitempty" yaml:"no_color,omitempty"`
	Format       string `json:"format,omitempty" yaml:"format,omitempty"`
	ContextLines int    `json:"context_lines,omitempty" yaml:"context_lines,omitempty"`
	// contains filtered or unexported fields
}

Config holds necessary information of diff.

func NewDiff ¶

func NewDiff(format string, noColor bool, log *logrus.Logger) *Config

NewDiff returns a new instance of Config.

func (*Config) Diff ¶

func (cfg *Config) Diff(oldData, newData string) (bool, string, error)

Diff identifies the discrepancies between two provided objects, which can be in formats such as YAML or JSON.

func (*Config) String ¶

func (cfg *Config) String(input any) (string, error)

String returns the string representation of the DataStructure in the specified format.

Source Files ¶

View all Source files

diff.go

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