runner

Documentation

Index

• Constants
• func ParseConfigFlag(f *flag.FlagSet) map[string]TomlInfo
• type Config
  • func InitConfig(path string) (cfg *Config, err error)
  • func (c *Config) GetPollingInterval() time.Duration
  • 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 TomlInfo

Constants

const DefaultPollingInterval = 3 * time.Second

DefaultPollingInterval is 3 seconds for file changes.

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

Functions

func ParseConfigFlag

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

ParseConfigFlag parse toml information for flag

Types

type Config

type Config struct {
	Root        string     `toml:"root"`
	TmpDir      string     `toml:"tmp_dir"`
	TestDataDir string     `toml:"testdata_dir"`
	Polling     cfgPolling `toml:"polling"`
	Build       cfgBuild   `toml:"build"`
	Color       cfgColor   `toml:"color"`
	Log         cfgLog     `toml:"log"`
	Misc        cfgMisc    `toml:"misc"`
	Screen      cfgScreen  `toml:"screen"`
}

Config is the main configuration structure for Air.

func InitConfig

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

InitConfig initializes the configuration.

func (*Config) GetPollingInterval

func (c *Config) GetPollingInterval() time.Duration

GetPollingInterval returns the polling interval.

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 TomlInfo

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

TomlInfo is a struct for toml config file