Class: LanguageServer::Protocol::Interface::CompletionItem

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/completion_item.rb,
sig/language_server/protocol/interface/completion_item.rbs

Overview

A completion item represents a text snippet that is proposed to complete text that is being typed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(label:, label_details: nil, kind: nil, tags: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, insert_text_mode: nil, text_edit: nil, text_edit_text: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil) ⇒ CompletionItem

Returns a new instance of CompletionItem.

Parameters:

  • label: (String)
  • label_details: (Object) (defaults to: nil)
  • kind: (Object) (defaults to: nil)
  • tags: (Array[untyped]) (defaults to: nil)
  • detail: (String) (defaults to: nil)
  • documentation: (Object) (defaults to: nil)
  • deprecated: (Boolean) (defaults to: nil)
  • preselect: (Boolean) (defaults to: nil)
  • sort_text: (String) (defaults to: nil)
  • filter_text: (String) (defaults to: nil)
  • insert_text: (String) (defaults to: nil)
  • insert_text_format: (Object) (defaults to: nil)
  • insert_text_mode: (Object) (defaults to: nil)
  • text_edit: (Object) (defaults to: nil)
  • text_edit_text: (String) (defaults to: nil)
  • additional_text_edits: (Array[untyped]) (defaults to: nil)
  • commit_characters: (Array[String]) (defaults to: nil)
  • command: (Object) (defaults to: nil)
  • data: (Object) (defaults to: nil) 


9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 9

def initialize(label:, label_details: nil, kind: nil, tags: nil, detail: nil, documentation: nil, deprecated: nil, preselect: nil, sort_text: nil, filter_text: nil, insert_text: nil, insert_text_format: nil, insert_text_mode: nil, text_edit: nil, text_edit_text: nil, additional_text_edits: nil, commit_characters: nil, command: nil, data: nil)
  @attributes = {}

  @attributes[:label] = label
  @attributes[:labelDetails] = label_details if label_details
  @attributes[:kind] = kind if kind
  @attributes[:tags] = tags if tags
  @attributes[:detail] = detail if detail
  @attributes[:documentation] = documentation if documentation
  @attributes[:deprecated] = deprecated if deprecated
  @attributes[:preselect] = preselect if preselect
  @attributes[:sortText] = sort_text if sort_text
  @attributes[:filterText] = filter_text if filter_text
  @attributes[:insertText] = insert_text if insert_text
  @attributes[:insertTextFormat] = insert_text_format if insert_text_format
  @attributes[:insertTextMode] = insert_text_mode if insert_text_mode
  @attributes[:textEdit] = text_edit if text_edit
  @attributes[:textEditText] = text_edit_text if text_edit_text
  @attributes[:additionalTextEdits] = additional_text_edits if additional_text_edits
  @attributes[:commitCharacters] = commit_characters if commit_characters
  @attributes[:command] = command if command
  @attributes[:data] = data if data

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Hash[Symbol, untyped] (readonly)

Returns the value of attribute attributes.

Returns:

  • (Hash[Symbol, untyped]) 


266
267
268
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 266

def attributes
  @attributes
end

Instance Method Details

#additional_text_edits ⇒ TextEdit[]

An optional array of additional TextEdit text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main CompletionItem.textEdit edit nor with themselves.

Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).

Returns:



233
234
235
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 233

def additional_text_edits
  attributes.fetch(:additionalTextEdits)
end

#command ⇒ Command

An optional Command command that is executed after inserting this completion. Note that additional modifications to the current document should be described with the CompletionItem.additionalTextEdits additionalTextEdits-property.

Returns:



253
254
255
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 253

def command
  attributes.fetch(:command)
end

#commit_characters ⇒ string[]

An optional set of characters that when pressed while this completion is active will accept it first and then type that character. Note that all commit characters should have length=1 and that superfluous characters will be ignored.

Returns:

  • (string[]) 


243
244
245
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 243

def commit_characters
  attributes.fetch(:commitCharacters)
end

#data ⇒ LSPAny

A data entry field that is preserved on a completion item between a CompletionRequest and a CompletionResolveRequest.

Returns:

  • (LSPAny) 


262
263
264
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 262

def data
  attributes.fetch(:data)
end

#deprecated ⇒ boolean

Deprecated.

Use tags instead.

Indicates if this item is deprecated.

Returns:

  • (boolean) 


100
101
102
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 100

def deprecated
  attributes.fetch(:deprecated)
end

#detail ⇒ string

A human-readable string with additional information about this item, like type or symbol information.

Returns:

  • (string) 


83
84
85
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 83

def detail
  attributes.fetch(:detail)
end

