Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

common

package

Go to main page

Versions in this module

v1

v1.1.1

Jul 24, 2021

v1.1.0

Jul 24, 2021

v1.0.34

Jun 16, 2021

v1.0.33

Jun 14, 2021

v1.0.32

Jun 11, 2021

Changes in this version

+ const DebugLog

+ const DefaultFileModeDirectory

+ const DefaultFileModeFile

+ const GithooksEmoji

+ const IsDebug

+ const ListItemLiteral

+ const WindowsExecutableSuffix

+ const WindowsOsName

+ func All(vs []interface{}, f func(interface{}) bool) bool

+ func Any(vs []interface{}, f func(interface{}) bool) bool

+ func AssertNoErrorPanic(err error, lines ...string)

+ func AssertNoErrorPanicF(err error, format string, args ...interface{})

+ func AssertOrPanic(condition bool, lines ...string)

+ func AssertOrPanicF(condition bool, format string, args ...interface{})

+ func Chmod(filePath string, mode os.FileMode) error

+ func CombineErrors(err error, errs ...error) error

+ func ContainsDotFile(p string) bool

+ func CopyFileOrDirectory(src string, dest string) error

+ func CopyFileWithBackup(src string, dst string, backupDir string, doMoveInstead bool) (err error)

+ func DebugAssert(condition bool, lines ...string)

+ func DebugAssertF(condition bool, format string, args ...interface{})

+ func DebugAssertNoError(err error, lines ...string)

+ func DebugAssertNoErrorF(err error, format string, args ...interface{})

+ func Error(lines ...string) error

+ func ErrorF(format string, args ...interface{}) error

+ func ExtractTarGz(gzipStream io.Reader, baseDir string) (paths []string, err error)

+ func ExtractZip(zipFile io.ReaderAt, zipFileSize int64, destDir string) (paths []string, err error)

+ func Filter(vs []interface{}, f func(interface{}) bool) []interface

+ func FormatError(err error) string

+ func FormatMessage(suffix string, indent string, lines ...string) string

+ func FormatMessageF(suffix string, indent string, format string, args ...interface{}) string

+ func GetAllFiles(root string) (files []string, err error)

+ func GetCombinedOutputFromExecutable(ctx IExecContext, exe IExecutable, pipeSetup PipeSetupFunc, args ...string) ([]byte, error)

+ func GetCtty() (*os.File, error)

+ func GetDuration(since time.Duration) time.Duration

+ func GetFiles(root string, filter FileFilter) (files []string, err error)

+ func GetOutputFromExecutable(ctx IExecContext, exe IExecutable, pipeSetup PipeSetupFunc, args ...string) ([]byte, error)

+ func GetOutputFromExecutableSep(ctx IExecContext, exe IExecutable, pipeSetup PipeSetupFunc, args ...string) ([]byte, []byte, error)

+ func GetOutputFromExecutableTrimmed(ctx IExecContext, exe IExecutable, ...) (string, error)

+ func GetProgressBar(log ILogContext, title string, length int) (bar *pb.ProgressBar)

+ func GetSHA1Hash(reader io.Reader) (string, error)

+ func GetSHA1HashFile(path string) (sha string, err error)

+ func GetSHA256Hash(reader io.Reader) (string, error)

+ func GetStartTime() time.Duration

+ func GetTempPath(dir string, postfix string) (file string)

+ func Glob(pattern string, ignoreErrors bool) (l []string, err error)

+ func GlobMatch(pattern string, path string) (bool, error)

+ func HandleCLIErrors(err interface{}, cwd string, log ILogContext, ...) bool

+ func IsDirectory(path string) bool

+ func IsExecutable(path string) bool

+ func IsFile(path string) bool

+ func IsPathError(err error) bool

+ func IsPathExisting(path string) (bool, error)

+ func IsWritable(path string) bool

+ func LoadJSON(file string, repr interface{}) error

+ func LoadYAML(file string, repr interface{}) error

+ func MakeExecutable(path string) (err error) — darwin/amd64, js/wasm, linux/amd64

+ func MakeExecutable(path string) error — windows/amd64

+ func MakeRelative(base string, path string) (s string, e error)

+ func Map(vs []interface{}, f func(interface{}) interface{}) []interface

+ func MatchLineRegexInFile(filePath string, regex *regexp.Regexp) (found bool, err error)

+ func Panic(lines ...string)

+ func PanicF(format string, args ...interface{})

+ func PanicIf(condition bool, lines ...string)

