Editor support for JSONiq and XQuery, built around the RumbleDB engine. It includes a language server, a VS Code extension, and a small Java process that lets the server ask RumbleDB about your query.
If you just want to write queries, install the extension from the VS Code Marketplace or Open VSX. Its README covers what it does. For other editors, see the language server.
| Package | What it is |
|---|---|
jsoniq-language-server |
The LSP server, written in TypeScript. Parsing, completion, navigation and formatting happen here. |
rumble-lsp-wrapper |
A long-running Java process around RumbleDB. It handles type checking, type lookups and running queries. |
jsoniq-vscode |
The VS Code extension: TextMate grammars, the language client, and the query results panel. |
They fit together like this:
flowchart LR
vscode["VS Code extension"] -- LSP --> server["Language server"]
server -. "JSON over stdin/stdout" .-> wrapper["Java wrapper (RumbleDB)"]
The server works without the wrapper, so you can turn it off or run without Java. You lose type checking, type-aware completion and running queries, but everything based on the parser keeps working.
You need Node.js (CI runs on 26), pnpm, Java 17+, Maven and Git. The first build fetches RumbleDB at a pinned commit and compiles it, so expect it to take a while.
pnpm install
pnpm run generate:grammar
pnpm run buildTo try your build, open the repo in VS Code and start the Launch VSCode Exension debug configuration. pnpm run dev rebuilds the server, webview and extension as you edit.
| Command | What it does |
|---|---|
pnpm run build |
Builds the wrapper, server and extension. |
pnpm run build:prod |
Clean production build, including regenerated built-in catalogs. |
pnpm run dev |
Builds once, then watches the server, webview and extension. |
pnpm test |
Runs the wrapper tests, then the language server tests. |
pnpm run lint |
Lints with oxlint. |
pnpm run fmt |
Formats with oxfmt (and Spotless for the Java code). |
pnpm run clean |
Removes dist folders and the Java target directory. |
Bug reports and pull requests are welcome on GitHub. If your change affects a published package, add a changeset with pnpm changeset.
