cargo-todox

确保 cargo 项目的源文件中不包含 TODOX 问题。

安装

要安装

cargo install cargo-todox

运行

在当前工作目录中的 cargo 项目上运行

cargo todox

这将列出项目中所有（不区分大小写）的 TODOX 字符串 任何地方 的 任何 源文件（从 git ls-files 中获取）。如果没有这样的出现，则成功。

支持的命令行标志有

• 运行 cargo todox DIRECTORY 只检查特定目录中的文件。
• 运行 cargo todox --output FILE 将输出重定向到文件。
• 运行 cargo todox --version 报告版本号。
• 运行 cargo todox --help 获取选项列表的帮助信息。

为什么使用 TODOX？

使用 TODOX 允许在检查代码前对代码进行临时修改。这可能出于多种原因：调试、快速运行某些代码、调查替代方案或只是记录需要解决的问题。

无论出于什么原因，使用TODOX可以标记问题并继续前进，无需担心。在完成工作之前，所有此类标记都需要被移除，要么将它们转换为TODO以供以后工作，要么修复问题。这就是cargo todox发挥作用的地方——它会在项目的任何位置生成一个格式良好的标记位置列表，并且只有在找不到此类标记时才退出状态为零。因此，很容易将cargo todox包含在预提交检查中，以及在CI构建中。

这是使用rustfmt中的report_fixme = "Always"的一般化，这个特性似乎即将被移除。与report_fixme相比，与cargo todox的不同之处在于：

• 它看起来在所有源文件中的每个地方，而不仅仅是.rs文件中的注释。这允许将todox用作变量名称的一部分、注释中、打印的调试消息中、.toml文件中、.yaml文件中、README文件中等。相比之下，FIXME仅在rust文件的注释中被检测到，这允许在大多数但不是所有此类标记的有用情况下使用。

• 它允许通过说ALLOW TODOX来免除某些行（通常在注释中）。这允许配置文件指定运行cargo todox，而无需报告自身。

• 它寻找的是（不区分大小写）字符串TODOX，而不是字符串FIXME。

许可证

cargo-todox是根据GNU通用公共许可证（版本3.0）分发的。有关详细信息，请参阅许可证。