report

type AdditiveChanges struct {
	Changes
	// Added contains additional content that was added
	Added *delta.Content `json:"added,omitempty"`
}

type BreakingChanges struct {
	Changes
	Removed *delta.Content `json:"removed,omitempty"`
}

type Changes struct {
	// Consts contains changes to constant definitions
	Consts map[string]delta.Signature `json:"consts,omitempty"`
	// TypeAliases contains changes to type alias definitions
	TypeAliases map[string]delta.Signature `json:"typeAliases,omitempty"`
	// Funcs contains changes to function signatures
	Funcs map[string]delta.FuncSig `json:"funcs,omitempty"`
	// Interfaces contains changes to interface definitions
	Interfaces map[string]delta.InterfaceDef `json:"interfaces,omitempty"`
	// Structs contains changes to struct definitions
	Structs map[string]delta.StructDef `json:"structs,omitempty"`
}

type CommitPkgReport struct {
	// BreakingChanges includes the commit hashes that contains breaking changes
	BreakingChanges []string `json:"breakingChanges,omitempty"`
	// CommitsReports stores the package report with the key of commit hashes
	CommitsReports map[string]Package `json:"deltas"`
}

type CommitPkgsReport struct {
	// AffectedPackages stores the package list with key of commit hashes
	AffectedPackages map[string]PkgsList `json:"affectedPackages"`
	// BreakingChanges stores the commit hashes that contain breaking changes
	BreakingChanges []string `json:"breakingChanges,omitempty"`
	// CommitsReports stores the detailed reports with the key of commit hashes
	CommitsReports map[string]PkgsReport `json:"deltas"`
}

type GenerationOption struct {
	// OnlyBreakingChanges ...
	OnlyBreakingChanges bool
	// OnlyAdditiveChanges ...
	OnlyAdditiveChanges bool
}

type ModifiedPackages map[string]Package

type Package struct {
	AdditiveChanges *AdditiveChanges `json:"additiveChanges,omitempty"`
	BreakingChanges *BreakingChanges `json:"breakingChanges,omitempty"`
}

type PkgsList []string

type PkgsReport struct {
	// AddedPackages stores the added packages in the report
	AddedPackages PkgsList `json:"added,omitempty"`
	// ModifiedPackages stores the details of all modified packages
	ModifiedPackages ModifiedPackages `json:"modified,omitempty"`
	// RemovedPackages stores the removed packages in the report
	RemovedPackages PkgsList `json:"removed,omitempty"`
}

type Status interface {
	IsEmpty() bool
	HasBreakingChanges() bool
	HasAdditiveChanges() bool
}