Crate xtask_watch
source · [−]Expand description
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.
Setup
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 project using xtask
-
Create a new directory that will contains the two package of your project and the workspace’s
Cargo.toml
mkdir my-project cd my-project touch Cargo.toml
-
Create the project package and the xtask package using
cargo new
:cargo new my-project cargo new xtask
-
Open the workspace’s Cargo.toml and add the following:
[workspace] members = [ "my-project", "xtask", ]
-
Create a
.cargo/config.toml
file and add the following content:[alias] xtask = "run --package xtask --"
The directory layout should look like this:
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:
cargo xtask
You can find more informations about xtask here.
Use xtask-watch as a dependency
Finally, add the following to the xtask package’s Cargo.toml:
[dependencies]
xtask-watch = "0.1.0"
Examples
A basic implementation
use std::process::Command;
use xtask_watch::{
anyhow::Result,
clap,
};
#[derive(clap::Parser)]
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(())
}
A more complex demonstration
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.
Re-exports
Structs
Watches over your project’s source code, relaunching the given command when changes are detected.
Functions
Fetch the metadata of the crate.
Fetch information of a package in the current crate.
Return a std::process::Command
of the xtask command currently running.