struct
LSP::CompletionItem
- LSP::CompletionItem
- Struct
- Value
- Object
Included Modules
Defined in:
base/completion_item.crConstructors
Instance Method Summary
-
#additional_text_edits : Array(TextEdit) | Nil
An optional array of additional text edits that are applied when selecting this completion.
-
#additional_text_edits=(additional_text_edits : Array(TextEdit) | Nil)
An optional array of additional text edits that are applied when selecting this completion.
-
#command : Command | Nil
An optional command that is executed after inserting this completion.
-
#command=(command : Command | Nil)
An optional command that is executed after inserting this completion.
-
#commit_characters : Array(String) | Nil
An optional set of characters that when pressed while this completion is active will accept it first and then type that character.
-
#commit_characters=(commit_characters : Array(String) | Nil)
An optional set of characters that when pressed while this completion is active will accept it first and then type that character.
- #data : JSON::Any | Nil
- #data=(data : JSON::Any | Nil)
-
#detail : String | Nil
A human-readable string with additional information about this item, like type or symbol information.
-
#detail=(detail : String | Nil)
A human-readable string with additional information about this item, like type or symbol information.
-
#documentation : String | MarkupContent | Nil
A human-readable string that represents a doc-comment.
-
#documentation=(documentation : String | MarkupContent | Nil)
A human-readable string that represents a doc-comment.
-
#filter_text : String | Nil
A string that should be used when filtering a set of completion items.
-
#filter_text=(filter_text : String | Nil)
A string that should be used when filtering a set of completion items.
-
#insert_text : String | Nil
A string that should be inserted into a document when selecting this completion.
-
#insert_text=(insert_text : String | Nil)
A string that should be inserted into a document when selecting this completion.
-
#insert_text_format : InsertTextFormat | Nil
The format of the insert text.
-
#insert_text_format=(insert_text_format : InsertTextFormat | Nil)
The format of the insert text.
-
#kind : CompletionItemKind | Nil
The kind of this completion item.
-
#kind=(kind : CompletionItemKind | Nil)
The kind of this completion item.
-
#label : String
The label of this completion item.
-
#label=(label : String)
The label of this completion item.
-
#preselect : Bool | Nil
Select this item when showing.
-
#preselect=(preselect : Bool | Nil)
Select this item when showing.
-
#sort_text : String | Nil
A string that should be used when comparing this item with other items.
-
#sort_text=(sort_text : String | Nil)
A string that should be used when comparing this item with other items.
-
#tags : Array(CompletionItemTag) | Nil
Tags for this completion item.
-
#tags=(tags : Array(CompletionItemTag) | Nil)
Tags for this completion item.
-
#text_edit : TextEdit | Nil
An edit which is applied to a document when selecting this completion.
-
#text_edit=(text_edit : TextEdit | Nil)
An edit which is applied to a document when selecting this completion.
Macros inherited from module JSON::Serializable
json_discriminator(field, mapping, *, default = nil)
json_discriminator
Constructor Detail
Instance Method Detail
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).
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).
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.
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.
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 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.
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 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.
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.
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 standardized set
of available values is defined in 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.
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.
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.
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.