struct

LSP::CompletionItem

Inherits JSON::Serializable < Struct < Value < Object

Constructors

new(pull : JSON::PullParser)

new(insert_text_format : Int32 | Nil = 2, documentation : String = "", deprecated : Bool = false, preselect : Bool = false, sort_text : String = false, filter_text : String = "", insert_text : String = "", detail : String = "", label : String = "", kind : LSP::CompletionItemKind = 1)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance methods

deprecated=(deprecated : Bool)

Indicates if this item is deprecated.

deprecated?

Indicates if this item is deprecated.

detail

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

detail=(detail : String)

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

documentation

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

documentation=(documentation : String)

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

filter_text

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

filter_text=(filter_text : String)

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

insert_text

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.

@deprecated Use textEdit instead.

insert_text=(insert_text : String)

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.

@deprecated Use textEdit instead.

insert_text_format

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.

insert_text_format=(insert_text_format : Int32 | Nil)

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.

kind

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

kind=(kind : CompletionItemKind)

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

label

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

label=(label : String)

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

preselect=(preselect : Bool)

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.

preselect?

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.

sort_text

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

sort_text=(sort_text : String)

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