Skip to content

Commit 0e7944a

Browse files
authored
Merge pull request #796 from Shopify/vs/remove_bundle_exec_readme
Indicate that using `bundle exec` is no longer recommended as of v0.7.0
2 parents 64cfd2a + c8bf2f5 commit 0e7944a

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

EDITORS.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,11 @@ new H2 header in this file containing the instructions. -->
1111

1212
## Emacs Eglot
1313

14-
[Eglot](https://github.com/joaotavora/eglot) runs solargraph server by default. To set it up with ruby-lsp you need to put that in your init file:
14+
[Eglot](https://github.com/joaotavora/eglot) runs solargraph server by default. To set it up with ruby-lsp you need to
15+
put that in your init file:
1516
```el
1617
(with-eval-after-load 'eglot
1718
(add-to-list 'eglot-server-programs '((ruby-mode ruby-ts-mode) "ruby-lsp")))
1819
```
19-
Or if you want to run it with bundler:
20-
```el
21-
(with-eval-after-load 'eglot
22-
(add-to-list 'eglot-server-programs '((ruby-mode ruby-ts-mode) "bundle" "exec" "ruby-lsp")))
23-
```
24-
20+
2521
When you run `eglot` command it will run `ruby-lsp` process for you.

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,11 @@ The gem can be installed by doing
2727
gem install ruby-lsp
2828
```
2929

30-
If you decide to add the gem to the bundle, it is not necessary to require it.
30+
**NOTE**: starting with v0.7.0, it is no longer recommended to add the `ruby-lsp` to the bundle. The gem will generate a
31+
custom bundle in `.ruby-lsp/Gemfile` which is used to identify the versions of dependencies that should be used for the
32+
application (e.g.: the correct RuboCop version).
33+
34+
For older versions, if you decide to add the gem to the bundle, it is not necessary to require it.
3135
```ruby
3236
group :development do
3337
gem "ruby-lsp", require: false

0 commit comments

Comments
 (0)