nerd

Documentation

Index

• Constants
• Variables
• func VersionMessage(current string)
• type GHError
• type GHRelease
• type SemVer
  • func ParseSemVer(ver string) (*SemVer, error)
  • func (s *SemVer) GreaterThan(other *SemVer) bool
  • func (s *SemVer) ToString() string

Constants

const (
	//GHReleasesURL is the GitHub API URL that lists all releases.
	GHReleasesURL = "https://api.github.com/repos/nerdalize/nerd/releases"
	//BuiltFromSourceVersion is the version when building form source (no real version).
	BuiltFromSourceVersion = "built.from.src"
)

Variables

var (
	//ErrNotImplemented is returned when a function is not yet implemented
	ErrNotImplemented = errors.New("not yet implemented")

	//ErrTokenRevoked is returned when trying to refresh a revoked token
	ErrTokenRevoked = errors.New("ErrTokenRevoked")

	//ErrTokenUnset is returned when no oauth access token was found in the config file
	ErrTokenUnset = errors.New("You're not logged in. Please login with `nerd login`.")

	//ErrProjectIDNotSet is returned when no project id is set in the session
	ErrProjectIDNotSet = errors.New("No project ID specified, use `nerd project set` to configure a project to work on.")
)

Functions

func VersionMessage

func VersionMessage(current string)

VersionMessage shows a message to the user if a new CLI version is available.

Types

type GHError

type GHError struct {
	Message string `json:"message"`
	URL     string `json:"documentation_url"`
}

GHError is an error object from the GitHub API.

type GHRelease

type GHRelease struct {
	Name    string `json:"name"`
	HTMLURL string `json:"html_url"`
}

GHRelease is a `release` object from the GitHub API.

type SemVer

type SemVer struct {
	Major int
	Minor int
	Patch int
}

SemVer is a semantic version.

func ParseSemVer

func ParseSemVer(ver string) (*SemVer, error)

ParseSemVer parses a semantic version from string.

func (*SemVer) GreaterThan

func (s *SemVer) GreaterThan(other *SemVer) bool

GreaterThan checks if `s` is a greater semantic version than `other`

func (*SemVer) ToString

func (s *SemVer) ToString() string

ToString converts a SemVer to a string