Add a basic RubyLSP dependencies custom request #1346
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
Co-authored-by: Vinicius Stock <[email protected]>
st0012
reviewed
Feb 1, 2024
lib/ruby_lsp/executor.rb
Outdated
| @@ -222,6 +222,16 @@ def run(request) | |||
| workspace_symbol(request.dig(:params, :query)) | |||
| when "rubyLsp/textDocument/showSyntaxTree" | |||
| show_syntax_tree(uri, request.dig(:params, :range)) | |||
| when "rubyLsp/workspace/dependencies" | |||
| dep_keys = Bundler.definition.locked_deps.keys.to_set | |||
| Bundler.definition.specs.map do |spec| | |||
There was a problem hiding this comment.
I think we had a few cases where definition.to_spec returns nil (e.g. #1326). Can definition.specs also contain nil?
There was a problem hiding this comment.
I don't think so, since definition.specs should map directly to the list of specs in the GEM section of a Gemfile.lock.
Btw, the issue you mention is a RubyGems issue, not a Bundler issue, whereas the calls we are making here are purely to Bundler.
vinistock
force-pushed
the
uk-add-bundler-view
branch
from
6bd90cb to
a1da8a6
Compare
st0012
approved these changes
Feb 5, 2024
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.
Motivation
In order to support the "Dependencies" view in VSCode, we need to add a custom request in Ruby LSP to gather and return a list of dependencies of the current project.
Implementation
Discover all direct dependencies using
Bundler.definition.locked_depsand then convert all of the specs in theBundler.definitioninto a list of spec name, version, path and if the spec is a direct dependency or not. The last property is useful for either sorting the view based on direct dependency vs transitive dependency, and, in the future, will also allow us to show "Remove" buttons next to direct dependencies.Automated Tests
No tests yet
Manual Tests
Can't manually test it except for making the LSP request.