runner

Documentation

Overview

Package runner …

Index

• Constants
• Variables
• func ParseConfigFlag(f *flag.FlagSet) map[string]TomlInfo
• type BuildFailedMsg
• type Config
  • func InitConfig(path string) (cfg *Config, err error)
  • func (c *Config) WithArgs(args map[string]TomlInfo)
• type Engine
  • func NewEngine(cfgPath string, debugMode bool) (*Engine, error)
  • func NewEngineWithConfig(cfg *Config, debugMode bool) (*Engine, error)
  • func (e *Engine) Run()
  • func (e *Engine) Stop()
• type Proxy
  • func NewProxy(cfg *cfgProxy) *Proxy
  • func (p *Proxy) BuildFailed(msg BuildFailedMsg)
  • func (p *Proxy) Reload()
  • func (p *Proxy) Run()
  • func (p *Proxy) Stop() error
• type ProxyStream
  • func NewProxyStream() *ProxyStream
  • func (stream *ProxyStream) AddSubscriber() *Subscriber
  • func (stream *ProxyStream) BuildFailed(err BuildFailedMsg)
  • func (stream *ProxyStream) Reload()
  • func (stream *ProxyStream) RemoveSubscriber(id int32)
  • func (stream *ProxyStream) Stop()
• type StreamMessage
  • func (m StreamMessage) AsSSE() string
• type StreamMessageType
• type Streamer
• type Subscriber
• type TomlInfo

Constants

const (
	//PlatformWindows const for windows
	PlatformWindows = "windows"
)

Variables

var ProxyScript string

Functions

func ParseConfigFlag

func ParseConfigFlag(f *flag.FlagSet) map[string]TomlInfo

ParseConfigFlag parse toml information for flag

Types

type BuildFailedMsg

type BuildFailedMsg struct {
	Error   string `json:"error"`
	Command string `json:"command"`
	Output  string `json:"output"`
}

type Config

type Config struct {
	Root        string    `toml:"root" usage:"Working directory, . or absolute path, please note that the directories following must be under root"`
	TmpDir      string    `toml:"tmp_dir" usage:"Temporary directory for air"`
	TestDataDir string    `toml:"testdata_dir"`
	Build       cfgBuild  `toml:"build"`
	Color       cfgColor  `toml:"color"`
	Log         cfgLog    `toml:"log"`
	Misc        cfgMisc   `toml:"misc"`
	Screen      cfgScreen `toml:"screen"`
	Proxy       cfgProxy  `toml:"proxy"`
}

Config is the main configuration structure for Air.

func InitConfig

func InitConfig(path string) (cfg *Config, err error)

InitConfig initializes the configuration.

func (*Config) WithArgs

func (c *Config) WithArgs(args map[string]TomlInfo)

WithArgs returns a new config with the given arguments added to the configuration.

type Engine

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

Engine ...

func NewEngine

func NewEngine(cfgPath string, debugMode bool) (*Engine, error)

NewEngine ...

func NewEngineWithConfig

func NewEngineWithConfig(cfg *Config, debugMode bool) (*Engine, error)

NewEngineWithConfig ...

func (*Engine) Run

func (e *Engine) Run()

Run run run

func (*Engine) Stop

func (e *Engine) Stop()

Stop the air

type Proxy

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

func NewProxy

func NewProxy(cfg *cfgProxy) *Proxy

func (*Proxy) BuildFailed

func (p *Proxy) BuildFailed(msg BuildFailedMsg)

func (*Proxy) Reload

func (p *Proxy) Reload()

func (*Proxy) Run

func (p *Proxy) Run()

func (*Proxy) Stop

func (p *Proxy) Stop() error

type ProxyStream

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

func NewProxyStream

func NewProxyStream() *ProxyStream

func (*ProxyStream) AddSubscriber

func (stream *ProxyStream) AddSubscriber() *Subscriber

func (*ProxyStream) BuildFailed

func (stream *ProxyStream) BuildFailed(err BuildFailedMsg)

func (*ProxyStream) Reload

func (stream *ProxyStream) Reload()

func (*ProxyStream) RemoveSubscriber

func (stream *ProxyStream) RemoveSubscriber(id int32)

func (*ProxyStream) Stop

func (stream *ProxyStream) Stop()

type StreamMessage

type StreamMessage struct {
	Type StreamMessageType
	Data interface{}
}

func (StreamMessage) AsSSE

func (m StreamMessage) AsSSE() string

type StreamMessageType

type StreamMessageType string

const (
	StreamMessageReload      StreamMessageType = "reload"
	StreamMessageBuildFailed StreamMessageType = "build-failed"
)

type Streamer

type Streamer interface {
	AddSubscriber() *Subscriber
	RemoveSubscriber(id int32)
	Reload()
	BuildFailed(msg BuildFailedMsg)
	Stop()
}

type Subscriber

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

type TomlInfo

type TomlInfo struct {
	Value *string
	// contains filtered or unexported fields
}

TomlInfo is a struct for toml config file