VSCode如何配置Ruby开发环境 VSCode搭建Ruby项目的完整教程-VSCode-PHP中文网

在vscode里搭建ruby开发环境需三步：首先安装ruby并推荐使用rbenv或rvm进行版本管理，其中rbenv轻量透明，rvm功能全面但侵入性强；其次安装vscode扩展，包括ruby、solargraph（需gem install solargraph）、code runner、ruby debugger及rubocop，并在settings.json中配置格式化与保存时检查；最后配置调试环境，在.vscode/launch.json中定义rdbg调试器的启动方式，支持调试文件、rake任务和rails服务器，通过设置断点并使用调试面板操作实现高效调试，整个流程强调环境清晰、扩展协同与配置精准，最终实现流畅开发体验。

VSCode如何配置Ruby开发环境 VSCode搭建Ruby项目的完整教程

在VSCode里搭建Ruby开发环境，核心在于三步：先确保系统安装了Ruby，接着在VSCode里安装必要的Ruby相关扩展，最后根据项目需求配置好调试器和LSP（语言服务器协议）。这并非什么高深莫测的技术，更多是耐心和对细节的把握。

解决方案

要让VSCode成为你得力的Ruby开发伙伴，你需要依次完成以下几步，每一步都有其存在的理由，环环相扣：

首先，确保你的系统上安装了Ruby。这听起来是废话，但很多人直接跳过这一步，或者依赖系统自带的老旧版本。我个人倾向于使用版本管理工具，比如

rbenv

登录后复制

或

RVM

登录后复制

，它们能让你在不同的项目间轻松切换Ruby版本，避免版本冲突带来的各种头疼问题。安装完Ruby后，记得检查你的

PATH

登录后复制

环境变量，确保Ruby可执行文件能被系统正确找到。

接下来是VSCode本身。打开它，进入扩展市场（Extensions），搜索并安装几个关键的扩展。首当其冲的是官方的“Ruby”扩展，它提供了基本的语法高亮、代码片段和一些语言特性支持。但真正让开发体验质变的，是像

Solargraph

登录后复制

这样的LSP服务器。它能提供智能的代码补全、定义跳转、引用查找以及错误检查。安装完Solargraph扩展后，通常还需要在终端里运行

gem install solargraph

登录后复制

来安装Solargraph gem本身。

再者，为了提升效率，我还会安装

Code Runner

登录后复制

，它能让你快速运行当前文件中的Ruby代码，测试小片段时非常方便。如果你需要调试，那么“Ruby Debugger”或兼容

rdbg

登录后复制

的扩展也是必不可少的。

最后一步是配置。这包括VSCode的用户设置（

settings.json

登录后复制

）和项目级的配置（

.vscode/settings.json

登录后复制

或

.vscode/launch.json

登录后复制

）。你可能需要指定Solargraph的工作区、配置代码格式化工具（比如

rubocop

登录后复制

）的路径，或者设置调试器的启动配置。举个例子，如果你的项目使用

rubocop

登录后复制

进行代码风格检查，你可能需要在VSCode设置里指定它的路径，或者让它在保存时自动运行。这些配置虽然看起来零碎，但它们是构建流畅开发体验的关键。

Ruby版本管理工具的选择与安装，哪个更适合我？

说到Ruby版本管理，这真是个老生常谈的话题，但每次都值得再聊聊。市面上最主流的无疑是

rbenv

登录后复制

和

RVM

登录后复制

。它们都能让你在同一台机器上安装并管理多个Ruby版本，这对于同时维护多个Ruby项目，或者需要测试新版本Ruby兼容性时，简直是救命稻草。

RVM (Ruby Version Manager) 出现得更早，功能也更强大，它不仅管理Ruby版本，还能管理gemset（gem的独立集合），这意味着你可以为每个项目创建独立的gem环境，彻底避免gem之间的冲突。RVM的安装通常比较简单，通过一个curl命令就能搞定。它的一个特点是会修改你的shell环境，通过

source

