在VSCode中运行Ruby程序 - 基础环境搭建与调试

在 VSCode 里折腾 Ruby 环境时，你是不是也遇到过这样的情况：点下调试按钮，系统毫无反应；断点明明打了，却怎么也不触发；想跳转定义，结果光标怎么点都没变化…… 坦白说，90% 的“调试失败”并不是因为 Ruby 本身多难，而是因为最基础的链路不通。

VSCode 本身不会帮你运行 Ruby，它只是调用你系统里已经装好的 ruby 命令。如果终端里连 ruby -v 都报错，那后续所有配置都建立在空中楼阁之上。环境搭建这件事，得从最底层的“通”与“不通”开始讲起。

确认 ruby 和 bundle 在 VSCode 终端里能用

这一步最容易被跳过，但偏偏是 90% 问题的源头。先打开 VSCode 的集成终端（快捷键 Ctrl + `），运行 which ruby 和 which bundle。关键看输出路径：它应该指向 .rbenv/shims 或 .rvm/rubies 这一类由版本管理工具管理的路径，而不是 /usr/bin/ruby——那是系统自带的旧版 Ruby，通常不适用于项目需求。

• Mac 用户请注意：rbenv init 输出的 eval 配置行，要写进 ~/.zprofile 而不是 ~/.zshrc。配置完成后，需要彻底退出 VSCode（按下 Cmd + Q），再重新打开。
• Windows 用户：用 RubyInstaller 安装时，务必勾选 “Add Ruby executables to your PATH”。如果忘记勾选，也可以手动将 C:Ruby32-x64bin 写入系统环境变量，然后重启 VSCode。
• 验证成功的标志有两个：VSCode 状态栏左下角显示 Ruby 3.x.x；并且 gem list 能正常列出已安装的 gem。

launch.json 中 type 字段必须和实际插件匹配

type 字段写错是调试器启动即退出、断点变灰、或者控制台报 undefined method `write' for nil:NilClass 这类诡异错误的常见原因。

• 如果你用的是 castwide.ruby-lsp 插件（这也是目前比较推荐的方式），type 必须写成 "ruby_lsp"，同时删掉配置里所有 pathToRDebugIDE 和 rdebug-ide 相关字段。
• 老插件 rebornix.ruby 虽然还在用，但已经停止更新。如果非要用它，type 写成 "Ruby"。不过要注意，Ruby 3.1 以上版本用这个插件容易崩溃。
• 调试 Rails 项目服务器时，program 要写成 "${workspaceFolder}/bin/rails"，而不是简单的 "rails"——后者不会走 bundle exec 环境，容易出问题。
• 调试单个脚本时，program 写成 "ruby ${file}" 比直接写 "${file}" 更稳妥，能避免 shebang 或权限问题导致启动失败。

调试必须用 debug gem，别碰 byebug 或 pry-byebug

byebug 在 Ruby 3.1 及以上版本中已经不可用，pry-byebug 则会和 debug 产生冲突，导致断点卡死甚至进程假死。所以，Gemfile 里直接加 gem "debug", group: :development, require: false，然后 bundle install。同时把 binding.pry、byebug、pry-byebug 这些相关代码全部清理干净。

• 如果你用的是 Rails 7+ 项目，还需要在 config/environments/development.rb 里加上 config.autoloader = :classic，然后运行 bin/rails tmp:clear，否则断点经常跳错文件。
• 如果设置完后断点仍然不进入 app/models 这类目录，可以在 launch.json 的 env 字段里加入 "RUBY_DEBUG_NO_RAILS": "1"，临时禁用 Rails 集成，用来验证是不是 autoload 机制在干扰。

ruby-lsp gem 必须本地安装，且路径要对得上当前 Ruby 版本

castwide.ruby-lsp 插件只是一个前端壳子，真正干活的是你本地安装的 ruby-lsp 可执行文件。只装插件不装 gem，Output 面板里的 “Ruby LSP” 标签页会一直卡在 Indexing 状态，或者直接报 Failed to start language server。

• 确保当前终端使用的 Ruby 版本和项目要求一致：比如运行 rbenv local 3.2.2 或 rvm use 3.2.2，然后再运行 gem install ruby-lsp。
• ruby-lsp 0.15 及以上版本要求 Ruby 3.1 以上。如果你的项目还在用 Ruby 2.7，安装最新版 ruby-lsp 会静默失败。
• 如果项目使用了 Bundler，需要在 VSCode 设置中将 rubyLsp.serverPath 改为 bundle exec ruby-lsp，否则 LSP 无法正确加载 Gemfile.lock 里的依赖。
• 还有一个最容易被忽视的细节：必须从项目根目录启动 VSCode，也就是在终端里运行 code .。如果通过双击图标或用 open -a 的方式启动，系统根本读不到 rbenv 的 shims，所有环境变量都丢了。这个动作不是可选项，是必要条件。

回头来看，整个配置过程其实没什么复杂的知识点，无非是“终端环境通不通”“插件和 gem 对不对得上”“启动方式对不对”这三件事。但正是这些不起眼的细节，最容易在不知不觉中把人绊住。把这几个环节逐一确认一遍，调试环境应该就能稳稳跑起来了。