class RubyLsp::Requests::DocumentSymbol

The document symbol request informs the editor of all the important symbols, such as classes, variables, and methods, defined in a file. With this information, the editor can populate breadcrumbs, file outline and allow for fuzzy symbol searches.

In VS Code, fuzzy symbol search can be accessed by opening the command palette and inserting an @ symbol.

Example¶ ↑

class Person # --> document symbol: class
  attr_reader :age # --> document symbol: field

  def initialize
    @age = 0 # --> document symbol: variable
  end

  def age # --> document symbol: method
  end
end

Public Class Methods

new(uri, dispatcher)

Calls superclass method

# File lib/ruby_lsp/requests/document_symbol.rb, line 49
def initialize(uri, dispatcher)
  super()
  @response_builder = T.let(ResponseBuilders::DocumentSymbol.new, ResponseBuilders::DocumentSymbol)
  Listeners::DocumentSymbol.new(@response_builder, uri, dispatcher)

  Addon.addons.each do |addon|
    addon.create_document_symbol_listener(@response_builder, dispatcher)
  end
end

provider()

# File lib/ruby_lsp/requests/document_symbol.rb, line 38
def provider
  Interface::DocumentSymbolClientCapabilities.new(
    hierarchical_document_symbol_support: true,
    symbol_kind: {
      value_set: (Constant::SymbolKind::FILE..Constant::SymbolKind::TYPE_PARAMETER).to_a,
    },
  )
end

Public Instance Methods

perform()

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