yb

Documentation

Overview

Package yb contains some helpers and wraps goyek/goyek/v2.

Index

• Variables
• func ContextWithA(a *A) context.Context
• func ContextWithLogger(ctx context.Context, logger aLogger) context.Context
• func GoDeps(ctx context.Context, name string) []string
• func GoInstall(ctx context.Context, name string, opts ...InstallOption) (bool, error)
• func GoInstallA(a *goyek.A, opts ...InstallOption)
• func GoShouldBuild(ctx context.Context, name string) bool
• func Installed() []string
• func LoggerFromContext(ctx context.Context) aLogger
• func MTime(paths ...string) int64
• func PackageName(path string) (string, error)
• func ReadDirLinks(path string) ([]string, error)
• func ResetInstalled()
• func Run(a *goyek.A, progArgs []string, opts ...RunOption)
• func TemplateIsOld(ctx context.Context, root string, force bool) (string, error)
• type A
  • func AFromContext(ctx context.Context) *A
• type DefinedTask
• type Deps
• type InstallOption
  • func WithForce(force bool) InstallOption
  • func WithRace(race bool) InstallOption
• type RunOption
  • func AtDir(dir string) RunOption
• type Task

Variables

var (
	Define     = goyek.Define
	Main       = boot.Main
	SetDefault = goyek.SetDefault
)

var (
	GoBin = os.Getenv("GOBIN")
)

Functions

func ContextWithA

func ContextWithA(a *A) context.Context

ContextWithA returns a.Context()

func ContextWithLogger

func ContextWithLogger(ctx context.Context, logger aLogger) context.Context

ComtextWithLogger returns a context with the logger set.

func GoDeps

func GoDeps(ctx context.Context, name string) []string

GoDeps returns the subpackage names that the given package depends on.

func GoInstall

func GoInstall(ctx context.Context, name string, opts ...InstallOption) (bool, error)

GoInstall go install the given name.

func GoInstallA

func GoInstallA(a *goyek.A, opts ...InstallOption)

GoInstallA is GoInstall for a.Name() with a.Context().

func GoShouldBuild

func GoShouldBuild(ctx context.Context, name string) bool

GoShouldBuild reports whether the given package needs compilation.

func Installed

func Installed() []string

Installed returns the list of succeessfully installed names.

func LoggerFromContext

func LoggerFromContext(ctx context.Context) aLogger

LoggerFromContext returns the logger from the context, or a default slog logger.

func MTime

func MTime(paths ...string) int64

MTime returns the maximum ModTime().UnixMillis() of the given paths.

func PackageName

func PackageName(path string) (string, error)

PackageName returns the name of the package at the given path.

func ReadDirLinks

func ReadDirLinks(path string) ([]string, error)

ReadDirLinks reads the links contained at path dir.

func ResetInstalled

func ResetInstalled()

ResetInstalled empties the installed set.

func Run

func Run(a *goyek.A, progArgs []string, opts ...RunOption)

Run an external program reporting on a.

func TemplateIsOld

func TemplateIsOld(ctx context.Context, root string, force bool) (string, error)

TemplateIsOldreports whether the given directory needs qtc/templ to be run.

Types

type A

type A = goyek.A

func AFromContext

func AFromContext(ctx context.Context) *A

AFromContext returns A from the Context.

type DefinedTask

type DefinedTask = goyek.DefinedTask

type Deps

type Deps = goyek.Deps

type InstallOption

type InstallOption func(*installParams)

func WithForce

func WithForce(force bool) InstallOption

func WithRace

func WithRace(race bool) InstallOption

type RunOption

type RunOption func(*exec.Cmd)

func AtDir

func AtDir(dir string) RunOption

AtDir RunOption sets cmd.Dir.

type Task

type Task = goyek.Task