Skip to content

Commit

Permalink
lib/modules: Report a better error when option tree has bare type
Browse files Browse the repository at this point in the history
Improves on 0d472a6
- NixOS#242339

We actually do have the file name.

Thanks Shawn8901 for the [feedback]!

feedback: NixOS#242339 (comment)
  • Loading branch information
roberth committed Aug 18, 2023
1 parent ed9af6d commit 5ad01f1
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions lib/modules.nix
Original file line number Diff line number Diff line change
Expand Up @@ -633,7 +633,7 @@ let
optionDecls = filter
(m: m.options?_type
&& (m.options._type == "option"
|| throwDeclarationTypeError loc m.options._type
|| throwDeclarationTypeError loc m.options._type m._file
)
)
decls;
Expand Down Expand Up @@ -698,14 +698,14 @@ let
) unmatchedDefnsByName);
};

throwDeclarationTypeError = loc: actualTag:
throwDeclarationTypeError = loc: actualTag: file:
let
name = lib.strings.escapeNixIdentifier (lib.lists.last loc);
path = showOption loc;
depth = length loc;

paragraphs = [
"Expected an option declaration at option path `${path}` but got an attribute set with type ${actualTag}"
"In module ${file}: expected an option declaration at option path `${path}` but got an attribute set with type ${actualTag}"
] ++ optional (actualTag == "option-type") ''
When declaring an option, you must wrap the type in a `mkOption` call. It should look somewhat like:
${comment}
Expand Down
6 changes: 3 additions & 3 deletions lib/tests/modules.sh
Original file line number Diff line number Diff line change
Expand Up @@ -394,9 +394,9 @@ checkConfigError \
./declare-set.nix ./declare-enable-nested.nix

# Options: accidental use of an option-type instead of option (or other tagged type; unlikely)
checkConfigError 'Expected an option declaration at option path .result. but got an attribute set with type option-type' config.result ./options-type-error-typical.nix
checkConfigError 'Expected an option declaration at option path .result.here. but got an attribute set with type option-type' config.result.here ./options-type-error-typical-nested.nix
checkConfigError 'Expected an option declaration at option path .result. but got an attribute set with type configuration' config.result ./options-type-error-configuration.nix
checkConfigError 'In module .*/options-type-error-typical.nix: expected an option declaration at option path .result. but got an attribute set with type option-type' config.result ./options-type-error-typical.nix
checkConfigError 'In module .*/options-type-error-typical-nested.nix: expected an option declaration at option path .result.here. but got an attribute set with type option-type' config.result.here ./options-type-error-typical-nested.nix
checkConfigError 'In module .*/options-type-error-configuration.nix: expected an option declaration at option path .result. but got an attribute set with type configuration' config.result ./options-type-error-configuration.nix

# Check that that merging of option collisions doesn't depend on type being set
checkConfigError 'The option .group..*would be a parent of the following options, but its type .<no description>. does not support nested options.\n\s*- option.s. with prefix .group.enable..*' config.group.enable ./merge-typeless-option.nix
Expand Down

0 comments on commit 5ad01f1

Please sign in to comment.