api

package
v1.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2025 License: MIT Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Requirement

type Requirement interface {
	Info() *RequirementInfo
	Ensure(env RequirementEnvironment) (*RequirementResult, error)
}

type RequirementEnvironment

type RequirementEnvironment interface {
	BuildDir() string
	RootDir() string
}

type RequirementInfo

type RequirementInfo struct {
	Description string
}

type RequirementResult

type RequirementResult struct {
	AddToPath []string
	// template to append to init file, Args will be available under {{.Extra.<key>}}
	BashRcAppend *Template
}

type Specification

type Specification struct {
	Requirements []Requirement
	// empty means <script dir>
	RootDir string
	// Console prompt. If empty, default will be used
	PromptText string
}

type Template

type Template struct {
	Template string
	Args     map[string]any
}

Template passed to text/template

Jump to

Keyboard shortcuts

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