Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BreakingChanges ¶
type BreakingChanges struct {
Consts map[string]delta.Signature `json:"consts,omitempty"`
Funcs map[string]delta.FuncSig `json:"funcs,omitempty"`
Interfaces map[string]delta.InterfaceDef `json:"interfaces,omitempty"`
Structs map[string]delta.StructDef `json:"structs,omitempty"`
Removed *delta.Content `json:"removed,omitempty"`
}
BreakingChanges represents a set of breaking changes.
func (BreakingChanges) IsEmpty ¶
func (bc BreakingChanges) IsEmpty() bool
IsEmpty returns true if there are no breaking changes.
type Package ¶
type Package struct {
AdditiveChanges *delta.Content `json:"additiveChanges,omitempty"`
BreakingChanges *BreakingChanges `json:"breakingChanges,omitempty"`
}
Package represents a per-package report that contains additive and breaking changes.
func Generate ¶
Generate generates a package report based on the delta between lhs and rhs. onlyBreakingChanges - pass true to include only breaking changes in the report. onlyAdditions - pass true to include only addition changes in the report.
func (Package) HasAdditiveChanges ¶
HasAdditiveChanges returns true if the package report contains additive changes.
func (Package) HasBreakingChanges ¶
HasBreakingChanges returns true if the package report contains breaking changes.
func (Package) IsEmpty ¶
IsEmpty returns true if the report contains no data (e.g. no changes in exported types).
func (Package) ToMarkdown ¶
ToMarkdown creates a report of the package changes in markdown format.
Source Files