[Completion]
textDocument/completion and completionItem/resolve from builtin metadata, module-dot triggers, and fuzzy filter.
Completion
Abstract
Completion is metadata-driven, not evaluator-driven. The server loads a catalog of builtins (plaintext JSON in development, Fernet-encrypted in compiled binaries), filters by prefix or module, and returns CompletionItem rows with optional snippet insertText. Resolve re-hydrates documentation for a single item.
Conceptual model
Interface surface
| Method | Capability |
|---|---|
textDocument/completion | trigger_characters=["."], returns CompletionList |
completionItem/resolve | resolve_provider=True |
Handler: features/completion.py → handle_completion / handle_completion_resolve.
Trigger logic
- Compute
text_before_cursoron the current line. get_trigger_char— if the previous character is.(or(,,, space), treat as trigger.- If the last token contains
.(e.g.ta.orta.sm), callbuild_module_completion(module). - Else
build_completion_list(prefix=prefix)over the full catalog.
Word boundaries for Pine identifiers: [a-zA-Z_][a-zA-Z0-9_.]* (protocol/utils.py).
Item fields
Built by providers/completion_items.py:
| Field | Source |
|---|---|
label | metadata label (e.g. ta.sma) |
kind | CompletionItemKind.Function |
detail | signature / detail string |
documentation | Markdown from metadata |
insert_text | Snippet if ${...} present, else plain label |
insert_text_format | Snippet or PlainText |
filter_text | dotted parts + brief |
sort_text | modules first (\x01…), root second (\x02…) |
Category headers may appear as Folder-kind items with empty insert text and labels like --- Technical Analysis (ta.*) (N) ---.
Internals
| Path | Role |
|---|---|
features/completion.py | Request context + dispatch |
providers/completion_items.py | List / item / module builders |
providers/builtin_metadata.py | Load cache, fuzzy_filter, get_builtin |
protocol/utils.py | Word + trigger helpers |
Fuzzy filter scores
fuzzy_filter(query, items, limit=50):
| Match | Score |
|---|---|
| Exact label | 1000 |
| Prefix | 500 |
| Substring in label | 100 |
| Category | 50 |
| Brief | 25 |
Results sorted by score descending, capped at limit.
Resolve
handle_completion_resolve looks up params.label in metadata; if found, rebuilds a full CompletionItem. Unknown labels return unchanged.
Invariants and edge cases
- No user-symbol completion yet — only catalog builtins (not local
myFuncunless it appears in metadata). - Empty metadata dict yields an empty list (failed decrypt / missing files).
- Module completion uses
startswith(module + ".")— nested namespaces beyond one dot still work if labels are fully qualified. - Snippets are generated at metadata build time (
scripts/generate_builtin_metadata.py); incompleteness of placeholders is a generator concern, not the LSP handler.
Worked example
User types ta. → module completion for all ta.* labels.
User types sma without a module → fuzzy filter may return ta.sma among others (substring score).
Resolve on ta.sma reloads full documentation markup for the detail pane.
Failure modes
| Symptom | Cause |
|---|---|
| Zero items always | Metadata not loaded — check builtin metadata |
| Dot trigger ignored | Client did not set completion trigger characters from server capabilities |
| Snippets inserted raw | Client disabled snippet support; extension setting pynescript.completion.snippets |
See also
- Hover — shares metadata
- Builtin metadata
- Inlay hints — uses return types from
detail