cli

Documentation

Index

• type Blueprint
  • func (h *Blueprint) Add(p *cli.Context) error
  • func (h *Blueprint) Clean()
  • func (h *Blueprint) Insert(p *cli.Context) error
  • func (h *Blueprint) List() error
  • func (h *Blueprint) Remove(p *cli.Context) error
  • func (h *Blueprint) Run() error
• type Buffer
• type BufferOut
• type Cli
• type File
• type Project
• type Watcher

Types

type Blueprint

type Blueprint struct {
	*c.Settings `yaml:"-"`
	Projects    []Project   `yaml:"projects,omitempty" json:"projects,omitempty"`
	Sync        chan string `yaml:"-"`
}

Blueprint struct contains a projects list

func (*Blueprint) Add

func (h *Blueprint) Add(p *cli.Context) error

Add a new project

func (*Blueprint) Clean

func (h *Blueprint) Clean()

Clean duplicate projects

func (*Blueprint) Insert

func (h *Blueprint) Insert(p *cli.Context) error

Insert a new project in projects list

func (*Blueprint) List

func (h *Blueprint) List() error

List of all the projects

func (*Blueprint) Remove

func (h *Blueprint) Remove(p *cli.Context) error

Remove a project

func (*Blueprint) Run

func (h *Blueprint) Run() error

Run launches the toolchain for each project

type Buffer

type Buffer struct {
	StdOut []BufferOut `json:"stdOut"`
	StdLog []BufferOut `json:"stdLog"`
	StdErr []BufferOut `json:"stdErr"`
}

Buffer define an array buffer for each log files

type BufferOut

type BufferOut struct {
	Time   time.Time `json:"time"`
	Text   string    `json:"text"`
	Path   string    `json:"path"`
	Type   string    `json:"type"`
	Stream string    `json:"stream"`
	Errors []string  `json:"errors"`
}

BufferOut is used for exchange information between "realize cli" and "web realize"

type Cli

type Cli struct {
	Streams bool `yaml:"streams" json:"streams"`
}

Cli output status, enables or disables

type File

type File struct {
	Streams bool `yaml:"streams" json:"streams"`
	Logs    bool `yaml:"logs" json:"logs"`
	Errors  bool `yaml:"errors" json:"errors"`
}

File determinates the status of each log files (streams, logs, errors)

type Project

type Project struct {
	c.Settings    `yaml:"-"`
	LastChangedOn time.Time `yaml:"-" json:"-"`

	Name     string   `yaml:"name" json:"name"`
	Path     string   `yaml:"path" json:"path"`
	Fmt      bool     `yaml:"fmt" json:"fmt"`
	Test     bool     `yaml:"test" json:"test"`
	Generate bool     `yaml:"generate" json:"generate"`
	Bin      bool     `yaml:"bin" json:"bin"`
	Build    bool     `yaml:"build" json:"build"`
	Run      bool     `yaml:"run" json:"run"`
	Params   []string `yaml:"params" json:"params"`
	Watcher  Watcher  `yaml:"watcher" json:"watcher"`
	Cli      Cli      `yaml:"cli" json:"cli"`
	File     File     `yaml:"file" json:"file"`
	Buffer   Buffer   `yaml:"-" json:"buffer"`
	// contains filtered or unexported fields
}

Project defines the informations of a single project

type Watcher

type Watcher struct {
	// different before and after on re-run?
	Before  []string `yaml:"before" json:"before"`
	After   []string `yaml:"after" json:"after"`
	Paths   []string `yaml:"paths" json:"paths"`
	Ignore  []string `yaml:"ignore_paths" json:"ignore"`
	Exts    []string `yaml:"exts" json:"exts"`
	Preview bool     `yaml:"preview" json:"preview"`
}

Watcher struct defines the livereload's logic