Class: RubyLsp::Requests::CodeActions

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

Overview

![Code actions demo](../../code_actions.gif)

The [code actions](microsoft.github.io/language-server-protocol/specification#textDocument_codeAction) request informs the editor of RuboCop quick fixes that can be applied. These are accessible by hovering over a specific diagnostic.

# Example

“‘ruby def say_hello puts “Hello” # –> code action: quick fix indentation end “`

Constant Summary collapse

EXTRACT_TO_VARIABLE_TITLE = 
"Refactor: Extract Variable"
EXTRACT_TO_METHOD_TITLE = 
"Refactor: Extract Method"
TOGGLE_BLOCK_STYLE_TITLE = 
"Refactor: Toggle block style"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document, range, context) ⇒ CodeActions

Returns a new instance of CodeActions.



45
46
47
48
49
50
51
 
# File 'lib/ruby_lsp/requests/code_actions.rb', line 45

def initialize(document, range, context)
  super()
  @document = document
  @uri = T.let(document.uri, URI::Generic)
  @range = range
  @context = context
end

Class Method Details

.provider ⇒ Object 



30
31
32
33
34
35
 
# File 'lib/ruby_lsp/requests/code_actions.rb', line 30

def provider
  Interface::CodeActionRegistrationOptions.new(
    document_selector: [Interface::DocumentFilter.new(language: "ruby")],
    resolve_provider: true,
  )
end

Instance Method Details

#perform ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/ruby_lsp/requests/code_actions.rb', line 54

def perform
  diagnostics = @context[:diagnostics]

  code_actions = diagnostics.flat_map do |diagnostic|
    diagnostic.dig(:data, :code_actions) || []
  end

  # Only add refactor actions if there's a non empty selection in the editor
  unless @range.dig(:start) == @range.dig(:end)
    code_actions << Interface::CodeAction.new(
      title: EXTRACT_TO_VARIABLE_TITLE,
      kind: Constant::CodeActionKind::REFACTOR_EXTRACT,
      data: { range: @range, uri: @uri.to_s },
    )
    code_actions << Interface::CodeAction.new(
      title: EXTRACT_TO_METHOD_TITLE,
      kind: Constant::CodeActionKind::REFACTOR_EXTRACT,
      data: { range: @range, uri: @uri.to_s },
    )
    code_actions << Interface::CodeAction.new(
      title: TOGGLE_BLOCK_STYLE_TITLE,
      kind: Constant::CodeActionKind::REFACTOR_REWRITE,
      data: { range: @range, uri: @uri.to_s },
    )
  end

  code_actions
end