# Nim SQL Parser Build Procedure
The parser shared library is a generated local artifact and is intentionally
ignored by Git. Use the repository-level scripts so the toolchain and output
name stay aligned with Cargo's FFI build script.
## Linux, macOS, and Windows
From the repository root:
```sh
make nim-parser
bash scripts/test-nim-parser.sh
```
`auto` uses a host Nim/Nimble installation when both are available and falls
back to Docker. The host toolchain must be Nim 2.2 or newer. To select a
backend explicitly:
```sh
bash scripts/build-nim-parser.sh --backend host
bash scripts/build-nim-parser.sh --backend docker
bash scripts/test-nim-parser.sh --backend host
bash scripts/test-nim-parser.sh --backend docker
```
The Docker backend uses the digest-pinned `nimlang/nim:2.2` image and mounts
only `crates/alopex-sql/nim-sql-parser`. Mounting only the parser directory is
intentional: a Git worktree's `.git` file points outside the container and can
break Nimble's dependency resolution.
The build output is one of:
- Linux: `libalopex_sql_parser.so`
- macOS: `libalopex_sql_parser.dylib`
- Windows: `alopex_sql_parser.dll`
The library exports `alopex_parse_sql`, `alopex_parse_promql`,
`alopex_parser_version`, `alopex_parser_init`, and `alopex_free_buffer`.
The current SQL/PromQL MessagePack contract version is `0.3.0`.
For Skulk development, copy the host artifact into
`crates/skulk/nim-parser/vendor/<target-triple>/` in the Skulk repository.
Skulk's build script also accepts `SKULK_NIM_PARSER_LIB_DIR` for an explicit
artifact directory.
## Rust checks
Cargo automatically discovers the generated library in the parser directory.
For a worktree or an explicit output directory, use:
```sh
NIM_SQL_PARSER_LIB_DIR="$PWD/crates/alopex-sql/nim-sql-parser" \
LD_LIBRARY_PATH="$PWD/crates/alopex-sql/nim-sql-parser" \
cargo test -p alopex-sql --lib
```
CI calls the same build and test scripts. Release-wheel jobs that compile Nim
inside a manylinux image remain separate because they target the wheel's
architecture and toolchain image.