nerd

Documentation

Index

• Constants
• Variables
• func SetupLogging(verbose, json bool)
• func VersionMessage(current string)
• type GHError
• type GHRelease
• type PlainFormatter
  • func (f *PlainFormatter) Format(entry *logrus.Entry) ([]byte, error)
• type SemVer
  • func ParseSemVer(ver string) (*SemVer, error)
  • func (s *SemVer) GreaterThan(other *SemVer) bool
  • func (s *SemVer) ToString() string
• type User
  • func GetCurrentUser() *User

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")
)

Functions

func SetupLogging

func SetupLogging(verbose, json bool)

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 PlainFormatter

type PlainFormatter struct {
}

PlainFormatter is a Logrus formatter that only includes the log message.

func (*PlainFormatter) Format

func (f *PlainFormatter) Format(entry *logrus.Entry) ([]byte, error)

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

type User

type User struct {
	Region string
}

User holds a reference to a user session

func GetCurrentUser

func GetCurrentUser() *User

GetCurrentUser returns the current user session