struct LSP::CompletionItem
- LSP::CompletionItem
- Struct
- Value
- Object
Included Modules
- JSON::Serializable
Defined in:
lsp/protocol/completion_item.crConstructors
- .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)
Instance Method Summary
-
#deprecated=(deprecated : Bool)
Indicates if this item is deprecated.
-
#deprecated? : Bool
Indicates if this item is deprecated.
-
#detail : String
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 : String
A human-readable string that represents a doc-comment.
-
#documentation=(documentation : String)
A human-readable string that represents a doc-comment.
-
#filter_text : String
A string that should be used when filtering a set of completion items.
-
#filter_text=(filter_text : String)
A string that should be used when filtering a set of completion items.
-
#insert_text : String
A string that should be inserted into a document when selecting this completion.
-
#insert_text=(insert_text : String)
A string that should be inserted into a document when selecting this completion.
-
#insert_text_format : Int32 | Nil
The format of the insert text.
-
#insert_text_format=(insert_text_format : Int32 | Nil)
The format of the insert text.
-
#kind : CompletionItemKind
The kind of this completion item.
-
#kind=(kind : CompletionItemKind)
The kind of this completion item.
-
#label : String
The label of this completion item.
-
#label=(label : String)
The label of this completion item.
-
#preselect=(preselect : Bool)
Select this item when showing.
-
#preselect? : Bool
Select this item when showing.
-
#sort_text : String
A string that should be used when comparing this item with other items.
-
#sort_text=(sort_text : String)
A string that should be used when comparing this item with other items.
Constructor Detail
Instance Method Detail
A human-readable string with additional information about this item, like type or symbol information.
A human-readable string with additional information about this item, like type or symbol information.
A human-readable string that represents a doc-comment.
A string that should be used when filtering a set of
completion items. When falsy the label is used.
A string that should be used when filtering a set of
completion items. When falsy the label is used.
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.
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.
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.
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.
The kind of this completion item. Based of the kind an icon is chosen by the editor.
The kind of this completion item. Based of the kind an icon is chosen by the editor.
The label of this completion item. By default also the text that is inserted when selecting this completion.
The label of this completion item. By default also the text that is inserted when selecting this completion.
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.
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.
A string that should be used when comparing this item
with other items. When falsy the label is used.
A string that should be used when comparing this item
with other items. When falsy the label is used.