class RubyLsp::Requests::DocumentLink

The document link 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¶ ↑

# 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

Public Class Methods

new(uri, comments, dispatcher)

Calls superclass method

# File lib/ruby_lsp/requests/document_link.rb, line 40
def initialize(uri, comments, dispatcher)
  super()
  @response_builder = T.let(
    ResponseBuilders::CollectionResponseBuilder[Interface::DocumentLink].new,
    ResponseBuilders::CollectionResponseBuilder[Interface::DocumentLink],
  )
  Listeners::DocumentLink.new(@response_builder, uri, comments, dispatcher)
end

provider()

# File lib/ruby_lsp/requests/document_link.rb, line 28
def provider
  Interface::DocumentLinkOptions.new(resolve_provider: false)
end

Public Instance Methods

perform()

# File lib/ruby_lsp/requests/document_link.rb, line 50
def perform
  @response_builder.response
end

class RubyLsp::Requests::DocumentLink

Example¶ ↑

Public Class Methods

new(uri, comments, dispatcher) Show source

provider() Show source

Public Instance Methods

perform() Show source

new(uri, comments, dispatcher)

provider()

perform()