interesting
/
gaper
mirror of https://github.com/maxcnunes/gaper.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add notes about the watch method used in Gaper

This commit is contained in:
Max Claus Nunes 2019-01-19 17:43:21 -02:00
parent 2cdb29eb89
commit 60a0a90d11
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -64,9 +64,9 @@ GLOBAL OPTIONS:
### Watch and Ignore paths
For those options gaper supports static paths (e.g. `build/`, `seed.go`) or glob paths (e.g. `migrations/**/up.go`, `*_test.go`).
For those options Gaper supports static paths (e.g. `build/`, `seed.go`) or glob paths (e.g. `migrations/**/up.go`, `*_test.go`).
On using a path to a directory please add a `/` at the end (e.g. `build/`) to make sure gaper won't include other matches that starts with that same value (e.g. `build/`, `build_settings.go`).
On using a path to a directory please add a `/` at the end (e.g. `build/`) to make sure Gaper won't include other matches that starts with that same value (e.g. `build/`, `build_settings.go`).
### Default ignore settings
@ -78,6 +78,10 @@ Since in most projects there is no need to watch changes of:
Gaper by default ignores those cases already. Although, if you need Gaper to watch those files anyway it is possible to disable this setting with `--disable-default-ignore` argument.
### Watch method
Currently Gaper uses polling to watch file changes. We have plans to [support fs events](https://github.com/maxcnunes/gaper/issues/12) though in a near future.
### Examples
Using all defaults provided by Gaper: