2016-09-18 22:42:11 +02:00
|
|
|
#watchexec
|
|
|
|
|
|
|
|
|
|
Software development often involves running the same commands over and over. Boring!
|
|
|
|
|
|
|
|
|
|
`watchexec` is a **simple**, standalone tool that watches a path and runs a command whenever it detects modifications.
|
|
|
|
|
|
|
|
|
|
Example use cases:
|
|
|
|
|
|
|
|
|
|
* Automatically run unit tests
|
|
|
|
|
* Run linters/syntax checkers
|
|
|
|
|
|
|
|
|
|
##Status
|
|
|
|
|
|
2016-10-12 15:30:40 +02:00
|
|
|
Beta: Adding final features and polish
|
2016-09-18 22:42:11 +02:00
|
|
|
|
|
|
|
|
##Features
|
|
|
|
|
|
|
|
|
|
* Simple invocation and use
|
|
|
|
|
* Runs on OS X, Linux and Windows
|
2016-10-15 16:25:37 +02:00
|
|
|
* Monitors current directory and all subdirectories for changes (use `--watch` to override)
|
2016-09-23 19:59:57 +02:00
|
|
|
* Uses most efficient event polling mechanism for your platform (except for [BSD](https://github.com/passcod/rsnotify#todo))
|
2016-09-18 22:42:11 +02:00
|
|
|
* Coalesces multiple filesystem events into one, for editors that use swap/backup files during saving
|
2016-10-12 15:12:42 +02:00
|
|
|
* By default, uses `.gitignore` to filter for changes
|
2016-09-23 19:59:57 +02:00
|
|
|
* Support for watching files with a specific extension
|
2016-09-22 16:03:23 +02:00
|
|
|
* Support for filtering/ignoring events based on glob patterns
|
2016-09-18 22:42:11 +02:00
|
|
|
* Optionally clears screen between executions
|
2016-09-24 19:52:54 +02:00
|
|
|
* Optionally restarts the command with every modification (good for servers)
|
2016-09-18 22:42:11 +02:00
|
|
|
* Does not require a language runtime
|
|
|
|
|
|
|
|
|
|
##Anti-Features
|
|
|
|
|
|
|
|
|
|
* Not tied to any particular language or ecosystem
|
|
|
|
|
* Does not require a cryptic command line involving `xargs`
|
|
|
|
|
|
2016-09-23 19:59:57 +02:00
|
|
|
##Usage Examples
|
2016-09-18 22:42:11 +02:00
|
|
|
|
2016-09-23 19:59:57 +02:00
|
|
|
Watch all JavaScript, CSS and HTML files in the current directory and all subdirectories for changes, running `make` when a change is detected:
|
2016-09-18 22:42:11 +02:00
|
|
|
|
2016-09-23 19:59:57 +02:00
|
|
|
$ watchexec --exts js,css,html make
|
2016-09-18 22:42:11 +02:00
|
|
|
|
2016-09-23 19:59:57 +02:00
|
|
|
Watch all files below `src` and subdirectories for changes, running `make test` when a change is detected:
|
2016-09-22 16:03:23 +02:00
|
|
|
|
2016-09-23 19:59:57 +02:00
|
|
|
$ watchexec --watch src make test
|
2016-09-22 16:03:23 +02:00
|
|
|
|
|
|
|
|
Call `make test` when any file changes in this directory/subdirectory, except for everything below `target`:
|
|
|
|
|
|
2016-09-23 19:59:57 +02:00
|
|
|
$ watchexec -i target make
|
2016-09-18 22:42:11 +02:00
|
|
|
|
2016-09-24 19:52:54 +02:00
|
|
|
Call/restart `python server.py` when any Python file in the current directory (and all subdirectories) changes:
|
|
|
|
|
|
|
|
|
|
$ watchexec -e py -r python server.py
|
|
|
|
|
|
2016-10-12 15:12:42 +02:00
|
|
|
Run `make` when any file changes, using the `.gitignore` file in the current directory to filter:
|
|
|
|
|
|
|
|
|
|
$ watchexec make
|
|
|
|
|
|
2016-09-18 22:42:11 +02:00
|
|
|
##Installation
|
|
|
|
|
|
2016-09-19 18:49:18 +02:00
|
|
|
###OS X with Homebrew
|
|
|
|
|
|
2016-09-26 14:04:56 +02:00
|
|
|
$ brew install https://raw.githubusercontent.com/mattgreen/watchexec/master/pkg/brew/watchexec.rb
|
2016-09-18 22:42:11 +02:00
|
|
|
|
|
|
|
|
##Credits
|
|
|
|
|
|
2016-09-19 18:49:18 +02:00
|
|
|
* [notify](https://github.com/passcod/rsnotify) for doing most of the heavy-lifting
|
