Skip to content

Commit 832e354

Browse files
authored
lib/modules: improve mismatching class error mesage (#377345)
2 parents e77b40f + b3884c8 commit 832e354

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

lib/modules.nix

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,14 @@ let
367367
if m._class == null || m._class == class
368368
then m
369369
else
370-
throw "The module ${m._file or m.key} was imported into ${class} instead of ${m._class}."
370+
throw ''
371+
The module `${m._file or m.key}` (class: ${lib.strings.escapeNixString m._class}) cannot be imported into a module evaluation that expects class ${lib.strings.escapeNixString class}.
372+
373+
Help:
374+
- Ensure that you are importing the correct module.
375+
- Verify that the module's `_class`, ${lib.strings.escapeNixString m._class} matches the expected `class` ${lib.strings.escapeNixString class}.
376+
- If you are using a custom class, make sure it is correctly defined and used consistently across your modules.
377+
''
371378
else
372379
m: m;
373380

lib/tests/modules.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -538,12 +538,12 @@ checkConfigOutput '^1$' config.sub.specialisation.value ./extendModules-168767-i
538538
# Class checks, evalModules
539539
checkConfigOutput '^{}$' config.ok.config ./class-check.nix
540540
checkConfigOutput '"nixos"' config.ok.class ./class-check.nix
541-
checkConfigError 'The module .*/module-class-is-darwin.nix was imported into nixos instead of darwin.' config.fail.config ./class-check.nix
542-
checkConfigError 'The module foo.nix#darwinModules.default was imported into nixos instead of darwin.' config.fail-anon.config ./class-check.nix
541+
checkConfigError 'The module `.*/module-class-is-darwin.nix`.*?expects class "nixos".' config.fail.config ./class-check.nix
542+
checkConfigError 'The module `foo.nix#darwinModules.default`.*?expects class "nixos".' config.fail-anon.config ./class-check.nix
543543

544544
# Class checks, submoduleWith
545545
checkConfigOutput '^{}$' config.sub.nixosOk ./class-check.nix
546-
checkConfigError 'The module .*/module-class-is-darwin.nix was imported into nixos instead of darwin.' config.sub.nixosFail.config ./class-check.nix
546+
checkConfigError 'The module `.*/module-class-is-darwin.nix`.*?expects class "nixos".' config.sub.nixosFail.config ./class-check.nix
547547

548548
# submoduleWith type merge with different class
549549
checkConfigError 'A submoduleWith option is declared multiple times with conflicting class values "darwin" and "nixos".' config.sub.mergeFail.config ./class-check.nix

0 commit comments

Comments
 (0)