登录后复制

命令加载RVM的脚本，让RVM的命令可以直接使用。对于初学者来说，RVM可能感觉更“全能”，因为它把Ruby和gem都管得服服帖帖。

然而，rbenv 的哲学则完全不同。它更轻量级，遵循Unix的“小工具做一件事并做好”的原则。rbenv只负责管理Ruby版本，不直接管理gemset。它通过修改

PATH

登录后复制

环境变量，在命令查找路径中插入一个垫片（shim），当你在终端输入

ruby

登录后复制

或

bundle

登录后复制

时，rbenv会根据当前目录的

.ruby-version

登录后复制

文件来决定使用哪个Ruby版本。gemset的管理则通常交给

bundler

登录后复制

或者

gemset

登录后复制

插件（比如

rbenv-gemset

登录后复制

）。我个人更偏爱rbenv，因为它侵入性更小，更符合我的“少即是多”的开发理念。它的工作方式也更透明，你总能清楚地知道哪个Ruby可执行文件正在被调用。

选择哪个，真的取决于你的个人偏好和项目需求。如果你喜欢一个大而全、开箱即用的解决方案，RVM可能更适合你。如果你追求轻量、模块化、对系统侵入性小，并且不介意额外配置gemset，那么rbenv会是更好的选择。安装方面，两者都有详细的官方文档，通常几行命令就能搞定。安装后，别忘了运行

rbenv init

登录后复制

或

rvm requirements

登录后复制

来确保环境配置正确。

VSCode Ruby开发常用扩展推荐及配置技巧

VSCode的强大之处，很大程度上在于其丰富的扩展生态。对于Ruby开发，有那么几款扩展，我觉得几乎是必备的，它们能将你的开发体验从“能用”提升到“好用”甚至“愉悦”。

首先，Ruby 扩展（通常是官方或社区维护的那个，图标是个红色的Ruby菱形）。这是基础，提供了语法高亮、代码片段、基本智能感知。但它本身并不提供强大的LSP功能。

琅琅配音

全能AI配音神器

208

查看详情

真正让智能感知飞跃的是 Solargraph。安装这个VSCode扩展后，你还需要在你的Ruby环境里安装

Solargraph

登录后复制

这个gem：

gem install solargraph

登录后复制

。Solargraph是一个Ruby的语言服务器，它能分析你的代码，提供精准的自动补全、方法签名提示、定义跳转、引用查找以及实时错误检查。它的配置通常很简单，默认就能工作。但如果你遇到性能问题或者想要更精确的类型推断，可以在项目根目录创建

.solargraph.yml

登录后复制

文件进行配置，比如排除一些目录：

require:
  - solargraph-rails # 如果是Rails项目，安装这个gem并在这里require
include:
  - "**/*.rb"
exclude:
  - "**/bin/**/*"
  - "**/node_modules/**/*"
  - "**/vendor/**/*"

登录后复制

接着是 Ruby Debugger。这通常指的是基于

rdbg

登录后复制

（Ruby 3.1+内置）或

ruby-debug-ide

登录后复制

的调试器。安装VSCode的Ruby Debugger扩展后，你需要在项目中配置

launch.json

登录后复制

文件，才能让调试器知道如何启动你的应用。这部分我们会在下一个小节详细讲。

Code Runner 也是个小而美的工具。它让你能快速运行当前打开的Ruby文件或者选中的代码片段。对于快速测试一个函数或者验证一个小逻辑，它比每次都打开终端运行要方便得多。

如果你使用

rubocop

登录后复制

进行代码风格检查和格式化，那么安装一个 RuboCop 扩展（或者直接在VSCode的设置中配置保存时运行RuboCop）也是非常推荐的。你可以在

settings.json

登录后复制

中这样配置：

{
    "ruby.format": "rubocop",
    "ruby.rubocop.onSave": true,
    "ruby.rubocop.executePath": "/path/to/your/rubocop" // 如果rubocop不在PATH中，需要指定路径
}

登录后复制

