Merge #195: feat(ci): add justfile

df6675d fix(docs): fix `bitcoin::block::Header` link (Luis Schwab)
4b98565 feat(ci): add justfile (Luis Schwab)

Pull request description:

  This PR adds a `justfile` stolen from `rust-esplora-client`.

ACKs for top commit:
  oleonardolima:
    tACK df6675d

Tree-SHA512: 8d8f43c27631d7dc1c0eac28e01828510118a0600c762e9459b779a6423ceb6b1e3000f5c797d065a2ef6e511e2c47f6ad7bcf0182a515e573fc097e74f9e04b

Author: oleonardolima

justfile

@@ -0,0 +1,34 @@
+alias b := build
+alias c := check
+alias f := fmt
+alias t := test
+alias p := pre-push
+
+_default:
+   @just --list
+
+# Build the project
+build:
+   cargo build
+
+# Check code: formatting, compilation, linting, doc comments, and commit signature
+check:
+   cargo +nightly fmt --all -- --check
+   cargo check --all-features --all-targets
+   cargo clippy --all-features --all-targets -- -D warnings
+   RUSTDOCFLAGS="-D warnings" cargo doc --all-features --no-deps
+   @[ "$(git log --pretty='format:%G?' -1 HEAD)" = "N" ] && \
+       echo "\n⚠️  Unsigned commit: BDK requires that commits be signed." || \
+       true
+
+# Format all code
+fmt:
+   cargo +nightly fmt
+
+# Run all tests on the workspace with all features
+test:
+   cargo test --all-features -- --test-threads=1
+
+# Run pre-push suite: format, check, and test
+pre-push: fmt check test
+

src/utils.rs

@@ -13,7 +13,7 @@ use bitcoin::Txid;
 /// otherwise.
 ///
 /// [`transaction_get_merkle`]: crate::ElectrumApi::transaction_get_merkle
-/// [`BlockHeader`]: bitcoin::BlockHeader
+/// [`BlockHeader`]: bitcoin::block::Header
 pub fn validate_merkle_proof(
     txid: &Txid,
     merkle_root: &TxMerkleNode,