xtask-watch
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:
[] = [ "my-project", "xtask", ]
-
Create a
.cargo/config.toml
file and add the following content:[] = "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:
[]
= "0.1.0"
Examples
A basic implementation
use Command;
use ;
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.
Troubleshooting
When using the re-export of clap
, you
might encounter this error:
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:
use clap;
Or like this:
use ;