+ func PanicIfF(condition bool, format string, args ...interface{})

+ func ReadJSON(reader io.Reader, repr interface{}) error

+ func ReplaceTilde(p string) (string, error)

+ func ReplaceTildeWith(p string, repl string) string

+ func RunExecutable(ctx IExecContext, exe IExecutable, pipeSetup PipeSetupFunc, args ...string) error

+ func SplitPath(p string) []string

+ func StoreJSON(file string, repr interface{}) error

+ func StoreYAML(file string, repr interface{}) error

+ func ToErrorWriter(log ILogContext) io.Writer

+ func ToInfoWriter(log ILogContext) io.Writer

+ func TouchFile(filePath string, makeDirs bool) (err error)

+ func VerifyFile(file io.Reader, signature io.Reader, publicKey string) error

+ func WalkFiles(root string, filter FileFunc) error

+ func WalkPaths(root string, filter FileFunc) error

+ func WriteJSON(writer io.Writer, repr interface{}) error

+ type CmdContext struct

+ BaseCmd string

+ Cwd string

+ Env []string

+ func (c *CmdContext) Check(args ...string) error

+ func (c *CmdContext) CheckPiped(args ...string) error

+ func (c *CmdContext) Get(args ...string) (string, error)

+ func (c *CmdContext) GetCombined(args ...string) (string, error)

+ func (c *CmdContext) GetExitCode(args ...string) (int, error)

+ func (c *CmdContext) GetSplit(args ...string) ([]string, error)

+ type ExecContext struct

+ Cwd string

+ Env []string

+ func (c *ExecContext) GetEnv() []string

+ func (c *ExecContext) GetWorkingDir() string

+ type Executable struct

+ Args []string

+ Cmd string

+ func (e *Executable) GetArgs(args ...string) []string

+ func (e *Executable) GetCommand() string

+ func (e *Executable) GetString() string

+ type FileFilter = func(path string, info os.FileInfo) bool

+ type FileFunc = func(path string, info os.FileInfo) error

+ type GithooksFailure struct

+ func (e *GithooksFailure) Error() string

+ type IExecContext interface

+ GetEnv func() []string

+ GetWorkingDir func() string

+ type IExecutable interface

+ GetArgs func(args ...string) []string

+ GetCommand func() string

+ GetString func() string

+ type ILogContext interface

+ AssertNoError func(err error, lines ...string) bool

+ AssertNoErrorF func(err error, format string, args ...interface{}) bool

+ AssertNoErrorPanic func(err error, lines ...string)

+ AssertNoErrorPanicF func(err error, format string, args ...interface{})

+ AssertWarn func(condition bool, lines ...string)

+ AssertWarnF func(condition bool, format string, args ...interface{})

+ ColorError func(string) string

+ ColorInfo func(string) string

+ ColorPrompt func(string) string

+ Debug func(lines ...string)

+ DebugF func(format string, args ...interface{})

+ DebugIf func(condition bool, lines ...string)

+ DebugIfF func(condition bool, format string, args ...interface{})

+ Error func(lines ...string)

+ ErrorF func(format string, args ...interface{})

+ ErrorIf func(condition bool, lines ...string)

+ ErrorIfF func(condition bool, format string, args ...interface{})

+ ErrorOrPanicF func(isFatal bool, err error, format string, args ...interface{})

+ ErrorWithStacktrace func(lines ...string)

+ ErrorWithStacktraceF func(format string, args ...interface{})

+ GetErrorFormatter func(withColor bool) func(format string, args ...interface{}) string

+ GetErrorWriter func() io.Writer

+ GetIndent func() string

+ GetInfoFormatter func(withColor bool) func(format string, args ...interface{}) string

+ GetInfoWriter func() io.Writer

+ GetPromptFormatter func(withColor bool) func(format string, args ...interface{}) string

+ HasColors func() bool

+ Info func(lines ...string)

+ InfoF func(format string, args ...interface{})

+ InfoIf func(condition bool, lines ...string)

+ InfoIfF func(condition bool, format string, args ...interface{})

+ IsErrorATerminal func() bool

+ IsInfoATerminal func() bool

+ Panic func(lines ...string)

+ PanicF func(format string, args ...interface{})

+ PanicIf func(condition bool, lines ...string)

+ PanicIfF func(condition bool, format string, args ...interface{})

+ Warn func(lines ...string)

+ WarnF func(format string, args ...interface{})

+ WarnIf func(condition bool, lines ...string)

+ WarnIfF func(condition bool, format string, args ...interface{})

