feedback

Documentation

Index

• Constants
• func GetLockingFeedback(version, revision, depType, projectPath string) string
• func GetUsingFeedback(version, consType, depType, projectPath string) string
• type BrokenImportFeedback
  • func NewBrokenImportFeedback(ld *LockDiff) *BrokenImportFeedback
  • func (b BrokenImportFeedback) LogFeedback(logger *log.Logger)
• type ConstraintFeedback
  • func NewConstraintFeedback(pc gps.ProjectConstraint, depType string) *ConstraintFeedback
  • func NewLockedProjectFeedback(lp gps.LockedProject, depType string) *ConstraintFeedback
  • func (cf ConstraintFeedback) LogFeedback(logger *log.Logger)
• type LockDiff
  • func DiffLocks(l1, l2 gps.Lock) *LockDiff
• type LockedProjectDiff
  • func DiffProjects(lp1, lp2 gps.LockedProject) *LockedProjectDiff
• type StringDiff
  • func (diff *StringDiff) String() string

Constants

const (
	// ConsTypeConstraint represents a constraint
	ConsTypeConstraint = "constraint"

	// ConsTypeHint represents a constraint type hint
	ConsTypeHint = "hint"

	// DepTypeDirect represents a direct dependency
	DepTypeDirect = "direct dep"

	// DepTypeTransitive represents a transitive dependency,
	// or a dependency of a dependency
	DepTypeTransitive = "transitive dep"

	// DepTypeImported represents a dependency imported by an external tool
	DepTypeImported = "imported dep"
)

Functions

func GetLockingFeedback

func GetLockingFeedback(version, revision, depType, projectPath string) string

GetLockingFeedback returns a dependency "locking" feedback message. For example:

Locking in v1.1.4 (bc29b4f) for direct dep github.com/foo/bar
Locking in master (436f39d) for transitive dep github.com/baz/qux

func GetUsingFeedback

func GetUsingFeedback(version, consType, depType, projectPath string) string

GetUsingFeedback returns a dependency "using" feedback message. For example:

Using ^1.0.0 as constraint for direct dep github.com/foo/bar
Using 1b8edb3 as hint for direct dep github.com/bar/baz

Types

type BrokenImportFeedback

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

BrokenImportFeedback holds information on changes to locks pre- and post- solving.

func NewBrokenImportFeedback

func NewBrokenImportFeedback(ld *LockDiff) *BrokenImportFeedback

NewBrokenImportFeedback builds a feedback entry that compares an initially imported, unsolved lock to the same lock after it has been solved.

func (BrokenImportFeedback) LogFeedback

func (b BrokenImportFeedback) LogFeedback(logger *log.Logger)

LogFeedback logs a warning for all changes between the initially imported and post- solve locks

type ConstraintFeedback

type ConstraintFeedback struct {
	Constraint, LockedVersion, Revision, ConstraintType, DependencyType, ProjectPath string
}

ConstraintFeedback holds project constraint feedback data

func NewConstraintFeedback

func NewConstraintFeedback(pc gps.ProjectConstraint, depType string) *ConstraintFeedback

NewConstraintFeedback builds a feedback entry for a constraint in the manifest.

func NewLockedProjectFeedback

func NewLockedProjectFeedback(lp gps.LockedProject, depType string) *ConstraintFeedback

NewLockedProjectFeedback builds a feedback entry for a project in the lock.

func (ConstraintFeedback) LogFeedback

func (cf ConstraintFeedback) LogFeedback(logger *log.Logger)

LogFeedback logs feedback on changes made to the manifest or lock.

type LockDiff

type LockDiff struct {
	Add    []LockedProjectDiff
	Remove []LockedProjectDiff
	Modify []LockedProjectDiff
}

LockDiff is the set of differences between an existing lock file and an updated lock file. Fields are only populated when there is a difference, otherwise they are empty.

func DiffLocks

func DiffLocks(l1, l2 gps.Lock) *LockDiff

DiffLocks compares two locks and identifies the differences between them. Returns nil if there are no differences.

type LockedProjectDiff

type LockedProjectDiff struct {
	Name     gps.ProjectRoot
	Source   *StringDiff
	Version  *StringDiff
	Branch   *StringDiff
	Revision *StringDiff
	Packages []StringDiff
}

LockedProjectDiff contains the before and after snapshot of a project reference. Fields are only populated when there is a difference, otherwise they are empty.

func DiffProjects

func DiffProjects(lp1, lp2 gps.LockedProject) *LockedProjectDiff

DiffProjects compares two projects and identifies the differences between them. Returns nil if there are no differences.

type StringDiff

type StringDiff struct {
	Previous string
	Current  string
}

StringDiff represents a modified string value. * Added: Previous = nil, Current != nil * Deleted: Previous != nil, Current = nil * Modified: Previous != nil, Current != nil * No Change: Previous = Current, or a nil pointer

func (*StringDiff) String

func (diff *StringDiff) String() string