watch

Documentation

Index

• Variables
• type FSNotifyTracker
  • func (t *FSNotifyTracker) Add(path string) error
  • func (t *FSNotifyTracker) Close() error
  • func (t *FSNotifyTracker) Errors() chan error
  • func (t *FSNotifyTracker) Events() chan fsnotify.Event
  • func (t *FSNotifyTracker) IsTracked(path string) bool
  • func (t *FSNotifyTracker) Remove(path string)
  • func (t *FSNotifyTracker) Tracked() []string
• type Tracker
  • func NewTracker(cfg *c.Config) Tracker

Variables

var OneRunCmd = cli.Command{
	Name:    "one",
	Aliases: []string{"1"},
	Usage:   "runs the pipeline once and exits",
	Action:  oneRun,
	Flags:   []cli.Flag{},
}

OneRunCmd is the command to run a pipeline once.

var WatchCmd = cli.Command{
	Name:   "watch",
	Usage:  "starts watching folder(s)",
	Action: watchIt,
	Flags:  []cli.Flag{},
}

WatchCmd is the command that starts a watching files in the project folder and triggers the pipeline once a relevant change did happen.

Types

type FSNotifyTracker

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

FSNotifyTracker is a tracker that uses FSNotify.

func (*FSNotifyTracker) Add

func (t *FSNotifyTracker) Add(path string) error

Add adds a path to the list of tracked paths

func (*FSNotifyTracker) Close

func (t *FSNotifyTracker) Close() error

Close stops all watching and event publication of this tracker.

func (*FSNotifyTracker) Errors

func (t *FSNotifyTracker) Errors() chan error

Errors returns a channel that will return all errors issued by this tracker.

func (*FSNotifyTracker) Events

func (t *FSNotifyTracker) Events() chan fsnotify.Event

Events returns a channel that will deliver all events issued by this tracker.

func (*FSNotifyTracker) IsTracked

func (t *FSNotifyTracker) IsTracked(path string) bool

IsTracked determines whether the passed path is tracked (true) or not (false).

func (*FSNotifyTracker) Remove

func (t *FSNotifyTracker) Remove(path string)

Remove removes the handed path from the tracker.

func (*FSNotifyTracker) Tracked

func (t *FSNotifyTracker) Tracked() []string

Tracked returns all paths that this tracker will report changes on.

type Tracker

type Tracker interface {
	Tracked() []string
	Add(p string) error
	IsTracked(p string) bool
	Remove(path string)
	Events() chan fsnotify.Event
	Errors() chan error
	Close() error
}

Tracker keeps track of file system changes, and let's you control what it monitors.

func NewTracker

func NewTracker(cfg *c.Config) Tracker

NewTracker returns a new tracker based on the config passed.