Text of code.visualstudio.com › docs › languages › ruby as Styx crawled it on Nov 18, 2026. The page may have changed since. Only its words are kept, without pictures or layout, and only the first part of a long page.

Open the live page

Ruby in Visual Studio Code

AI agents: See llms.txt for documentation discovery and navigation. Documentation articles are also available as Markdown by appending .md to the article URL. Join VS Code at Microsoft Ignite or catch the sessions online. A year of VS Code, wrapped. Explore the highlights. Ruby in Visual Studio Code View as Markdown Ask in VS Code Ask in VS Code Insiders Ruby is a dynamic, open-source programming language known for its simplicity and productivity.

With an expressive and elegant syntax, part of the Ruby philosophy is to make developers happy. It is often used for web development with a range of different frameworks, and for scripting, allowing for fast iterations when building prototypes. This topic goes into detail about setting up and using Ruby within Visual Studio Code, with the Ruby LSP extension. Installation Install Ruby through a version manager While Ruby is installed by default on some operating systems (such as macOS and some distributions of Linux), we recommend using a version manager to access newer versions of Ruby such as rbenv on macOS and Linux and rbenv on Windows .

Follow the installation guidance for your platform. Note : As with installing any new toolset on your machine, you'll want to make sure to restart your terminal/Command Prompt and VS Code instances to use the updated toolset location in your platform's PATH variable. Install the Ruby LSP extension in VS Code You can find and install the Ruby LSP extension from within VS Code via the Extensions view ( ⇧⌘X (Windows, Linux Ctrl+Shift+X ) ) and searching for 'Ruby LSP'.

We'll discuss many of Ruby LSP features in this topic but you can also refer to the extension's documentation and repository . Check your installation After installing, check the language status item in the Status Bar to see the status of the Ruby LSP server. If the version manager has been configured, it should display the right Ruby version for your project. The server status should display starting or running, but not error.

The extension generates a .ruby-lsp folder automatically with a custom bundle that includes the language server gem ruby-lsp . No configuration should be required. By default, the extension tries to automatically detect the Ruby version manager you're using and use the right versions and paths accordingly. If you want to customize that behavior, set the following configuration in your user settings : { "rubyLsp.rubyVersionManager" : { "identifier" : "rbenv" } } The extension will automatically try to update the ruby-lsp language server gem periodically; if you want to force that to happen, use the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) to execute Ruby LSP: Update language server gem .

If you have any problems, see troubleshooting for next steps. Main features Navigation and IntelliSense The Ruby LSP provides several navigation and IntelliSense related features, such as go to definition, hover, workspace symbol, document symbol, completion and signature help. Sorry, your browser doesn't support HTML 5 video. To learn more about moving quickly through your source code with VS Code, check out Code Navigation .

Inlay hints Ruby LSP is able to display useful information about inferred or implicit values in your code. In the example below, you can see StandardError being shown as the implicit exception class being rescued in an empty rescue call. While inlay hints can be helpful for understanding your code, you can also disable the feature via the Editor > Inlay Hints: Enabled setting ( editor.inlayHints.enabled Open in VS Code Open in VS Code Insiders ) or use the following to disable this feature only for Ruby LSP: "rubyLsp.enabledFeatures" : { "inlayHint" : false , } Semantic syntax highlighting Ruby LSP is able to use semantic syntax highlighting and styling due to its rich understanding of a project source code.

For example, it can highlight: Method invocations consistently, without confusing it with local variables. Local arguments (such as method, block or lambda arguments) consistently inside the scope in which they exist. Note : This screenshot is using the Spinel theme included in the Ruby extension pack . Themes must use the information surfaced by the Ruby LSP in order to provide rich highlighting for Ruby files. To use this feature, the editor must have semantic highlighting enabled.

"editor.semanticHighlighting.enabled" : true , Linting and formatting By default, Ruby LSP provides linting and formatting through an integration with RuboCop . You can format your Ruby file using ⇧⌥F (Windows Shift+Alt+F , Linux Ctrl+Shift+I ) or by running the Format Document command from the Command Palette ( ⇧⌘P (Windows, Linux Ctrl+Shift+P ) ) or the context menu in the editor. If your project does not use RuboCop, the Ruby LSP will format files using SyntaxTree .

You can also run the formatter on each save ( Editor: Format On Save ) to keep your Ruby code properly formatted automatically while you are working. To do that, you must enable format on save. "editor.formatOnSave" : true The Ruby LSP extension also provides some convenient completions using format on type. For example, it will auto-continue comment lines and auto-close end tokens, pipes, or string interpolation curly braces.

To use format on type, make sure it's enabled in the editor with: "editor.formatOnType" : true Quick Fixes When the linter finds errors and warnings in your source code, Ruby LSP can often provide suggested Quick Fixes (also called Code Actions), which are available via a light bulb hover in the editor. You can quickly open available Quick Fixes via the ⌘. (Windows, Linux Ctrl+. ) . Additionally, Code Action Widget: Include Nearby Quick Fixes ( editor.codeActionWidget.includeNearbyQuickFixes Open in VS Code Open in VS Code Insiders ) is a setting that is enabled on default, which will activate the nearest Quick Fix in a line from ⌘. (Windows, Linux Ctrl+. ) (command ID editor.action.quickFix ), no matter where your cursor is in that line.

The command highlights the source code that will be refactored or fixed with Quick Fixes. Normal Code Actions and non-fix refactorings can still be activated at the cursor location. Refactoring In addition to Quick Fixes, the Ruby LSP also provides refactor options through Code Actions. For example, it can extract a Ruby expression into a local variable with a single click. Run and debug tests The Ruby LSP extension integrates with the VS Code Testing view to discover, run, debug, and measure coverage for Ruby tests.

Ruby LSP includes built-in support for Minitest and Test Unit. In Rails projects, the Ruby LSP Rails add-on provides support for ActiveSupport::TestCase . Other test frameworks, such as RSpec, require a compatible Ruby LSP add-on. To discover and run tests: Open the Testing view ( ). Expand the test tree to discover tests in your workspace. Select the run button next to a test, test group, or file. You can also use the test CodeLens actions in the editor.

The Testing view provides the following test profiles: Run runs the selected tests and displays their results in the Test Results panel. Run in Terminal runs the selected tests in a terminal configured by Ruby LSP. Debug starts a debugging session for the selected tests. Coverage runs the tests with coverage enabled and displays coverage information in the editor. Ruby LSP discovers test files that follow common Ruby conventions.

Test files must be in a test , spec , or features directory and use a supported file name, such as *_test.rb , test_*.rb , or *_spec.rb . Tests defined dynamically through metaprogramming might not appear until you run their test file. For framework support, discovery limitations, and customization options, see the Ruby LSP Test Explorer documentation . To add tests with optional AI assistance, follow the test-writing workflow using your repository's existing framework and helpers.

Keep its Minitest assertions or RSpec matchers, for example, rather th

The rest of this page is on the live site.