This crate provides a Watch that launch a given command, re-launching the
command when changes are detected in your source code.
This Watch struct is intended to be used with the
xtask concept and implements
clap::Parser so it can easily be used in
your xtask crate. See clap's flatten
to see how to extend it.
The best way to add xtask-watch to your project is to create a workspace with two packages: your project's package and the xtask package.
Create a new directory that will contains the two package of your project
and the workspace's Cargo.toml
console
mkdir my-project
cd my-project
touch Cargo.toml
Create the project package and the xtask package using cargo new:
console
cargo new my-project
cargo new xtask
Open the workspace's Cargo.toml and add the following:
toml
[workspace]
members = [
"my-project",
"xtask",
]
Create a .cargo/config.toml file and add the following content:
toml
[alias]
xtask = "run --package xtask --"
The directory layout should look like this:
console
my-project
├── .cargo
│ └── config.toml
├── Cargo.toml
├── my-project
│ ├── Cargo.toml
│ └── src
│ └── ...
└── xtask
├── Cargo.toml
└── src
└── main.rs
And now you can run your xtask package using:
console
cargo xtask
You can find more informations about xtask
here.
Finally, add the following to the xtask package's Cargo.toml:
toml
[dependencies]
xtask-watch = "0.1.0"
```rust use std::process::Command; use xtask_watch::{ anyhow::Result, clap, };
enum Opt { Watch(xtask_watch::Watch), }
fn main() -> Result<()> { let opt: Opt = clap::Parser::parse();
let mut run_command = Command::new("cargo");
run_command.arg("check");
match opt {
Opt::Watch(watch) => {
log::info!("Starting to watch `cargo check`");
watch.run(run_command)?;
}
}
Ok(())
} ```
examples/demo provides an
implementation of xtask-watch that naively parse a command given by the user
(or use cargo check by default) and watch the workspace after launching this command.
When using the re-export of clap, you
might encounter this error:
console
error[E0433]: failed to resolve: use of undeclared crate or module `clap`
--> xtask/src/main.rs:4:10
|
4 | #[derive(Parser)]
| ^^^^^^ use of undeclared crate or module `clap`
|
= note: this error originates in the derive macro `Parser` (in Nightly builds, run with -Z macro-backtrace for more info)
This occurs because you need to import clap in the scope too. This error can be resolved like this:
```rust use xtask_wasm::clap;
```
Or like this:
```rust use xtask_wasm::{clap, clap::Parser};
```