class LanguageServer::Protocol::Interface::CompletionItem

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).

@return [TextEdit

# File lib/language_server/protocol/interface/completion_item.rb, line 221
def additional_text_edits
  attributes.fetch(:additionalTextEdits)
end

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.

@return [Command]

# File lib/language_server/protocol/interface/completion_item.rb, line 242
def command
  attributes.fetch(:command)
end

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.

@return [string

# File lib/language_server/protocol/interface/completion_item.rb, line 232
def commit_characters
  attributes.fetch(:commitCharacters)
end

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

@return [LSPAny]

# File lib/language_server/protocol/interface/completion_item.rb, line 251
def data
  attributes.fetch(:data)
end

Indicates if this item is deprecated.

@return [boolean]

# File lib/language_server/protocol/interface/completion_item.rb, line 92
def deprecated
  attributes.fetch(:deprecated)
end

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

@return [string]

# File lib/language_server/protocol/interface/completion_item.rb, line 76
def detail
  attributes.fetch(:detail)
end

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

@return [string | MarkupContent]

# File lib/language_server/protocol/interface/completion_item.rb, line 84
def documentation
  attributes.fetch(:documentation)
end

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.

@return [string]

# File lib/language_server/protocol/interface/completion_item.rb, line 124
def filter_text
  attributes.fetch(:filterText)
end

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.

@return [string]

# File lib/language_server/protocol/interface/completion_item.rb, line 142
def insert_text
  attributes.fetch(:insertText)
end

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`.

@return [InsertTextFormat]

# File lib/language_server/protocol/interface/completion_item.rb, line 155
def insert_text_format
  attributes.fetch(:insertTextFormat)
end

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.

@return [InsertTextMode]

# File lib/language_server/protocol/interface/completion_item.rb, line 165
def insert_text_mode
  attributes.fetch(:insertTextMode)
end

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`.

@return [CompletionItemKind]

# File lib/language_server/protocol/interface/completion_item.rb, line 59
def kind
  attributes.fetch(:kind)
end

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.

@return [string]

# File lib/language_server/protocol/interface/completion_item.rb, line 41
def label
  attributes.fetch(:label)
end

Additional details for the label

@return [CompletionItemLabelDetails]

# File lib/language_server/protocol/interface/completion_item.rb, line 49
def label_details
  attributes.fetch(:labelDetails)
end

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.

@return [boolean]

# File lib/language_server/protocol/interface/completion_item.rb, line 104
def preselect
  attributes.fetch(:preselect)
end

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.

@return [string]

# File lib/language_server/protocol/interface/completion_item.rb, line 114
def sort_text
  attributes.fetch(:sortText)
end

Tags for this completion item.

@return [1

# File lib/language_server/protocol/interface/completion_item.rb, line 67
def tags
  attributes.fetch(:tags)
end

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.

@return [TextEdit | InsertReplaceEdit]

# File lib/language_server/protocol/interface/completion_item.rb, line 192
def text_edit
  attributes.fetch(:textEdit)
end

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.

@return [string]

# File lib/language_server/protocol/interface/completion_item.rb, line 207
def text_edit_text
  attributes.fetch(:textEditText)
end