cargo-fix(1)

名称

cargo-fix — 自动修复 rustc 报告的 lint 警告

概要

cargo fix [选项]

描述

此 Cargo 子命令将自动采纳 rustc 从诊断信息（如警告）中提出的建议，并将其应用于您的源代码。这旨在帮助自动化 rustc 本身已经知道如何告诉您修复的任务！

执行 cargo fix 将在后台执行 cargo-check(1)。任何适用于您的 crate 的警告都将自动修复（如果可能），并且所有剩余的警告将在检查过程完成后显示。例如，如果您想将所有修复应用于当前包，您可以运行

cargo fix

其行为与 cargo check --all-targets 相同。

cargo fix 只能修复通常使用 cargo check 编译的代码。如果代码是通过可选功能有条件启用的，则需要启用这些功能才能分析该代码

cargo fix --features foo

类似地，其他 cfg 表达式（如特定于平台的代码）将需要传递 --target 来修复给定目标的代码。

cargo fix --target x86_64-pc-windows-gnu

如果您在使用 cargo fix 时遇到任何问题，或者有任何其他问题或功能请求，请随时在 https://github.com/rust-lang/cargo 提交问题。

版本迁移

cargo fix 子命令也可用于将包从一个 版本 迁移到下一个版本。一般步骤是

  1. 运行 cargo fix --edition。如果您的项目有多个功能，请考虑同时使用 --all-features 标志。如果您的项目有由 cfg 属性控制的平台特定代码，您可能还想使用不同的 --target 标志多次运行 cargo fix --edition。
  2. 修改 Cargo.toml 以将 版本字段 设置为新版本。
  3. 运行您的项目测试以验证一切仍然正常。如果发出新警告，您可以考虑再次运行 cargo fix（不带 --edition 标志）以应用编译器给出的任何建议。

希望就这样！请记住上面提到的注意事项，即 cargo fix 不能更新非活动功能或 cfg 表达式的代码。此外，在极少数情况下，编译器无法自动将所有代码迁移到新版本，这可能需要在新版本构建后手动更改。

选项

修复选项

--broken-code
即使代码已经存在编译器错误，也要修复代码。如果 cargo fix 无法应用更改，这将非常有用。它将应用更改并将损坏的代码保留在工作目录中，以便您检查和手动修复。
--edition
应用将代码更新到下一个版本的更改。这不会更新 Cargo.toml 清单中的版本，必须在 cargo fix --edition 完成后手动更新。
--edition-idioms
应用将代码更新为当前版本首选样式的建议。
--allow-no-vcs
即使未检测到 VCS，也要修复代码。
--allow-dirty
即使工作目录中有更改，也要修复代码。
--allow-staged
即使工作目录中有已暂存的更改，也要修复代码。

包选择

默认情况下，当未给出包选择选项时，选择的包取决于所选的清单文件（如果未给出 --manifest-path，则基于当前工作目录）。如果清单是工作区的根目录，则选择工作区的默认成员，否则仅选择清单定义的包。

可以使用根清单中的 workspace.default-members 键显式设置工作区的默认成员。如果未设置，则虚拟工作区将包含所有工作区成员（相当于传递 --workspace），而非虚拟工作区将仅包含根 crate 本身。

-p 规范…
--package 规范…
仅修复指定的包。有关规范格式，请参阅 cargo-pkgid(1)。此标志可以指定多次，并支持常见的 Unix glob 模式，如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理 glob 模式之前意外展开它们，您必须在每个模式周围使用单引号或双引号。
--workspace
修复工作区中的所有成员。
--all
已弃用的 --workspace 别名。
--exclude SPEC…
排除指定的包。必须与 --workspace 标志一起使用。此标志可以指定多次，并支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理之前意外扩展 glob 模式，您必须在每个模式周围使用单引号或双引号。

目标选择

如果未指定目标选择选项，则 cargo fix 将修复所有目标（隐含 --all-targets）。如果二进制文件具有缺少的 required-features，则将跳过它们。

传递目标选择标志将仅修复指定的目标。

请注意，--bin、--example、--test 和 --bench 标志也支持常见的 Unix glob 模式，例如 *、? 和 []。但是，为了避免您的 shell 在 Cargo 处理之前意外扩展 glob 模式，您必须在每个 glob 模式周围使用单引号或双引号。

