mab122
/
radicle-heartwood-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

hooks: Filter for "radicle.{xyz,zulipchat.com}" 

This hook should make people think before committing domain names
like "radicle.xyz" and "radicle.zulipchat.com" to our Rust code.

Note that these checks can be easily skipped as follows:

    SKIP=grep-radicle.xyz,grep-radicle.zulipchat.com git commit …

See also <https://pre-commit.com/#temporarily-disabling-hooks>
This commit is contained in:
Lorenz Leutgeb 2025-08-28 11:42:15 +02:00 committed by Fintan Halpenny
parent b301fa6a00
commit 9b7529baa7
1 changed files with 71 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
flake.nix
View File

@ -168,54 +168,81 @@
prefix = "msrv-";
})
// {
pre-commit-check = inputs.git-hooks.lib.${system}.run {
src = ./.;
settings.rust.check.cargoDeps = pkgs.rustPlatform.importCargoLock {lockFile = ./Cargo.lock;};
hooks = {
alejandra.enable = true;
rustfmt = {
pre-commit-check = let
grep = rec {
words = ["radicle.xyz" "radicle.zulipchat.com"];
after = map id words;
prefix = "grep-";
id = word: prefix + word;
hooks = builtins.listToAttrs (map (word: {
# "," is problematic, as this is used to split
# lists of hook names, when skipping, see:
# https://pre-commit.com/#temporarily-disabling-hooks
name = assert !lib.hasInfix "," word; id word;
value = hook word;
})
words);
hook = word: {
enable = true;
fail_fast = true;
packageOverrides.rustfmt = rustup.toolchain;
};
cargo-check = {
enable = true;
name = "cargo check";
after = ["rustfmt"];
fail_fast = true;
};
cargo-doc = let
# We wrap `cargo` in order to set an environment variable that
# gives us a non-zero exit on warning.
command =
pkgs.writeShellScript
"cargo"
"RUSTDOCFLAGS='--deny warnings' ${lib.getExe' rustup.toolchain "cargo"} $@";
in {
enable = true;
name = "cargo doc";
after = ["rustfmt"];
fail_fast = true;
entry = "${command} doc --workspace --all-features --no-deps";
entry = builtins.toString (pkgs.writeShellScript
"grep-${word}"
"! ${lib.getExe pkgs.ripgrep} --context=3 --fixed-strings '${word}' $@");
name = "Avoid '${word}' in Rust code";
files = "\\.rs$";
pass_filenames = false;
pass_filenames = true;
};
clippy = {
enable = true;
name = "cargo clippy";
stages = ["pre-push"]; # Only pre-push, because it takes a while.
settings = {
allFeatures = true;
denyWarnings = true;
};
packageOverrides = {
cargo = rustup.toolchain;
clippy = rustup.toolchain;
};
};
shellcheck.enable = true;
};
};
in
inputs.git-hooks.lib.${system}.run {
src = ./.;
settings.rust.check.cargoDeps = pkgs.rustPlatform.importCargoLock {lockFile = ./Cargo.lock;};
hooks =
{
alejandra.enable = true;
rustfmt = {
enable = true;
fail_fast = true;
packageOverrides.rustfmt = rustup.toolchain;
};
cargo-check = {
enable = true;
name = "cargo check";
after = ["rustfmt"] ++ grep.after;
fail_fast = true;
};
cargo-doc = let
# We wrap `cargo` in order to set an environment variable that
# gives us a non-zero exit on warning.
command =
pkgs.writeShellScript
"cargo"
"RUSTDOCFLAGS='--deny warnings' ${lib.getExe' rustup.toolchain "cargo"} $@";
in {
enable = true;
name = "cargo doc";
after = ["rustfmt"] ++ grep.after;
fail_fast = true;
entry = "${command} doc --workspace --all-features --no-deps";
files = "\\.rs$";
pass_filenames = false;
};
clippy = {
enable = true;
name = "cargo clippy";
stages = ["pre-push"]; # Only pre-push, because it takes a while.
settings = {
allFeatures = true;
denyWarnings = true;
};
packageOverrides = {
cargo = rustup.toolchain;
clippy = rustup.toolchain;
};
};
shellcheck.enable = true;
}
// grep.hooks;
};
# Build the crate as part of `nix flake check` for convenience
inherit (self.packages.${system}) radicle;