Skip to content

Commit 051c5c6

Browse files
siviziussivizius
committed
feat(hooks): add additional cargo-options
1 parent 1211305 commit 051c5c6

File tree

6 files changed

+778
-139
lines changed

6 files changed

+778
-139
lines changed

‎modules/hooks.nix‎

Lines changed: 11 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
{ config, lib, pkgs, hookModule, ... }:
22
let
3-
inherit (config) hooks tools settings;
3+
inherit (config) hooks tools;
44
cfg = config;
55
inherit (lib) flatten mapAttrs mapAttrsToList mkDefault mkOption mkRemovedOptionModule mkRenamedOptionModule types;
66

7-
cargoManifestPathArg =
8-
lib.optionalString
9-
(settings.rust.cargoManifestPath != null)
10-
"--manifest-path ${lib.escapeShellArg settings.rust.cargoManifestPath}";
11-
127
mkCmdArgs = predActionList:
138
lib.concatStringsSep
149
" "
@@ -76,7 +71,8 @@ in
7671

7772
# PLEASE keep this sorted alphabetically.
7873
options.hooks =
79-
{
74+
import ./rust/options.nix { inherit config lib hookModule; }
75+
// {
8076
alejandra = mkOption {
8177
description = "alejandra hook";
8278
type = types.submodule {
@@ -201,50 +197,6 @@ in
201197
};
202198
};
203199
};
204-
clippy = mkOption {
205-
description = "clippy hook";
206-
type = types.submodule
207-
({ config, ... }: {
208-
imports = [ hookModule ];
209-
options.packageOverrides = {
210-
cargo = mkOption {
211-
type = types.package;
212-
description = "The cargo package to use";
213-
};
214-
clippy = mkOption {
215-
type = types.package;
216-
description = "The clippy package to use";
217-
};
218-
};
219-
options.settings = {
220-
denyWarnings = mkOption {
221-
type = types.bool;
222-
description = "Fail when warnings are present";
223-
default = false;
224-
};
225-
offline = mkOption {
226-
type = types.bool;
227-
description = "Run clippy offline";
228-
default = true;
229-
};
230-
allFeatures = mkOption {
231-
type = types.bool;
232-
description = "Run clippy with --all-features";
233-
default = false;
234-
};
235-
extraArgs = mkOption {
236-
type = types.str;
237-
description = "Additional arguments to pass to clippy";
238-
default = "";
239-
};
240-
};
241-
242-
config.extraPackages = [
243-
config.packageOverrides.cargo
244-
config.packageOverrides.clippy
245-
];
246-
});
247-
};
248200
cmake-format = mkOption {
249201
description = "cmake-format hook";
250202
type = types.submodule {
@@ -1372,37 +1324,6 @@ in
13721324
};
13731325
};
13741326
};
1375-
rustfmt = mkOption {
1376-
description = ''
1377-
Additional rustfmt settings
1378-
1379-
Override the `rustfmt` and `cargo` packages by setting `hooks.rustfmt.packageOverrides`.
1380-
1381-
```
1382-
hooks.rustfmt.packageOverrides.cargo = pkgs.cargo;
1383-
hooks.rustfmt.packageOverrides.rustfmt = pkgs.rustfmt;
1384-
```
1385-
'';
1386-
type = types.submodule
1387-
({ config, ... }: {
1388-
imports = [ hookModule ];
1389-
options.packageOverrides = {
1390-
cargo = mkOption {
1391-
type = types.package;
1392-
description = "The cargo package to use.";
1393-
};
1394-
rustfmt = mkOption {
1395-
type = types.package;
1396-
description = "The rustfmt package to use.";
1397-
};
1398-
};
1399-
1400-
config.extraPackages = [
1401-
config.packageOverrides.cargo
1402-
config.packageOverrides.rustfmt
1403-
];
1404-
});
1405-
};
14061327
shfmt = mkOption {
14071328
description = "shfmt hook";
14081329
type = types.submodule {
@@ -1738,8 +1659,10 @@ in
17381659
};
17391660
};
17401661

