chore: make Prettier
[webi-installers/.git] / watchexec / README.md
index 59599fedcce4df8b2be17d1ba453f8254f3e81d0..f3ee6bd11d9a3a08c2f1b0cfb4ad436e85740cf5 100644 (file)
@@ -5,37 +5,33 @@ tagline: |
   watchexec is a simple, standalone tool that watches a path and runs a command whenever it detects modifications.
 ---
 
-### Updating `watchexec`
-
-`webi watchexec@stable`
-
-Use the `@beta` tag for pre-releases.
+To update or switch versions, run `webi watchexec@stable` (or `@v1.17`, `@beta`,
+etc).
 
 ## Cheat Sheet
 
 `watchexec` runs a given command when any files in watched directories change. \
 It respects `.[git]ignore`.
 
-The full `--help` detailed and very useful. Here's the shortlist of what I find
-most useful:
+Here's the shortlist of options we've found most useful:
 
 ```txt
--w, --watch     ./src/          watch the given directory
--e, --exts      js,html,css     watch only the given extensions
--i, --ignore    '*.md'          do not watch the given pattern
--d, --debounce  5000            the minimum number of milleseconds
-                                    to wait between changes
-
--r, --restart                   restart the process (for servers and such)
--s, --signal    SIGHUP          like -r, but with a signal (ex: SIGHUP)
--c, --clear                     clear the screen between command runs
--W  (wait)                      ignore all changes while the command runs
-
---              npm start       what command to run, which its arguments
-
---no-ignore                     disregard both .ignore and .gitignore
---no-vcs-ignore                 disregard only .gitignore
---no-default-ignore             disregard built-in ignore lists
+-w, --watch     ./src/      watch the given directory
+-e, --exts      js,css      watch only the given extensions
+-i, --ignore    '*.md'      do not watch the given pattern
+-d, --debounce  5000        the minimum number of milleseconds
+                                to wait between changes
+
+-r, --restart               restart the process (for servers, etc)
+-s, --signal    SIGHUP      like -r, but with a signal (ex: SIGHUP)
+-c, --clear                 clear the screen between command runs
+-W  (wait)                  ignore all changes as the command runs
+
+--              npm start   what command to run, with its arguments
+
+--no-ignore                 disregard both .ignore and .gitignore
+--no-vcs-ignore             disregard only .gitignore
+--no-default-ignore         disregard built-in ignore lists
 ```
 
 ### How to use
@@ -52,9 +48,9 @@ Here's a "kitchen sink" example.
 
 ```bash
 watchexec -c -r -s SIGKILL -d 2000 -W --verbose \
-    -w ./src -w ./lib -w ./server.js \
-    -e ts,js,sass,css,html \
-    -i '.git' '*.min.js' -i '*.min.css' \
+    -w ./src -w ./server.js \
+    -e js,css,html \
+    -i '*.md' -i 'package-lock.json' \
     -- npm run build
 ```