watcher

README

Watcher

Make it create watcher easier.

Installation

To install the package, run:

go get github.com/go-zoox/watcher

Getting Started

import (
  "testing"
  "github.com/go-zoox/watcher"
)

func main(t *testing.T) {
	pwd, _ := os.Getwd()
	watcher := watcher.New(&watcher.Config{
		Context: path.Join(pwd, "example/program"),
		Ignores: []string{},
		Commands: []string{
			"go run .",
		},
	})

	if err := watcher.Watch(); err != nil {
		logger.Error("failed to watch: %s", err)
	}
}

Inspired By

• silenceper/gowatch - 🚀 gowatch is a command line tool that builds and (re)starts your go project everytime you save a Go or template file.
• fsnotify/fsnotify - Cross-platform file system notifications for Go.

License

GoZoox is released under the MIT License.

Documentation

Index

• Variables
• type Config
• type Watcher
  • func New(cfg *Config) Watcher

Variables

var Version = "1.0.3"

Version is the current version of the package.

Types

type Config

type Config struct {
	Context  string
	Paths    []string
	Ignores  []string
	Commands []string
	Env      map[string]string
}

type Watcher

type Watcher interface {
	Watch() error
	Stop() error
}

func New

func New(cfg *Config) Watcher