Class: RubyLsp::Requests::DocumentLink
- Inherits:
-
BaseRequest
- Object
- SyntaxTree::Visitor
- BaseRequest
- RubyLsp::Requests::DocumentLink
- Extended by:
- T::Sig
- Defined in:
- lib/ruby_lsp/requests/document_link.rb
Overview
![Document link demo](../../misc/document_link.gif)
The [document link](microsoft.github.io/language-server-protocol/specification#textDocument_documentLink) makes ‘# source://PATH_TO_FILE#line` comments in a Ruby/RBI file clickable if the file exists. When the user clicks the link, it’ll open that location.
# Example
“‘ruby # source://syntax_tree/3.2.1/lib/syntax_tree.rb#51 <- it will be clickable and will take the user to that location def format(source, maxwidth = T.unsafe(nil)) end “`
Constant Summary collapse
- GEM_TO_VERSION_MAP =
T.let( [*::Gem::Specification.default_stubs, *::Gem::Specification.stubs].map! do |s| [s.name, s.version.to_s] end.to_h.freeze, T::Hash[String, String], )
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(uri, document) ⇒ DocumentLink
constructor
A new instance of DocumentLink.
- #run ⇒ Object
- #visit_comment(node) ⇒ Object
Methods inherited from BaseRequest
#full_constant_name, #locate, #range_from_syntax_tree_node, #visible?
Constructor Details
#initialize(uri, document) ⇒ DocumentLink
Returns a new instance of DocumentLink.
73 74 75 76 77 78 79 80 81 |
# File 'lib/ruby_lsp/requests/document_link.rb', line 73 def initialize(uri, document) super(document) # Match the version based on the version in the RBI file name. Notice that the `@` symbol is sanitized to `%40` # in the URI version_match = /(?<=%40)[\d.]+(?=\.rbi$)/.match(uri) @gem_version = T.let(version_match && version_match[0], T.nilable(String)) @links = T.let([], T::Array[LanguageServer::Protocol::Interface::DocumentLink]) end |
Class Method Details
.gem_paths ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/ruby_lsp/requests/document_link.rb', line 35 def gem_paths @gem_paths ||= T.let( begin lookup = {} Gem::Specification.stubs.each do |stub| spec = stub.to_spec lookup[spec.name] = {} lookup[spec.name][spec.version.to_s] = {} Dir.glob("**/*.rb", base: "#{spec.full_gem_path}/").each do |path| lookup[spec.name][spec.version.to_s][path] = "#{spec.full_gem_path}/#{path}" end end Gem::Specification.default_stubs.each do |stub| spec = stub.to_spec lookup[spec.name] = {} lookup[spec.name][spec.version.to_s] = {} prefix_matchers = Regexp.union(spec.require_paths.map do |rp| Regexp.new("^#{rp}/") end) prefix_matcher = Regexp.union(prefix_matchers, //) spec.files.each do |file| path = file.sub(prefix_matcher, "") lookup[spec.name][spec.version.to_s][path] = "#{RbConfig::CONFIG["rubylibdir"]}/#{path}" end end lookup end, T.nilable(T::Hash[String, T::Hash[String, T::Hash[String, String]]]), ) end |
Instance Method Details
#run ⇒ Object
84 85 86 87 |
# File 'lib/ruby_lsp/requests/document_link.rb', line 84 def run visit(@document.tree) if @document.parsed? @links end |
#visit_comment(node) ⇒ Object
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/ruby_lsp/requests/document_link.rb', line 90 def visit_comment(node) match = node.value.match(%r{source://.*#\d+$}) return unless match uri = T.cast(URI(match[0]), URI::Source) gem_version = T.must(resolve_version(uri)) file_path = self.class.gem_paths.dig(uri.gem_name, gem_version, uri.path) return if file_path.nil? @links << LanguageServer::Protocol::Interface::DocumentLink.new( range: range_from_syntax_tree_node(node), target: "file://#{file_path}##{uri.line_number}", tooltip: "Jump to #{file_path}##{uri.line_number}", ) end |