#documentation ⇒ string | MarkupContent

A human-readable string that represents a doc-comment.

Returns:



91
92
93
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 91

def documentation
  attributes.fetch(:documentation)
end

#filter_text ⇒ string

A string that should be used when filtering a set of completion items. When falsy the CompletionItem.label label is used.

Returns:

  • (string) 


132
133
134
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 132

def filter_text
  attributes.fetch(:filterText)
end

#insert_text ⇒ string

A string that should be inserted into a document when selecting this completion. When falsy the CompletionItem.label label is used.

The insertText is subject to interpretation by the client side. Some tools might not take the string literally. For example VS Code when code complete is requested in this example con<cursor position> and a completion item with an insertText of console is provided it will only insert sole. Therefore it is recommended to use textEdit instead since it avoids additional client side interpretation.

Returns:

  • (string) 


150
151
152
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 150

def insert_text
  attributes.fetch(:insertText)
end

#insert_text_format ⇒ InsertTextFormat

The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit. If omitted defaults to InsertTextFormat.PlainText.

Please note that the insertTextFormat doesn't apply to additionalTextEdits.

Returns:

  • (InsertTextFormat) 


163
164
165
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 163

def insert_text_format
  attributes.fetch(:insertTextFormat)
end

#insert_text_mode ⇒ InsertTextMode

How whitespace and indentation is handled during completion item insertion. If not provided the clients default value depends on the textDocument.completion.insertTextMode client capability.

Returns:

  • (InsertTextMode)

Since:

  • 3.16.0



175
176
177
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 175

def insert_text_mode
  attributes.fetch(:insertTextMode)
end

#kind ⇒ CompletionItemKind

The kind of this completion item. Based of the kind an icon is chosen by the editor.

Returns:

  • (CompletionItemKind) 


64
65
66
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 64

def kind
  attributes.fetch(:kind)
end

#label ⇒ string

The label of this completion item.

The label property is also by default the text that is inserted when selecting this completion.

If label details are provided the label itself should be an unqualified name of the completion item.

Returns:

  • (string) 


45
46
47
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 45

def label
  attributes.fetch(:label)
end

#label_details ⇒ CompletionItemLabelDetails

Additional details for the label

Returns:

Since:

  • 3.17.0



55
56
57
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 55

def label_details
  attributes.fetch(:labelDetails)
end

#preselect ⇒ boolean

Select this item when showing.

Note that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the first item of those that match best is selected.

Returns:

  • (boolean) 


112
113
114
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 112

def preselect
  attributes.fetch(:preselect)
end

#sort_text ⇒ string

A string that should be used when comparing this item with other items. When falsy the CompletionItem.label label is used.

Returns:

  • (string) 


122
123
124
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 122

def sort_text
  attributes.fetch(:sortText)
end

#tags ⇒ CompletionItemTag[]

Tags for this completion item.

Returns:

  • (CompletionItemTag[])

Since:

  • 3.15.0



74
75
76
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 74

def tags
  attributes.fetch(:tags)
end

#text_edit ⇒ TextEdit | InsertReplaceEdit

An TextEdit edit which is applied to a document when selecting this completion. When an edit is provided the value of CompletionItem.insertText insertText is ignored.

Most editors support two different operations when accepting a completion item. One is to insert a completion text and the other is to replace an existing text with a completion text. Since this can usually not be predetermined by a server it can report both ranges. Clients need to signal support for InsertReplaceEdits via the textDocument.completion.insertReplaceSupport client capability property.

Note 1: The text edit's range as well as both ranges from an insert replace edit must be a [single line] and they must contain the position at which completion has been requested. Note 2: If an InsertReplaceEdit is returned the edit's insert range must be a prefix of the edit's replace range, that means it must be contained and starting at the same position.

Returns:

Since:

  • 3.16.0 additional type InsertReplaceEdit



202
203
204
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 202

def text_edit
  attributes.fetch(:textEdit)
end

#text_edit_text ⇒ string

The edit text used if the completion item is part of a CompletionList and CompletionList defines an item default for the text edit range.

Clients will only honor this property if they opt into completion list item defaults using the capability completionList.itemDefaults.

If not provided and a list's default range is provided the label property is used as a text.

Returns:

  • (string)

Since:

  • 3.17.0



219
220
221
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 219

def text_edit_text
  attributes.fetch(:textEditText)
end

#to_hash ⇒ Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


268
269
270
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 268

def to_hash
  attributes
end

#to_json(*args) ⇒ String

Parameters:

  • (Object)

Returns:

  • (String) 


272
273
274
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 272

def to_json(*args)
  to_hash.to_json(*args)
end