class RubyLsp::Requests::Definition

The definition request jumps to the definition of the symbol under the cursor.

Currently supported targets: - Classes - Modules - Constants - Require paths - Methods invoked on self only

Example¶ ↑

require "some_gem/file" # <- Request go to definition on this string will take you to the file
Product.new # <- Request go to definition on this class name will take you to its declaration.

Public Class Methods

new(document, global_state, position, dispatcher, typechecker_enabled)

Calls superclass method

# File lib/ruby_lsp/requests/definition.rb, line 40
def initialize(document, global_state, position, dispatcher, typechecker_enabled)
  super()
  @response_builder = T.let(
    ResponseBuilders::CollectionResponseBuilder[Interface::Location].new,
    ResponseBuilders::CollectionResponseBuilder[Interface::Location],
  )
  @dispatcher = dispatcher

  target, parent, nesting = document.locate_node(
    position,
    node_types: [Prism::CallNode, Prism::ConstantReadNode, Prism::ConstantPathNode],
  )

  if target.is_a?(Prism::ConstantReadNode) && parent.is_a?(Prism::ConstantPathNode)
    # If the target is part of a constant path node, we need to find the exact portion of the constant that the
    # user is requesting to go to definition for
    target = determine_target(
      target,
      parent,
      position,
    )
  elsif target.is_a?(Prism::CallNode) && target.name != :require && target.name != :require_relative &&
      !covers_position?(target.message_loc, position)
    # If the target is a method call, we need to ensure that the requested position is exactly on top of the
    # method identifier. Otherwise, we risk showing definitions for unrelated things
    target = nil
  end

  if target
    Listeners::Definition.new(
      @response_builder,
      global_state,
      document.uri,
      nesting,
      dispatcher,
      typechecker_enabled,
    )

    Addon.addons.each do |addon|
      addon.create_definition_listener(@response_builder, document.uri, nesting, dispatcher)
    end
  end

  @target = T.let(target, T.nilable(Prism::Node))
end

Public Instance Methods

perform()

# File lib/ruby_lsp/requests/definition.rb, line 87
def perform
  @dispatcher.dispatch_once(@target) if @target
  @response_builder.response
end