orderfile

package

v0.0.0-...-345791d Latest Latest Go to latest Published: Jan 14, 2021 License: MIT Imports: 4 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

Package orderfile file defines models for Orderfile.yml and its particular substructures as well as some basic abstractraction on data reading.

This section is empty.

This section is empty.

This section is empty.

type Cmd string

Cmd represents single script command

type Order struct {
	Description string `yaml:"description"`
	Script      []Cmd  `yaml:"script"`
}

Order represents single command order

type Orderfile struct {
	Version string `yaml:"version"`
	Orders  Orders `yaml:"orders"`
}

Orderfile represents single instance of orderfile

func NewOrderFileFrom(path string) (*Orderfile, error)

NewOrderFileFrom parses orderfile under given path and returns it's object representation

func (o *Orderfile) GetOrder(orderName string) (*Order, bool)

GetOrder returns order under given name Or false status for when there is no order with given name

func (o *Orderfile) ListOrdersNames() []string

ListOrdersNames returns string slice with all defined orders

type Orders map[string]Order

Orders represents orders section of file