目录

ripgrep(rg)是一款递归搜索目录并应用 .gitignore 等排除规则的搜索工具。先试试 rg '搜索词',如果有文件搜不到,请检查搜索范围的筛选设置。

要点#

  • rg 默认读取 .gitignore、.ignore、.rgignore,并将隐藏文件和二进制文件排除在搜索范围之外。
  • 用 -t 指定文件类型,用 -n 显示行号。
  • 要忽略排除规则并搜索所有文件,请使用 -uuu。
  • 默认的正则表达式不支持前瞻和反向引用,需要时可启用 PCRE2。

开始搜索#

在项目根目录下,传入要搜索的字符串。即使不做特殊指定,也会递归搜索下级文件,结果中会显示文件名和匹配行。

example.sh
rg 'TODO'
rg -n 'TODO'

第二条命令还会输出行号。如果只想搜索特定文件,请在模式后指定路径。也可以使用正则表达式,例如查找大写标识符时,可以写成 [A-Z]+_SUSPEND。

缩小搜索范围#

按扩展名或文件类型限定搜索范围,可以让结果更易读。只搜索 Python 文件时指定 -tpy,排除 JavaScript 时指定 -Tjs。

example.sh
rg -tpy 'def main'
rg -Tjs 'fetch'

可以配置支持的类型和自定义类型规则。在大型仓库中,先缩小范围再搜索,更容易避开无关结果。

搜索被排除的文件#

rg 默认不搜索符合 .gitignore 等规则的文件,也不搜索隐藏文件和二进制文件。如果字符串应该在配置文件或生成文件中,却找不到,请检查是否由排除设置导致。

添加 -uuu 可以关闭所有自动筛选。搜索量容易因此增大,实际使用时建议仅在需要时启用。

example.sh
rg -uuu '設定値'

正则表达式与特殊输入#

默认的正则表达式引擎支持 Unicode,能快速执行常规搜索。但它不支持前瞻和反向引用。需要这些功能时,请使用编译时启用了 PCRE2 支持的 rg,并指定 -P。

example.sh
rg -P '(?<=user_id=)\d+'

不必始终使用 PCRE2。如果不确定编译时是否已启用,请查看 rg --help 或所用软件包的信息。

也可以搜索非 UTF-8 编码的文件和压缩文件。用 -E 指定字符编码,用 -z 搜索支持的压缩文件。

example.sh
rg -E Shift_JIS '検索語' data.txt
rg -z '検索語' archive.gz

速度与工具选择#

ripgrep 使用 Rust 的正则表达式引擎、并行目录遍历等技术来加快搜索。GitHub README 中的 Linux 内核对比示例显示,在指定条件下,rg 耗时 0.082 秒,git grep 耗时 0.273 秒。不过,这些数字是在特定机器和搜索条件下得到的结果。在你的环境中,不一定会有同样的差距。

它可用于 Windows、macOS 和 Linux,但并非 POSIX 标准工具,也不是所有环境都预装。在难以额外安装软件的环境中,标准工具 grep 可能更方便。

下一步#

在项目根目录下执行 rg -n 'TODO',如果需要搜索未出现在结果中的文件,再试试 rg -uuu -n 'TODO'。

来源: https://github.com/burntsushi/ripgrep

目录