compare

Documentation

Index

• type Change
  • func Decls(name string, base, target types.Object) ([]Change, error)
  • func Packages(base, target *packages.Package) ([]Change, error)
  • func Repos(base, target *parser.Repo) ([]Change, error)
• type DeclChange
  • func (c DeclChange) Compatible() bool
  • func (c DeclChange) String() string
• type IdentChange
  • func (c IdentChange) Compatible() bool
  • func (c IdentChange) String() string

Types

type Change

type Change interface {
	String() string
	Compatible() bool
}

A Change is the basic abstraction of all changes, backwards compatible or not.

func Decls

func Decls(name string, base, target types.Object) ([]Change, error)

Decls compares two different declarations.

func Packages

func Packages(base, target *packages.Package) ([]Change, error)

Packages compares two packages and returns the list of changes in its identifiers.

func Repos

func Repos(base, target *parser.Repo) ([]Change, error)

Repos compares two given Repos.

type DeclChange

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

DeclChange tracks the addition or removal of an identifier declaration in a package.

func (DeclChange) Compatible

func (c DeclChange) Compatible() bool

Compatible returns true when the change is backwards compatible.

func (DeclChange) String

func (c DeclChange) String() string

type IdentChange

type IdentChange struct {
	Name                 string
	BaseType, TargetType types.Type
}

IdentChange tracks changes in the definition of an identifier.

func (IdentChange) Compatible

func (c IdentChange) Compatible() bool

Compatible returns whether the change is backwards compatible.

func (IdentChange) String

func (c IdentChange) String() string