Watchexec library
The library which powers Watchexec CLI and other tools.
- API documentation.
- Licensed under Apache 2.0.
- Minimum Supported Rust Version: 1.58.0 (incurs a minor semver bump).
- Status: maintained.
Quick start
use ;
use ;
async
// ignore this! it's stuff to make the above code get checked by cargo doc tests!
; use Diagnostic; use Error; ;
Kitchen sink
The library also exposes a number of components which are available to make your own tool, or to make anything else you may want:
-
Command handling, to build a command with an arbitrary shell, deal with grouped and ungrouped processes the same way, and supervise a process while also listening for & acting on interventions such as sending signals.
-
Event sources: Filesystem, Signals, (more to come).
-
Finding a common prefix of a set of paths.
-
And more!
Filterers are split into their own crates, so they can be evolved independently:
-
The Globset filterer implements the default Watchexec filter, and mimics the pre-1.18 behaviour as much as possible.
-
The Tagged filterer is an experiment in creating a more powerful filtering solution, which can operate on every part of events, not just their paths.
-
The Ignore filterer implements ignore-file semantics, and especially supports trees of ignore files. It is used as a subfilterer in both of the main filterers above.
There are also separate, standalone crates used to build Watchexec which you can tap into:
-
ClearScreen makes clearing the terminal screen in a cross-platform way easy by default, and provides advanced options to fit your usecase.
-
Command Group augments the std and tokio
Command
with support for process groups, portable between Unix and Windows. -
Ignore files finds, parses, and interprets ignore files.
-
Project Origins finds the origin (or root) path of a project, and what kind of project it is.