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

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

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.



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

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 ⇒ Object (readonly)

Returns the value of attribute attributes.



255
256
257
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 255

def attributes
  @attributes
end

Instance Method Details

#additional_text_edits ⇒ TextEdit[]

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main 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:



221
222
223
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 221

def additional_text_edits
  attributes.fetch(:additionalTextEdits)
end

#command ⇒ Command

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

Returns:



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

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[]) 


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

def commit_characters
  attributes.fetch(:commitCharacters)
end

#data ⇒ LSPAny

A data entry field that is preserved on a completion item between a completion and a completion resolve request.

Returns:

  • (LSPAny) 


251
252
253
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 251

def data
  attributes.fetch(:data)
end

#deprecated ⇒ boolean

Indicates if this item is deprecated.

Returns:

  • (boolean) 


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

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) 


76
77
78
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 76

def detail
  attributes.fetch(:detail)
end

#documentation ⇒ string | MarkupContent

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

Returns:



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

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 label is used as the filter text for this item.

Returns:

  • (string) 


124
125
126
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 124

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 label is used as the insert text for this item.

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) 


142
143
144
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 142

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) 


155
156
157
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 155

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 client’s default value depends on the ‘textDocument.completion.insertTextMode` client capability.

Returns:

  • (InsertTextMode) 


165
166
167
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 165

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. The standardized set of available values is defined in ‘CompletionItemKind`.

Returns:

  • (CompletionItemKind) 


59
60
61
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 59

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) 


41
42
43
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 41

def label
  attributes.fetch(:label)
end

#label_details ⇒ CompletionItemLabelDetails

Additional details for the label

Returns:



49
50
51
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 49

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) 


104
105
106
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 104

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 label is used as the sort text for this item.

Returns:

  • (string) 


114
115
116
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 114

def sort_text
  attributes.fetch(:sortText)
end

#tags ⇒ 1[]

Tags for this completion item.

Returns:

  • (1[]) 


67
68
69
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 67

def tags
  attributes.fetch(:tags)
end

#text_edit ⇒ TextEdit | InsertReplaceEdit

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

Note: The range of the edit must be a single line range and it must contain the position at which completion has been requested.

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 ‘InsertReplaceEdit`s via the `textDocument.completion.completionItem.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:



192
193
194
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 192

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) 


207
208
209
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 207

def text_edit_text
  attributes.fetch(:textEditText)
end

#to_hash ⇒ Object 



257
258
259
 
# File 'lib/language_server/protocol/interface/completion_item.rb', line 257

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



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

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