$ cargo watch

Cargo Watch 会监视您项目的源代码变化，并在变化发生时运行 Cargo 命令。

如果您使用过 nodemon、guard 或 entr，这可能会让您感到熟悉。

• 在公共领域 / 以 CC0 许可。
• 最低支持的 Rust 版本：1.70.0。
  • 只支持最后五个稳定版本。
  • 发布时，该范围内的 MSRV 以外的增加不会导致主要版本号的增加。

安装

与 cargo-binstall 一起

$ cargo binstall cargo-watch

从源代码

$ cargo install cargo-watch

或者克隆并使用 $ cargo build 然后放置在您的 $PATH 中。

您还可以从 发布页面 上的预构建二进制文件中进行安装。

辅助

此存储库包含一个 手册页面 和 Zsh 完成项，您可能希望安装。

用法

默认情况下，它运行 check。尽管您可以轻松地覆盖它

$ cargo watch [-x command]...

一些示例

# Run tests only
$ cargo watch -x test

# Run check then tests
$ cargo watch -x check -x test

# Run run with arguments
$ cargo watch -x 'run -- --some-arg'

# Run an arbitrary command
$ cargo watch -- echo Hello world

# Run with features passed to cargo
$ cargo watch --features "foo,bar"

您还可以做更多的事情！以下是帮助信息的副本

USAGE:
    cargo watch [FLAGS] [OPTIONS]

FLAGS:
    -c, --clear              Clear the screen before each run
    -h, --help               Display this message
        --ignore-nothing     Ignore nothing, not even target/ and .git/
        --debug              Show debug output
        --why                Show paths that changed
    -q, --quiet              Suppress output from cargo-watch itself
        --no-vcs-ignores       Don’t use .gitignore files
        --no-dot-ignores          Don’t use .ignore files
        --no-restart         Don’t restart command while it’s still running
    -N, --notify             Send a desktop notification when watchexec notices a change
                             (experimental, behaviour may change)
        --poll               Force use of polling for file changes
        --postpone           Postpone first run until a file changes
        --skip-local-deps    Don't try to find local dependencies of the current crate and watch
                             their working directories. Only watch the current directory.
    -V, --version            Display version information
        --watch-when-idle    Ignore events emitted while the commands run.

OPTIONS:
    -x, --exec <cmd>...            Cargo command(s) to execute on changes [default: check]
    -s, --shell <cmd>...           Shell command(s) to execute on changes
    -d, --delay <delay>            File updates debounce delay in seconds [default: 0.5]
        --features <features>      List of features passed to cargo invocations
    -i, --ignore <pattern>...      Ignore a glob/gitignore-style pattern
    -B <rust-backtrace>            Inject RUST_BACKTRACE=VALUE (generally you want to set it to 1)
                                   into the environment
        --use-shell <use-shell>    Use a different shell. E.g. --use-shell=bash
    -w, --watch <watch>...         Watch specific file(s) or folder(s). Disables finding and
                                   watching local dependencies.
    -C, --workdir <workdir>        Change working directory before running command [default: crate
                                   root]

ARGS:
    <cmd:trail>...    Full command to run. -x and -s will be ignored!

Cargo commands (-x) are always executed before shell commands (-s). You can use the `-- command`
style instead, note you'll need to use full commands, it won't prefix `cargo` for you.

By default, the workspace directories of your project and all local dependencies are watched,
except for the target/ and .git/ folders. Your .ignore and .gitignore files are used to filter
paths.

On Windows, patterns given to -i have forward slashes (/) automatically
converted to backward ones (\) to ease command portability.

忽略文件

.gitignore 文件默认用于忽略要监视和触发运行的路径。要停止尊重它们，请传递 --no-vcs-ignores。

.ignore 文件在相同的语法中也被默认使用。该文件可用于指定应被 cargo watch 忽略但应提交到 git 的文件，而无需在命令行上不断添加 --ignore abc 选项。请注意，.ignore 文件也可能被其他程序使用，例如 ripgrep。要停止尊重这些，请传递 --no-dot-ignores。

Cargo watch 还有一个内部默认忽略列表，这些列表在文件中指定的基础上，例如 target/ 和 .git/ 以及各种其他常见类型（日志、编辑器交换文件、锁文件等）。

要跳过所有忽略，请使用 --ignore-nothing 标志。

.git/info/exclude 和全局的 $HOME/.gitignore 以及类似的忽略文件 尚不支持。

忽略语法

有关它们在此工具上下文中的工作方式，请参阅 Glob 模式页面。这是 --ignore 选项使用的语法。

此外，还有一些特定的怪癖和行为

• 在 Windows 上，应使用 Windows 风格的（\\）分隔符指定模式。Unix 风格的分隔符（/）不会匹配 Windows 路径，这可能会造成混淆，并给人一种命令行忽略不起作用的印象。

• 从 Cargo Watch 7.0.0 开始，在 Windows 上运行时，命令行忽略中的 / 会自动转换为 \\，但仍然应尝试为平台编写正确的模式，因为可能存在更微妙的不同。

• 从 Cargo Watch 7.3.0 开始，--ignore 模式得到了修复，以提供更好的目录匹配体验。以前，忽略一个文件夹需要固执的 -/** 模式；现在这被内部处理，只需 - 就可以产生相同的效果。

$ systemfd --no-pid -s http::5000 -- cargo watch -x run

$ cargo watch -x check -s 'touch .trigger'

$ cargo watch --no-vcs-ignores -w .trigger -x run

$ /path/to/cargo-watch watch -x build

# ...
RUN mkdir -p /build
WORKDIR `/src`
ENTRYPOINT cargo watch -C /build --manifest-path=/src/Cargo.toml -- cargo run

# ...
RUN mkdir -p /build
WORKDIR `/src`
ENV CARGO_TARGET_DIR=/build
ENTRYPOINT cargo watch -- cargo run

$ cargo watch -x 'build -p subcrate'

$ cargo watch -x 'check --color=always'

$ cargo watch -x 'test -- --color=always'

$ cargo watch --features foo,bar

$ cargo watch --features foo,bar -x build -x doc