todo_finder 在您的源代码中查找 TODO 并将其记录为 github issue。

安装

从源代码

在克隆此仓库并 cd 到其中之后，您可以使用以下命令安装

bash .ci/common.sh
cargo install --debug --path ./todo_finder --root $HOME/.cargo/

这将安装 Rust 工具链和任何依赖项，例如 ripgrep，然后安装 todo_finder 可执行文件。

从 crates.io

要从 crates.io 安装，您需要一个 Rust 工具链。我更喜欢使用 rustup。

然后安装 ripgrep，它为 todo_finder 提供了广泛范围的文件系统搜索

cargo install ripgrep

然后安装 todo_finder 运行

cargo install todo_finder

使用

在您想要搜索的目录中使用命令行来使用 todo_finder。找到的 TODO 可以输出到文件，或者如果当前目录是 git 仓库，则与被搜索仓库的 GitHub Issues 同步。

与 GitHub Issues 同步

todo_cli -o github --auth XXX12340981723409872783asonetuhHtonoas24 -l todo

上述命令将在当前目录中搜索 TODO 并尝试使用标签 "todo" 将结果发布到仓库的 GitHub issue。此命令需要一个 github 认证令牌。

输出到文件

todo_cli -o markdown

上述命令将任何找到的 TODO 输出到当前目录中名为 todos.md 的 markdown 文件。