README
¶
Watcher 
Watcher is a command line tool inspired by fresh and used for watching .go file changes, and restarting the app in case of an update/delete/add operation.
File change event listening infrastructure depends on stable version (.v1) of fsnotify
Installation
Get the package with:
go get github.com/canthefason/go-watcher
Install the binary under go/bin folder:
go install github.com/canthefason/go-watcher/cmd/watcher
If not added please append your go/bin folder to PATH environment variable.
Usage
cd /path/to/myapp
Start watcher:
watcher
Watcher works like your native binary package. You can pass all the arguments that you are currently using.
myapp -c config -p 7000 -h localhost
watcher -c config -p 7000 -h localhost
When you run the command it starts watching folders recursively, starting from the current working directory. It only watches .go and .tmpl files and ignores hidden folders.
watcher -c config -run github.com/username/somerootpackagename
When your GOPATH is set, you can run your apps via their package names with -run parameter. By default it watches the underlying folder with subfolders.
watcher -c config -run github.com/username/somerootpackagename -watch github.com/username
For the cases where your app depends on a few packages that are still in development, and you want to watch all the changes including those packages, you can pass a different package name for watching with -watch parameter.
Micro management of the watched packages are not supported yet. So you cannot exclude any folders.
Author
License
The MIT License (MIT) - see LICENSE.md for more details
Documentation
¶
Overview ¶
Watcher is a command line tool inspired by fresh (https://github.com/pilu/fresh) and used for watching .go file changes, and restarting the app in case of an update/delete/add operation. After you installed it, you can run your apps with their default parameters as: watcher -c config -p 7000 -h localhost
Package watcher watches all file changes via fsnotify package and sends update events to builder
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrPathNotSet = errors.New("gopath not set")
GoPath not set error
Functions ¶
Types ¶
type Params ¶
type Params struct {
// Package parameters
Package []string
// Go-Watcher parameters
System map[string]string
}
func NewParams ¶
func NewParams() *Params
NewParams creates a new instance of Params and returns the pointer
func PrepareArgs ¶
PrepareArgs filters the system parameters from package parameters and returns Params instance
func (*Params) CloneRun ¶
func (p *Params) CloneRun()
CloneRun copies run parameter value to watch parameter in-case watch parameter does not exist
func (*Params) GetPackage ¶
type Runner ¶
type Runner struct {
// contains filtered or unexported fields
}
Runner listens change events and depending on that kills the obsolete process, and runs the new one
type Watcher ¶
type Watcher struct {
// contains filtered or unexported fields
}
Watcher watches the file change events from fsnotify and sends update messages. It is also used as a fsnotify.Watcher wrapper
func MustRegisterWatcher ¶
MustRegisterWatcher creates a new Watcher and starts listening given folders
Source Files
Directories