ruby: Document use_bundler configuration option
#22498
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cla-bot
bot
added
the
cla-signed
|
Excellent. Many thanks. |
helgemahrt
pushed a commit
to helgemahrt/zed
that referenced
this pull request
Jan 1, 2025
Hello, This PR documents the `use_bundler` configuration option that was added in https://github.com/zed-extensions/ruby/releases/tag/v0.3.3 **What it does?** This option allows users to run `solargraph` and `rubocop` within the context of Bundler, which is the most commonly used scenario in the Ruby ecosystem. Ruby LSP is not configured to run in the context of Bundler because it is recommended not to add it to the project dependencies (https://shopify.github.io/ruby-lsp/composed-bundle.html). However, if this is the case, the Ruby LSP can still be configured to run in the context of Bundler via the same configuration option. This configuration option has the following default values: - `rubocop` - `use_bundler` is `true`. - `solargraph` - `use_bundler` is `true`. - `ruby-lsp` - `use_bundler` is `false`. Release Notes: - N/A
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello,
This PR documents the
use_bundlerconfiguration option that was added in https://github.com/zed-extensions/ruby/releases/tag/v0.3.3What it does?
This option allows users to run
solargraphandrubocopwithin the context of Bundler, which is the most commonly used scenario in the Ruby ecosystem. Ruby LSP is not configured to run in the context of Bundler because it is recommended not to add it to the project dependencies (https://shopify.github.io/ruby-lsp/composed-bundle.html). However, if this is the case, the Ruby LSP can still be configured to run in the context of Bundler via the same configuration option.This configuration option has the following default values:
rubocop-use_bundleristrue.solargraph-use_bundleristrue.ruby-lsp-use_bundlerisfalse.Release Notes: