Class: RubyLsp::Requests::WorkspaceSymbol

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/ruby_lsp/requests/workspace_symbol.rb

Overview

![Workspace symbol demo](../../workspace_symbol.gif)

The [workspace symbol](microsoft.github.io/language-server-protocol/specification#workspace_symbol) request allows fuzzy searching declarations in the entire project. On VS Code, use CTRL/CMD + T to search for symbols.

# Example

“‘ruby # Searching for `Floo` will fuzzy match and return all declarations according to the query, including this `Foo` class class Foo end “`

Instance Method Summary collapse

Constructor Details

#initialize(query, index) ⇒ WorkspaceSymbol

Returns a new instance of WorkspaceSymbol.



25
26
27
28
 
# File 'lib/ruby_lsp/requests/workspace_symbol.rb', line 25

def initialize(query, index)
  @query = query
  @index = index
end

Instance Method Details

#run ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ruby_lsp/requests/workspace_symbol.rb', line 31

def run
  bundle_path = begin
    Bundler.bundle_path.to_s
  rescue Bundler::GemfileNotFound
    nil
  end

  @index.fuzzy_search(@query).filter_map do |entry|
    # If the project is using Sorbet, we let Sorbet handle symbols defined inside the project itself and RBIs, but
    # we still return entries defined in gems to allow developers to jump directly to the source
    file_path = entry.file_path
    if DependencyDetector.instance.typechecker && bundle_path && !file_path.start_with?(bundle_path) &&
        !file_path.start_with?(RbConfig::CONFIG["rubylibdir"])

      next
    end

    # We should never show private symbols when searching the entire workspace
    next if entry.visibility == :private

    kind = kind_for_entry(entry)
    loc = entry.location

    # We use the namespace as the container name, but we also use the full name as the regular name. The reason we
    # do this is to allow people to search for fully qualified names (e.g.: `Foo::Bar`). If we only included the
    # short name `Bar`, then searching for `Foo::Bar` would not return any results
    *container, _short_name = entry.name.split("::")

    Interface::WorkspaceSymbol.new(
      name: entry.name,
      container_name: T.must(container).join("::"),
      kind: kind,
      location: Interface::Location.new(
        uri: URI::Generic.from_path(path: file_path).to_s,
        range:  Interface::Range.new(
          start: Interface::Position.new(line: loc.start_line - 1, character: loc.start_column),
          end: Interface::Position.new(line: loc.end_line - 1, character: loc.end_column),
        ),
      ),
    )
  end
end