--lib
修复包的库。
--bin name…
修复指定的二进制文件。此标志可以指定多次，并支持常见的 Unix glob 模式。
--bins
修复所有二进制目标。
--example name…
修复指定的示例。此标志可以指定多次，并支持常见的 Unix glob 模式。
--examples
修复所有示例目标。
--test name…
修复指定的集成测试。此标志可以指定多次，并支持常见的 Unix glob 模式。
--tests
修复测试模式下所有设置了 test = true 清单标志的目标。默认情况下，这包括作为单元测试构建的库和二进制文件，以及集成测试。请注意，这也会构建任何所需的依赖项，因此 lib 目标可能会构建两次（一次作为单元测试，一次作为二进制文件、集成测试等的依赖项）。可以通过在目标的清单设置中设置 test 标志来启用或禁用目标。
--bench name…
修复指定的基准测试。此标志可以指定多次，并支持常见的 Unix glob 模式。
--benches
修复基准测试模式下所有设置了 bench = true 清单标志的目标。默认情况下，这包括作为基准测试构建的库和二进制文件，以及基准测试目标。请注意，这也会构建任何所需的依赖项，因此 lib 目标可能会构建两次（一次作为基准测试，一次作为二进制文件、基准测试等的依赖项）。可以通过在目标的清单设置中设置 bench 标志来启用或禁用目标。
--all-targets
修复所有目标。这等效于指定 --lib --bins --tests --benches --examples。

功能选择

功能标志允许您控制启用哪些功能。如果未指定功能选项，则将为每个选定的包激活 default 功能。

有关更多详细信息，请参阅功能文档。

-F features
--features features
要激活的功能的空格或逗号分隔列表。可以使用 package-name/feature-name 语法启用工作区成员的功能。此标志可以指定多次，这将启用所有指定的功能。
--all-features
激活所有选定包的所有可用功能。
--no-default-features
不要激活所选包的 default 功能。

编译选项

--target triple
为给定的体系结构修复。默认值为主机体系结构。三元组的一般格式为 <arch><sub>-<vendor>-<sys>-<abi>。运行 rustc --print target-list 以获取受支持目标的列表。此标志可以指定多次。

这也可以使用 build.target 配置值指定。

请注意，指定此标志会使 Cargo 在不同的模式下运行，其中目标工件放置在单独的目录中。有关更多详细信息，请参阅构建缓存文档。

-r
--release
使用 release 配置文件修复优化的工件。另请参阅 --profile 选项，以按名称选择特定配置文件。
--profile name
使用给定的配置文件修复。

作为一种特殊情况，指定 test 配置文件还将在测试模式下启用检查，这将启用测试检查并启用 test cfg 选项。有关更多详细信息，请参阅rustc 测试。

有关配置文件的更多详细信息，请参阅参考。

--timings=fmts
输出信息，说明每次编译需要多长时间，并跟踪随时间推移的并发信息。接受可选的逗号分隔的输出格式列表；不带参数的 --timings 将默认为 --timings=html。指定输出格式（而不是默认格式）是不稳定的，需要 -Zunstable-options。有效的输出格式

  • html（不稳定，需要 -Zunstable-options）：将人类可读的文件 cargo-timing.html 写入 target/cargo-timings 目录，其中包含编译报告。如果您想查看旧的运行，还可以将报告写入同一目录，并在文件名中包含时间戳。HTML 输出仅适用于人类阅读，不提供机器可读的计时数据。
  • json（不稳定，需要 -Zunstable-options）：发出有关计时信息的机器可读 JSON 信息。

输出选项

--target-dir directory
所有生成的工件和中间文件的目录。也可以使用 CARGO_TARGET_DIR 环境变量或 build.target-dir 配置值指定。默认为工作区根目录中的 target。

显示选项

-v
--verbose
使用详细输出。可以指定两次以获得“非常详细”的输出，其中包括额外的输出，例如依赖项警告和构建脚本输出。也可以使用 term.verbose 配置值指定。
-q
--quiet
不打印 cargo 日志消息。也可以使用 term.quiet 配置值指定。
--color when
控制何时使用彩色输出。有效值

  • auto（默认）：自动检测终端上是否支持颜色。
  • always：始终显示颜色。
  • never：从不显示颜色。

也可以使用 term.color 配置值指定。

