go-helper

Collections of Golang helper functions.

Table Of Content

• Table Of Content
• Features
  • common.go
  • crypto.go
  • debug.go
  • err.go
  • file.go
  • gitCmd.go
  • myArray.go
  • myCmd.go
  • report.go
  • string.go
• Doc
• Usage
• Test
• Used By Project
• Repository
• Contributors
• Change Log
• License

Features

File	Description
common.go	Debug flag
crypto.go	Crypto function
debug.go	Debug functions
err.go	Basic error type
file.go	File/directory functions
gitCmd.go	Git functions
myArray.go	A simple generic array type
myCmd.go	exec.Command shell wrapper
report.go	report/log functions auto detect and apply json marshal indent
string.go	string/array functions

common.go

• var Debug bool = false
• var DebugReport bool = false
• var Errs ErrsType
• var Warns Warnings
• var NIL_SPRINT string = fmt.Sprint(nil)
• var NIL_JSON string
• func init()

crypto.go

• func BoxSealAnonymous(base64PublicKey, msg *string) *string

debug.go

• func DebugEnv() bool
• func DebugLog(msg ...interface{})
• func ErrCheck(e error)

err.go

• type Err string
• type ErrsType struct
• func (self Err) Error() string
• func (self *Err) String() string
• func (self *Err) StringP() *string

file.go

• func CurrentPath() *string
• func CurrentDirBase() *string
• func FullPath(workPathP *string) *string
• func FullPathStr(workPath string) *string
• func IsRegularFile(workPath string) bool
• func IsDir(workPath string) bool
• func SameDir(path1, path2 string) bool
• func FileHasExt(name, ext string) bool
• func FileRemoveExt(filename string) string
• func FileInDir(dir, filename string) string
• func FileSimplifyName(filename string) string

gitCmd.go

• func Git(workPathP *string, optionsP *[]string) *MyCmd
• func GitClone(workPathP *string, optionsP *[]string) *MyCmd
• func GitExecExist() bool
• func GitExecPath() string
• func GitInit(workPathP *string) *MyCmd
• func GitBranchCurrent(workPathP *string) *MyCmd
• func GitPull(workPathP *string, optionsP *[]string) *MyCmd
• func GitPush(workPathP *string, optionsP *[]string) *MyCmd
• func GitRemote(workPathP *string, v bool) *[]string
• func GitRemoteAdd(workPathP *string, name string, git string) *MyCmd
• func GitRemoteExist(workPathP *string, name string) bool
• func GitRemoteRemove(workPathP *string, name string) *MyCmd
• func GitRemoteRemoveAll(workPathP *string)
• func GitRoot(workPathP *string) string
• func GitRootSubmodule(workPathP *string) string

myArray.go

• type myArray[T any] []T
• func (self *myArray[T]) Empty() bool
• func (self *myArray[T]) NotEmpty() bool
• func (self *myArray[T]) Clear()
• func (self *myArray[T]) Add(t T) *myArray[T]

myCmd.go

• type MyCmd struct
• func MyCmdRun(cmdName string, argsP *[]string, workPathP *string) *MyCmd
• func MyCmdRunWg(cmdName string, argsP *[]string, workPathP *string, title *string, wgP *sync.WaitGroup, output bool) *MyCmd
• func MyCmdInit(name string, argsP *[]string, workPathP *string) *MyCmd
• func (self *MyCmd) Init(name string, argsP *[]string, workPathP *string) *MyCmd
• func (self *MyCmd) Reset() *MyCmd
• func (self *MyCmd) Run() error
• func (self *MyCmd) ExitCode() int

report.go

• type ReportT struct
• func Report(data any, title string, skipEmpty bool, singleLine bool)
• func ReportDebug(data any, title string, skipEmpty bool, singleLine bool)
• func ReportSp(data any, title string, skipEmpty bool, singleLine bool) *string
• func ReportSpDebug(data any, title string, skipEmpty bool, singleLine bool) *string
• func ReportStatus(data bool, title string, singleLine bool)
• func ReportStatusSp(data bool, title string, singleLine bool) *string
• func ReportNew(data any, title string, skipEmpty bool, singleLine bool) *ReportT
• func (self *ReportT) String() string
• func (self *ReportT) StringDebug() string
• func (self *ReportT) StringP() *string
• func (self *ReportT) StringPDebug() *string

