filestore

Documentation

Index

• type FileStore
  • func New(baseDir string, updateInterval time.Duration, logger func(args ...interface{})) (*FileStore, error)
  • func (f *FileStore) Add(theme *models.Theme) error
  • func (f *FileStore) AddPackage(p *packages.Package) error
  • func (f *FileStore) Get(themeName string) (store.Theme, error)
  • func (f *FileStore) GetAsset(assetName string) (*models.ThemeAsset, error)
  • func (f *FileStore) List() ([]*models.Theme, error)
  • func (f *FileStore) UpdateThemeToRef(themeName, commitHash string) error
• type Theme
  • func (t *Theme) GetAsset(assetName string) (*models.ThemeAsset, error)
  • func (t *Theme) GetTemplate(templateName string) (*models.ThemeTemplate, error)
  • func (t *Theme) Proto() *models.Theme
  • func (t *Theme) Ref() (string, bool)

Types

type FileStore

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

FileStore stores and loads templates on the filesystem

func New

func New(baseDir string, updateInterval time.Duration, logger func(args ...interface{})) (*FileStore, error)

New returns a new file store which updates periodically

func (*FileStore) Add

func (f *FileStore) Add(theme *models.Theme) error

Add a theme directly to the themeDir.

func (*FileStore) AddPackage

func (f *FileStore) AddPackage(p *packages.Package) error

AddPackage adds a theme from a theme file by cloning it from the VCS location to the themeDir.

func (*FileStore) Get

func (f *FileStore) Get(themeName string) (store.Theme, error)

Get a theme from the file store. Template and asset data (i.e. the file contents) are NOT loaded.

func (*FileStore) GetAsset

func (f *FileStore) GetAsset(assetName string) (*models.ThemeAsset, error)

func (*FileStore) List

func (f *FileStore) List() ([]*models.Theme, error)

List all themes in the store

func (*FileStore) UpdateThemeToRef

func (f *FileStore) UpdateThemeToRef(themeName, commitHash string) error

type Theme

type Theme struct {
	*models.Theme
	// contains filtered or unexported fields
}

func (*Theme) GetAsset

func (t *Theme) GetAsset(assetName string) (*models.ThemeAsset, error)

func (*Theme) GetTemplate

func (t *Theme) GetTemplate(templateName string) (*models.ThemeTemplate, error)

func (*Theme) Proto

func (t *Theme) Proto() *models.Theme

func (*Theme) Ref

func (t *Theme) Ref() (string, bool)