util

package

v0.1.1 Latest Latest Go to latest Published: Feb 18, 2022 License: MIT Imports: 18 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

Repository

github.com/Cray-HPE/yapl

Links

Open Source Insights

Documentation ¶

Index ¶

func ClearCache() error
func DocGenFromPipeline(cfg *Config) error
func ExecutePipeline(cfg *Config) error
func HasRunAlready(id string) bool
func IsCached(id string) bool
func MarkdownToText(md string) string
func NewTemplateFilter(varsFile string) (func([]byte) ([]byte, error), error)
func PopFromCache(id string) (model.GenericYAML, error)
func PushToCache(genericYAML model.GenericYAML) error
func ReadYAML(filePath string) (model.GenericYAML, error)
func RenderPipeline(cfg *Config) (int, string, error)
type Config
type SafeCounter
type TemplateFilter
type TmplVars

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ClearCache ¶

func ClearCache() error

func DocGenFromPipeline ¶

func DocGenFromPipeline(cfg *Config) error

func ExecutePipeline ¶

func ExecutePipeline(cfg *Config) error

func HasRunAlready ¶ added in v0.0.2

func HasRunAlready(id string) bool

func IsCached ¶ added in v0.0.2

func IsCached(id string) bool

func MarkdownToText ¶

func MarkdownToText(md string) string

func NewTemplateFilter ¶

func NewTemplateFilter(varsFile string) (func([]byte) ([]byte, error), error)

NewTemplateFilter creates a new Template Filter based in the file and inline variables.

func PopFromCache ¶ added in v0.0.2

func PopFromCache(id string) (model.GenericYAML, error)

func PushToCache ¶ added in v0.0.2

func PushToCache(genericYAML model.GenericYAML) error

func ReadYAML ¶

func ReadYAML(filePath string) (model.GenericYAML, error)

func RenderPipeline ¶

func RenderPipeline(cfg *Config) (int, string, error)

Types ¶

type Config ¶

type Config struct {
	File          string
	Debug         bool
	NoColor       bool
	Vars          string
	OutputDir     string
	NoCache       bool
	ConsoleOutput bool
}

type SafeCounter ¶ added in v0.0.2

type SafeCounter struct {
	// contains filtered or unexported fields
}

SafeCounter is safe to use concurrently.

func (*SafeCounter) Inc ¶ added in v0.0.2

func (c *SafeCounter) Inc()

Inc increments the counter for the given key.

func (*SafeCounter) Lock ¶ added in v0.0.2

func (c *SafeCounter) Lock()

func (*SafeCounter) Unlock ¶ added in v0.0.2

func (c *SafeCounter) Unlock()

func (*SafeCounter) Value ¶ added in v0.0.2

func (c *SafeCounter) Value() int

Value returns the current value of the counter for the given key.

type TemplateFilter ¶

type TemplateFilter func([]byte) ([]byte, error)

TemplateFilter is the type of the yapl Template Filter which include custom variables and functions.

type TmplVars ¶

type TmplVars struct {
	Vars map[string]interface{}
}

Source Files ¶

View all Source files

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