tiltextension

Documentation

Overview

Package extension implements Tilt extensions. This is not the internal Starkit abstraction, but the user-visible feature. In a Tiltfile, you can write `load("ext://foo", "bar")` to load the function bar from the extension foo.

Index

• type Downloader
• type Extension
  • func NewExtension(fetcher Fetcher, store Store) *Extension
  • func (e *Extension) LocalPath(t *starlark.Thread, arg string) (localPath string, err error)
  • func (e Extension) NewState() interface{}
  • func (e *Extension) OnStart(env *starkit.Environment) error
• type Fetcher
• type GithubFetcher
  • func NewGithubFetcher(dlr Downloader) *GithubFetcher
  • func (f *GithubFetcher) CleanUp() error
  • func (f *GithubFetcher) Fetch(ctx context.Context, moduleName string) (ModuleContents, error)
• type LocalStore
  • func NewLocalStore(baseDir string) *LocalStore
  • func (s *LocalStore) ModulePath(ctx context.Context, moduleName string) (string, error)
  • func (s *LocalStore) Write(ctx context.Context, contents ModuleContents) (string, error)
• type Metadata
• type MetadataFile
• type ModuleContents
• type State
  • func GetState(m starkit.Model) (State, error)
  • func MustState(model starkit.Model) State
• type Store
• type TempDirDownloader
  • func NewTempDirDownloader() (*TempDirDownloader, error)
  • func (d *TempDirDownloader) Download(pkg string) (string, error)
  • func (d *TempDirDownloader) RootDir() string

Types

type Downloader

type Downloader interface {
	RootDir() string
	Download(pkg string) (string, error)
}

type Extension

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

func NewExtension

func NewExtension(fetcher Fetcher, store Store) *Extension

func (*Extension) LocalPath

func (e *Extension) LocalPath(t *starlark.Thread, arg string) (localPath string, err error)

func (Extension) NewState

func (e Extension) NewState() interface{}

func (*Extension) OnStart

func (e *Extension) OnStart(env *starkit.Environment) error

type Fetcher

type Fetcher interface {
	Fetch(ctx context.Context, moduleName string) (ModuleContents, error)
	CleanUp() error
}

type GithubFetcher

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

func NewGithubFetcher

func NewGithubFetcher(dlr Downloader) *GithubFetcher

func (*GithubFetcher) CleanUp

func (f *GithubFetcher) CleanUp() error

func (*GithubFetcher) Fetch

func (f *GithubFetcher) Fetch(ctx context.Context, moduleName string) (ModuleContents, error)

type LocalStore

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

func NewLocalStore

func NewLocalStore(baseDir string) *LocalStore

func (*LocalStore) ModulePath

func (s *LocalStore) ModulePath(ctx context.Context, moduleName string) (string, error)

func (*LocalStore) Write

func (s *LocalStore) Write(ctx context.Context, contents ModuleContents) (string, error)

TODO(dmiller): should this error if we try to write an extension with the same name as one that already exists?

type Metadata

type Metadata struct {
	Name              string
	ExtensionRegistry string
	TimeFetched       time.Time
}

type MetadataFile

type MetadataFile struct {
	Extensions []Metadata
}

type ModuleContents

type ModuleContents struct {
	Name              string
	Dir               string
	ExtensionRegistry string
	TimeFetched       time.Time
}

type State

type State struct {
	ExtsLoaded map[string]bool
}

func GetState

func GetState(m starkit.Model) (State, error)

func MustState

func MustState(model starkit.Model) State

type Store

type Store interface {
	// ModulePath is used to check if an extension exists before fetching it
	// Returns ErrNotExist if module doesn't exist
	ModulePath(ctx context.Context, moduleName string) (string, error)
	Write(ctx context.Context, contents ModuleContents) (string, error)
}

type TempDirDownloader

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

func NewTempDirDownloader

func NewTempDirDownloader() (*TempDirDownloader, error)

func (*TempDirDownloader) Download

func (d *TempDirDownloader) Download(pkg string) (string, error)

func (*TempDirDownloader) RootDir

func (d *TempDirDownloader) RootDir() string