RustForge/justfile at main · rwilliamspbg-ops/RustForge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# Common commands for working on RustForge. Install `just`:
# https://github.com/casey/just — then run `just` to list recipes.

# List available recipes.
default:
    @just --list

# Mirror the CI gate locally (fmt, clippy, tests, and cargo-deny if installed).
check:
    ./scripts/check.sh

# Format the whole workspace.
fmt:
    cargo fmt --all

# Check formatting without modifying files.
fmt-check:
    cargo fmt --all --check

# Lint the default feature set.
clippy:
    cargo clippy --workspace --all-targets -- -D warnings

# Lint every feature except compile-fail (matches CI's `test` job).
clippy-all:
    cargo clippy --workspace --all-targets --features async,no_std,perf,fuzz,edge,snapshot -- -D warnings

# Run the default test suite.
test:
    cargo test --workspace

# Run every feature except compile-fail (matches CI's `test` job).
test-all:
    cargo test --workspace --features async,no_std,perf,fuzz,edge,snapshot

# Run trybuild's compile-fail/UI tests. Run on stable — see ci/README.md.
test-compile-fail:
    cargo test -p syntax-tests --features compile-fail

# Run the workspace under cargo-nextest instead of `cargo test` (install: cargo install cargo-nextest --locked).
nextest:
    cargo nextest run --workspace --features async,no_std,perf,fuzz,edge,snapshot

# Run Criterion benchmarks (targets named explicitly — see bench-baseline for why).
bench:
    cargo bench -p performance-tests --features perf --bench sum_bench --bench collection_ops_bench

# Save a Criterion baseline named "main" — run this before your change.
bench-baseline:
    cargo bench -p performance-tests --features perf --bench sum_bench --bench collection_ops_bench -- --save-baseline main

# Compare current code against the "main" baseline (see docs/performance-regression-testing.md).
bench-compare:
    cargo bench -p performance-tests --features perf --bench sum_bench --bench collection_ops_bench -- --baseline main

# Type-check the detached fuzz/ workspace (doesn't require nightly).
fuzz-check:
    cd fuzz && cargo check

# Build fuzz targets. Requires nightly: rustup toolchain install nightly
fuzz-build:
    cd fuzz && cargo +nightly fuzz build

# Run one fuzz target with its seed corpus, e.g. `just fuzz-run utf8_input` (requires nightly).
fuzz-run target:
    cd fuzz && cargo +nightly fuzz run {{target}} seed_corpus/{{target}}

# Feature-powerset check per crate, matching CI's `hack` job (install: cargo install cargo-hack --locked).
hack:
    cargo hack test --workspace --feature-powerset --exclude-features compile-fail

# Test against the lowest versions every Cargo.toml constraint allows, matching CI's `minimal-versions` job.
# Needs nightly for resolution (install: cargo install cargo-hack cargo-minimal-versions --locked).
minimal-versions:
    cargo minimal-versions test --workspace --exclude performance-tests

# Check licenses/advisories/bans/sources for both workspaces (install: cargo install cargo-deny --locked).
deny:
    cargo deny check
    cd fuzz && cargo deny check

# Generate an HTML coverage report (install: rustup component add llvm-tools-preview && cargo install cargo-llvm-cov --locked).
coverage:
    ./scripts/coverage.sh

# Build and open rustdoc for the whole workspace.
doc:
    cargo doc --workspace --all-features --no-deps --open

# Check docs for broken intra-doc links etc., matching CI's `docs` job.
doc-check:
    RUSTDOCFLAGS="-D warnings" cargo doc --workspace --all-features --no-deps

# Chain everything CI runs (fmt, clippy, tests, nextest, doc-check, deny) into one local pre-push command.
full-ci: fmt-check clippy-all test-all nextest doc-check
    #!/usr/bin/env bash
    set -euo pipefail
    if cargo deny --version >/dev/null 2>&1; then
        echo "==> cargo deny check"
        cargo deny check
        echo "==> cargo deny check (fuzz/)"
        (cd fuzz && cargo deny check)
    else
        echo "==> skipping cargo-deny check (not installed; cargo install cargo-deny --locked)"
    fi

# Release-build every optional feature as a readiness check (no publish step — every crate is `publish = false`).
release-dry-run:
    cargo build --workspace --release --features async,no_std,perf,fuzz,edge,snapshot

# Exploratory mutation-testing pass, local-only, never wired into CI (install: cargo install cargo-mutants --locked).
mutants:
    cargo mutants --workspace