Skip to content

docs(ruby): document test discovery and execution via Testing view #9204

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DakotaB75 wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −0
Open

docs(ruby): document test discovery and execution via Testing view #9204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/languages/ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,20 @@ In addition to Quick Fixes, the Ruby LSP also provides refactor options through

![Refactor extract to variable](images/ruby/ruby_lsp_refactor.png)

## Testing with the Testing view

The Ruby LSP extension integrates with the VS Code Testing view to support test discovery and execution.

When working on a Ruby project that uses a supported test framework, tests are automatically discovered and displayed in the Testing view, where they can be run individually, by file, or as a group.

This integration is powered by the Ruby LSP and uses the VS Code Testing API, providing a consistent testing experience alongside other languages supported by VS Code.

For example, after opening a Ruby project with the Ruby LSP extension enabled, you can open the Testing view (`kb(workbench.view.testing)`) to explore available tests and run them directly from the editor UI.

For more details about supported frameworks and configuration options, see the Ruby LSP documentation:
https://shopify.github.io/ruby-lsp/#test-explorer


## Debugging

The Ruby LSP extension supports debugging using the debug gem (Ruby's official debugger). Alternatively, developers can
Expand Down Expand Up @@ -212,6 +226,8 @@ If you have any issues or feature requests, feel free to log them in the Ruby LS

If you'd like to learn more about VS Code, try these topics:

You can also explore how VS Code provides a unified testing experience across languages using the Testing view.

* [Basic Editing](/docs/editing/codebasics.md) - A quick introduction to the basics of the VS Code editor.
* [Install an Extension](/docs/configure/extensions/extension-marketplace.md) - Learn about other extensions are available in the [Marketplace](https://marketplace.visualstudio.com/vscode).
* [Code Navigation](/docs/editing/editingevolved.md) - Move quickly through your source code.