util

Documentation

Index

• func DotSlash(path string) string
• func EnsureNewline(b []byte) []byte
• func FindCueMod(path string) (root string, err error)
• func FindRootLeaf(target string) (root string, leaf string, err error)
• 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)
  • func RunCmdA(ctx context.Context, w io.Writer, name string, args ...string) (result RunResult, err error)
  • func RunCmdW(ctx context.Context, w io.Writer, name string, args ...string) (result RunResult, err error)

Functions

func DotSlash

func DotSlash(path string) string

DotSlash ensures a relative path has a leading ./ needed for CUE loading.

func EnsureNewline

func EnsureNewline(b []byte) []byte

EnsureNewline adds a trailing newline if not already there.

func FindCueMod

func FindCueMod(path string) (root string, err error)

FindCueMod returns the root module location containing the cue.mod.

func FindRootLeaf

func FindRootLeaf(target string) (root string, leaf string, err error)

FindRootLeaf returns the root path containing the cue.mod and the leaf path relative to the root for the given target path. FindRootLeaf calls filepath.Clean on the returned paths.

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"

func RunCmdA

func RunCmdA(ctx context.Context, w io.Writer, name string, args ...string) (result RunResult, err error)

RunCmdA calls RunCmd and always copies the result stderr to w.

func RunCmdW

func RunCmdW(ctx context.Context, w io.Writer, name string, args ...string) (result RunResult, err error)

RunCmdW calls RunCmd and copies the result stderr to w if there is an error.