--message-format fmt
诊断消息的输出格式。可以指定多次，并由逗号分隔的值组成。有效值

  • human（默认）：以人类可读的文本格式显示。与 short 和 json 冲突。
  • short：输出更短、人类可读的文本消息。与 human 和 json 冲突。
  • json：将 JSON 消息输出到标准输出。有关更多详细信息，请参阅参考。与 human 和 short 冲突。
  • json-diagnostic-short：确保 JSON 消息的 rendered 字段包含来自 rustc 的“简短”渲染。不能与 human 或 short 一起使用。
  • json-diagnostic-rendered-ansi：确保 JSON 消息的 rendered 字段包含嵌入式 ANSI 颜色代码，以遵循 rustc 的默认配色方案。不能与 human 或 short 一起使用。
  • json-render-diagnostics：指示 Cargo 不要在打印的 JSON 消息中包含 rustc 诊断信息，而是由 Cargo 本身渲染来自 rustc 的 JSON 诊断信息。Cargo 自己的 JSON 诊断信息和其他来自 rustc 的诊断信息仍然会被输出。不能与 human 或 short 一起使用。

清单选项

--manifest-path 路径
Cargo.toml 文件的路径。默认情况下，Cargo 在当前目录或任何父目录中搜索 Cargo.toml 文件。
--ignore-rust-version
忽略包中的 rust-version 规范。
--locked
断言使用的依赖项和版本与最初生成现有 Cargo.lock 文件时完全相同。在出现以下任一情况时，Cargo 将退出并报错

  • 缺少锁定文件。
  • 由于依赖项解析不同，Cargo 尝试更改锁定文件。

它可以在需要确定性构建的环境中使用，例如在 CI 管道中。

--offline
阻止 Cargo 出于任何原因访问网络。如果没有此标志，Cargo 在需要访问网络而网络不可用时将停止并报错。使用此标志，Cargo 将尝试在可能的情况下在没有网络的情况下继续。

请注意，这可能会导致与在线模式不同的依赖项解析。Cargo 将限制自己使用本地下载的 crate，即使本地索引副本中可能指示有更新的版本。请参阅 cargo-fetch(1) 命令以下载依赖项，然后再离线。

也可以使用 net.offline 配置值 指定。

--frozen
等效于同时指定 --locked 和 --offline。

通用选项

+工具链
如果 Cargo 是使用 rustup 安装的，并且 cargo 的第一个参数以 + 开头，则它将被解释为 rustup 工具链名称（例如 +stable 或 +nightly）。有关工具链覆盖如何工作的更多信息，请参阅 rustup 文档。
--config KEY=VALUE 或 路径
覆盖 Cargo 配置值。参数应采用 KEY=VALUE 的 TOML 语法，或作为额外配置文件的路径提供。此标志可以指定多次。有关更多信息，请参阅 命令行覆盖部分。
-C 路径
在执行任何指定的操作之前更改当前工作目录。这会影响 Cargo 默认查找项目清单 (Cargo.toml) 的位置，以及搜索 .cargo/config.toml 等目录的位置。此选项必须出现在命令名称之前，例如 cargo -C path/to/my-project build。

此选项仅在 夜间版通道 上可用，并且需要 -Z unstable-options 标志才能启用（请参阅 #10098）。

-h
--help
打印帮助信息。
-Z 标志
Cargo 的不稳定（仅限夜间版）标志。运行 cargo -Z help 获取详细信息。

其他选项

-j N
--jobs N
要运行的并行作业数。也可以使用 build.jobs 配置值 指定。默认为逻辑 CPU 的数量。如果为负数，则将最大并行作业数设置为逻辑 CPU 数加上提供的数值。如果提供了字符串 default，则会将该值设置回默认值。不应为 0。
--keep-going
在依赖关系图中尽可能多地构建 crate，而不是在第一个构建失败时中止构建。

例如，如果当前包依赖于依赖项 fails 和 works，其中一个构建失败，则 cargo fix -j1 可能会也可能不会构建成功的那个（取决于 Cargo 选择首先运行的两个构建中的哪一个），而 cargo fix -j1 --keep-going 肯定会运行这两个构建，即使第一个构建失败。

环境

有关 Cargo 读取的环境变量的详细信息，请参阅 参考。

退出状态

  • 0：Cargo 成功。
  • 101：Cargo 未能完成。

示例

  1. 将编译器建议应用于本地包

    cargo fix

  2. 更新包以使其为下一个版本做好准备

    cargo fix --edition

  3. 应用当前版本的建议习语

    cargo fix --edition-idioms

另请参阅

cargo(1)，cargo-check(1)