1662+
config.assertions = import ./rust/assertions.nix { inherit config lib; };
17411663
config.warnings =
1742-
lib.optional cfg.hooks.rome.enable ''
1664+
import ./rust/warnings.nix { inherit config lib; }
1665+
++ lib.optional cfg.hooks.rome.enable ''
17431666
The hook `hooks.rome` has been renamed to `hooks.biome`.
17441667
''
17451668
++ lib.optional cfg.hooks.nixfmt.enable ''
@@ -1749,8 +1672,9 @@ in
17491672
'';
17501673

17511674
# PLEASE keep this sorted alphabetically.
1752-
config.hooks = mapAttrs (_: mapAttrs (_: mkDefault))
1753-
rec {
1675+
config.hooks = mapAttrs (_: mapAttrs (_: mkDefault)) (
1676+
import ./rust/config.nix { inherit config lib pkgs; }
1677+
// rec {
17541678
actionlint =
17551679
{
17561680
name = "actionlint";
@@ -1889,15 +1813,6 @@ in
18891813
entry = "${hooks.cabal2nix.package}/bin/cabal2nix-dir";
18901814
files = "\\.cabal$";
18911815
};
1892-
cargo-check =
1893-
{
1894-
name = "cargo-check";
1895-
description = "Check the cargo package for errors";
1896-
package = tools.cargo;
1897-
entry = "${hooks.cargo-check.package}/bin/cargo check ${cargoManifestPathArg}";
1898-
files = "\\.rs$";
1899-
pass_filenames = false;
1900-
};
19011816
checkmake = {
19021817
name = "checkmake";
19031818
description = "Experimental linter/analyzer for Makefiles";
@@ -2060,28 +1975,6 @@ in
20601975
entry = "${hooks.clang-tidy.package}/bin/clang-tidy --fix";
20611976
types_or = [ "c" "c++" "c#" "objective-c" ];
20621977
};
2063-
clippy =
2064-
let
2065-
inherit (hooks.clippy) packageOverrides;
2066-
wrapper = pkgs.symlinkJoin {
2067-
name = "clippy-wrapped";
2068-
paths = [ packageOverrides.clippy ];
2069-
nativeBuildInputs = [ pkgs.makeWrapper ];
2070-
postBuild = ''
2071-
wrapProgram $out/bin/cargo-clippy \
2072-
--prefix PATH : ${lib.makeBinPath [ packageOverrides.cargo ]}
2073-
'';
2074-
};
2075-
in
2076-
{
2077-
name = "clippy";
2078-
description = "Lint Rust code.";
2079-
package = wrapper;
2080-
packageOverrides = { cargo = tools.cargo; clippy = tools.clippy; };
2081-
entry = "${hooks.clippy.package}/bin/cargo-clippy clippy ${cargoManifestPathArg} ${lib.optionalString hooks.clippy.settings.offline "--offline"} ${lib.optionalString hooks.clippy.settings.allFeatures "--all-features"} ${hooks.clippy.settings.extraArgs} -- ${lib.optionalString hooks.clippy.settings.denyWarnings "-D warnings"}";
2082-
files = "\\.rs$";
2083-
pass_filenames = false;
2084-
};
20851978
cljfmt =
20861979
{
20871980
name = "cljfmt";
@@ -3259,28 +3152,6 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.ormol
32593152
entry = "${hooks.ruff.package}/bin/ruff format";
32603153
types = [ "python" ];
32613154
};
3262-
rustfmt =
3263-
let
3264-
inherit (hooks.rustfmt) packageOverrides;
3265-
wrapper = pkgs.symlinkJoin {
3266-
name = "rustfmt-wrapped";
3267-
paths = [ packageOverrides.rustfmt ];
3268-
nativeBuildInputs = [ pkgs.makeWrapper ];
3269-
postBuild = ''
3270-
wrapProgram $out/bin/cargo-fmt \
3271-
--prefix PATH : ${lib.makeBinPath [ packageOverrides.cargo packageOverrides.rustfmt ]}
3272-
'';
3273-
};
3274-
in
3275-
{
3276-
name = "rustfmt";
3277-
description = "Format Rust code.";
3278-
package = wrapper;
3279-
packageOverrides = { cargo = tools.cargo; rustfmt = tools.rustfmt; };
3280-
entry = "${hooks.rustfmt.package}/bin/cargo-fmt fmt ${cargoManifestPathArg} --all -- --color always";
3281-
files = "\\.rs$";
3282-
pass_filenames = false;
3283-
};
32843155
shellcheck =
32853156
{
32863157
name = "shellcheck";
@@ -3640,5 +3511,6 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.ormol
36403511
types_or = [ "clojure" "clojurescript" "edn" ];
36413512
};
36423513

3643-
};
3514+
}
3515+
);
36443516
}

