templates

package

v0.7.2 Latest Latest Go to latest Published: Jan 16, 2024 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const PATH_TOKEN = "{path}"

View Source

const PROJECT_TOKEN = "{project}"

View Source

const SPACE_TOKEN = "{space}"

This section is empty.

func Add(name string, steps []Step) error

func GetTemplateNames(templates map[string][]Step) []string

func ListTemplates() map[string][]Step

func Remove(name string) error

func Run(template Template, space, project, path string) error

Run goes over each steps of the template and execute them.

type Step struct {
	Command []string `json:"command"`
	Dir     string   `json:"dir"`
}

Step represents a command to execute in a specific directory.

func FindTemplate(name string) ([]Step, bool)

FindTemplate returns the steps associated with a template name, if any was found.

type Template = []Step

func Default() Template

Default returns the default template to add when there is not configuration file yet.

func FromConfig(key string) (Template, error)

func FromFile(file *os.File) (Template, error)