class LSProtocol::CompletionRegistrationOptions

Overview

Registration options for a CompletionRequest.

Included Modules

Defined in:

lsprotocol/types.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(document_selector : DocumentSelector | Nil, all_commit_characters : Array(String) | Nil = nil, completion_item : ServerCompletionItemOptions | Nil = nil, resolve_provider : Bool | Nil = nil, trigger_characters : Array(String) | Nil = nil, work_done_progress : Bool | Nil = nil) #

[View source]

Instance Method Detail

def all_commit_characters : Array(String) | Nil #

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.

@since 3.2.0


[View source]
def completion_item : ServerCompletionItemOptions | Nil #

The server supports the following CompletionItem specific capabilities.

@since 3.17.0


[View source]
def 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.


[View source]
def resolve_provider : Bool | Nil #

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


[View source]
def trigger_characters : Array(String) | Nil #

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.


[View source]
def work_done_progress : Bool | Nil #

[View source]