rusq for VS Code

SQL diagnostics, quick fixes and formatting, powered by rusq server (the rusq language server).

The extension is a thin LSP client: all linting and formatting happens in the rusq binary you already have, so the extension never goes out of date relative to the CLI.

Features

• Diagnostics as you type for every SQL file — the same rule catalog the CLI ships (the AL, AM, CP, CV, LT, RF, ST families, the dialect families PG, OR, TQ, and the RUS meta rules).
• Quick fixes — Ctrl+. / Cmd+. offers each rule's automatic fix, plus a suppress action that writes the right -- rusq: directive for you and a fix all auto-fixable problems source action.
• Format document and selection — Shift+Alt+F (or Format Selection) runs the rusq formatter, honouring your .rusq.toml [format] options. The formatter is layout-only: it never changes token case and never rewrites a template tag.
• Templated SQL — a finding inside a {{ ... }} tag is reported at the tag's position in your source file, not at a line in some rendered output.
• Per-file configuration — diagnostics come from .rusq.toml discovery, so nested projects with different dialects and rule selections behave exactly as they do on the command line.

Requirements

Installed from the Marketplace or Open VSX: nothing to install. Each platform package (linux-x64, linux-arm64, darwin-x64, darwin-arm64, win32-x64, win32-arm64) ships the matching rusq binary, so the extension works out of the box. On a platform with no specific package — the generic package, or another architecture — the extension falls back to a rusq on PATH:

go install github.com/ppreeper/rusq/cmd/rusq@latest

The client tracks rusq v0.1.2; pin a specific release with go install github.com/ppreeper/rusq/cmd/rusq@v0.1.2.

or build it from a checkout (go build -o rusq ./cmd/rusq) and point rusq.binaryPath at it.

Settings

Commands: rusq: Restart language server, rusq: Show output channel.

Build and install from source

cd editors/vscode
npm install
npm run build        # bundles src/ into dist/extension.js
npm run compile      # type-check only
npm run package          # generic package, no bundled binary
npm run package:targets  # six platform packages, each bundling the binary
code --install-extension rusq-sql-0.1.2@linux-x64.vsix

To hack on the extension, open this folder in VS Code and press F5 (Run rusq extension) — it launches an Extension Development Host with this folder as the extension.

Notes

• The client uses full-text synchronisation and the server pushes diagnostics, so there is nothing to configure to get started.

• VS Code's built-in SQL support also offers a formatter. To make rusq the default, add to your settings:

  "[sql]": { "editor.defaultFormatter": "ppreeper.rusq-sql" }
  

• Formatting a selection is supported through the LSP range-formatting request; on the command line the equivalent is rusq format --range start_line:col-end_line:col.

• Language ids other than VS Code's built-in sql come from other extensions (jinja-sql, sql-bigquery, dbt-sql, pgsql, mysql, plsql). All of them are covered out of the box.

License

MIT — see LICENSE.