Justfile

docker_image := "registry.gitlab.com/xfbs/restless"
docker_target_volume := "restless_target"
docker_registry_volume := "restless_registry"

# list commands
list:
    just --list

# pull docker image
docker-pull:
    docker pull {{docker_image}}

# build docker image
docker-build:
    docker build . -t {{docker_image}}

# run a raw command in docker
docker-run +command:
    docker volume create {{docker_target_volume}}
    docker volume create {{docker_registry_volume}}
    docker run -it --rm -v $(pwd):/crate:ro -v {{docker_target_volume}}:/crate/target -v {{docker_registry_volume}}:/usr/local/cargo/registry --workdir /crate {{docker_image}} {{command}}

# delete docker volumes
docker-clean:
    docker volume remove {{docker_target_volume}}
    docker volume remove {{docker_registry_volume}}

# run some just targets inside the docker container (try `just docker check`)
docker +target:
    just docker-run just {{target}}

# run tests (using cargo test)
test:
    cargo test --all-features --all

# test crate features (using cargo hack)
features:
    cargo hack --feature-powerset --depth 2 check --all

# check style (using clippy and rustfmt)
style:
    cargo clippy --all-features --all -- --deny warnings
    cargo fmt --check --all

# build crate docs (using rustdoc)
docs:
    cargo doc --all-features

# build book (using mdbook)
book-build:
    mdbook build

# test code examples in book
book-test:
    cargo build --all-features --target-dir target/book/target
    mdbook test -L target/book/target/debug/deps

# serve code from book
book-serve:
    mdbook serve

# build coverage (using cargo llvm-cov)
coverage:
    cargo llvm-cov --html --all-features --all
    cargo llvm-cov report

# run checks (runs test, style and features)
checks:
    just test style features

# validate semver compliance (using cargo semver-checks)
semver:
    cargo semver-checks --workspace

# publish the crate with the given name. consider running `just semver` before
publish crate:
    #!/usr/bin/env bash
    set -euxo pipefail
    CRATE_VERSION=$(cargo metadata --format-version 1 | jq -r ".packages[] | select(.name == \"{{crate}}\") | .version")
    if [ "$CRATE_VERSION" != "0.1.0" ]; then
        cargo semver-checks --package {{crate}}
    fi
    cargo publish --dry-run --package {{crate}}
    GIT_TAG="{{crate}}-v$CRATE_VERSION"
    git tag "$GIT_TAG"
    cargo publish --package {{crate}}
    git push origin "$GIT_TAG"