Development

Este conteúdo não está disponível em sua língua ainda.

Install the host dependencies in Building, then run pnpm install from the repository root. Package scripts are the command reference; CLAUDE.md lists the common ones, including how to run a single test.

Workflows

Command	Purpose
`pnpm dev:frontend`	React/Vite in a browser, port 1420
`pnpm dev:backend`	Authenticated Node HTTP JSON-RPC, port 41920
`pnpm dev:tauri`	Native desktop; starts the frontend and sidecars

Run frontend and backend separately for browser development. Limit local Rust builds to two jobs: CARGO_BUILD_JOBS=2 pnpm dev:tauri in Bash, or $env:CARGO_BUILD_JOBS='2' before pnpm dev:tauri in PowerShell.

To get test databases and seed matching connections, see docker/test-dbs.

JVM sidecar

Build the JAR when you need CTE column resolution or JDBC:

cd services/jvm-sidecar
./bootstrap.sh             # first time, if the Gradle wrapper is absent
./gradlew jar              # gradlew.bat jar on Windows

The output is services/jvm-sidecar/build/libs/omni-sql-sidecar.jar. Rebuild it after JVM changes and restart Tauri, which runs the JAR directly. Avoid gradlew run: its daemon can keep port 41921 busy. Without the JAR, basic autocomplete still works, but CTE resolution and JDBC are unavailable.

Checks

Run affected typecheck, lint and tests once after a coherent change; pnpm verify checks all TypeScript packages. For Rust changes run CARGO_BUILD_JOBS=2 cargo check --manifest-path apps/desktop/src-tauri/Cargo.toml; for JVM changes run ./gradlew test. Testing covers hooks, coverage, integration and CI.

Documentation site

The site at https://cccadet.github.io/omni-sql/docs/ is built with Astro Starlight from the Markdown in docs/, which stays the single source. apps/docs/pages.mjs maps each file to a page and a sidebar section; add an entry there when you add a page. scripts/sync-docs.mjs copies the files into the site, moves the # Title into frontmatter, rewrites links between mapped pages, and sends other repository links to GitHub.

pnpm --filter @omni-sql/docs build   # sync + build into apps/docs/dist
pnpm --filter @omni-sql/docs dev     # sync once, then a live dev server
pnpm --filter @omni-sql/docs test    # link-rewriting tests

Astro needs Node 22.23.4 or newer. The Pages workflow builds the docs on every push to main that touches docs/, apps/docs/ or website/, and publishes them under /docs next to the landing page. Portuguese pages fall back to English until a translation exists.

MCP clients during development

Desktop MCP clients may not inherit shell setup from Node version managers such as fnm. Make Node reachable through the MCP server’s env.PATH using a stable installation directory, not a temporary fnm_multishells path, and restart the client after changing it. See MCP.md for client setup.