README
¶
config
import "github.com/eunomie/dague/config"
Index
- Constants
- Variables
- func IsMapping(i interface{}) bool
- func IsScalar(i interface{}) bool
- func IsSequence(i interface{}) bool
- func YAML(sources [][]byte, strict bool) (*bytes.Buffer, error)
- func describe(i interface{}) string
- func merge(into, from interface{}, strict bool) (interface{}, error)
- type Build
- type Cache
- type Dague
- type Exec
- type Export
- type Fmt
- type Go
- type Goimports
- type Golangci
- type Govulncheck
- type Image
- type Lint
- type Target
- type Task
- type Tasks
- type mapping
- type sequence
Constants
const (
defaultConfigFile = ".dague.yml"
)
Variables
var defaults []byte
func IsMapping
func IsMapping(i interface{}) bool
IsMapping reports whether a type is a mapping in YAML, represented as a map[interface{}]interface{}.
func IsScalar
func IsScalar(i interface{}) bool
IsScalar reports whether a type is a scalar value in YAML.
func IsSequence
func IsSequence(i interface{}) bool
IsSequence reports whether a type is a sequence in YAML, represented as an []interface{}.
func YAML
func YAML(sources [][]byte, strict bool) (*bytes.Buffer, error)
YAML deep-merges any number of YAML sources, with later sources taking priority over earlier ones.
Maps are deep-merged. For example,
{"one": 1, "two": 2} + {"one": 42, "three": 3}
== {"one": 42, "two": 2, "three": 3}
Sequences are replaced. For example,
{"foo": [1, 2, 3]} + {"foo": [4, 5, 6]}
== {"foo": [4, 5, 6]}
In non-strict mode, duplicate map keys are allowed within a single source, with later values overwriting previous ones. Attempting to merge mismatched types (e.g., merging a sequence into a map) replaces the old value with the new.
Enabling strict mode returns errors in both of the above cases.
func describe
func describe(i interface{}) string
func merge
func merge(into, from interface{}, strict bool) (interface{}, error)
type Build
type Build struct {
Targets map[string]Target `yaml:"targets"`
}
type Cache
type Cache struct {
Target string `yaml:"target"`
}
type Dague
type Dague struct {
Vars map[string]string `yaml:"vars"`
Go Go `yaml:"go"`
Tasks Tasks `yaml:"tasks"`
}
func Load
func Load(ctx context.Context) (Dague, error)
func (*Dague) VarsDup
func (d *Dague) VarsDup() map[string]string
type Exec
type Exec struct {
Deps []string `yaml:"deps"`
Cmds string `yaml:"cmds"`
Export Export `yaml:"export"`
}
type Export
type Export struct {
Pattern string `yaml:"pattern"`
Path string `yaml:"path"`
}
type Fmt
type Fmt struct {
Formatter string `yaml:"formatter"`
Goimports Goimports `yaml:"goimports"`
}
type Go
type Go struct {
Image Image `yaml:"image"`
AppDir string `yaml:"appDir"`
Fmt Fmt `yaml:"fmt"`
Lint Lint `yaml:"lint"`
Build Build `yaml:"build"`
Exec map[string]Exec `yaml:"exec"`
}
type Goimports
type Goimports struct {
Locals []string `yaml:"locals"`
}
type Golangci
type Golangci struct {
Enable bool `yaml:"enable"`
Image string `yaml:"image"`
}
type Govulncheck
type Govulncheck struct {
Enable bool `yaml:"enable"`
}
type Image
type Image struct {
Src string `yaml:"src"`
AptPackages []string `yaml:"aptPackages"`
ApkPackages []string `yaml:"apkPackages"`
GoPackages []string `yaml:"goPackages"`
Mounts map[string]string `yaml:"mounts"`
Env map[string]string `yaml:"env"`
Caches []Cache `yaml:"caches"`
}
type Lint
type Lint struct {
Govulncheck Govulncheck `yaml:"govulncheck"`
Golangci Golangci `yaml:"golangci"`
}
type Target
type Target struct {
Path string `yaml:"path"`
Out string `yaml:"out"`
Env map[string]string `yaml:"env"`
Ldflags string `yaml:"ldflags"`
Platforms []string `yaml:"platforms,omitempty"`
}
type Task
type Task struct {
Deps []string `yaml:"deps"`
Cmds string `yaml:"cmds"`
}
type Tasks
type Tasks map[string]Task
type mapping
YAML has three fundamental types. When unmarshaled into interface{}, they're represented like this.
type mapping = map[interface{}]interface{}
func mergeMapping
func mergeMapping(into, from mapping, strict bool) (mapping, error)
type sequence
type sequence = []interface{}
Generated by gomarkdoc
Documentation
¶
Index ¶
- func IsMapping(i interface{}) bool
- func IsScalar(i interface{}) bool
- func IsSequence(i interface{}) bool
- func YAML(sources [][]byte, strict bool) (*bytes.Buffer, error)
- type Build
- type Cache
- type Dague
- type Exec
- type Export
- type Fmt
- type Go
- type Goimports
- type Golangci
- type Govulncheck
- type Image
- type Lint
- type Target
- type Task
- type Tasks
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsMapping ¶ added in v0.6.0
func IsMapping(i interface{}) bool
IsMapping reports whether a type is a mapping in YAML, represented as a map[interface{}]interface{}.
func IsScalar ¶ added in v0.6.0
func IsScalar(i interface{}) bool
IsScalar reports whether a type is a scalar value in YAML.
func IsSequence ¶ added in v0.6.0
func IsSequence(i interface{}) bool
IsSequence reports whether a type is a sequence in YAML, represented as an []interface{}.
func YAML ¶ added in v0.6.0
YAML deep-merges any number of YAML sources, with later sources taking priority over earlier ones.
Maps are deep-merged. For example,
{"one": 1, "two": 2} + {"one": 42, "three": 3}
== {"one": 42, "two": 2, "three": 3}
Sequences are replaced. For example,
{"foo": [1, 2, 3]} + {"foo": [4, 5, 6]}
== {"foo": [4, 5, 6]}
In non-strict mode, duplicate map keys are allowed within a single source, with later values overwriting previous ones. Attempting to merge mismatched types (e.g., merging a sequence into a map) replaces the old value with the new.
Enabling strict mode returns errors in both of the above cases.
Types ¶
type Dague ¶ added in v0.5.1
type Govulncheck ¶ added in v0.5.1
type Govulncheck struct {
Enable bool `yaml:"enable"`
}
type Lint ¶ added in v0.5.1
type Lint struct {
Govulncheck Govulncheck `yaml:"govulncheck"`
Golangci Golangci `yaml:"golangci"`
}
Source Files