Skip to content

Commit 4f5dd98

Browse files
committed
Update readme
1 parent efdec52 commit 4f5dd98

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,30 @@
1-
# Ruby::Lsp::Rspec
1+
# Ruby LSP RSpec
22

3-
TODO: Delete this and the text below, and describe your gem
3+
Ruby LSP RSpec is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for displaying code-lenses for RSpec tests.
44

5-
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ruby/lsp/rspec`. To experiment with that code, run `bin/console` for an interactive prompt.
5+
![Screenshot of the code lenses](/misc/example.png)
66

77
## Installation
88

9-
TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
9+
To install, add the following line to your application's Gemfile:
1010

11-
Install the gem and add to the application's Gemfile by executing:
11+
```ruby
12+
# Gemfile
13+
group :development do
14+
gem "ruby-lsp-rspec"
15+
end
16+
```
1217

13-
$ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
18+
After running `bundle install`, restart Ruby LSP and you should start seeing code-lenses in your RSpec test files.
1419

15-
If bundler is not being used to manage dependencies, install the gem by executing:
20+
## Usages (with VS Code)
1621

17-
$ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
22+
1. When clicking `Run`, the test(s) will be executed via the Test Explorer.
23+
- However, deeply nested tests may not be displayed correctly at the moment.
24+
2. When clicking `Run In Terminal`, a test command will be generated in the terminal.
25+
3. When clicking `Debug`, the test(s) will be executed with VS Code debugger enabled (requires the [`debug`](https://github.com/ruby/debug) gem).
26+
- [Learn how to set breakpoints in VS Code](https://code.visualstudio.com/docs/editor/debugging#_breakpoints).
1827

19-
## Usage
20-
21-
TODO: Write usage instructions here
2228

2329
## Development
2430

@@ -28,12 +34,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
2834

2935
## Contributing
3036

31-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/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/[USERNAME]/ruby-lsp-rspec/blob/main/CODE_OF_CONDUCT.md).
37+
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).
3238

3339
## License
3440

3541
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
3642

3743
## Code of Conduct
3844

39-
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/[USERNAME]/ruby-lsp-rspec/blob/main/CODE_OF_CONDUCT.md).
45+
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).

misc/example.png

36.4 KB
Loading

0 commit comments

Comments
 (0)