+ type ILogStats interface

+ DisableStats func()

+ EnableStats func()

+ ErrorCount func() int

+ ResetStats func()

+ WarningCount func() int

+ type ITask interface

+ Clone func() ITask

+ Run func(exitCh chan bool) (taskError error)

+ func RunTaskWithProgress(taskIn ITask, log ILogContext, timeout time.Duration, sett ProgressSettings) (taskOut ITask, taskError error)

+ type LogContext struct

+ func CreateLogContext(onlyStderr bool) (*LogContext, error)

+ func (c *LogContext) AssertNoError(err error, lines ...string) bool

+ func (c *LogContext) AssertNoErrorF(err error, format string, args ...interface{}) bool

+ func (c *LogContext) AssertNoErrorPanic(err error, lines ...string)

+ func (c *LogContext) AssertNoErrorPanicF(err error, format string, args ...interface{})

+ func (c *LogContext) AssertWarn(condition bool, lines ...string)

+ func (c *LogContext) AssertWarnF(condition bool, format string, args ...interface{})

+ func (c *LogContext) ColorError(s string) string

+ func (c *LogContext) ColorInfo(s string) string

+ func (c *LogContext) ColorPrompt(s string) string

+ func (c *LogContext) Debug(lines ...string)

+ func (c *LogContext) DebugF(format string, args ...interface{})

+ func (c *LogContext) DebugIf(condition bool, lines ...string)

+ func (c *LogContext) DebugIfF(condition bool, format string, args ...interface{})

+ func (c *LogContext) DisableStats()

+ func (c *LogContext) EnableStats()

+ func (c *LogContext) Error(lines ...string)

+ func (c *LogContext) ErrorCount() int

+ func (c *LogContext) ErrorF(format string, args ...interface{})

+ func (c *LogContext) ErrorIf(condition bool, lines ...string)

+ func (c *LogContext) ErrorIfF(condition bool, format string, args ...interface{})

+ func (c *LogContext) ErrorOrPanicF(isFatal bool, err error, format string, args ...interface{})

+ func (c *LogContext) ErrorWithStacktrace(lines ...string)

+ func (c *LogContext) ErrorWithStacktraceF(format string, args ...interface{})

+ func (c *LogContext) GetErrorFormatter(withColor bool) func(format string, args ...interface{}) string

+ func (c *LogContext) GetErrorWriter() io.Writer

+ func (c *LogContext) GetIndent() string

+ func (c *LogContext) GetInfoFormatter(withColor bool) func(format string, args ...interface{}) string

+ func (c *LogContext) GetInfoWriter() io.Writer

+ func (c *LogContext) GetPromptFormatter(withColor bool) func(format string, args ...interface{}) string

+ func (c *LogContext) HasColors() bool

+ func (c *LogContext) Info(lines ...string)

+ func (c *LogContext) InfoF(format string, args ...interface{})

+ func (c *LogContext) InfoIf(condition bool, lines ...string)

+ func (c *LogContext) InfoIfF(condition bool, format string, args ...interface{})

+ func (c *LogContext) IsErrorATerminal() bool

+ func (c *LogContext) IsInfoATerminal() bool

+ func (c *LogContext) Panic(lines ...string)

+ func (c *LogContext) PanicF(format string, args ...interface{})

+ func (c *LogContext) PanicIf(condition bool, lines ...string)

+ func (c *LogContext) PanicIfF(condition bool, format string, args ...interface{})

+ func (c *LogContext) ResetStats()

+ func (c *LogContext) Warn(lines ...string)

+ func (c *LogContext) WarnF(format string, args ...interface{})

+ func (c *LogContext) WarnIf(condition bool, lines ...string)

+ func (c *LogContext) WarnIfF(condition bool, format string, args ...interface{})

+ func (c *LogContext) WarningCount() int

+ type PipeSetupFunc func() (io.Reader, io.Writer, io.Writer)

+ func UseOnlyStdin(inPipe io.Reader) PipeSetupFunc

+ func UseStdStreams(pipeStdin bool, pipeStdOut bool, pipeStderr bool) PipeSetupFunc

+ func UseStreams(in io.Reader, out io.Writer, err io.Writer) PipeSetupFunc

+ type ProgressSettings struct

+ ProgressStillRunningAfter time.Duration

+ ProgressUpdateInterval time.Duration

+ Title string

+ TitleStillRunning string

+ func CreateDefaultProgressSettings(title string, titleStillRunning string) ProgressSettings