医生

检查一个 crate 的 cargo 文档中提到的所有链接是否活跃

安装

$ cargo install cargo-doctor

(请查看 cargo 的文档以了解 cargo install 的工作原理以及如何设置您的系统以便找到由 cargo 安装的二进制文件。)

用法

医生扫描文档并检查每个提到的链接是否有效或损坏。它可以与本地使用 cargo doc 生成的文档以及上传到 docs.rs 的文档一起使用。

### 本地文档：要在本地文档上运行医生，请使用 -l 标志

cargo doctor -l
# or
cargo doctor --local

这将输出成功消息或未找到/无效的链接列表。

确保在运行医生之前运行过 cargo doc。

远程文档

要在您 crate 的 docs.rs 链接上运行医生，请执行

cargo doctor -r 
# or
cargo doctor --remote

它将根据您 crate 的 Cargo.toml 中的 crate 名称和版本生成链接。

您也可以使用 --path 或 -p 与 -r 或 -l 一起指定不同的路径。

cargo doctor -r --path="https://docs.rs/cargo_doctor/0.1.0/cargo_doctor/"

(注意：路径应以 / 结尾)

贡献

如果您想建议任何新功能或报告错误，您可以在此处打开一个问题或直接提交一个拉取请求。

目前，我还需要测试大多数功能，因此您可以通过运行

cargo run -- -r

此软件包使用 Rust 1.29.1 编写。

在提交拉取请求之前，请在最新 nightly 上运行 cargo fmt。

许可证

许可方式任选其一

• Apache 许可证 2.0 版，(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)

。