检索“TODO”文本文件中的行

Question

我正在 GEdit（文本编辑器）中编辑一个项目。当我输入 TODO 时，它会突出显示为黄色以供将来参考。我周围有很多这样的TODO。

为了更清楚地说明我需要做什么，任何人都可以向我展示一种从一堆文件中提取任何 TODO 行并将它们放入一个名为 TODOs.txt 的文本文件中的方法。 txt ？

我有这样的东西：

// TODO：错误处理。

并希望将其放入这样的文件中：

* <文件名>; <行号>错误处理

Linux 应用程序（CLI、GUI 不介意）会更好，但正则表达式脚本或其他人可能想出的方法会很酷。

Answer 1

尝试 grep TODO -rnf * > TODOs.txt

Answer 2

如果文件是 git 版本控制的，您可能需要重用 git 的 grep。要在源文件中 grep 查找 TODO，请在存储库的根目录中键入以下命令

git grep TODO

该命令输出如下所示：

[~/projects/atl][ros] > git grep TODO
atl_gazebo/src/plugins/quadrotor_gplugin.cpp:  // TODO: switch to attitude controller when in offboard mode

要包含行号，请添加 -n 标志：

[~/projects/atl][ros] > git grep -n TODO
atl_gazebo/src/plugins/quadrotor_gplugin.cpp:92:  // TODO: switch to attitude controller when in offboard mode

有关更多选项，文档为 < a href="https://git-scm.com/docs/git-grep" rel="nofollow noreferrer">此处。

Answer 3

如果包含 TODO 的文件列表存储在一个名为“file_list.txt”的文件中，请运行：

grep -n `cat file_list.txt` > TODOs.txt

这将检索包含“TODO”字符串的所有行的列表，前面加上文件名和行号，并存储TODOs.txt 中的内容

Answer 4

Riley Lark（和 EdoDodo）的答案可能是最简洁的，但是为了不在输出中显示字面的“TODO”文本，您可以使用 ack：

ack --no-group 'TODO (.*)' --output=' $1' > TODOs.txt

输出：

lib/Example.pm:102: Move _cmd out into a separate role
lib/Example.pm:364: Add a filename parameter
lib/Example2.pm:45: Move comment block to POD format

如果您想要一些稍微不同的格式，那么添加 --no-group 选项将提供：

lib/Example.pm
102: Move Move _cmd out into a separate role
364: Add a filename parameter

lib/Example2.pm
45: Move comment block to POD format

Answer 5

这将在当前目录下的任何文件中递归地查找任何带有“// TODO”的行：

grep -rn '// *TODO' .

这会稍微清理输出：

grep -rn '// *TODO' . | while read l; do
        echo "$(cut -d : -f 1,2 <<<"$l"):$(sed 's|.*//[[:space:]]*TODO||' <<<"$l")"
done

请注意，如果源代码文件名中存在冒号（：），这可能会中断。

您可以将输出放入具有最终重定向的文件中。

编辑：

这更好：

grep -rn '// *TODO' . | sed 's|^\([^:]*:[^:]*:\).*//[[:space:]]*TODO|\1|'

Answer 6

这是一个命令，它将查找您所在目录及其子目录中的所有 TODO，并将它们放入文本文件中：

grep 'TODO' -rn * > TODOs.txt

编辑：

要删除之前不必要的输出，您可以使用此 命令命令改为：

grep 'TODO.*' -rno * > TODOs.txt

Answer 7

遇到了同样的问题，所以想出了一个简单的 python 脚本来使用 git grep 来完成它......

import os
import subprocess
from contextlib import suppress

result = subprocess.run("git grep -l TODO", stdout=subprocess.PIPE)
lst = result.stdout.decode().split("\n")

with suppress(Exception): lst.remove(os.path.basename(__file__)) # remove this filename
with suppress(Exception): lst.remove("") # remove empty filename

todos = []
for file in lst:
    with open(file) as reader:
        for idx, row in enumerate(reader):
            if "TODO" in row: todos.append((file, idx, row))

for todo in todos:
    print(todo)