Class: LanguageServer::Protocol::Interface::CodeActionRegistrationOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/code_action_registration_options.rb,
sig/language_server/protocol/interface/code_action_registration_options.rbs

Overview

Registration options for a CodeActionRequest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_selector:, code_action_kinds: nil, resolve_provider: nil, work_done_progress: nil) ⇒ CodeActionRegistrationOptions

Returns a new instance of CodeActionRegistrationOptions.

Parameters:

  • document_selector: (Object)
  • code_action_kinds: (Array[untyped]) (defaults to: nil)
  • resolve_provider: (Boolean) (defaults to: nil)
  • work_done_progress: (Boolean) (defaults to: nil) 


8
9
10
11
12
13
14
15
16
17
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 8

def initialize(document_selector:, code_action_kinds: nil, resolve_provider: nil, work_done_progress: nil)
  @attributes = {}

  @attributes[:documentSelector] = document_selector
  @attributes[:codeActionKinds] = code_action_kinds if code_action_kinds
  @attributes[:resolveProvider] = resolve_provider if resolve_provider
  @attributes[:workDoneProgress] = work_done_progress if work_done_progress

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Hash[Symbol, untyped] (readonly)

Returns the value of attribute attributes.

Returns:

  • (Hash[Symbol, untyped]) 


55
56
57
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 55

def attributes
  @attributes
end

Instance Method Details

#code_action_kinds ⇒ CodeActionKind[]

CodeActionKinds that this server may return.

The list of kinds may be generic, such as CodeActionKind.Refactor, or the server may list out every specific kind they provide.

Returns:

  • (CodeActionKind[]) 


35
36
37
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 35

def code_action_kinds
  attributes.fetch(:codeActionKinds)
end

#document_selector ⇒ DocumentSelector | nil

A document selector to identify the scope of the registration. If set to null the document selector provided on the client side will be used.

Returns:

  • (DocumentSelector | nil) 


24
25
26
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 24

def document_selector
  attributes.fetch(:documentSelector)
end

#resolve_provider ⇒ boolean

The server provides support to resolve additional information for a code action.

Returns:

  • (boolean)

Since:

  • 3.16.0



46
47
48
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 46

def resolve_provider
  attributes.fetch(:resolveProvider)
end

#to_hash ⇒ Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


57
58
59
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 57

def to_hash
  attributes
end

#to_json(*args) ⇒ String

Parameters:

  • (Object)

Returns:

  • (String) 


61
62
63
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 61

def to_json(*args)
  to_hash.to_json(*args)
end

#work_done_progress ⇒ boolean

Returns:

  • (boolean) 


51
52
53
 
# File 'lib/language_server/protocol/interface/code_action_registration_options.rb', line 51

def work_done_progress
  attributes.fetch(:workDoneProgress)
end