View Source GenLSP.Structures.CompletionItem (gen_lsp v0.10.0)

A completion item represents a text snippet that is proposed to complete text that is being typed.

Link to this section Summary



  • label: The label of this completion item.

Link to this section Types

@type t() :: %GenLSP.Structures.CompletionItem{
  additional_text_edits: [GenLSP.Structures.TextEdit.t()] | nil,
  command: GenLSP.Structures.Command.t() | nil,
  commit_characters: [String.t()] | nil,
  data: GenLSP.TypeAlias.LSPAny.t() | nil,
  deprecated: boolean() | nil,
  detail: String.t() | nil,
  documentation: (String.t() | GenLSP.Structures.MarkupContent.t()) | nil,
  filter_text: String.t() | nil,
  insert_text: String.t() | nil,
  insert_text_format: GenLSP.Enumerations.InsertTextFormat.t() | nil,
  insert_text_mode: GenLSP.Enumerations.InsertTextMode.t() | nil,
  kind: GenLSP.Enumerations.CompletionItemKind.t() | nil,
  label: String.t(),
  label_details: GenLSP.Structures.CompletionItemLabelDetails.t() | nil,
  preselect: boolean() | nil,
  sort_text: String.t() | nil,
  tags: [GenLSP.Enumerations.CompletionItemTag.t()] | nil,
    (GenLSP.Structures.TextEdit.t() | GenLSP.Structures.InsertReplaceEdit.t())
    | nil,
  text_edit_text: String.t() | nil

Link to this section Functions

Link to this function


View Source (struct)



  • label: 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.

  • label_details: Additional details for the label

    @since 3.17.0

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

  • tags: Tags for this completion item.

    @since 3.15.0

  • detail: 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.

  • deprecated: Indicates if this item is deprecated. @deprecated Use tags instead.

  • 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 {@link CompletionItem.label label} is used.

  • filter_text: A string that should be used when filtering a set of completion items. When falsy the {@link CompletionItem.label label} is used.

  • insert_text: A string that should be inserted into a document when selecting this completion. When falsy the {@link CompletionItem.label 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.

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

    Please note that the insertTextFormat doesn't apply to additionalTextEdits.

  • insert_text_mode: How whitespace and indentation is handled during completion item insertion. If not provided the clients default value depends on the textDocument.completion.insertTextMode client capability.

    @since 3.16.0

  • text_edit: An {@link TextEdit edit} which is applied to a document when selecting this completion. When an edit is provided the value of {@link CompletionItem.insertText insertText} is ignored.

    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 InsertReplaceEdits via the textDocument.completion.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.

    @since 3.16.0 additional type InsertReplaceEdit

  • text_edit_text: 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.

    @since 3.17.0

  • additional_text_edits: An optional array of additional {@link TextEdit text edits} that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main {@link CompletionItem.textEdit 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).

  • commit_characters: 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.

  • command: An optional {@link Command command} that is executed after inserting this completion. Note that additional modifications to the current document should be described with the {@link CompletionItem.additionalTextEdits additionalTextEdits}-property.

  • data: A data entry field that is preserved on a completion item between a {@link CompletionRequest} and a {@link CompletionResolveRequest}.