Class: LanguageServer::Protocol::Interface::CompletionRegistrationOptions

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

Overview

Registration options for a CompletionRequest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_selector:, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: nil) ⇒ CompletionRegistrationOptions

Returns a new instance of CompletionRegistrationOptions.

Parameters:

  • document_selector: (Object)
  • trigger_characters: (Array[String]) (defaults to: nil)
  • all_commit_characters: (Array[String]) (defaults to: nil)
  • resolve_provider: (Boolean) (defaults to: nil)
  • completion_item: (Object) (defaults to: nil)
  • work_done_progress: (Boolean) (defaults to: nil) 


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

def initialize(document_selector:, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil, work_done_progress: nil)
  @attributes = {}

  @attributes[:documentSelector] = document_selector
  @attributes[:triggerCharacters] = trigger_characters if trigger_characters
  @attributes[:allCommitCharacters] = all_commit_characters if all_commit_characters
  @attributes[:resolveProvider] = resolve_provider if resolve_provider
  @attributes[:completionItem] = completion_item if completion_item
  @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]) 


85
86
87
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 85

def attributes
  @attributes
end

Instance Method Details

#all_commit_characters ⇒ string[]

The list of all possible characters that commit a completion. This field can be used if clients don't support individual commit characters per completion item. See ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport

If a server provides both allCommitCharacters and commit characters on an individual completion item the ones on the completion item win.

Returns:

  • (string[])

Since:

  • 3.2.0



56
57
58
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 56

def all_commit_characters
  attributes.fetch(:allCommitCharacters)
end

#completion_item ⇒ { labelDetailsSupport?: boolean; }

The server supports the following CompletionItem specific capabilities.

Returns:

  • ({ labelDetailsSupport?: boolean; })

Since:

  • 3.17.0



76
77
78
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 76

def completion_item
  attributes.fetch(:completionItem)
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) 


26
27
28
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 26

def document_selector
  attributes.fetch(:documentSelector)
end

#resolve_provider ⇒ boolean

The server provides support to resolve additional information for a completion item.

Returns:

  • (boolean) 


65
66
67
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 65

def resolve_provider
  attributes.fetch(:resolveProvider)
end

#to_hash ⇒ Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


87
88
89
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 87

def to_hash
  attributes
end

#to_json(*args) ⇒ String

Parameters:

  • (Object)

Returns:

  • (String) 


91
92
93
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 91

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

#trigger_characters ⇒ string[]

Most tools trigger completion request automatically without explicitly requesting it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user starts to type an identifier. For example if the user types c in a JavaScript file code complete will automatically pop up present console besides others as a completion item. Characters that make up identifiers don't need to be listed here.

If code complete should automatically be trigger on characters not being valid inside an identifier (for example . in JavaScript) list them in triggerCharacters.

Returns:

  • (string[]) 


41
42
43
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 41

def trigger_characters
  attributes.fetch(:triggerCharacters)
end

#work_done_progress ⇒ boolean

Returns:

  • (boolean) 


81
82
83
 
# File 'lib/language_server/protocol/interface/completion_registration_options.rb', line 81

def work_done_progress
  attributes.fetch(:workDoneProgress)
end