modmake

package module

Go to main page

Versions in this module

v0

v0.4.0

May 1, 2024

Changes in this version

type GoBuild

+ func (b *GoBuild) TrimPath() *GoBuild

type Step

+ func (s *Step) Debounce(interval time.Duration) Task

+ func (s *Step) ResetState() *Step

type Task

+ func (t Task) Debounce(interval time.Duration) Task

v0.3.1

Mar 31, 2024

Changes in this version

type Build

+ func (b *Build) AddNewStep(name, description string, run Runner) *Step

+ func (b *Build) ImportAndLink(prefix string, other *Build)

type Command

+ func (i *Command) Task() Task

type GoBuild

+ func (b *GoBuild) Task() Task

type GoClean

+ func (c *GoClean) Task() Task

v0.3.0

Mar 11, 2024

Changes in this version

+ func F(fmt string, data ...EnvMap) string

+ func FReader(in io.Reader, data ...EnvMap) []byte

type AppBuild

+ func (a *AppBuild) Install(pf AppPackageFunc) *AppBuild

type AppPackageFunc

+ func PackageGoInstall() AppPackageFunc

+ type EnvMap map[string]string

+ func Environment() EnvMap

type GoTools

+ func (g *GoTools) GetEnv(key string) string

type PathString

+ func (p PathString) Cat() ([]byte, error)

type Task

+ func CallRemote(module string, buildPath PathString, args ...string) Task

v0.2.2

Dec 17, 2023

v0.2.1

Dec 12, 2023

Changes in this version

type PathString

+ func (p PathString) Abs() (PathString, error)

+ func (p PathString) Rel(other PathString) (PathString, error)

v0.2.0

Dec 6, 2023

Changes in this version

+ type AppBuild struct

+ func NewAppBuild(appName, mainPath, version string) *AppBuild

+ func (a *AppBuild) Build(bf AppBuildFunc) *AppBuild

+ func (a *AppBuild) HostVariant() *AppVariant

+ func (a *AppBuild) NamedVariant(variant, os, arch string) *AppVariant

+ func (a *AppBuild) Variant(os, arch string) *AppVariant

+ type AppBuildFunc func(gb *GoBuild)

+ func (bf AppBuildFunc) Then(other AppBuildFunc) AppBuildFunc

+ type AppPackageFunc func(binaryPath, destDir PathString, app, variant, version string) Task

+ func PackageTar() AppPackageFunc

+ func PackageZip() AppPackageFunc

+ func (pf AppPackageFunc) Then(other AppPackageFunc) AppPackageFunc

+ type AppVariant struct

+ func (v *AppVariant) Build(bf AppBuildFunc) *AppVariant

+ func (v *AppVariant) NoPackage() *AppVariant

+ func (v *AppVariant) Package(pf AppPackageFunc) *AppVariant

type Build

+ func (b *Build) ImportApp(a *AppBuild)

v0.1.1

Oct 22, 2023

Changes in this version

type Command

+ func (i *Command) Output(w io.Writer) *Command

+ func (i *Command) Stderr(w io.Writer) *Command

+ func (i *Command) Stdout(w io.Writer) *Command

v0.1.0

Oct 15, 2023

Changes in this version

+ var ErrCycleDetected = errors.New("possible dependency cycle detected")

+ func SetLogOutput(w io.Writer)

+ func SetStepDebug(printDebug bool)

+ type Build struct

+ func NewBuild() *Build

+ func (b *Build) AddStep(step *Step)

+ func (b *Build) Benchmark() *Step

+ func (b *Build) Build() *Step

+ func (b *Build) Execute(args ...string)

+ func (b *Build) ExecuteErr(args ...string) (err error)

+ func (b *Build) Generate() *Step

+ func (b *Build) Graph(verbose bool)

+ func (b *Build) Import(prefix string, other *Build)

+ func (b *Build) Package() *Step

+ func (b *Build) Step(name string) *Step

+ func (b *Build) StepOk(name string) (*Step, bool)

+ func (b *Build) Steps() []string

+ func (b *Build) Test() *Step

+ func (b *Build) Tools() *Step

+ func (b *Build) Workdir(workdir string) *Build

