Robot/watchexec
1
0
Fork 0
mirror of https://github.com/watchexec/watchexec.git synced 2024-11-13 07:41:11 +01:00
Code Issues Projects Releases Packages Wiki Activity
Executes commands in response to file modifications
693 commits 19 branches 274 tags 5.2 MiB
Rust 99.6%
Shell 0.3%
Find a file
Félix Saparelli 81bee9513d
Remove derive-builder 
* the InitConfigBuilder non-miette error goes away
* creating an InitConfig is no longer faillible for no reason
* the "builder" style is consistent between the two config structs
2021-10-09 18:37:59 +13:00
.github/workflows Temporarily disable rpm releases 2021-07-31 06:36:57 +12:00
bin Apply tabs project-wide 2021-08-24 20:22:25 +12:00
cli Remove derive-builder 2021-10-09 18:37:59 +13:00
completions Apply tabs project-wide 2021-08-24 20:22:25 +12:00
doc Add --no-process-group flag 2021-07-22 00:56:35 +12:00
lib Remove derive-builder 2021-10-09 18:37:59 +13:00
test Remask received signal after re-raising it 2016-12-15 09:41:10 -05:00
.editorconfig Fix cli tests 2021-08-24 22:53:44 +12:00
.gitignore Add rpm support with cargo-generate-rpm 2021-07-10 03:48:12 +12:00
.rustfmt.toml Apply tabs project-wide 2021-08-24 20:22:25 +12:00
Cargo.lock == and != perform case-insensitive comparisons 2021-09-30 02:34:27 +13:00
Cargo.toml Apply tabs project-wide 2021-08-24 20:22:25 +12:00
CITATION.cff cli: v1.17.1 2021-07-31 06:37:29 +12:00
CONTRIBUTING.md Split the versioning of the lib and cli (in theory) 2021-05-01 04:22:33 +12:00
LICENSE Create LICENSE 2016-09-18 16:43:26 -04:00
README.md Merge branch 'docs/website' 2021-07-22 00:18:13 +12:00

README.md

CI status

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

Features

  • Simple invocation and use, does not require a cryptic command line involving xargs
  • Runs on OS X, Linux, and Windows
  • Monitors current directory and all subdirectories for changes
  • Coalesces multiple filesystem events into one, for editors that use swap/backup files during saving
  • Loads .gitignore and .ignore files
  • Uses process groups to keep hold of forking programs
  • Provides the paths that changed in environment variables
  • Does not require a language runtime, not tied to any particular language or ecosystem
  • And more!

Quick start

Watch all JavaScript, CSS and HTML files in the current directory and all subdirectories for changes, running npm run build when a change is detected:

$ watchexec -e js,css,html npm run build

Call/restart python server.py when any Python file in the current directory (and all subdirectories) changes:

$ watchexec -r -e py -- python server.py

More usage examples: in the CLI README!

Install

  • As pre-built binary package: https://watchexec.github.io/downloads/
  • With your package manager for Arch, Homebrew, Nix, Scoop, Chocolatey…
  • From source with Cargo: cargo install watchexec-cli

All options in detail: in the CLI README.

Extend

  • watchexec library: to create more specialised watchexec-powered tools! such as:
  • clearscreen: to clear the (terminal) screen on every platform.
  • command group: to run commands in process groups.
  • notify: to respond to file modifications (third-party).
  • globset: to match globs (third-party).