Features and Settings

Features

Diagnostics

Two complementary layers:

• Parser diagnostics — your opensips.cfg is checked by the real OpenSIPS parser (opensips -C) on open and save; errors appear as squiggles at the exact line and column the parser reports. Failed or timed-out checks clear stale squiggles instead of leaving them pinned; results are versioned against the buffer they were computed for; runs are serialized, time-bounded, and output-capped. Automatically off in untrusted workspaces (checking a config loads its modules, which executes code).
• Analyzer warnings — fast, between saves, as you type (debounced): route(name) calls whose target is defined nowhere in the file or its includes, and duplicate route definitions. Source opensips-lsp, severity warning; toggle with opensipsLsp.diagnostics.analyzer.

Completion

Context-sensitive, from documentation harvested out of your OpenSIPS source tree (result cached per tree):

You type	You get
loadmodule "	every module in the tree
modparam("	module names
modparam("tm", "	tm's parameters, each with docs
letters in a route	exported functions of loaded modules, core functions, core parameters, route names, keywords
route(	route names (this file and its includes)
$	pseudo-variables with descriptions (the typed $word is replaced, never doubled)

Duplicate labels are collapsed, keeping the most informative item. Modules loaded and routes defined in include_file/import_file files count — the closure is followed (open editor buffers preferred over disk).

Function completions insert snippets — the cursor lands between the parentheses (t_relay(│)) — disable with opensipsLsp.completion.snippets.

Signature help

Type ( or , inside a call and the function's signature pops up with the active parameter highlighted — module exports first, then core functions. Commas inside strings don't advance the parameter.

Hover, navigation, outline

Hover any function/parameter/module/$variable for its documentation; Ctrl+Click a route(name) reference to jump to its definition — including definitions that live in an included file; Ctrl+Shift+O lists every route block with its full extent (the outline nests, and breadcrumbs know which block you're in).

References, rename, highlights

Shift+F12 lists every call site and the definition of a route name; F2 renames a route everywhere (quoted call sites are rewritten inside the quotes; illegal names are rejected); all occurrences of the route under the cursor are highlighted, the definition as a write.

Workspace symbols, code lenses

Ctrl+T searches route definitions across every open file and its includes. Named route blocks show a reference count code lens (counted across the include closure); disable with opensipsLsp.codeLens.references.

Quick fixes

The lightbulb offers: Load module 'X' when the parser reports unknown command <f> and the catalog knows which module exports f (inserted after the last loadmodule), and Create route[x] for an undefined route(x) target (a stub is appended).

Catalog-pinned validation

modparam("m", "p", ...) warns as you type when the configured source tree documents module m but no parameter p — version-exact by construction, since the catalog IS your pinned tree. Unknown modules stay silent.

Semantic highlighting

Route names (definitions and call sites) and pseudo-variables get semantic tokens, so themes color them consistently — including pvars inside strings (either quote style), where OpenSIPS interpolates them. Comments — line or block — are excluded byte-by-byte through the same classifier the analyzer uses, so a # inside a string does not hide the rest of the line and a /* ... */ block hides all of its interior.

CLI check mode

opensips-lsp check [--strict] [--bin <opensips>] <file>... runs the same analyzer (plus the real -C when a binary is given) for CI pipelines and git hooks. Exit codes: 0 clean, 1 findings, 2 usage.

Folding

Every route-family block folds (route, failure_route[x], event_route[...], ...), with string- and comment-safe brace matching.

Static snippets

Type a prefix and press Tab: route, routen, failure_route, onreply_route, branch_route, event_route, startup_route, loadmodule, modparam, ifmethod, ifelse, while, switch, xlog, send_reply.

Settings

VS Code settings (Ctrl+, → search "opensips"); other editors pass the initialization option; environment variables are the fallback for clients that can't pass options.

VS Code setting	Init option	Environment	Default	Effect
opensipsLsp.enable	—	—	true	Master switch for the extension.
opensipsLsp.serverPath	—	—	opensips-lsp	Server binary; the default uses the copy bundled in platform builds, then PATH.
opensipsLsp.opensipsPath	opensipsPath	OPENSIPS_LSP_BIN	opensips	Binary for -C diagnostics; empty disables them.
opensipsLsp.opensipsSrc	opensipsSrc	OPENSIPS_LSP_SRC	(unset)	Source tree for completion/hover docs.
opensipsLsp.diagnostics.enable	(maps to empty opensipsPath)	—	true	Toggle diagnostics without losing the configured path.
opensipsLsp.diagnostics.maxProblems	maxDiagnostics	—	100	Bound on published diagnostics per file.
opensipsLsp.diagnostics.analyzer	analyzerDiagnostics	—	true	Fast analyzer warnings between saves (undefined route() targets, duplicate definitions, undocumented modparams).
opensipsLsp.codeLens.references	codeLensReferences	—	true	Reference-count code lenses on route definitions.
opensipsLsp.checkTimeoutMs	checkTimeoutMs	OPENSIPS_LSP_CHECK_TIMEOUT_MS	10000	Kill a -C run after this many ms.
opensipsLsp.completion.snippets	snippetCompletions	—	true	Function completions as tabstop snippets.
opensipsLsp.cacheDir	cacheDir	OPENSIPS_LSP_CACHE_DIR	platform cache dir	Documentation-catalog cache location.
opensipsLsp.trace.server	—	—	off	LSP traffic tracing in the output channel.
—	—	OPENSIPS_LSP_OUTPUT_CAP_BYTES	1048576	Byte cap on captured -C output.

Notes

• Server-backed options apply at initialization; the VS Code client restarts the server automatically when any opensipsLsp.* setting changes, so edits take effect immediately.
• Snippet completions and static snippets compose: static snippets scaffold blocks, completion snippets fill in calls.
• Include handling is capped for safety: depth 8, 64 files, 1 MiB per file (OpenSIPS itself allows depth 50). The LSP resolves relative include paths against the including file's directory; note that at runtime OpenSIPS tries the process working directory FIRST and only then the including file's directory — a same-named file in the daemon's CWD can differ from what the editor analyzed. OPENSIPS_LSP_ANALYZER_DEBOUNCE_MS tunes the analyzer debounce (default 300).
• The analyzer's undefined-route warnings are ADDITIVE to opensips -C: the parser accepts a config whose route(x) target does not exist (the failure happens at runtime), so only the analyzer catches it while editing.