+ type Command struct

+ func CallBuild(workdir, buildRef string, args ...string) *Command

+ func Exec(cmdAndInitArgs ...string) *Command

+ func (i *Command) Arg(args ...string) *Command

+ func (i *Command) CaptureStdin() *Command

+ func (i *Command) Env(key, value string) *Command

+ func (i *Command) OptArg(condition bool, args ...string) *Command

+ func (i *Command) Run(ctx context.Context) error

+ func (i *Command) Silent() *Command

+ func (i *Command) WorkDir(workdir string) *Command

+ type GoBuild struct

+ func (b *GoBuild) AddressSanitizer() *GoBuild

+ func (b *GoBuild) Arch(arch string) *GoBuild

+ func (b *GoBuild) BuildArchive() *GoBuild

+ func (b *GoBuild) BuildCArchive() *GoBuild

+ func (b *GoBuild) BuildCShared() *GoBuild

+ func (b *GoBuild) BuildExe() *GoBuild

+ func (b *GoBuild) BuildPie() *GoBuild

+ func (b *GoBuild) BuildPlugin() *GoBuild

+ func (b *GoBuild) BuildShared() *GoBuild

+ func (b *GoBuild) ChangeDir(newDir string) *GoBuild

+ func (b *GoBuild) DryRun() *GoBuild

+ func (b *GoBuild) Env(key, value string) *GoBuild

+ func (b *GoBuild) ForceRebuild() *GoBuild

+ func (b *GoBuild) GoCompileFlags(flags ...string) *GoBuild

+ func (b *GoBuild) LinkerFlags(flags ...string) *GoBuild

+ func (b *GoBuild) MemorySanitizer() *GoBuild

+ func (b *GoBuild) OS(os string) *GoBuild

+ func (b *GoBuild) OutputFilename(filename PathString) *GoBuild

+ func (b *GoBuild) PrintCommands() *GoBuild

+ func (b *GoBuild) PrintPackages() *GoBuild

+ func (b *GoBuild) Private(privateHosts ...string) *GoBuild

+ func (b *GoBuild) RaceDetector() *GoBuild

+ func (b *GoBuild) Run(ctx context.Context) error

+ func (b *GoBuild) SetVariable(pkg, varName, value string) *GoBuild

+ func (b *GoBuild) Silent() *GoBuild

+ func (b *GoBuild) StripDebugSymbols() *GoBuild

+ func (b *GoBuild) Tags(tags ...string) *GoBuild

+ func (b *GoBuild) Verbose() *GoBuild

+ func (b *GoBuild) Workdir(workdir string) *GoBuild

+ type GoClean struct

+ func (c *GoClean) BuildCache() *GoClean

+ func (c *GoClean) FuzzCache() *GoClean

+ func (c *GoClean) ModCache() *GoClean

+ func (c *GoClean) Run(ctx context.Context) error

+ func (c *GoClean) TestCache() *GoClean

+ type GoTools struct

+ func Go() *GoTools

+ func (g *GoTools) Benchmark(pattern string) *Command

+ func (g *GoTools) BenchmarkAll() *Command

+ func (g *GoTools) Build(targets ...string) *GoBuild

+ func (g *GoTools) Clean() *GoClean

+ func (g *GoTools) Command(command string, args ...string) *Command

+ func (g *GoTools) Generate(patterns ...string) *Command

+ func (g *GoTools) GenerateAll() *Command

+ func (g *GoTools) Get(pkg string) *Command

+ func (g *GoTools) GetUpdated(pkg string) *Command

+ func (g *GoTools) Install(pkg string) *Command

+ func (g *GoTools) InvalidateCache()

+ func (g *GoTools) ModTidy() *Command

+ func (g *GoTools) ModuleName() string

+ func (g *GoTools) ModuleRoot() string

+ func (g *GoTools) Run(target string, args ...string) *Command

+ func (g *GoTools) Test(patterns ...string) *Command

+ func (g *GoTools) TestAll() *Command

+ func (g *GoTools) ToModulePackage(pkg string) string

+ func (g *GoTools) ToModulePath(dir string) string

+ type PathString string

+ func Getwd() (PathString, error)

