README.md in rerun-0.8.2 vs README.md in rerun-0.9.0
- old
+ new
@@ -111,15 +111,15 @@
rerun foreman start
# Options:
-`--dir` directory (or directories) to watch (default = "."). Separate multiple paths with ','.
+`--dir` directory (or directories) to watch (default = "."). Separate multiple paths with ',' and/or use multiple `-d` options.
`--pattern` glob to match inside directory. This uses the Ruby Dir glob style -- see <http://www.ruby-doc.org/core/classes/Dir.html#M002322> for details.
By default it watches files ending in: `rb,js,css,scss,sass,erb,html,haml,ru`.
-It also ignores directories named `.rbx .bundle .git .svn log tmp vendor` and files named `.DS_Store`.
+On top of this, it also ignores dotfiles, `.tmp` files, and some other files and directories (like `.git .hg .rbx .svn bundle log tmp`) -- run `rerun --help` for the full list.
`--signal` (or -s) use specified signal (instead of the default SIGTERM) to terminate the previous process.
This may be useful for forcing the respective process to terminate as quickly as possible.
(`--signal KILL` is the equivalent of `kill -9`)
@@ -129,10 +129,12 @@
`--background` (or -b) disable on-the-fly commands, allowing the process to be backgrounded
`--no-growl` don't use growl
+`--name` set the app name (for display)
+
Also --version and --help, naturally.
# Growl Notifications
If you have `growlnotify` available on the `PATH`, it sends notifications to
@@ -147,10 +149,11 @@
While the app is (re)running, you can make things happen by pressing keys:
* **r** -- restart (as if a file had changed)
* **c** -- clear the screen
* **x** or **q** -- exit (just like control-C)
+* **p** -- pause/unpause filesystem watching
If you're backgrounding or using Pry or a debugger, you might not want these
keys to be trapped, so use the `--background` option.
# Signals
@@ -167,24 +170,27 @@
# To Do:
* Cooldown (so if a dozen files appear in a burst, say from 'git pull', it only restarts once)
* If the last element of the command is a `.ru` file and there's no other command then use `rackup`
-* Exclude files beginning with a dot, unless the pattern explicitly says to include them
-* --exclude pattern
+* --ignore pattern (currently we're using Listen's default list plus dotfiles)
* ".rerun" file to specify options per project or in $HOME.
-* Test on Linux.
-* On OS X, use a C library using growl's developer API <http://growl.info/developer/>
-* Use growl's AppleScript or SDK instead of relying on growlnotify
-* "Failed" icon
-* Figure out an algorithm so "-x" is not needed (if possible)
+* Figure out an algorithm so "-x" is not needed (if possible) -- maybe by accepting a "--port" option or reading `config.ru`
* Specify (or deduce) port to listen for to determine success of a web server launch
* Make sure to pass through quoted options correctly to target process [bug]
* Make it work on Windows, like Guard now does. See
* https://github.com/guard/guard/issues/59
* https://github.com/guard/guard/issues/27
* Optionally do "bundle install" before and "bundle exec" during launch
+* On OS X:
+ * use a C library using growl's developer API <http://growl.info/developer/>
+ * Use growl's AppleScript or SDK instead of relying on growlnotify
+ * Use OS X notifications
+ * "Failed" icon for notifications
+* On Linux:
+ * Test on Linux.
+ * Use libnotify or notify-send http://www.linuxjournal.com/content/tech-tip-get-notifications-your-scripts-notify-send
# Other projects that do similar things
* Restartomatic: <http://github.com/adammck/restartomatic>
* Shotgun: <http://github.com/rtomayko/shotgun>
@@ -273,9 +279,16 @@
* <https://github.com/FND>
* Barry Sia <https://github.com/bsia>
* Paul Rangel <https://github.com/ismell>
# Version History
+
+* v0.9.0
+ * --dir (or -d) can be specified more than once, for multiple directories (thanks again Barry!)
+ * --name option
+ * press 'p' to pause/unpause filesystem watching (Barry is the man!)
+ * works with Listen 2 (note: needs 2.3 or higher)
+ * ignore all dotfiles, and add actual list of ignored dirs and files
* v0.8.2
* bugfix, forcing Rerun to use Listen v1.0.3 while we work out the troubles we're having with Listen 1.3 and 2.1
* v0.8.1