pi

Documentation

Index

• Constants
• type Dependency
  • func NewDependency(m *debug.Module) (dep *Dependency, err error)
• type ProgramInfo
  • func NewProgramInfo() (info *ProgramInfo, err error)
  • func (pi *ProgramInfo) DependenciesList() (list []*Dependency)
  • func (pi *ProgramInfo) DependenciesText() (txt string)
  • func (pi *ProgramInfo) IsUpdateAvailable() bool
  • func (pi *ProgramInfo) LatestVersion() *ver.Version
  • func (pi *ProgramInfo) ProgramName() (name string)
  • func (pi *ProgramInfo) ProgramVcsVersion() *ver.Version
  • func (pi *ProgramInfo) ProgramVersionNumber() (versionNumber string)
  • func (pi *ProgramInfo) ProgramVersionString() (version string)

Constants

const (
	ErrBuildInfoIsNotAvailable      = "build info is not available"
	ErrDependencyInfoIsNotAvailable = "dependency info is not available"
	ErrProgramNameIsEmpty           = "program name is empty"
	ErrDependencyNameIsEmpty        = "dependency name is empty"
	ErrProgramVersionIsEmpty        = "program version is empty"
	ErrDependencyVersionIsEmpty     = "dependency version is empty"
)

const (
	NameUnknown    = "???"
	VersionUnknown = "v??"
)

const (
	ErrUnsupportedVCS        = "unsupported VCS: %v"
	ErrGitHubRepositoryOwner = "GitHub repository owner is not found"
)

const (
	DependenciesTextPrefix = "Dependencies: "
)

const (
	VcsGitHub = "github.com"
)

const VersionMark = 'v'

Types

type Dependency

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

Dependency is information about program's dependency.

func NewDependency

func NewDependency(m *debug.Module) (dep *Dependency, err error)

type ProgramInfo

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

ProgramInfo is information about program and its dependencies.

func NewProgramInfo

func NewProgramInfo() (info *ProgramInfo, err error)

NewProgramInfo provides convenient access to program's name, program's version and information about dependencies. Program's version is taken from both runtime and VCS. Dependencies are taken from runtime.

func (*ProgramInfo) DependenciesList

func (pi *ProgramInfo) DependenciesList() (list []*Dependency)

DependenciesList returns a list of dependencies provided by runtime.

func (*ProgramInfo) DependenciesText

func (pi *ProgramInfo) DependenciesText() (txt string)

DependenciesText returns a textual list of dependencies provided by runtime.

func (*ProgramInfo) IsUpdateAvailable

func (pi *ProgramInfo) IsUpdateAvailable() bool

IsUpdateAvailable tells if there is an updated version of the program available. This information is provided by VCS.

func (*ProgramInfo) LatestVersion

func (pi *ProgramInfo) LatestVersion() *ver.Version

LatestVersion return latest version provided by VCS.

func (*ProgramInfo) ProgramName

func (pi *ProgramInfo) ProgramName() (name string)

ProgramName returns program's name provided by runtime.

func (*ProgramInfo) ProgramVcsVersion

func (pi *ProgramInfo) ProgramVcsVersion() *ver.Version

ProgramVcsVersion returns version string provided by VCS.

func (*ProgramInfo) ProgramVersionNumber

func (pi *ProgramInfo) ProgramVersionNumber() (versionNumber string)

ProgramVersionNumber returns version string provided by runtime with prefix trimmed.

func (*ProgramInfo) ProgramVersionString

func (pi *ProgramInfo) ProgramVersionString() (version string)

ProgramVersionString returns version string provided by runtime.