class RubyLsp::Requests::PrepareTypeHierarchy

The prepare type hierarchy request displays the list of ancestors (supertypes) and descendants (subtypes) for the selected type.

Currently only supports supertypes due to a limitation of the index.

Example¶ ↑

class Foo; end
class Bar < Foo; end

puts Bar # <-- right click on `Bar` and select "Show Type Hierarchy"

Public Class Methods

new(document, index, position)

Calls superclass method

# File lib/ruby_lsp/requests/prepare_type_hierarchy.rb, line 43
def initialize(document, index, position)
  super()

  @document = document
  @index = index
  @position = position
end

provider()

# File lib/ruby_lsp/requests/prepare_type_hierarchy.rb, line 31
def provider
  Interface::TypeHierarchyOptions.new
end

Public Instance Methods

perform()

# File lib/ruby_lsp/requests/prepare_type_hierarchy.rb, line 52
def perform
  context = @document.locate_node(
    @position,
    node_types: [
      Prism::ConstantReadNode,
      Prism::ConstantWriteNode,
      Prism::ConstantPathNode,
    ],
  )

  node = context.node
  parent = context.parent
  return unless node && parent

  target = determine_target(node, parent, @position)
  entries = @index.resolve(target.slice, context.nesting)
  return unless entries

  # While the spec allows for multiple entries, VSCode seems to only support one
  # We'll just return the first one for now
  first_entry = T.must(entries.first)

  range = range_from_location(first_entry.location)

  [
    Interface::TypeHierarchyItem.new(
      name: first_entry.name,
      kind: kind_for_entry(first_entry),
      uri: URI::Generic.from_path(path: first_entry.file_path).to_s,
      range: range,
      selection_range: range,
    ),
  ]
end