Class: LanguageServer::Protocol::Interface::CompletionOptions

Inherits:
WorkDoneProgressOptions show all
Defined in:
lib/language_server/protocol/interface/completion_options.rb

Overview

Completion options.

Direct Known Subclasses

CompletionRegistrationOptions

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from WorkDoneProgressOptions

#work_done_progress

Constructor Details

#initialize(work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil) ⇒ CompletionOptions

Returns a new instance of CompletionOptions.



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

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

  @attributes[:workDoneProgress] = work_done_progress if work_done_progress
  @attributes[:triggerCharacters] = trigger_characters if trigger_characters
  @attributes[:allCommitCharacters] = all_commit_characters if all_commit_characters
  @attributes[:resolveProvider] = resolve_provider if resolve_provider

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



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

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[]) 


43
44
45
 
# File 'lib/language_server/protocol/interface/completion_options.rb', line 43

def all_commit_characters
  attributes.fetch(:allCommitCharacters)
end

#resolve_provider ⇒ boolean

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

Returns:

  • (boolean) 


52
53
54
 
# File 'lib/language_server/protocol/interface/completion_options.rb', line 52

def resolve_provider
  attributes.fetch(:resolveProvider)
end

#to_hash ⇒ Object 



58
59
60
 
# File 'lib/language_server/protocol/interface/completion_options.rb', line 58

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



62
63
64
 
# File 'lib/language_server/protocol/interface/completion_options.rb', line 62

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[]) 


30
31
32
 
# File 'lib/language_server/protocol/interface/completion_options.rb', line 30

def trigger_characters
  attributes.fetch(:triggerCharacters)
end