+ func Path(path string, segments ...string) PathString

+ func UserHomeDir() (PathString, error)

+ func (p PathString) Base() string

+ func (p PathString) Chdir() error

+ func (p PathString) CopyTo(other PathString) error

+ func (p PathString) Create() (*os.File, error)

+ func (p PathString) Dir() PathString

+ func (p PathString) Exists() bool

+ func (p PathString) IsDir() bool

+ func (p PathString) IsFile() bool

+ func (p PathString) Join(segments ...string) PathString

+ func (p PathString) JoinPath(segments ...PathString) PathString

+ func (p PathString) Mkdir(mode os.FileMode) error

+ func (p PathString) MkdirAll(mode os.FileMode) error

+ func (p PathString) Open() (*os.File, error)

+ func (p PathString) OpenFile(flag int, mode os.FileMode) (*os.File, error)

+ func (p PathString) Remove() error

+ func (p PathString) RemoveAll() error

+ func (p PathString) Stat() (os.FileInfo, error)

+ func (p PathString) String() string

+ func (p PathString) ToSlash() string

+ type RunState int

+ const StateFailed

+ const StateNotRun

+ const StateSuccessful

+ type Runner interface

+ Run func(context.Context) error

+ func ContextAware(r Runner) Runner

+ func NoOp() Runner

+ func Script(fns ...Runner) Runner

+ type Step struct

+ func NewStep(name, description string) *Step

+ func (s *Step) AfterRun(op Runner) *Step

+ func (s *Step) BeforeRun(op Runner) *Step

+ func (s *Step) Debug(msg string, args ...any)

+ func (s *Step) DependsOn(dependency *Step) *Step

+ func (s *Step) DependsOnRunner(name, description string, fn Runner) *Step

+ func (s *Step) Does(operation Runner) *Step

+ func (s *Step) DryRun(ctx context.Context) error

+ func (s *Step) Error(msg string, args ...any)

+ func (s *Step) Info(msg string, args ...any)

+ func (s *Step) Run(ctx context.Context) error

+ func (s *Step) Skip() *Step

+ func (s *Step) SkipDependencies() *Step

+ func (s *Step) UnSkip() *Step

+ func (s *Step) Warn(msg string, args ...any)

+ type TarArchive struct

+ func Tar(location PathString) *TarArchive

+ func (t *TarArchive) AddFile(sourcePath PathString) *TarArchive

+ func (t *TarArchive) AddFileWithPath(sourcePath, archivePath PathString) *TarArchive

+ func (t *TarArchive) Create() Runner

+ func (t *TarArchive) Extract(extractDir PathString) Runner

+ func (t *TarArchive) Update() Runner

+ type Task func(ctx context.Context) error

+ func Chdir(newWorkdir PathString, runner Runner) Task

+ func CopyFile(source, target PathString) Task

+ func Download(url string, location PathString) Task

+ func Error(msg string, args ...any) Task

+ func IfError(canErr Runner, handler Runner) Task

+ func IfExists(file PathString, r Runner) Task

+ func IfNotExists(file PathString, r Runner) Task

+ func Mkdir(dir PathString, perm os.FileMode) Task

+ func MkdirAll(dir PathString, perm os.FileMode) Task

+ func MoveFile(source, target PathString) Task

+ func Plain(fn func()) Task

+ func Print(msg string, args ...any) Task

+ func RemoveDir(file PathString) Task

+ func RemoveFile(file PathString) Task

+ func WithoutContext(fn func() error) Task

+ func WithoutErr(fn func(context.Context)) Task

+ func (t Task) Catch(catch func(error) error) Task

+ func (t Task) Run(ctx context.Context) error

+ func (t Task) Then(other Runner) Task

+ type ZipArchive struct

+ func Zip(location PathString) *ZipArchive

+ func (z *ZipArchive) AddFile(sourcePath PathString) *ZipArchive

+ func (z *ZipArchive) AddFileWithPath(sourcePath, archivePath PathString) *ZipArchive

+ func (z *ZipArchive) Create() Runner

+ func (z *ZipArchive) Extract(extractDir PathString) Runner

+ func (z *ZipArchive) Update() Runner

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL