class RubyLsp::Addon

To register an addon, inherit from this class and implement both name and activate

Example¶ ↑

module MyGem
  class MyAddon < Addon
    def activate
      # Perform any relevant initialization
    end

    def name
      "My addon name"
    end
  end
end

Attributes

addon_classes (attr_reader)

addons (attr_accessor)

file_watcher_addons (attr_accessor)

Public Class Methods

inherited(child_class)

Calls superclass method

# File lib/ruby_lsp/addon.rb, line 47
def inherited(child_class)
  addon_classes << child_class
  super
end

load_addons(global_state, outgoing_queue)

# File lib/ruby_lsp/addon.rb, line 54
def load_addons(global_state, outgoing_queue)
  # Require all addons entry points, which should be placed under
  # `some_gem/lib/ruby_lsp/your_gem_name/addon.rb`
  Gem.find_files("ruby_lsp/**/addon.rb").each do |addon|
    require File.expand_path(addon)
  rescue => e
    $stderr.puts(e.full_message)
  end

  # Instantiate all discovered addon classes
  self.addons = addon_classes.map(&:new)
  self.file_watcher_addons = addons.select { |addon| addon.respond_to?(:workspace_did_change_watched_files) }

  # Activate each one of the discovered addons. If any problems occur in the addons, we don't want to
  # fail to boot the server
  addons.each do |addon|
    addon.activate(global_state, outgoing_queue)
  rescue => e
    addon.add_error(e)
  end
end

new()

# File lib/ruby_lsp/addon.rb, line 78
def initialize
  @errors = T.let([], T::Array[StandardError])
end

Public Instance Methods

activate(global_state, outgoing_queue)

# File lib/ruby_lsp/addon.rb, line 109
def activate(global_state, outgoing_queue); end

add_error(error)

# File lib/ruby_lsp/addon.rb, line 83
def add_error(error)
  @errors << error
  self
end

backtraces()

# File lib/ruby_lsp/addon.rb, line 102
def backtraces
  @errors.filter_map(&:backtrace).join("\n\n")
end

create_code_lens_listener(response_builder, uri, dispatcher)

# File lib/ruby_lsp/addon.rb, line 128
def create_code_lens_listener(response_builder, uri, dispatcher); end

create_completion_listener(response_builder, nesting, dispatcher, uri)

# File lib/ruby_lsp/addon.rb, line 177
def create_completion_listener(response_builder, nesting, dispatcher, uri); end

create_definition_listener(response_builder, uri, nesting, dispatcher)

# File lib/ruby_lsp/addon.rb, line 166
def create_definition_listener(response_builder, uri, nesting, dispatcher); end

create_document_symbol_listener(response_builder, dispatcher)

# File lib/ruby_lsp/addon.rb, line 147
def create_document_symbol_listener(response_builder, dispatcher); end

create_hover_listener(response_builder, nesting, dispatcher)

# File lib/ruby_lsp/addon.rb, line 138
def create_hover_listener(response_builder, nesting, dispatcher); end

create_semantic_highlighting_listener(response_builder, dispatcher)

# File lib/ruby_lsp/addon.rb, line 155
def create_semantic_highlighting_listener(response_builder, dispatcher); end

deactivate()

# File lib/ruby_lsp/addon.rb, line 114
def deactivate; end

error?()

# File lib/ruby_lsp/addon.rb, line 89
def error?
  @errors.any?
end

formatted_errors()

# File lib/ruby_lsp/addon.rb, line 94
    def formatted_errors
      <<~ERRORS
        #{name}:
          #{@errors.map(&:message).join("\n")}
      ERRORS
    end

name()

# File lib/ruby_lsp/addon.rb, line 118
def name; end

class RubyLsp::Addon

Example¶ ↑

Attributes

addon_classes (attr_reader)

addons (attr_accessor)

file_watcher_addons (attr_accessor)

Public Class Methods

inherited(child_class) Show source

load_addons(global_state, outgoing_queue) Show source

new() Show source

Public Instance Methods

activate(global_state, outgoing_queue) Show source

add_error(error) Show source

backtraces() Show source

create_code_lens_listener(response_builder, uri, dispatcher) Show source

create_completion_listener(response_builder, nesting, dispatcher, uri) Show source

create_definition_listener(response_builder, uri, nesting, dispatcher) Show source

create_document_symbol_listener(response_builder, dispatcher) Show source

create_hover_listener(response_builder, nesting, dispatcher) Show source

create_semantic_highlighting_listener(response_builder, dispatcher) Show source

deactivate() Show source

error?() Show source

formatted_errors() Show source

name() Show source

inherited(child_class)

load_addons(global_state, outgoing_queue)

new()

activate(global_state, outgoing_queue)

add_error(error)

backtraces()

create_code_lens_listener(response_builder, uri, dispatcher)

create_completion_listener(response_builder, nesting, dispatcher, uri)

create_definition_listener(response_builder, uri, nesting, dispatcher)

create_document_symbol_listener(response_builder, dispatcher)

create_hover_listener(response_builder, nesting, dispatcher)

create_semantic_highlighting_listener(response_builder, dispatcher)

deactivate()

error?()

formatted_errors()

name()