From eccd3fe57b2fbfbd238bd4d28084d582b1417405 Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Tue, 22 Aug 2023 12:31:02 +1000 Subject: [PATCH] Introduce a basic justfile Introduce usage of `just` by adding a basic `justfile`. --- README.md | 5 +++++ justfile | 18 ++++++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 justfile diff --git a/README.md b/README.md index a7cd5117..83ea39fd 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/justfile b/justfile new file mode 100644 index 00000000..54bbeede --- /dev/null +++ b/justfile @@ -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