class LanguageServer::Protocol::Interface::CompletionRegistrationOptions

Attributes

attributes[R]

Public Class Methods

new(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil) click to toggle source

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 5
def initialize(document_selector:, work_done_progress: nil, trigger_characters: nil, all_commit_characters: nil, resolve_provider: nil, completion_item: nil)
  @attributes = {}

  @attributes[:documentSelector] = document_selector
  @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[:completionItem] = completion_item if completion_item

  @attributes.freeze
end

Public Instance Methods

all_commit_characters() click to toggle source

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 client capability ‘completion.completionItem.commitCharactersSupport`.

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

@return [string

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 60
def all_commit_characters
  attributes.fetch(:allCommitCharacters)
end

completion_item() click to toggle source

The server supports the following ‘CompletionItem` specific capabilities.

@return [{ labelDetailsSupport?: boolean; }]

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 78
def completion_item
  attributes.fetch(:completionItem)
end

document_selector() click to toggle source

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.

@return [DocumentSelector]

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 23
def document_selector
  attributes.fetch(:documentSelector)
end

resolve_provider() click to toggle source

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

@return [boolean]

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 69
def resolve_provider
  attributes.fetch(:resolveProvider)
end

to_hash() click to toggle source

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 84
def to_hash
  attributes
end

to_json(*args) click to toggle source

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 88
def to_json(*args)
  to_hash.to_json(*args)
end

trigger_characters() click to toggle source

The additional characters, beyond the defaults provided by the client (typically [a-zA-Z]), that should automatically trigger a completion request. For example ‘.` in JavaScript represents the beginning of an object property or method and is thus a good candidate for triggering a completion request.

Most tools trigger a 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.

@return [string

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 46
def trigger_characters
  attributes.fetch(:triggerCharacters)
end

work_done_progress() click to toggle source

@return [boolean]

# File lib/language_server/protocol/interface/completion_registration_options.rb, line 28
def work_done_progress
  attributes.fetch(:workDoneProgress)
end