如何用 :tree-sitter-subtree 查看语法树来编写 Helix 查询

如何用 :tree-sitter-subtree 查看语法树来编写 Helix 查询【免费下载链接】helixA post-modern modal text editor.项目地址: https://gitcode.com/GitHub_Trending/he/helix编写 Helix 的 tree-sitter 查询文件highlights.scm、rainbows.scm、textobjects.scm等时最难的部分往往不是查询语法本身而是弄清楚当前文档被解析成了哪些节点、节点叫什么名字。:tree-sitter-subtree命令就是为这件事准备的它显示跨越主选择区primary selection的最小子树主要用于调试查询。本文基于 rainbows.scm 查询指南、新增语言指南 和 typable 命令参考说明如何用这个命令从查看语法树走到写出可验证的查询。前提条件当前文件类型必须已经加载了 tree-sitter grammar。Helix 的按键映射文档明确标注了带 (TS) 标记的功能都要求该文件类型有 grammar 可用没有 grammar 时无法解析出语法树也就没有子树可看。如果你是在runtime目录里开发查询、而 Helix 找不到它们需要把环境变量HELIX_RUNTIME指向你正在开发的runtime目录。查看主选择区下的语法树打开一个有 grammar 的文件把光标或选区放在你想捕获的语法结构上。在命令模式输入:tree-sitter-subtree也可以用它缩短的别名:ts-subtree。命令会弹出显示最小的、能完整覆盖主选择区的子树输出为 tsq 的 S 表达式格式例如以下来自官方文档示例(call function: (identifier) ; func arguments: (arguments ; (arg1, arg2, arg3) (identifier) ; arg1 (identifier) ; arg2 (identifier))) ; arg3选区决定了你看到的树的粒度选区越窄命令返回的子树就越小、越贴近叶子节点选区越宽看到的节点层级越高。所以实际使用时是反复调整的——先选中一个较大的结构确认节点名再把选区缩小到具体要捕获的 token 上核对匿名节点。读懂节点命名节点与字面量查询只能匹配 S 表达式里实际出现的写法这是读树时最重要的规则。官方指南在讲 rainbow 查询时给出了说明圆括号里带引号的文本捕获的是字面量节点grammar 里以字符串形式写的节点如(、)、[、]而不带引号的括号如(identifier)对应 grammar 中规则的命名节点查询里就用这些规则名来捕获。以 rainbow bracket 为例指南为 TSQ 语言写的括号捕获是[( ) [ ]] rainbow.bracket而层级提升的 scope 捕获用的是命名节点[ (group) (named_node) (wildcard_node) (predicate) (alternation) ] rainbow.scope选哪些节点作为rainbow.scope正是靠查看语法树确认的指南建议对照 grammar 仓库里的grammar.js找出直接包含括号字面量、且本身又需要切换颜色的父节点。仓库中 TSQ 的最终版本在 runtime/queries/tsq/rainbows.scm可以作为对照。标记语言会更麻烦。指南用 HTML 的alink/a演示了一个典型案例、、/是(start_tag)和(end_tag)的子节点而不是(element)的直接子节点。由于默认规则要求rainbow.bracket必须是rainbow.scope节点的直接后代才能被高亮这时需要给 scope 加上rainbow.include-children属性允许间接后代也被高亮((element) rainbow.scope (#set! rainbow.include-children))判断标准是查看语法树后如果提升嵌套层级的节点不是括号节点的直接父节点就加这个属性对绝大多数编程语言不需要。把查询放进正确的目录确定节点名后按 新增语言指南 的约定放置查询文件在runtime/queries/name/下创建文件。Helix 从该目录加载多个查询文件其中只有highlights.scm是必需的文件用途highlights.scm语法高亮injections.scm在字符串、代码围栏等区域嵌入其他语言indents.scm缩进textobjects.scm文本对象与导航mif、]f等locals.scm作用域跟踪让局部变量有高亮区分tags.scm文档/工作区符号选择器rainbows.scmrainbow bracket查询文件的第一行可以用; inherits: lang继承另一个语言的查询。高亮捕获function、type等的解析规则是匹配最具体的 scope、捕获你真正想指的叶子节点最后一个匹配的 pattern以及最内层节点胜出详见 themes 文档。验证查询是否有效写出查询后用 xtask 检查它能否对 grammar 正常编译cargo xtask query-check [language]该命令要求每个查询文件都能对 grammar 编译通过。指南同时提供了两个常见问题的排查方法运行 Helix 报查询相关错误时可能需要更新 grammar先hx --grammar fetch拉取再hx --grammar build重建过期的 grammar如果某个 parser 导致段错误需删除位于runtime/grammars/name.so的已编译 parser。另外指南还提到highlight-check和indent-check会在测试夹具上跑真实的高亮器和缩进器能捕捉query-check发现不了的错误。小结这条路径的每一步都有明确的判断点选区决定看到的树粒度S 表达式里的引号决定节点是字面量还是命名节点树中节点的父子关系决定是否需要rainbow.include-children最后cargo xtask query-check给出查询能否编译的结论。整篇文章涉及的完整指南见 book/src/guides/rainbow_bracket_queries.md 和 book/src/guides/adding_languages.md。【免费下载链接】helixA post-modern modal text editor.项目地址: https://gitcode.com/GitHub_Trending/he/helix创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考