todo_finder 查找您的源代码中的TODO并记录为github issues。

安装

从源代码

在克隆此仓库并 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可以输出到文件或与搜索的仓库的GitHub Issues同步，如果当前目录是git仓库。

与GitHub Issues同步

todo_cli -o github --auth XXX12340981723409872783asonetuhHtonoas24 -l todo

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

输出到文件

todo_cli -o markdown

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