class RubyLsp::Rails::Definition

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

Currently supported targets:

Callbacks
Named routes (e.g. users_path)

Example¶ ↑

before_action :foo # <- Go to definition on this symbol will jump to the method if it is defined in the same class

Notes for named routes:

It is available only in Rails 7.1 or newer.
Route may be defined across multiple files, e.g. using draw, rather than in routes.rb.
Routes won’t be found if not defined for the Rails development environment.
If using constraints, the route can only be found if the constraints are met.
Changes to routes won’t be picked up until the server is restarted.

Public Class Methods

new(client, response_builder, nesting, index, dispatcher)

# File lib/ruby_lsp/ruby_lsp_rails/definition.rb, line 43
def initialize(client, response_builder, nesting, index, dispatcher)
  @client = client
  @response_builder = response_builder
  @nesting = nesting
  @index = index

  dispatcher.register(self, :on_call_node_enter)
end

Public Instance Methods

on_call_node_enter(node)

# File lib/ruby_lsp/ruby_lsp_rails/definition.rb, line 53
def on_call_node_enter(node)
  return unless self_receiver?(node)

  message = node.message

  return unless message

  if Support::Callbacks::ALL.include?(message)
    handle_callback(node)
  elsif message.end_with?("_path") || message.end_with?("_url")
    handle_route(node)
  end
end

class RubyLsp::Rails::Definition
- Public Class Methods
  - new
- Public Instance Methods
  - on_call_node_enter