第57章 cargo vendor:将项目依赖本地化
名称
cargo-vendor — 将所有依赖本地化
概要
cargo vendor [选项] [路径]
描述
该 cargo 子命令会将项目中所有 crates.io 和 git 依赖本地化,并放置在指定目录 <path> 中。命令执行完成后,由 <path> 指定的 vendor 目录将包含所有依赖的远程源。可通过 -s 选项指定除默认之外的其他清单文件。
cargo vendor 完成本地化流程后,会使用标准输出打印必要的配置信息,以便使用这些本地化源。你需要将这些配置添加或重定向到你的 Cargo 配置文件中,对于当前包,本地文件通常为 .cargo/config.toml。
Cargo 将本地化源视为只读,处理方式与 registry 和 git 源相同。如果你计划修改来自远程源的 crate,请使用 [patch] 或指向该 crate 本地副本的 path 依赖。这样,Cargo 在增量重新构建时会正确处理该 crate,因为它已知该依赖不再是只读的。
选项
Vendor 选项
-smanifest--syncmanifest-
指定额外的
Cargo.toml清单,这些工作区也将被本地化并同步到输出目录。可以多次指定。 --no-delete-
执行本地化时不删除“vendor”目录,而是保留该目录中现有的所有内容
--respect-source-config-
不从默认忽略 .cargo/config.toml 中的 [source] 配置改为读取并使用该配置,例如在从 crates.io 下载 crate 时
--versioned-dirs-
通常只有当同一包存在多个版本时,版本号才会被添加用于区分。此选项使 vendor 目录下的所有目录都带上版本号,便于追踪 vendor 包随时间的变化历史,并在仅部分包发生变化时重新执行 vendor 操作时提升性能。
Manifest 选项
--manifest-pathpath-
Cargo.toml 文件的路径。默认情况下,Cargo 会在当前目录或其父目录中查找 Cargo.toml 文件。
--locked-
断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时完全一致。如果出现以下任一情况,Cargo 将退出并返回错误:
- lock 文件缺失。
- 由于依赖项解析不同,Cargo 试图修改 lock 文件。
此选项可用于希望确定性构建的环境,例如 CI 流水线中。
--offline-
禁止 Cargo 以任何理由访问网络。不使用该选项时,如果 Cargo 需要访问网络而网络不可用,会报错停止;使用该选项时,Cargo 会尽可能在无网络的情况下继续运行。
注意,这可能导致依赖解析结果与联网模式下不同。Cargo 只会使用已下载到本地的 crate,即使本地索引副本中显示有更新的版本。若想在离线前提前下载依赖,可使用 cargo-fetch(1) 命令。
也可以通过
net.offline配置项 指定。 --frozen-
等同于同时指定
--locked和--offline。
显示选项
-v--verbose-
输出详细日志。指定两次可获得“非常详细”的输出,包含依赖警告、构建脚本输出等额外信息。也可以通过
term.verbose配置项 指定。 -q--quiet-
不打印 Cargo 的日志信息。也可以通过
term.quiet配置项 指定。 --colorwhen-
控制何时使用彩色输出。有效值:
auto(默认):自动检测终端是否支持彩色输出。always:始终显示彩色。never:从不显示彩色。
也可通过
term.color配置值 指定。
通用选项
+toolchain-
如果 Cargo 是通过 rustup 安装的,且
cargo的第一个参数以+开头,则会被解释为 rustup 工具链名称(例如+stable或+nightly)。 请参阅 rustup 文档 了解工具链覆盖机制的详细信息。 --configKEY=VALUE 或 PATH-
覆盖 Cargo 配置值。参数应采用
KEY=VALUE的 TOML 语法, 或提供指向额外配置文件的文件路径。此选项可以多次指定。 请参阅命令行覆盖部分以获取更多详细信息。 -CPATH-
在执行任何指定操作之前更改当前工作目录。这会影响 Cargo 查找项目清单(
Cargo.toml)的默认位置,以及 用于查找.cargo/config.toml的目录等。例如cargo -C path/to/my-project build,此选项必须出现在命令名称之前。该选项仅在 nightly 通道 上可用,且需要启用
-Z unstable-options标志才能使用(详见 #10098)。 -h--help-
打印帮助信息。
-Zflag-
Cargo 的不稳定(仅限 nightly)标志。运行
cargo -Z help查看详细说明。
环境变量
关于 Cargo 读取的环境变量,请参阅参考文档。
退出状态码
0:Cargo 执行成功。101:Cargo 执行失败。
示例
-
将所有依赖项导入本地 “vendor” 目录
cargo vendor -
将所有依赖项导入本地 “third-party/vendor” 目录
cargo vendor third-party/vendor -
将当前工作区及另一个工作区的依赖项导入 “vendor” 目录
cargo vendor -s ../path/to/Cargo.toml -
导入依赖项并将必要的 vendor 配置重定向到配置文件。
cargo vendor > path/to/my/cargo/config.toml