这些扩展的组合，基本上就能覆盖日常Ruby开发的大部分需求。记住，配置不是一劳永逸的，随着项目和个人习惯的变化，你可能需要不断调整。

调试Ruby代码：VSCode调试器的配置与使用

调试是开发过程中不可或缺的一环，尤其是在处理复杂逻辑或追踪难以复现的bug时。VSCode的调试功能非常强大，但对于Ruby，它需要一些额外的配置。

核心在于

launch.json

登录后复制

文件，它位于你的项目根目录下的

.vscode

登录后复制

文件夹内。这个文件定义了VSCode如何启动和连接到你的Ruby应用进行调试。对于Ruby 3.1及以上版本，我们通常使用内置的

rdbg

登录后复制

调试器。

一个基本的

launch.json

登录后复制

配置可能长这样：

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Debug Current File",
            "type": "rdbg",
            "request": "launch",
            "program": "${file}",
            "args": [],
            "cwd": "${workspaceFolder}"
        },
        {
            "name": "Debug Rake Task",
            "type": "rdbg",
            "request": "launch",
            "program": "${workspaceFolder}/bin/bundle", // 确保bundle在PATH中或指定完整路径
            "args": [
                "exec",
                "rake",
                "your_rake_task_name" // 替换为你的Rake任务名
            ],
            "cwd": "${workspaceFolder}"
        },
        {
            "name": "Debug Rails Server",
            "type": "rdbg",
            "request": "launch",
            "program": "${workspaceFolder}/bin/rails",
            "args": [
                "server",
                "-p",
                "3000"
            ],
            "cwd": "${workspaceFolder}",
            "env": {
                "RAILS_ENV": "development"
            }
        }
    ]
}

登录后复制

配置说明：

type: "rdbg"
登录后复制
: 指定使用
```
rdbg
```
登录后复制
调试器。如果你使用的是旧版Ruby或
```
ruby-debug-ide
```
登录后复制
，这里可能需要调整。
request: "launch"
登录后复制
: 表示启动一个新的进程进行调试。
program
登录后复制
: 这是你要执行的Ruby脚本或命令的路径。
- ```
"${file}"
```
  登录后复制
  ：调试当前打开的文件。
- ```
"${workspaceFolder}/bin/bundle"
```
  登录后复制
  ：对于Rails或Rake任务，你通常会通过
```
bundle exec
```
  登录后复制
  来运行。
- ```
"${workspaceFolder}/bin/rails"
```
  登录后复制
  ：启动Rails服务器。
args
登录后复制
: 传递给
```
program
```
登录后复制
的命令行参数。
cwd
登录后复制
: 工作目录，通常是项目根目录
```
"${workspaceFolder}"
```
登录后复制
。
env
登录后复制
: 环境变量，比如设置
```
RAILS_ENV
```
登录后复制
。

使用流程：

设置断点： 在你想要暂停代码执行的行号左侧点击，会出现一个红点，这就是断点。
选择调试配置： 在VSCode左侧的“运行和调试”视图（虫子图标）中，顶部的下拉菜单选择你刚刚配置好的调试项（比如“Debug Current File”）。
启动调试： 点击绿色的播放按钮启动调试。
调试操作： 代码会在断点处暂停。此时，你可以使用调试控制面板上的按钮进行操作：
- 继续 (F5)：执行到下一个断点或程序结束。
- 单步跳过 (F10)：执行当前行并跳到下一行，不进入函数内部。
- 单步进入 (F11)：执行当前行并进入函数内部。
- 单步跳出 (Shift+F11)：从当前函数中跳出。
- 重新启动 (Ctrl+Shift+F5)：重新启动调试会话。
- 停止 (Shift+F5)：停止调试。
查看变量： 在左侧的“变量”面板中，你可以实时查看当前作用域内所有变量的值。
调用堆栈： “调用堆栈”面板显示了当前代码执行的路径。
监视表达式： 在“监视”面板中添加你关心的表达式，它们的值会实时更新。