util

Documentation

Index

• func EnsureNewline(b []byte) []byte
• func MakeWalkFunc(a *txtar.Archive) fs.WalkDirFunc
• func Remove(ctx context.Context, path string)
• func RunInteractiveCmd(ctx context.Context, name string, args ...string) error
• type RunResult
  • func RunCmd(ctx context.Context, name string, args ...string) (result RunResult, err error)

Functions

func EnsureNewline

func EnsureNewline(b []byte) []byte

EnsureNewline adds a trailing newline if not already there.

func MakeWalkFunc

func MakeWalkFunc(a *txtar.Archive) fs.WalkDirFunc

func Remove

func Remove(ctx context.Context, path string)

Remove cleans up path, useful for temporary directories.

func RunInteractiveCmd

func RunInteractiveCmd(ctx context.Context, name string, args ...string) error

RunInteractiveCmd runs a command within a context but allows the command to accept stdin interactively from the user. The caller is expected to handle errors.

Types

type RunResult

type RunResult struct {
	Stdout *bytes.Buffer
	Stderr *bytes.Buffer
}

runResult holds the stdout and stderr of a command.

func RunCmd

func RunCmd(ctx context.Context, name string, args ...string) (result RunResult, err error)

RunCmd runs a command within a context, captures its output, provides debug logging, and returns the result. Example:

result, err := RunCmd(ctx, "echo", "hello")
if err != nil {
  return wrapper.Wrap(err)
}
fmt.Println(result.Stdout.String())

Output:

"hello\n"