class LSProtocol::CompletionOptions
- LSProtocol::CompletionOptions
- Reference
- Object
Overview
Completion options.
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(pull : JSON::PullParser)
- .new(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)
Instance Method Summary
-
#all_commit_characters : Array(String) | Nil
The list of all possible characters that commit a completion.
-
#completion_item : ServerCompletionItemOptions | Nil
The server supports the following
CompletionItem
specific capabilities. -
#resolve_provider : Bool | Nil
The server provides support to resolve additional information for a completion item.
-
#trigger_characters : Array(String) | Nil
Most tools trigger completion request automatically without explicitly requesting it using a keyboard shortcut (e.g.
- #work_done_progress : Bool | Nil
Constructor Detail
Instance Method Detail
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
The server supports the following CompletionItem
specific
capabilities.
@since 3.17.0
The server provides support to resolve additional information for a completion item.
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
.