Merge rust-bitcoin/rust-bitcoin#2018: Introduce a basic justfile

eccd3fe57b Introduce a basic justfile (Tobin C. Harding)

Pull request description:

  Introduce usage of `just` by adding a basic `justfile`.

  If this goes in we can add various script invocations to it plus other useful things that often get red CI runs (eg, checking no-std).

ACKs for top commit:
  RCasatta:
    ACK eccd3fe57b
  apoelstra:
    ACK eccd3fe57b

Tree-SHA512: c10514e0ee623f366904c9103bc961a1316b199c09083180767fb9b5864e94df122c9db1a3ea084c8790f0b849e89c68b304f87247b70763fb93c28a33642d28
This commit is contained in:
Andrew Poelstra 2023-09-03 14:47:55 +00:00
commit 8e573f4b57
No known key found for this signature in database
GPG Key ID: C588D63CE41B97C1
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