typedef CompletionItem

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.

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

Most editors support two different operation 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 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 a 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.

Tags for this completion item.

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

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 thefirst* item of those that match best is selected.

Additional details for the label

The label of this completion item. By default also the text that is inserted when selecting this completion.

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

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

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.

A string that should be inserted into a document when selecting this completion. When falsy the 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.

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

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

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

Indicates if this item is deprecated.

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

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.

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

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