‎modules/rust/assertions.nix‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{ config, lib, ... }:
2+
3+
let
4+
cargoHooks = { inherit (config.hooks) cargo-bench cargo-check cargo-test clippy; };
5+
6+
forAllCargoHooks = assertions:
7+
lib.mapAttrsToList
8+
(hook: { settings, ... }: assertions "${hook}.settings" settings)
9+
cargoHooks;
10+
in
11+
[ ]
12+
++ forAllCargoHooks (hook: { profile ? null, release ? false, ... }: {
13+
assertion = release -> profile == null;
14+
message = "Options `${hook}.release` and `${hook}.profile` are mutually exclusive";
15+
})
16+
++ forAllCargoHooks (hook: { exclude ? [ ], workspace ? false, ... }: {
17+
assertion = exclude != [ ] -> workspace;
18+
message = "Option `${hook}.exclude` requires `${hook}.workspace == true`";
19+
})
20+
++ forAllCargoHooks (hook: { package ? [ ], workspace ? false, ... }: {
21+
assertion = package != [ ] -> workspace;
22+
message = "Option `${hook}.package` requires `${hook}.workspace == true`";
23+
})
24+
++ forAllCargoHooks (hook: { bench ? [ ], benches ? false, ... }: {
25+
assertion = benches -> bench == [ ];
26+
message = "Options `${hook}.bench` and `${hook}.benches` are mutually exclusive";
27+
})
28+
++ forAllCargoHooks (hook: { bin ? [ ], bins ? false, ... }: {
29+
assertion = bins -> bin == [ ];
30+
message = "Options `${hook}.bin` and `${hook}.bins` are mutually exclusive";
31+
})
32+
++ forAllCargoHooks (hook: { example ? [ ], examples ? false, ... }: {
33+
assertion = examples -> example == [ ];
34+
message = "Options `${hook}.example` and `${hook}.examples` are mutually exclusive";
35+
})
36+
++ forAllCargoHooks (hook: { test ? [ ], tests ? false, ... }: {
37+
assertion = tests -> test == [ ];
38+
message = "Options `${hook}.test` and `${hook}.tests` are mutually exclusive";
39+
})
40+
++ forAllCargoHooks (
41+
hook:
42+
{ all-targets ? false
43+
, bench ? [ ]
44+
, benches ? false
45+
, bin ? [ ]
46+
, bins ? false
47+
, example ? [ ]
48+
, examples ? false
49+
, lib ? false
50+
, test ? [ ]
51+
, tests ? false
52+
, ...
53+
}: {
54+
assertion = all-targets -> (
55+
!lib
56+
&& bench == [ ] && !benches
57+
&& bin == [ ] && !bins
58+
&& example == [ ] && !examples
59+
&& test == [ ] && !tests
60+
);
61+
message = "The `${hook}.all-targets` option and other target options are mutually exclusive";
62+
}
63+
)
64+
++ forAllCargoHooks (hook: { all-features ? false, features ? [ ], ... }: {
65+
assertion = all-features -> features == [ ];
66+
message = "Options `${hook}.all-features` and `${hook}.features` are mutually exclusive";
67+
})
68+
++ forAllCargoHooks (hook: { all-features ? false, no-default-features ? false, ... }: {
69+
assertion = all-features -> !no-default-features;
70+
message = "Options `${hook}.all-features` and `${hook}.no-default-features` are mutually exclusive";
71+
})
72+
++ forAllCargoHooks (hook: { frozen ? false, locked ? false, ... }: {
73+
assertion = locked -> !frozen;
74+
message = "Options `${hook}.locked` and `${hook}.frozen` are mutually exclusive";
75+
})

0 commit comments

Comments
 (0)