Merge #668: Add justfile

9f5849f Add justfile (Tobin C. Harding)

Pull request description:

  Add a `just` config file with various useful commands. Note that a bunch of these commands do not succeed currently on master, specifically:

  - just lint
  - just docsrs
  - just sane

  Will fix as separate PRs

ACKs for top commit:
  apoelstra:
    ACK 9f5849f

Tree-SHA512: 59e7c0feb72e43f3b3e9e89d1d6549f57c7fa7ca1cd48eb845ef90ddec7374c2478380c5763a041849c5113153139fb90e2b2865a1c72532aadd618d24449816

Author: apoelstra

justfile

@@ -0,0 +1,39 @@
+default:
+  @just --list
+
+# Cargo build everything.
+build:
+  cargo build --all-targets --all-features
+
+# Cargo check everything.
+check:
+  cargo check --all-targets --all-features
+
+# Lint everything.
+lint:
+  cargo +nightly clippy --all-targets --all-features -- --deny warnings
+
+# Run the formatter.
+fmt:
+  cargo +nightly fmt
+
+# Check the formatting.
+fmt-check:
+  cargo +nightly fmt --check
+
+# Run the benchmark suite.
+bench:
+  RUSTFLAGS='--cfg=bench' cargo +nightly bench
+
+# Build the docs (same as for docs.rs).
+docsrs:
+  RUSTDOCFLAGS="--cfg docsrs" cargo +nightly rustdoc --all-features -- -D rustdoc::broken-intra-doc-links
+
+# Quick and dirty CI useful for pre-push checks.
+sane: fmt-check lint
+  cargo test --quiet --all-targets --no-default-features --features > /dev/null || exit 1
+  cargo test --quiet --all-targets > /dev/null || exit 1
+  cargo test --quiet --all-targets --all-features > /dev/null || exit 1
+
+  # doctests don't get run from workspace root with `cargo test`.
+  cargo test --quiet --doc || exit 1