util

Documentation

Index

• Constants
• Variables
• func Assert(condition bool, message string)
• func AssertGoBuild(args []string)
• func AssertType[T any](v any) T
• func CopyDir(src string, dst string) error
• func CopyDirExclude(src string, dst string, exclude []string) error
• func CopyFile(src, dst string) error
• func Crc32(s string) string
• func FindFlagValue(cmd []string, flag string) string
• func GetInstrumentLogPath(name string) string
• func GetLogPath(name string) string
• func GetLoggerPath() string
• func GetMatchedRuleFile() string
• func GetPreprocessLogPath(name string) string
• func GetTempBuildDir() string
• func GetTempBuildDirWith(name string) string
• func GetToolName() (string, error)
• func GetVarNameOfFunc(fn string) string
• func HasGoBuildComment(text string) bool
• func InInstrument() bool
• func InPreprocess() bool
• func IsCgo1GoFile(path string) bool
• func IsCgoCommand(line string) bool
• func IsCompileCommand(line string) bool
• func IsGoFile(path string) bool
• func IsGoModFile(path string) bool
• func IsGoSumFile(path string) bool
• func IsGoTestFile(path string) bool
• func IsModPath(path string) bool
• func IsUnix() bool
• func IsWindows() bool
• func Jsonify(v interface{}) string
• func ListFiles(dir string) ([]string, error)
• func Log(format string, args ...interface{})
• func PathExists(path string) bool
• func PathNotExists(path string) bool
• func PhaseTimer(name string) func()
• func ReadFile(filePath string) (string, error)
• func RemoveGoBuildComment(text string) string
• func RenamePackage(source, newPkgName string) string
• func RunCmd(args ...string) error
• func SetLogger(w *os.File)
• func SetRunPhase(phase RunPhase)
• func ShouldNotReachHere()
• func SplitCompileCmds(input string) []string
• func Unimplemented(message string)
• func WriteFile(filePath string, content string) (string, error)
• type RunPhase
  • func GetRunPhase() RunPhase
  • func (rp RunPhase) String() string

Constants

const (
	GoBuildIgnoreComment = "//go:build ignore"
	GoModFile            = "go.mod"
	GoSumFile            = "go.sum"
	GoWorkSumFile        = "go.work.sum"
	DebugLogFile         = "debug.log"
	TempBuildDir         = ".otel-build"
)

const (
	BuildPattern    = "-p"
	BuildImportPath = "-importpath"
	BuildGoVer      = "-goversion"
	BuildPgoProfile = "-pgoprofile"
	BuildModeVendor = "-mod=vendor"
	BuildModeMod    = "-mod=mod"
	BuildWork       = "-work"
)

const (
	PInvalid    = "invalid"
	PPreprocess = "preprocess"
	PInstrument = "instrument"
)

Variables

var Guarantee = Assert // More meaningful name:)

Functions

func Assert

func Assert(condition bool, message string)

func AssertGoBuild

func AssertGoBuild(args []string)

func AssertType

func AssertType[T any](v any) T

func CopyDir

func CopyDir(src string, dst string) error

func CopyDirExclude

func CopyDirExclude(src string, dst string, exclude []string) error

func CopyFile

func CopyFile(src, dst string) error

func Crc32

func Crc32(s string) string

func FindFlagValue

func FindFlagValue(cmd []string, flag string) string

func GetInstrumentLogPath

func GetInstrumentLogPath(name string) string

func GetLogPath

func GetLogPath(name string) string

func GetLoggerPath

func GetLoggerPath() string

func GetMatchedRuleFile

func GetMatchedRuleFile() string

func GetPreprocessLogPath

func GetPreprocessLogPath(name string) string

func GetTempBuildDir

func GetTempBuildDir() string

func GetTempBuildDirWith

func GetTempBuildDirWith(name string) string

func GetToolName

func GetToolName() (string, error)

func GetVarNameOfFunc

func GetVarNameOfFunc(fn string) string

func HasGoBuildComment

func HasGoBuildComment(text string) bool

func InInstrument

func InInstrument() bool

func InPreprocess

func InPreprocess() bool

func IsCgo1GoFile

func IsCgo1GoFile(path string) bool

func IsCgoCommand

func IsCgoCommand(line string) bool

func IsCompileCommand

func IsCompileCommand(line string) bool

func IsGoFile

func IsGoFile(path string) bool

func IsGoModFile

func IsGoModFile(path string) bool

func IsGoSumFile

func IsGoSumFile(path string) bool

func IsGoTestFile

func IsGoTestFile(path string) bool

func IsModPath

func IsModPath(path string) bool

IsModPath checks if the provided module path is valid.

func IsUnix

func IsUnix() bool

func IsWindows

func IsWindows() bool

func Jsonify

func Jsonify(v interface{}) string

func ListFiles

func ListFiles(dir string) ([]string, error)

func Log

func Log(format string, args ...interface{})

func PathExists

func PathExists(path string) bool

func PathNotExists

func PathNotExists(path string) bool

func PhaseTimer

func PhaseTimer(name string) func()

func ReadFile

func ReadFile(filePath string) (string, error)

func RemoveGoBuildComment

func RemoveGoBuildComment(text string) string

func RenamePackage

func RenamePackage(source, newPkgName string) string

func RunCmd

func RunCmd(args ...string) error

func SetLogger

func SetLogger(w *os.File)

Be caution it's not thread safe

func SetRunPhase

func SetRunPhase(phase RunPhase)

func ShouldNotReachHere

func ShouldNotReachHere()

func SplitCompileCmds

func SplitCompileCmds(input string) []string

SplitCompileCmds splits the command line by space, but keep the quoted part as a whole. For example, "a b" c will be split into ["a b", "c"].

func Unimplemented

func Unimplemented(message string)

func WriteFile

func WriteFile(filePath string, content string) (string, error)

Types

type RunPhase

type RunPhase string

func GetRunPhase

func GetRunPhase() RunPhase

func (RunPhase) String

func (rp RunPhase) String() string