tree-sitter-grep

tree-sitter-grep 是一个类似于 grep 的搜索工具，它递归地搜索当前目录中的 tree-sitter 查询 模式。

MIT 或 UNLICENSE 协议双授权。

• 安装
• 用法
• 性能
• 编辑器集成
• 非目标
• 贡献/问题

安装

安装 Rust 工具链后，运行

$ cargo install tree-sitter-grep

用法

$ tree-sitter-grep -q '(trait_bounds) @t'
src/core.rs:14:pub struct Core<'s, M: 's, S> {
src/core.rs:30:impl<'s, M: Matcher, S: Sink> Core<'s, M, S> {
src/mod.rs:622:        P: AsRef<Path>,
src/mod.rs:623:        M: Matcher,
src/mod.rs:624:        S: Sink,
src/mod.rs:644:        M: Matcher,
[...]

指定查询

tree-sitter-grep 使用 tree-sitter 查询 来指定“模式”进行匹配

您可以通过 -q/--query 参数“内联”指定查询

$ tree-sitter-grep -q '(trait_bounds) @t'

或者通过 -Q/--query-file 参数指定到 tree-sitter 查询文件的路径（通常是 *.scm）

$ cat queries/trait_bounds.scm
(trait_bounds) @t
$ tree-sitter-grep -Q queries/trait_bounds.scm

tree-sitter-grep 使用 tree-sitter 查询“捕获”(@ whatever)来指定“匹配”的 tree-sitter AST 节点

因此，您的查询必须始终包含至少一个捕获

如果您的查询包含多个捕获（例如，如果您正在使用“预组合”查询或正在使用谓词），tree-sitter-grep 默认将查询中的第一个捕获（我认为是字典序）作为其“目标捕获”

要覆盖此行为，您可以传递 -c/--capture 参数

$ tree-sitter-grep -q '((field_declaration name: (field_identifier) @field_name (#eq? @field_name "pos")) @f)' --capture f

我如何确定我想要的查询是什么？

从 tree-sitter 查询文档 开始阅读是值得的

然后，为了确定您想要编写的查询的相关 tree-sitter AST 结构，一个 tree-sitter“游乐场”非常有价值，例如交互式在线版本，或者我使用 neovim 的 :InspectTree

在我的经验中，虽然树形查询是一个很好的起点，但它们并不总是足够“表达性”，无法精确指定您想要匹配的AST节点集合

因此，我们也支持指定 过滤器插件，在这里您可以完全“程序化控制”什么构成匹配或不匹配

支持的查询“谓词”

Tree-sitter查询 谓词 允许对匹配的Tree-sitter AST节点进行一些“过滤”

我们使用 Rust tree-sitter绑定，因此“我们支持它们所做的任何谓词”

具体包括以下内容

• #eq?

$ tree-sitter-grep -q '((field_declaration name: (field_identifier) @field_name (#eq? @field_name "pos")) @f)' --capture f
src/core.rs:20:    pos: usize,

• #match?

$ tree-sitter-grep -q '((field_declaration name: (field_identifier) @field_name (#match? @field_name "^p")) @f)' --capture f
src/core.rs:20:    pos: usize,
src/mod.rs:157:    passthru: bool,

过滤器插件

当您需要“程序语言的强大功能”来完全指定匹配的“标准”时，您可以编写一个“过滤器插件”

使用过滤器插件

如果您有一个现有的过滤器插件，您可以通过 -f/--filter 参数（带编译后的过滤器动态库文件的路径 .so/.dll/.dylib）指定您想要使用它

$ tree-sitter-grep -q '(trait_bounds) @t' -f path/to/libmy-filter.so

如果过滤器插件期望传递一个“过滤器参数”（例如，以某种方式参数化/配置其行为），则您可以使用 -/--filter-arg 参数指定它

$ tree-sitter-grep -q '(trait_bounds) @t' -f path/to/libmy-filter-that-expects-argument.so -a '{ the_filter_plugin_can_parse_this: "however_it_wants" }'

$ tree-sitter-grep -q '(trait_bounds) @t' -l rust

$ tree-sitter-grep -q '(trait_bounds) @t' src/main.rs src/compiler

$ tree-sitter-grep --help