https://github.com/st0012/ruby-lsp-rspec
A Ruby LSP addon for RSpec tests
https://github.com/st0012/ruby-lsp-rspec
rspec ruby-lsp vscode-extension
Last synced: 2 days ago
JSON representation
A Ruby LSP addon for RSpec tests
- Host: GitHub
- URL: https://github.com/st0012/ruby-lsp-rspec
- Owner: st0012
- License: mit
- Created: 2023-09-10T21:09:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-03T20:05:47.000Z (2 months ago)
- Last Synced: 2025-04-06T15:05:26.574Z (9 days ago)
- Topics: rspec, ruby-lsp, vscode-extension
- Language: Ruby
- Homepage:
- Size: 20 MB
- Stars: 154
- Watchers: 7
- Forks: 11
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-sorbet - ruby-lsp-rspec
README
# Ruby LSP RSpec
[](https://badge.fury.io/rb/ruby-lsp-rspec)
Ruby LSP RSpec is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) addon for displaying CodeLens for RSpec tests.
## Installation
To install, add the following line to your application's Gemfile:
```ruby
# Gemfile
group :development do
gem "ruby-lsp-rspec", require: false
end
```
> [!IMPORTANT]
> Make sure the relevant features are [enabled](https://github.com/Shopify/ruby-lsp/tree/main/vscode#enable-or-disable-features) under your VSCode's `rubyLsp.enabledFeatures` setting, such as `codeLens`.
After running `bundle install`, restart Ruby LSP and you should start seeing CodeLens in your RSpec test files.
## Features
### CodeLens
1. When clicking `Run`, the test(s) will be executed via the Test Explorer
- However, deeply nested tests may not be displayed correctly at the moment
2. When clicking `Run In Terminal`, a test command will be generated in the terminal
3. When clicking `Debug`, the test(s) will be executed with VS Code debugger enabled (requires the [`debug`](https://github.com/ruby/debug) gem)
- [Learn how to set breakpoints in VS Code](https://code.visualstudio.com/docs/editor/debugging#_breakpoints)
### Document Symbols
Document Symbols can be triggered by:
- Typing `@` in VS Code's command palette
- Pressing `Cmd+Shift+O`
### Go to definition
`ruby-lsp-rspec` supports go-to-definition on methods defined through `let` and `subject` DSLs in spec files.
In VS Code this feature can be triggered by one of the following methods:
- `Right click` on the target, and then select `Go to Definition`
- Placing the cursor on the target, and then hit `F12`
- `Command + click` the target
> [!Note]
> This feature requires indexing your spec files so they can't be excluded from Ruby LSP's indexing.
### VS Code Configuration
`ruby-lsp-rspec` can be configured through VS Code's `settings.json` file.
All configuration options must be nested under the `Ruby LSP RSpec` addon within `rubyLsp.addonSettings`:
```json
{
// ...
"rubyLsp.addonSettings": {
"Ruby LSP RSpec": {
// Configuration options go here
}
}
}
```
#### `rspecCommand`
**Description:**
Customize the command used to run tests via CodeLens. If not set, the command will be inferred based on the presence of a binstub or Gemfile.
**Default Value**: `nil`
**Example:**
```json
{
// ...
"rubyLsp.addonSettings": {
"Ruby LSP RSpec": {
"rspecCommand": "rspec -f d"
}
}
}
```
#### `debug`
**Description:**
Enable debug logging. Currently, this only logs the RSpec command used by CodeLens to stderr, which can be viewed in VS Code's `OUTPUT` panel under `Ruby LSP`.
**Default Value**: `false`
**Example:**
```json
{
"rubyLsp.addonSettings": {
"Ruby LSP RSpec": {
"debug": true
}
}
}
```
### Container Development
When developing in containers, use the official [`Dev Containers`](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension. This ensures Ruby LSP and Ruby LSP RSpec run inside the container, allowing correct spec path resolution.
For detailed container setup instructions, see the [Ruby LSP documentation](https://github.com/Shopify/ruby-lsp/blob/main/vscode/README.md?tab=readme-ov-file#developing-on-containers).
Make sure to configure Ruby LSP to run inside the container by adding it to your `.devcontainer.json`:
```json
{
"name": "my-app",
// ...
"customizations": {
"vscode": {
"extensions": [
"Shopify.ruby-lsp",
// ...
]
}
}
}
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/st0012/ruby-lsp-rspec. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/st0012/ruby-lsp-rspec/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Ruby::Lsp::Rspec project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/st0012/ruby-lsp-rspec/blob/main/CODE_OF_CONDUCT.md).