Introduce a basic justfile

Introduce usage of `just` by adding a basic `justfile`.
This commit is contained in:
Tobin C. Harding 2023-08-22 12:31:02 +10:00
parent c06c9beb01
commit eccd3fe57b
No known key found for this signature in database
GPG Key ID: 40BF9E4C269D6607
2 changed files with 23 additions and 0 deletions

View File

@ -131,6 +131,11 @@ cargo test
Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more
detailed instructions.
### Just
We support [`just`](https://just.systems/man/en/) for running dev workflow commands. Run `just` from
your shell to see list available sub-commands.
### Building the docs
We build docs with the nightly toolchain, you may wish to use the following shell alias to check

18
justfile Normal file
View File

@ -0,0 +1,18 @@
default:
@just --list
# Cargo build everything.
build:
cargo build --workspace --all-targets --all-features
# Cargo check everything.
check:
cargo check --workspace --all-targets --all-features
# Lint everything.
lint:
cargo clippy --workspace --all-targets --all-features -- --deny warnings
# Check the formatting
format:
cargo +nightly fmt --all --check