shared

package

v0.1.9 Latest Latest Go to latest Published: Mar 20, 2021 License: Apache-2.0 Imports: 8 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

This section is empty.

View Source

var (
	// ErrNotABool indicates a string value that cannot be converted to a bool
	ErrNotABool = errors.New("Not a valid boolean string")
)

View Source

var ErrNotLicense = errors.New("Licenses must be a single string or an array of strings")

ErrNotLicense indicates that a Licenses is being read from invalid YAML or written when empty

This section is empty.

type DefaultFalse struct {
	Valid bool
	Bool  bool
}

DefaultFalse is a boolean which should omitted if false when marshaling

func (df DefaultFalse) MarshalYAML() (out interface{}, err error)

MarshalYAML writes a DefaultFalse as "yes" if true and omits it if empty or invalid

func (df *DefaultFalse) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML converts a string to a DefaultFalse based on its value

type DefaultTrue struct {
	Valid bool
	Bool  bool
}

DefaultTrue is a boolean which should omitted if true when marshaling

func (dt DefaultTrue) MarshalYAML() (out interface{}, err error)

MarshalYAML writes a DefaultTrue as "no" if false and omits it if empty or invalid

func (dt *DefaultTrue) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML converts a string to a DefaultTrue based on its value

type Licenses []yaml.Node

Licenses is allowed to contain one or more SPDX license identifiers, but may be a scalar or a list in YAML

func (l Licenses) MarshalYAML() (out interface{}, err error)

MarshalYAML converts Licenses to a string (singular) or list (plural) when writing YAML

func (l *Licenses) UnmarshalYAML(value *yaml.Node) error

UnmarshalYAML converts a string (singular) or list (plural) to Licenses when reading YAML

type Source map[string]string

Source is a single entry map of URI to hash or Git Reference

func NewSource(URI string) (src Source, err error)

NewSource builds a new Source from a URI

func UpdateSources(URIs []string) (srcs []Source, err error)

UpdateSources gets the hashes for one or more URI sources

Path	Synopsis
array
constant