在nvim-treesitter-context中扩展Ruby代码块上下文显示

项目背景

nvim-treesitter-context是一个基于Tree-sitter的Neovim插件，它能够在编辑器顶部显示当前代码位置的上下文信息，帮助开发者更好地理解代码结构。对于Ruby语言，默认情况下主要显示类、模块和方法等高层结构，但Ruby中广泛使用的代码块（block）结构默认不包含在上下文显示中。

技术实现原理

该插件的上下文显示功能依赖于两个关键配置：

1. Tree-sitter查询文件（.scm文件）：定义了需要捕获的语法节点
2. 模式配置（patterns）：指定哪些语法节点类型应该被显示为上下文

自定义配置方案

要为Ruby代码块添加上下文显示，需要进行以下配置：

1. 创建自定义查询文件 在配置目录下创建queries/ruby/locals.scm文件，添加对Ruby代码块节点的捕获规则：

; 标准结构
(method name: (_) @method)
(module name: (_) @module)
(class name: (_) @class)
(def name: (_) @def)

; 控制结构
(if) @if
(unless) @unless
(case) @case
(when) @when
(for) @for
(while) @while
(until) @until

; 代码块结构
(do_block) @do_block
(begin) @begin
(rescue) @rescue
(ensure) @ensure
(lambda) @lambda
(block) @block
(call) @call

2. 更新插件配置 在插件配置中添加对应的模式匹配规则：

require'treesitter-context'.setup {
  patterns = {
    ruby = {
      "method", "module", "class", "def",
      "if", "unless", "case", "when",
      "for", "while", "until",
      "do_block", "begin", "rescue",
      "ensure", "lambda", "block", "call"
    },
  },
}

技术细节说明

1. 查询文件语法：

• @method等标签用于标记需要捕获的语法节点
• name: (_)部分用于捕获具体的名称标识符
• 简单的节点类型（如if）可以直接标记而不需要名称捕获

2. 运行时加载机制：

• Neovim会按照runtimepath顺序查找查询文件
• 用户配置目录（$XDG_CONFIG_HOME/nvim/queries）中的查询文件会覆盖默认配置

3. 节点类型说明：

• do_block：典型的Ruby块结构（do...end）
• begin：begin/rescue/ensure结构
• block：使用大括号的块结构
• call：方法调用（可能包含块）

实际效果

配置完成后，在编辑Ruby代码时，编辑器顶部不仅会显示类和方法定义，还会显示包含当前代码位置的各种块结构，如：

• if/unless条件块
• case/when选择结构
• 各种循环结构
• begin/rescue异常处理块
• 方法调用链中的块

这种增强的上下文显示特别有助于理解嵌套较深的Ruby代码逻辑。

注意事项

1. 过多的上下文显示可能会导致信息过载，建议根据实际需要选择要显示的节点类型
2. 不同版本的Ruby Tree-sitter语法解析器可能有略微不同的节点命名
3. 如果遇到显示问题，可以使用:TSPlayground命令检查实际的语法树结构