#cli-tool #comments #single-line #codebase #list #sorting #urgency

app todoit

用于显示项目中的所有 TODO 的 CLI 工具

2 个版本

0.1.1 2023 年 10 月 4 日
0.1.0 2023 年 10 月 3 日

#1335 in 命令行工具

GPL-3.0-only

19KB
95

todoit

todoit 是一个简单的 CLI 工具,您可以在代码库中运行它以列出代码库中的所有 TODO。

目前仅支持以 "//" 或 "///" 开头的单行注释

紧迫性

您的代码库中的所有 TODO 按紧迫性降序排列。您可以通过在 TODO 中简单地添加 O 来指定 TODO 的紧迫性,如下所示

// TODO: This is an urgency 1 todo
// TODOOOOO: This is an urgency 5 todo
// TODO: This is another urgency 1 todo

Sample output:
./src/main.rs:13 TODOOOOO: This is an urgency 5 todo
./src/main.rs:12 TODO: This is an urgency 1 todo
./src/main.rs:14 TODO: THis is another urgency 1 todo

用法

> todoit --help
CLI Tool for showing all TODO's in a project

Usage: todoit [OPTIONS] [DIR]

Arguments:
  [DIR]  Directory to list all TODO's from

Options:
  -e, --exclude <EXCLUDE>  Exclude file
      --hidden             Don't ignore hidden files
      --ascending          Sort todo's ascending by urgency instead of descending
  -h, --help               Print help
  -V, --version            Print version

致谢

这个项目受到了由 Tsoding 制作的 snitch 项目的很大启发。我制作了 todoit,因为我发现 snitch 对我的用例来说有点过度,并且我想重新发明轮子

许可证

本项目许可协议为 GPL-3.0,可在以下位置找到:[此处](https://git.ixhby.dev/ixhbinphoenix/LICENSE) 或 [https://www.gnu.org/licenses/gpl-3.0.html](https://www.gnu.org/licenses/gpl-3.0.html)

依赖关系

~5–14MB
~161K SLoC