util

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
  • func (c *SafeCounter) Inc()
  • func (c *SafeCounter) Lock()
  • func (c *SafeCounter) Unlock()
  • func (c *SafeCounter) Value() int
• type TemplateFilter
• type TmplVars

Functions

func ClearCache

func ClearCache() error

func DocGenFromPipeline

func DocGenFromPipeline(cfg *Config) error

func ExecutePipeline

func ExecutePipeline(cfg *Config) error

func HasRunAlready

func HasRunAlready(id string) bool

func IsCached

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

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

func PushToCache

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

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

SafeCounter is safe to use concurrently.

func (*SafeCounter) Inc

func (c *SafeCounter) Inc()

Inc increments the counter for the given key.

func (*SafeCounter) Lock

func (c *SafeCounter) Lock()

func (*SafeCounter) Unlock

func (c *SafeCounter) Unlock()

func (*SafeCounter) Value

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{}
}