string.go

• func BoolString(b bool) string
• func BoolStatus(b bool) string
• func BoolYesNo(b bool) string
• func StrArrayPtrContain(aP *[]string, sP *string) bool
• func StrArrayPtrRemoveEmpty(saP *[]string) *[]string
• func StrArrayPtrPrintln(saP *[]string)
• func StrArrayPtrPrintlnSp(saP *[]string) *string
• func StrPtrToArrayPtr(sP *string) *[]string
• func JsonIndentSp(baP *[]byte, endLn bool) *string
• func numToStr(data any) *string
• func AnyToJsonMarshalIndentSp(data any, endLn bool) *string
• func AnyToJsonMarshalSp(data any, endLn bool) *string
• func StrPtrToJsonIndentSp(strP *string, endLn bool) *string
• func StrToJsonIndentSp(str string, endLn bool) *string

Doc

• https://pkg.go.dev/github.com/J-Siu/go-helper

Usage

import	"github.com/J-Siu/go-helper"

func main() {
	helper.Debug = true
	helper.DebugLog("debug msg")
}

Test

cd test
# All
go test
# Individual
go test file_test.go
go test gitCmd_test.go
go test myCmd_test.go
go test report_test.go

Used By Project

• go-gitapi
• go-mygit

Repository

• go-helper

Contributors

• John Sing Dao Siu

Change Log

• 0.0.1
  • Initial Commit
• 0.9.0
  • Function update
• 0.9.1
  • Fix git command args
• v0.9.1
  • Add prefix v for version number
• v0.9.2
  • Fix MyCmdRunWg() missing wgP.Done()
• v0.9.3
  • ReportTStringP():
    • fix using wrong var when handling *[]byte
    • add []byte case
• v0.9.4
  • Report support SingleLine mode
• v0.9.5
  • Fix ReportT.SpringP() output
• v0.9.6
  • Fix ReportT.SpringP() skip empty output
• v0.9.8
  • Fix ReportT.SpringP() logical bug
  • Add report_test.go
• v0.9.9
  • Add workPath support for gitCmd and myCmd
  • Add GitRoot(), GitRootSubmodule(), GitExecExist(), GitExecPath()
  • Add test
• v1.0.0
  • file.go
    • Add FullPath()
    • All func return *string
  • gitCmd.go
    • GitPush() correct optionP param type
  • myCmd.go
    • MyCmd.Run() improve debug output
    • MyCmdInit() use full path for WorkDir
  • report.go
    • ReportT.StringP()
      • Add *[]string case
      • case []string, *[]string
        • fix bug only print last line
        • no longer remove empty line
  • string.go
    • StrArrayPtrRemoveEmpty() return new array
    • StrPToArrayP no longer remove empty line
    • func name StrPToArrayP -> StrPtrToArrayPtr
• v1.0.1
  • Improve comment for godoc
• v1.1.1
  • Add Git(), GitBranchCurrent(), GitClone(), GitPull()
• v1.1.2
  • Add IsRegularFile(), IsDir(), SameDir()
  • Add StrPtrToJsonIndentSp(), StrToJsonIndentSp(), AnyToJsonMarshalIndentSp()
  • Add basic error type
  • Add warning type
  • If !Debug, short circuit ReportDebug() ReportSpDebug()
  • Report() support error type
• v1.1.3
  • Add ErrsType.Empty(), ErrsType.Clear()
  • Add FullPathStr(), FileRemoveExt(), FileInDir(), FileSimplifyName(), FileHasExt()
  • Add MyCmd.Reset(), MyCmd.Init()
  • Add number types/pointers support in ReportT.StringP()
  • Fix #6 - ReportT().StringP add space after title ":"
  • Fix BoxSealAnonymous() decoding length checking
• v1.1.4
  • ReportT.StringP() handle nil *[]string
• v1.1.5
  • Go 1.20
• v1.1.6
  • MyCmd struct
    • Add ExitCode
    • Run() will handle exit code properly
    • Update test cases

License

The MIT License

Copyright (c) 2023 John Siu

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.