ChiselStrike Developer's Guide

Toolchain

On Linux, you can speed up build by first installing lld:

dnf install lld

and then configuring it in ~/.cargo/config.toml, for example:

[target.x86_64-unknown-linux-gnu]
rustflags = [
  "-C", "link-arg=-fuse-ld=lld",
]

The ChiselStrike code has API documentation written in RustDoc. To generate HTML pages, run:

cargo doc --no-deps --document-private-items

Step 1: Install Postgres client.

On macOS:

brew install libpq && echo 'export PATH="/opt/homebrew/opt/libpq/bin:$PATH"' >> ~/.zshrc

Verify that the client is working by running:

psql --version

which should output:

psql (PostgreSQL) 14.2

Step 2: Set up a Postgres database.

On macOS, install Postgres.app and start it up.

To verify that Postgres database is up and running, run:

psql

and you should see:

psql (14.2)
Type "help" for help.

penberg=#

Step 3: Run integration tests with Postgres:

cargo test -p cli --test integration_tests -- --database postgres