class LanguageServer::Protocol::Interface::CompletionOptions
Completion options.
Attributes
Public Class Methods
# 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
Public Instance Methods
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_options.rb, line 51 def all_commit_characters attributes.fetch(:allCommitCharacters) end
The server provides support to resolve additional information for a completion item.
@return [boolean]
# File lib/language_server/protocol/interface/completion_options.rb, line 60 def resolve_provider attributes.fetch(:resolveProvider) end
# File lib/language_server/protocol/interface/completion_options.rb, line 66 def to_hash attributes end
# File lib/language_server/protocol/interface/completion_options.rb, line 70 def to_json(*args) to_hash.to_json(*args) end
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`.
@return [string
# File lib/language_server/protocol/interface/completion_options.rb, line 37 def trigger_characters attributes.fetch(:triggerCharacters) end
@return [boolean]
# File lib/language_server/protocol/interface/completion_options.rb, line 20 def work_done_progress attributes.fetch(:workDoneProgress) end