入门 Zed Industries 2026-09-14 17:42:20 · 71 阅读

第106章 Ruby

Ruby 支持通过 Ruby 扩展提供。

该 Ruby 扩展同样支持 ERB 文件。

语言服务器

目前有多款适用于 Ruby 的语言服务器。Zed 支持以下两款:

它们都具备自动补全、诊断、代码操作等重叠的功能集,你可以自行选择使用哪一个。需要注意的是,不能同时使用两者。

除了这两款语言服务器,Zed 还支持:

  • rubocop,这是 Ruby 的静态代码分析器和 linter。在底层,Zed 也将其作为语言服务器使用,但其功能与 solargraph 和 ruby-lsp 形成互补。
  • sorbet,这是 Ruby 的静态类型检查器,拥有自定义的渐进式类型系统。
  • steep,这是 Ruby 的静态类型检查器,使用 Ruby Signature (RBS)。
  • Herb,这是针对 ERB 文件的语言服务器。
  • kanayago,这是一个 Ruby 语言服务器,它将 Ruby 的解析器(parser)封装为一个 gem 供使用。
  • fuzzy-ruby-server:一款专为大型代码库设计的 Ruby 语言服务器,利用全文搜索实现快速的模糊搜索结果,以近似 Ruby 的行为。
  • 配置语言服务器时,建议使用 'dev: Open Language Server Logs' 命令打开 LSP 日志窗口。之后,你可以选择对应的语言实例查看日志信息。

    配置语言服务器

    Ruby 扩展同时支持 solargraph 和 ruby-lsp 语言服务器。

    语言服务器激活

    对于所有受支持的 Ruby 语言服务器(solargraph、ruby-lsp、rubocop、sorbet 和 steep),Ruby 扩展遵循以下激活顺序:

    1. 如果在项目的 Gemfile 中找到该语言服务器,将通过 bundle exec 使用它。
    2. 如果未在 Gemfile 中找到,Ruby 扩展将在系统 PATH 中查找可执行文件。
    3. 如果在上述两个位置均未找到,Ruby 扩展将自动将其安装为全局 gem(注意:这不会安装到你当前的 Ruby gemset 中)。

    你可以通过在设置中将 use_bundler 设为 false,跳过步骤 1 并强制使用系统可执行文件:

    {
      "lsp": {
        "<SERVER_NAME>": {
          "settings": {
            "use_bundler": false
          }
        }
      }
    }
    

    使用 solargraph

    在 Ruby 扩展中,solargraph 默认已启用。

    使用 ruby-lsp

    在设置({#kb zed::OpenSettings})中,位于 Languages > Ruby 下配置语言服务器,或者添加到你的设置文件中:

    {
      "languages": {
        "Ruby": {
          "language_servers": ["ruby-lsp", "!solargraph", "!rubocop", "..."]
        },
        // 为 *.html.erb 文件启用 herb 和 ruby-lsp
        "HTML+ERB": {
          "language_servers": ["herb", "ruby-lsp", "..."]
        },
        // 为 *.js.erb 文件启用 ruby-lsp
        "JS+ERB": {
          "language_servers": ["ruby-lsp", "..."]
        },
        // 为 *.yaml.erb 文件启用 ruby-lsp
        "YAML+ERB": {
          "language_servers": ["ruby-lsp", "..."]
        }
      }
    }
    

    这样会禁用 solargraph 和 rubocop,改用 ruby-lsp。

    使用 rubocop

    Ruby 扩展还支持 rubocop 语言服务器,可用于问题检测和自动修复。

    你可以在设置({#kb zed::OpenSettings})中的 Languages > Ruby 里配置语言服务器,或直接在设置文件中添加:

    {
      "languages": {
        "Ruby": {
          "language_servers": ["ruby-lsp", "rubocop", "!solargraph", "..."]
        }
      }
    }
    

    反过来,你也可以禁用 ruby-lsp,启用 solargraph 和 rubocop:

    {
      "languages": {
        "Ruby": {
          "language_servers": ["solargraph", "rubocop", "!ruby-lsp", "..."]
        }
      }
    }
    

    配置 solargraph

    Solargraph 默认关闭了格式化和诊断功能。可以在 settings.json 中添加以下配置来启用它们:

    {
      "lsp": {
        "solargraph": {
          "initialization_options": {
            "diagnostics": true,
            "formatting": true
          }
        }
      }
    }
    

    配置文件

    Solargraph 会从项目根目录下的 .solargraph.yml 文件读取配置。关于该文件的更多信息,请参阅 Solargraph 配置文档。

    配置 ruby-lsp

    你可以将 Ruby LSP 的配置项传递给 initialization_options,例如:

    {
      "languages": {
        "Ruby": {
          "language_servers": ["ruby-lsp", "!solargraph", "..."]
        }
      },
      "lsp": {
        "ruby-lsp": {
          "initialization_options": {
            "enabledFeatures": {
              // "someFeature": false
            }
          }
        }
      }
    }
    

    关于完整的配置选项,请参见 Ruby LSP 网站。

    LSP 的 settings 和 initialization_options 也可以针对特定项目设置。例如,若要在特定项目中使用 standardrb/standard 作为格式化工具和代码检查器,请在项目仓库内添加一个 .zed/settings.json 文件,并写入以下内容:

    {
      "lsp": {
        "ruby-lsp": {
          "initialization_options": {
            "formatter": "standard",
            "linters": ["standard"]
          }
        }
      }
    }
    

    配置 rubocop LSP

    Rubocop 默认禁用了不安全的自动修复功能。通过在 settings.json 中添加以下配置,即可指示 Zed 启用该功能:

    {
      "languages": {
        "Ruby": {
          // Use ruby-lsp as the primary language server and rubocop as the secondary.
          "language_servers": ["ruby-lsp", "rubocop", "!solargraph", "..."]
        }
      },
      "lsp": {
        "rubocop": {
          "initialization_options": {
            "safeAutocorrect": false
          }
        },
        "ruby-lsp": {
          "initialization_options": {
            "enabledFeatures": {
              "diagnostics": false
            }
          }
        }
      }
    }
    

    配置 Sorbet

    Sorbet 是一款流行的 Ruby 静态类型检查器,内置了语言服务器功能。

    要启用 Sorbet,请将 "sorbet" 添加到 Ruby 的 language_servers 列表中。如果打算将 Sorbet 作为主要 LSP,或与另一个 LSP 搭配使用以实现类型检查等特定功能,建议禁用其他语言服务器。

    可以在设置({#kb zed::OpenSettings})的 Languages > Ruby 下配置语言服务器,或者直接添加到设置文件中:

    {
      "languages": {
        "Ruby": {
          "language_servers": [
            "ruby-lsp",
            "sorbet",
            "!rubocop",
            "!solargraph",
            "..."
          ]
        }
      }
    }
    

    关于安装 Sorbet、在项目中进行配置以及设置其行为的所有细节,请参阅 官方 Sorbet 文档。

    配置 Steep

    Steep 是一个 Ruby 静态类型检查器,使用 RBS 文件来定义类型。

    要启用 Steep,请将 "steep" 添加到 Ruby 的 language_servers 列表中。根据你想要的配置,可能需要调整顺序或禁用其他 LSP。

    可以在设置({#kb zed::OpenSettings})的 Languages > Ruby 下配置语言服务器,或者直接添加到设置文件中:

    {
      "languages": {
        "Ruby": {
          "language_servers": [
            "ruby-lsp",
            "steep",
            "!solargraph",
            "!rubocop",
            "..."
          ]
        }
      }
    }
    

    配置 Herb

    Herb 默认用于 HTML+ERB 语言。

    在 Ruby 中使用 Tailwind CSS 语言服务器

    要在 Ruby/ERB 文件中获取 Tailwind CSS 语言服务器 的全部功能(自动补全、代码检查等),需要配置语言服务器以告知其查找 CSS 类的位置,将以下内容添加到 settings.json 中:

    {
      "lsp": {
        "tailwindcss-language-server": {
          "settings": {
            "experimental": {
              "classRegex": ["\\bclass:\\s*['\"]([^'\"]*)['\"]"]
            }
          }
        }
      }
    }
    

    配置好这些设置后,你在 ERB 文件的 HTML 属性里,以及 Ruby/ERB 中紧跟 class: 键的字符串里,都能获得 Tailwind CSS 类名的自动补全。例如:

    # Ruby 文件:
    def method
      div(class: "pl-2 <补全位置>") do
        p(class: "mt-2 <补全位置>") { "Hello World" }
      end
    end
    
    # ERB 文件:
    <%= link_to "Hello", "/hello", class: "pl-2 <补全位置>" %>
    <a href="/hello" class="pl-2 <补全位置>">Hello</a>
    

    运行测试

    要在 Ruby 项目中运行测试,可以在本地的 .zed/tasks.json 配置文件里定义自定义任务。这些任务可以配合不同的测试框架使用,比如 Minitest、RSpec、quickdraw 和 tldr。下面是一些示例,展示如何在编辑器内运行测试。

    Rails 中的 Minitest

    [
      {
        "label": "test $ZED_RELATIVE_FILE -n /$ZED_CUSTOM_RUBY_TEST_NAME/",
        "command": "bin/rails",
        "args": [
          "test",
          "$ZED_RELATIVE_FILE",
          "-n",
          "\"$ZED_CUSTOM_RUBY_TEST_NAME\""
        ],
        "cwd": "$ZED_WORKTREE_ROOT",
        "tags": ["ruby-test"]
      }
    ]
    

    Minitest

    纯 Minitest 不支持按行号运行测试,只能按名称运行,所以需要改用 $ZED_CUSTOM_RUBY_TEST_NAME:

    [
      {
        "label": "-Itest $ZED_RELATIVE_FILE -n /$ZED_CUSTOM_RUBY_TEST_NAME/",
        "command": "bundle",
        "args": [
          "exec",
          "ruby",
          "-Itest",
          "$ZED_RELATIVE_FILE",
          "-n",
          "\"$ZED_CUSTOM_RUBY_TEST_NAME\""
        ],
        "cwd": "$ZED_WORKTREE_ROOT",
        "tags": ["ruby-test"]
      }
    ]
    

    RSpec

    [
      {
        "label": "test $ZED_RELATIVE_FILE:$ZED_ROW",
        "command": "bundle",
        "args": ["exec", "rspec", "\"$ZED_RELATIVE_FILE:$ZED_ROW\""],
        "cwd": "$ZED_WORKTREE_ROOT",
        "tags": ["ruby-test"]
      }
    ]
    

    同样的任务语法也适用于 quickdraw 或 tldr 等其他测试框架。

    调试

    Ruby 扩展提供了调试适配器(debug adapter),用于调试 Ruby 代码。该适配器在 Zed 界面及 debug.json 中的名称为 rdbg,底层基于 debug gem 实现。此扩展采用与语言服务器相同的激活逻辑。

    示例

    调试 Ruby 脚本

    [
      {
        "label": "Debug current file",
        "adapter": "rdbg",
        "request": "launch",
        "script": "$ZED_FILE",
        "cwd": "$ZED_WORKTREE_ROOT"
      }
    ]
    

    调试 Rails 服务器

    [
      {
        "label": "Debug Rails server",
        "adapter": "rdbg",
        "request": "launch",
        "command": "./bin/rails",
        "args": ["server"],
        "cwd": "$ZED_WORKTREE_ROOT",
        "env": {
          "RUBY_DEBUG_OPEN": "true"
        }
      }
    ]
    

    格式化工具

    erb-formatter

    若要格式化 ERB 模板,可使用 erb-formatter。该工具借助 erb-formatter gem 完成 ERB 模板的格式化处理。

    请在设置({#kb zed::OpenSettings})中进入 Languages > HTML+ERB 配置格式化,或在设置文件中添加以下内容:

    {
      "languages": {
        "HTML+ERB": {
          "formatter": {
            "external": {
              "command": "erb-formatter",
              "arguments": ["--stdin-filename", "{buffer_path}"]
            }
          }
        }
      }
    }
    

    评论 (0)