9 个不稳定版本 (3 个破坏性更新)

0.7.2	2019 年 2 月 11 日
0.7.1	2019 年 1 月 14 日
0.6.0	2019 年 1 月 3 日
0.5.1	2018 年 12 月 19 日
0.4.2	2018 年 12 月 10 日

#4 in #keeps

MIT 许可证

93KB
2.5K SLoC

Todo_r

一个命令即可找到所有笔记！

Todo_r 是一个简单的 Rust 命令行工具，用于跟踪代码中的待办事项。它的发音类似于“todoer”，就像一个做待办事项的人。

一个命令即可找到所有 TODO 笔记！

大部分功能借鉴自 leasot，但运行速度更快。

安装

最新版本可以从发布页面下载。

如果你使用 macOS Homebrew 或 Linuxbrew，你可以使用以下命令安装最新版本：

$ brew tap lavifb/todo_r https://github.com/lavifb/todo_r.git
$ brew install todor

特性

读取独立一行的 TODO 注释。

// TODO: do this
/* TODO: do that */

注意：不在独立一行上的注释不支持。

用户引用将被跟踪，可以使用 --user 标志找到。

// TODO(user1): item
// TODO: tagging @user2 and @user3
// TODO(user1): @user3 both are also found!

使用 todor -u user1 找到注释 1 和 3。

可以使用 -t 标志搜索自定义标签。
使用 -d 标志启动交互式模式以删除注释。
如果没有提供输入文件，todo_r 将搜索整个 git 仓库。
- .gitignore 文件将被尊重
- 可以使用与相同语法的 .todorignore 文件添加更多忽略项
- 如果你不使用 git，你可以在根目录中创建一个 .todor 文件

配置文件

使用 todor init 在工作区的根目录下创建一个 .todor 文件。

.todor 文件也可以用作配置文件，以设置自定义标签、注释类型、输出样式等。

Todo_r 还支持在 $XDG_CONFIG_HOME/todor/todor.conf（默认为 ~/.config/todor/todor.conf）处使用全局配置文件，在 Mac/Linux 上，Windows 上则为 ~\AppData\Roaming\lavifb\todor\todor.conf。

有关配置文件的更详细解释，请参阅 config.md。

默认语言支持

默认支持以下常用语言。您可以通过上述配置文件添加更多支持的语言。

文件类型	扩展名	注释类型
C/C++	`.c`，`.h`，`.cpp`	`//`,`/* */`
C#	`.cs`	`//`,`/* */`
CoffeeScript	`.coffee`	`#`
Go	`.go`	`//`,`/* */`
Haskell	`.hs`	`--`
HTML	`.html`，`.htm`	`<!-- -->`
Java	`.java`	`//`,`/* */`
JavaScript	`.js`，`.es`，`.es6`	`//`,`/* */`
Obj-C/C++	`.m`，`.mm`	`//`,`/* */`
Less	`.less`	`//`,`/* */`
Markdown	`.md`	`<!-- -->`
Perl	`.pl`，`.pm`	`#`
PHP	`.php`	`//`,`/* */`
Python	`.py`	`#`,`""" """`
Ruby	`.rb`	`#`
Rust	`.rs`	`//`,`/* */`
Sass	`.sass`，`scss`	`//`,`/* */`
Scala	`.scala`	`//`,`/* */`
Shell	`.sh`，`.bash`，`.zsh`	`#`
SQL	`.sql`	`--`,`/* */`
Stylus	`.styl`	`//`,`/* */`
Swift	`.swift`	`//`,`/* */`
TeX	`.tex`	`%`
TypeScript	`.ts`，`.tsx`	`//`,`/* */`
YAML	`.yaml`，`.yml`	`#`

如果您认为还有其他语言/扩展应该被默认支持，请随时提交问题/拉取请求。

由 Lavi Blumberg 编写

依赖关系

约 7-18MB
约 211K SLoC