Pure data structure for managing LSP completion state.
Holds the list of completion items returned by a language server, tracks the selected index, and filters items as the user continues typing. All functions are pure transformations with no side effects.
Lifecycle
new/2— create from parsed LSP completion items and a trigger positionfilter/2— narrow the visible items as the user types more charactersmove_up/1/move_down/1— navigate the selectionselected_item/1— get the currently highlighted itemaccept/1— returns the text/edit to insert for the selected item
Summary
Types
A parsed completion item.
LSP CompletionItemKind as an atom.
A text edit to apply when accepting a completion.
Functions
Returns the insert text and optional text edit for the selected item.
Returns true if there are any filtered items to show.
Returns the count of currently filtered items.
Filters completion items by the text typed since the trigger position.
Returns a single-character kind indicator for rendering.
Returns the number of semantic candidates matching the current filter before truncation.
Moves the selection down one item, wrapping at the bottom.
Moves the selection up one item, wrapping at the top.
Creates a new completion state from a list of parsed items and the cursor position where completion was triggered.
Creates completion state while retaining one matching stable selection in the bounded snapshot.
Parses a single LSP CompletionItem map into an item() struct.
Parses one completion item with its provider identity.
Parses an LSP completion response into a list of item() maps.
Parses a completion response and qualifies every item with its provider identity.
Selects an item by stable identity when it remains visible.
Selects an item by its offset in the current visible completion window.
Selects an item by its stable wire identifier. Unknown or stale identifiers are ignored.
Returns the currently selected item, or nil if no items.
Returns true when the selected item's raw identity equals the expected raw item.
Updates documentation for one stable item identity.
Updates documentation only when the currently selected item matches the expected raw identity.
Returns {visible_items, selected_offset} for rendering.
Types
@type item() :: Minga.Editing.Completion.Item.t()
A parsed completion item.
@type item_kind() :: Minga.Editing.Completion.Item.kind()
LSP CompletionItemKind as an atom.
@type t() :: %Minga.Editing.Completion{ filter_text: String.t(), filtered: [item()], incomplete?: boolean(), index: Minga.Editing.Completion.Index.t() | nil, items: [item()], last_resolved_identity: map() | nil, matched_count: non_neg_integer(), max_visible: pos_integer(), resolve_timer: reference() | nil, selected: non_neg_integer(), selected_item_id: Minga.Editing.Completion.Item.id() | nil, total_count: non_neg_integer(), trigger_position: {non_neg_integer(), non_neg_integer()} }
@type text_edit() :: Minga.Editing.Completion.Item.text_edit()
A text edit to apply when accepting a completion.
Functions
Returns the insert text and optional text edit for the selected item.
If the item has a text_edit, returns {:text_edit, edit}.
Otherwise returns {:insert_text, text}.
Returns true if there are any filtered items to show.
@spec count(t()) :: non_neg_integer()
Returns the count of currently filtered items.
Filters completion items by the text typed since the trigger position.
Items whose filter_text starts with prefix (case-insensitive) are kept.
Resets selection to the top.
Returns a single-character kind indicator for rendering.
@spec matched_count(t()) :: non_neg_integer()
Returns the number of semantic candidates matching the current filter before truncation.
Moves the selection down one item, wrapping at the bottom.
Moves the selection up one item, wrapping at the top.
@spec new([item()], {non_neg_integer(), non_neg_integer()}) :: t()
@spec new(Minga.Editing.Completion.Index.t(), {non_neg_integer(), non_neg_integer()}) :: t()
Creates a new completion state from a list of parsed items and the cursor position where completion was triggered.
@spec new( Minga.Editing.Completion.Index.t(), {non_neg_integer(), non_neg_integer()}, Minga.Editing.Completion.Item.id() | nil ) :: t()
Creates completion state while retaining one matching stable selection in the bounded snapshot.
Parses a single LSP CompletionItem map into an item() struct.
@spec parse_item(map(), Minga.Editing.Completion.Item.provider_id()) :: item()
Parses one completion item with its provider identity.
Parses an LSP completion response into a list of item() maps.
Handles both CompletionList (%{"items" => [...]}) and bare
CompletionItem[] response formats.
@spec parse_response( map() | [map()] | nil, Minga.Editing.Completion.Item.provider_id() ) :: [item()]
Parses a completion response and qualifies every item with its provider identity.
@spec select_item(t(), Minga.Editing.Completion.Item.id() | nil) :: t()
Selects an item by stable identity when it remains visible.
@spec select_visible(t(), non_neg_integer()) :: t()
Selects an item by its offset in the current visible completion window.
Selects an item by its stable wire identifier. Unknown or stale identifiers are ignored.
Returns the currently selected item, or nil if no items.
Returns true when the selected item's raw identity equals the expected raw item.
@spec update_item_documentation(t(), Minga.Editing.Completion.Item.id(), String.t()) :: t()
Updates documentation for one stable item identity.
Updates documentation only when the currently selected item matches the expected raw identity.
Called when a completionItem/resolve response arrives with the full documentation text.
@spec visible_items(t()) :: {[item()], non_neg_integer()}
Returns {visible_items, selected_offset} for rendering.
visible_items is a window of at most max_visible items centered
around the selection. selected_offset is the index of the selected
item within that window.