VSCode写Ruby开发环境？Solargraph配置【详解】-VSCode-PHP中文网

Solargraph在VSCode中启动失败主因是Ruby环境未被VSCode继承，需确保终端中ruby和solargraph命令可用、项目有Gemfile或.solargraph.yml配置require_paths、路径无空格/中文，并从终端执行code .启动VSCode。

vscode写ruby开发环境？solargraph配置【详解】

solargraph 在 VSCode 里起不来，基本不是插件问题，而是语言服务器根本没跑起来——它依赖你终端里那个真实的 Ruby 环境，且必须能被 VSCode「看见」。

这是最常见卡点：你在 iTerm 里 ruby -v 输出 3.2.2，which solargraph 有路径；但一进 VSCode 终端（Ctrl+`），两个命令都报 command not found。

实操建议：

VSCode 设置里搜 terminal.integrated.env.zsh（或 .bash），粘贴进去，例如：

"terminal.integrated.env.zsh": {"PATH": "/Users/you/.rbenv/shims:/usr/local/bin:$PATH"}

这个错误背后通常是路径或项目结构问题，不是配置写错了。

路径含空格或中文：旧版 solargraph ≤ 0.44 会直接崩溃，升级到最新版可缓解：gem update solargraph
项目根目录没有 Gemfile：Solargraph 会退到“无 bundle 模式”，跳转进不了 gem 源码，补全也弱。补一个空 Gemfile 并运行 bundle install
.solargraph.yml 存在但 require_paths 没配全：比如你的模型在 app/models，但配置里只写了 lib，那类定义就扫不到
Windows 用户用 WSL 装 Ruby，但开的是 Windows 版 VSCode：WSL 的 ruby 对它不可见，要么换 WSL 版 VSCode，要么在 Windows 上单独装 RubyInstaller

检查方法：在 VSCode 终端里手动运行 solargraph stdio，看是否立即报错。如果卡住或报路径异常，就是上面某一条没对上。

它不是实时监听文件变更的工具，索引靠的是启动时的一次性扫描 + 有限增量更新。

VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

默认只扫描 */.rb，如果你的代码在 src/ 或 domain/ 下，得在 .solargraph.yml 里显式加 require_paths
大型项目不会轮询所有文件，修改后需手动触发重建：Cmd+Shift+P → Solargraph: Restart Server
索引完成前右下角状态栏不会显示 Indexing completed，这时候补全和跳转大概率不准
solargraph bundle 命令比 solargraph config 更可靠——它会读 Gemfile.lock，生成带依赖映射的配置

示例 .solargraph.yml 片段：

require_paths:
- lib
- app/models
- app/services
- domain

solargraph 没停更，但官方维护重心已转向 ruby-lsp（由 Shopify 开发）。两者不兼容，不能共存。

如果你用 Ruby ≥ 3.1、项目依赖 Bundler、需要精准的类型感知（比如 Rails 7.1+ 的 debug、zeitwerk 自动加载），ruby-lsp 是更稳的选择
solargraph 仍适合轻量项目、旧 Ruby（2.6–3.0）、或你已有一套成熟 .solargraph.yml 配置不愿迁移
VSCode 插件层面：castwide.ruby-lsp（对应 ruby-lsp gem）和 castwide.solargraph（对应 solargraph gem）是两个独立插件，装错一个就服务连不上

关键区别在于启动方式：

solargraph：靠插件调用 solargraph socket 或 stdio
ruby-lsp：插件默认走 ruby-lsp 命令，但项目用了 Bundler 就得设 rubyLsp.serverPath: "bundle exec ruby-lsp"，否则加载不到 Gemfile.lock 里的版本

真正容易被忽略的点是：无论选哪个，VSCode 必须从终端启动（code .），且终端里 which ruby 和 which [server] 必须指向同一 Ruby 环境。路径不对，后面所有配置都是空中楼阁。