diff --git a/docs/src/languages/ruby.md b/docs/src/languages/ruby.md index 9bf8b42e42ab05..13d75cc5f069de 100644 --- a/docs/src/languages/ruby.md +++ b/docs/src/languages/ruby.md @@ -106,14 +106,14 @@ Solargraph has formatting and diagnostics disabled by default. We can tell Zed t } ``` -To use Solargraph in the context of the bundle, you can use [folder-specific settings](../configuring-zed.md#settings-files) and specify the absolute path to the [`binstub`](https://bundler.io/v2.5/man/bundle-binstubs.1.html) of Solargraph: +By default, Solargraph uses `bundle exec` to run in the context of the bundle. To disable that, you can use the `use_bundler` configuration option: ```json { "lsp": { "solargraph": { - "binary": { - "path": "/bin/solargraph" + "settings": { + "use_bundler": false } } } @@ -156,6 +156,20 @@ Ruby LSP uses pull-based diagnostics which Zed doesn't support yet. We can tell } ``` +By default, Ruby LSP does not use `bundle exec` to run in the context of the bundle. To enable that, you can use the `use_bundler` configuration option: + +```json +{ + "lsp": { + "ruby-lsp": { + "settings": { + "use_bundler": true + } + } + } +} +``` + ## Setting up `rubocop` LSP Zed currently doesn't install `rubocop` automatically. To use `rubocop`, you need to install the gem. Zed just looks for an executable called `rubocop` on your `PATH`. @@ -193,14 +207,14 @@ Rubocop has unsafe autocorrection disabled by default. We can tell Zed to enable } ``` -To use Rubocop in the context of the bundle, you can use [folder-specific settings](../configuring-zed.md#settings-files) and specify the absolute path to the [`binstub`](https://bundler.io/v2.5/man/bundle-binstubs.1.html) of Rubocop: +By default, `rubocop` uses `bundle exec` to run in the context of the bundle. To disable that, you can use the `use_bundler` configuration option: ```json { "lsp": { "rubocop": { - "binary": { - "path": "/bin/rubocop" + "settings": { + "use_bundler": false } } }