core

type Comparison map[string]interface{}

type ComparisonOptions struct {
	FileType       FileType                 // the type of the files we're comparing
	IdParamsString string                   // a JSON representation of a IdentificationParameter parameter; can be the path to an existing JSON file
	IdParams       *IdentificationParameter // the properties (values of the map) serving as unique IDs for given paths (keys of the map)
	Check          bool                     // if true, then the ID params are output to allow for some checks
	Fast           bool                     // if true, then, in an array, an object's index is used as its IDProp, if none is specified for its path in the data tree; i.e. the IDProp `#index` is used, instead of nothing
	Silent         bool                     // if true, then no info / warning message is written out
	StopAtFirst    bool                     // if true, then, when comparing folders, we stop at the first couple of files that differ
	Logger         Logger                   // a logger
	IgnoredString  string                   // the files to ignore, separated by a comma
	Ignored        map[string]bool          // the ignored files
	AllowRaw       bool                     // if true, then it's allowed to display the raw JSON entities as difference, when added or removed; else, a display template is required
	IsXml          bool                     // if true, then the compared files are XML files
	NParallel      int                      // the number of routines used at the same time when comparing several files at once (i.e. comparing folders)
}

type ConditionalIDParameter struct {
	Prop string `json:"prop,omitempty"`
	Is   string `json:"is,omitempty"`
	IdentificationParameter
}

type FileType string

type IdentificationParameter struct {
	At       string                              `json:"at,omitempty"`   // the relative path at which to use this identification parameter
	Use      []string                            `json:"_use,omitempty"` // which simple properties to concatenate to form a key
	Tpl1     []string                            `json:"tpl1,omitempty"` // a formattable string (Go template) to build an alias for an object, instead of outputting it completely in the comparison
	TplN     []string                            `json:"tplN,omitempty"` // a formattable string (Go template) to build an alias for an object, instead of outputting it completely in the comparison
	Incr     bool                                `json:"incr,omitempty"` // if true, then any key built with this ID param is augmented with a counter of its occurrences
	When     []*ConditionalIDParameter           `json:"when,omitempty"` // when to apply this identification parameter, and what to do (_use, look, or when ?)
	Look     []*IdentificationParameter          `json:"look,omitempty"` // which relationships to look into
	For      map[string]*IdentificationParameter `json:"_for,omitempty"` // how to deal with the embedded objects from this place
	Name     string                              `json:"name,omitempty"` // a name for this ID parameter, that may be used as a prefix for the keys built here
	FullPath string                              `json:"path,omitempty"` // the relative path at which to use this identification parameter
	Keep     bool                                `json:"keep,omitempty"` // if true, then, when comparing slice elements with this ID param, we're not clearing the identical elements before comparing the diverging ones
	// contains filtered or unexported fields
}

type JsonEntity struct {
	// contains filtered or unexported fields
}

type Logger interface {
	Info(str string, params ...interface{})
	Debug(str string, params ...interface{})
	Warn(str string, args ...interface{})
}