generator

Documentation

Index

• Constants
• func AuthMethodForURL(url string) transport.AuthMethod
• func FilepathFromURL(u string) (string, error)
• func IsAlias(templateID string) bool
• func IsFilePath(templateID string) bool
• func IsRepoURL(templateID string) bool
• func IsSSH(templateID string) bool
• func TypeForTemplateID(templateID string) string
• type SkelpGenerator
  • func New(options SkelpOptions) *SkelpGenerator
  • func (sg *SkelpGenerator) AddAlias(alias, fileOrUrl string) error
  • func (sg *SkelpGenerator) AliasMap() (map[string]string, error)
  • func (sg *SkelpGenerator) Generate(templateID string, dataProvider provider.DataProvider) error
  • func (sg *SkelpGenerator) IDForAlias(alias string) (string, error)
  • func (sg *SkelpGenerator) InitSkelpHome() (string, error)
  • func (sg *SkelpGenerator) RemoveAlias(alias string) error
• type SkelpOptions
  • func DefaultOptions() SkelpOptions

Constants

const (
	ErrAliasNotFound        = "Alias '%s' not found in registry"
	ErrInvalidAlias         = "Invalid alias '%s'"
	ErrInvalidAliasTemplate = "Invalid alias template: '%s' must be a filepath or url"
)

const (
	ErrBlankTemplateID           = "Template ID not provided"
	ErrTemplateRootNotFound      = "Template root not found %s"
	ErrSkelpTemplatesDirNotFound = "Skelp templates dir not found %s"
	ErrCacheNotFoundNoDownload   = "Cached template not found and downloads are turned off: %s"
)

const (
	TIDTypeRepo    = "REPO"
	TIDTypeFile    = "FILE"
	TIDTypeAlias   = "ALIAS"
	TIDTypeUnknown = "UNKNOWN"
)

Functions

func AuthMethodForURL

func AuthMethodForURL(url string) transport.AuthMethod

func FilepathFromURL

func FilepathFromURL(u string) (string, error)

func IsAlias

func IsAlias(templateID string) bool

func IsFilePath

func IsFilePath(templateID string) bool

func IsRepoURL

func IsRepoURL(templateID string) bool

func IsSSH

func IsSSH(templateID string) bool

func TypeForTemplateID

func TypeForTemplateID(templateID string) string

Types

type SkelpGenerator

type SkelpGenerator struct {
	SkelpHome string
	// contains filtered or unexported fields
}

func New

func New(options SkelpOptions) *SkelpGenerator

func (*SkelpGenerator) AddAlias

func (sg *SkelpGenerator) AddAlias(alias, fileOrUrl string) error

func (*SkelpGenerator) AliasMap

func (sg *SkelpGenerator) AliasMap() (map[string]string, error)

func (*SkelpGenerator) Generate

func (sg *SkelpGenerator) Generate(templateID string, dataProvider provider.DataProvider) error

func (*SkelpGenerator) IDForAlias

func (sg *SkelpGenerator) IDForAlias(alias string) (string, error)

func (*SkelpGenerator) InitSkelpHome

func (sg *SkelpGenerator) InitSkelpHome() (string, error)

func (*SkelpGenerator) RemoveAlias

func (sg *SkelpGenerator) RemoveAlias(alias string) error

type SkelpOptions

type SkelpOptions struct {
	Download          bool
	CheckForUpdates   bool
	OutputDir         string
	HomeDirOverride   string
	SkelpDirOverride  string
	OverwriteProvider provider.OverwriteProvider
	BasicAuthProvider provider.BasicAuthProvider
}

func DefaultOptions

func DefaultOptions() SkelpOptions