Re: [PATCH 2/6] ci: check formatting of our Rust code
- From
SZEDER Gábor <szeder.dev@gmail.com>
- Date
- Oct 8, 2025, 20:55 UTC
- Message-ID
- <aObPzzLtZzodZf+Q@szeder.dev>
- In-Reply-To
- <20251007-b4-pks-ci-rust-v1-2-394502abe7ea@pks.im>
On Tue, Oct 07, 2025 at 02:36:30PM +0200, Patrick Steinhardt wrote:
Show 21 quoted lines
> Introduce a CI check that verifies that our Rust code is well-formatted. > This check uses rustfmt(1), which is the de-facto standard in the Rust > world. > > The rustfmt(1) tool allows to tweak the final format in theory. In > practice though, the Rust ecosystem has aligned on style "editions". > These editions only exist to ensure that any potential changes to the > style don't cause reformats to existing code bases. Other than that, > most Rust projects out there accept this default style of a specific > edition. > > Let's do the same and use that default style. It may not be anyone's > favorite, but it is consistent and by making it part of our CI we also > enforce it right from the start. > > Note that we don't have to pick a specific style edition here, as the > edition is automatically derived from the edition we have specified in > our "Cargo.toml" file. > > Signed-off-by: Patrick Steinhardt <ps@pks.im> > ---
Show 18 quoted lines
> diff --git a/ci/run-rust-checks.sh b/ci/run-rust-checks.sh
> new file mode 100755
> index 0000000000..082eb52f11
> --- /dev/null
> +++ b/ci/run-rust-checks.sh
> @@ -0,0 +1,12 @@
> +#!/bin/sh
> +
> +. ${0%/*}/lib.sh
> +
> +set +x
> +
> +if ! group "Check Rust formatting" cargo fmt --all --check
> +then
> + RET=1
> +fi
> +
> +exit $RETOur ci/*.sh scripts usually rely on 'set -e' to catch failed commands. Either this script should follow that convention as well, or the commit message should justify the deviation from convention.