template

Documentation

Index

• func DeleteCachedTemplate(path string) error
• func DeleteLocalCacheDir(cacheDir string) (string, error)
• type CacheSourceOpts
• type GitSource
  • func (src *GitSource[T]) Parse() (*RawTemplate, error)
  • func (src *GitSource[T]) Read() (*TemplateInfo[T], error)
  • func (src *GitSource[T]) Validate() ([]*TemplateValidated, error)
• type GitSourceOptions
  • func (s *GitSourceOptions) CacheDirName() string
  • func (s *GitSourceOptions) CachePath() string
• type LocalSource
  • func (src *LocalSource[T]) Parse() (*RawTemplate, error)
  • func (src *LocalSource[T]) Read() (*TemplateInfo[T], error)
  • func (src *LocalSource[T]) Validate() ([]*TemplateValidated, error)
• type RawTemplate
  • func (t *RawTemplate) ToJson() (*RawTemplate, error)
  • func (t *RawTemplate) ToYaml() (*RawTemplate, error)
• type RemoteSource
  • func (src *RemoteSource[T]) Parse() (*RawTemplate, error)
  • func (src *RemoteSource[T]) Read() (*TemplateInfo[T], error)
  • func (src *RemoteSource[T]) Validate() ([]*TemplateValidated, error)
• type SourceLoader
  • func NewGitLoader[T TemplateType](opts *GitSourceOptions, name string) SourceLoader[T]
  • func NewLocalCachedLoader[T TemplateType](path string, cacheDir string) SourceLoader[T]
  • func NewLocalLoader[T TemplateType](path string) SourceLoader[T]
  • func NewRemoteLoader[T TemplateType](url string, cacheDir string) SourceLoader[T]
• type SourceType
  • func (s SourceType) String() string
• type SourceValidator
  • func NewGitValidator(opts *GitSourceOptions, name string) SourceValidator
  • func NewLocalValidator(path string) SourceValidator
  • func NewRemoteValidator(url string) SourceValidator
• type TemplateInfo
• type TemplateType
• type TemplateValidated
• type TemplateValue

Functions

func DeleteCachedTemplate

func DeleteCachedTemplate(path string) error

func DeleteLocalCacheDir

func DeleteLocalCacheDir(cacheDir string) (string, error)

Types

type CacheSourceOpts

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

type GitSource

type GitSource[T TemplateType] struct {
	// contains filtered or unexported fields
}

func (*GitSource[T]) Parse

func (src *GitSource[T]) Parse() (*RawTemplate, error)

func (*GitSource[T]) Read

func (src *GitSource[T]) Read() (*TemplateInfo[T], error)

func (*GitSource[T]) Validate

func (src *GitSource[T]) Validate() ([]*TemplateValidated, error)

type GitSourceOptions

type GitSourceOptions struct {
	CacheBaseDir    string
	RepositoryUrl   string
	DefaultRevision string
	Revision        string
	AllowOffline    bool
}

func (*GitSourceOptions) CacheDirName

func (s *GitSourceOptions) CacheDirName() string

func (*GitSourceOptions) CachePath

func (s *GitSourceOptions) CachePath() string

type LocalSource

type LocalSource[T TemplateType] struct {
	// contains filtered or unexported fields
}

func (*LocalSource[T]) Parse

func (src *LocalSource[T]) Parse() (*RawTemplate, error)

func (*LocalSource[T]) Read

func (src *LocalSource[T]) Read() (*TemplateInfo[T], error)

func (*LocalSource[T]) Validate

func (src *LocalSource[T]) Validate() ([]*TemplateValidated, error)

type RawTemplate

type RawTemplate TemplateValue[string]

alias to fix receiver types with generics

func (*RawTemplate) ToJson

func (t *RawTemplate) ToJson() (*RawTemplate, error)

func (*RawTemplate) ToYaml

func (t *RawTemplate) ToYaml() (*RawTemplate, error)

type RemoteSource

type RemoteSource[T TemplateType] struct {
	// contains filtered or unexported fields
}

func (*RemoteSource[T]) Parse

func (src *RemoteSource[T]) Parse() (*RawTemplate, error)

func (*RemoteSource[T]) Read

func (src *RemoteSource[T]) Read() (*TemplateInfo[T], error)

func (*RemoteSource[T]) Validate

func (src *RemoteSource[T]) Validate() ([]*TemplateValidated, error)

type SourceLoader

type SourceLoader[T TemplateType] interface {
	Read() (*TemplateInfo[T], error)
}

func NewGitLoader

func NewGitLoader[T TemplateType](opts *GitSourceOptions, name string) SourceLoader[T]

func NewLocalCachedLoader

func NewLocalCachedLoader[T TemplateType](path string, cacheDir string) SourceLoader[T]

func NewLocalLoader

func NewLocalLoader[T TemplateType](path string) SourceLoader[T]

func NewRemoteLoader

func NewRemoteLoader[T TemplateType](url string, cacheDir string) SourceLoader[T]

type SourceType

type SourceType uint

const (
	Local SourceType = iota
	Remote
	Git
)

func (SourceType) String

func (s SourceType) String() string

type SourceValidator

type SourceValidator interface {
	Parse() (*RawTemplate, error)
	Validate() ([]*TemplateValidated, error)
}

func NewGitValidator

func NewGitValidator(opts *GitSourceOptions, name string) SourceValidator

func NewLocalValidator

func NewLocalValidator(path string) SourceValidator

func NewRemoteValidator

func NewRemoteValidator(url string) SourceValidator

type TemplateInfo

type TemplateInfo[T TemplateType] struct {
	Value      *TemplateValue[T]
	SourceType SourceType
	Path       string // absolute path cached or resolved git path
	Revision   string // local/remote or git commit
}

type TemplateType

type TemplateType interface {
	string | box.BoxV1 | lab.LabV1 | task.TaskV1 | lab.DumpV1
}

type TemplateValidated

type TemplateValidated struct {
	Value   *RawTemplate
	Path    string
	IsValid bool
}

type TemplateValue

type TemplateValue[T TemplateType] struct {
	Kind schema.SchemaKind
	Data T // string or actual model
}