commit 0d472a62012364d064f0b75f1da491242c6ae9c6 · pyrox.dev/nixpkgs

+33 -1

lib/modules.nix

···

       630
       630
        
                 loc = prefix ++ [name];

     

       631
       631
        
                 defns = pushedDownDefinitionsByName.${name} or [];

     

       632
       632
        
                 defns' = rawDefinitionsByName.${name} or [];

     

       633
       633
       -
                 optionDecls = filter (m: isOption m.options) decls;

     

       633
       633
       +
                 optionDecls = filter

     

       634
       634
       +
                   (m: m.options?_type

     

       635
       635
       +
                       && (m.options._type == "option"

     

       636
       636
       +
                           || throwDeclarationTypeError loc m.options._type

     

       637
       637
       +
                       )

     

       638
       638
       +
                   )

     

       639
       639
       +
                   decls;

     

       634
       640
        
               in

     

       635
       641
        
                 if length optionDecls == length decls then

     

       636
       642
        
                   let opt = fixupOptionType loc (mergeOptionDecls loc decls);

     
···

       691
       697
        
                   }) defs

     

       692
       698
        
                 ) unmatchedDefnsByName);

     

       693
       699
        
           };

     

       700
       700
       +
       

     

       701
       701
       +
         throwDeclarationTypeError = loc: actualTag:

     

       702
       702
       +
           let

     

       703
       703
       +
             name = lib.strings.escapeNixIdentifier (lib.lists.last loc);

     

       704
       704
       +
             path = showOption loc;

     

       705
       705
       +
             depth = length loc;

     

       706
       706
       +
       

     

       707
       707
       +
             paragraphs = [

     

       708
       708
       +
               "Expected an option declaration at option path `${path}` but got an attribute set with type ${actualTag}"

     

       709
       709
       +
             ] ++ optional (actualTag == "option-type") ''

     

       710
       710
       +
                 When declaring an option, you must wrap the type in a `mkOption` call. It should look somewhat like:

     

       711
       711
       +
                     ${comment}

     

       712
       712
       +
                     ${name} = lib.mkOption {

     

       713
       713
       +
                       description = ...;

     

       714
       714
       +
                       type = <the type you wrote for ${name}>;

     

       715
       715
       +
                       ...

     

       716
       716
       +
                     };

     

       717
       717
       +
               '';

     

       718
       718
       +
       

     

       719
       719
       +
             # Ideally we'd know the exact syntax they used, but short of that,

     

       720
       720
       +
             # we can only reliably repeat the last. However, we repeat the

     

       721
       721
       +
             # full path in a non-misleading way here, in case they overlook

     

       722
       722
       +
             # the start of the message. Examples attract attention.

     

       723
       723
       +
             comment = optionalString (depth > 1) "\n    # ${showOption loc}";

     

       724
       724
       +
           in

     

       725
       725
       +
           throw (concatStringsSep "\n\n" paragraphs);

     

       694
       726
        
       

     

       695
       727
        
         /* Merge multiple option declarations into a single declaration.  In

     

       696
       728
        
            general, there should be only one declaration of each option.

+5

lib/tests/modules.sh

···

       393
       393
        
         config.set \

     

       394
       394
        
         ./declare-set.nix ./declare-enable-nested.nix

     

       395
       395
        
       

     

       396
       396
       +
       # Options: accidental use of an option-type instead of option (or other tagged type; unlikely)

     

       397
       397
       +
       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

     

       398
       398
       +
       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

     

       399
       399
       +
       checkConfigError 'Expected an option declaration at option path .result. but got an attribute set with type configuration' config.result ./options-type-error-configuration.nix

     

       400
       400
       +
       

     

       396
       401
        
       # Check that that merging of option collisions doesn't depend on type being set

     

       397
       402
        
       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

     

       398
       403

+6

lib/tests/modules/options-type-error-configuration.nix

···

       1
       1
       +
       { lib, ... }: {

     

       2
       2
       +
         options = {

     

       3
       3
       +
           # unlikely mistake, but we can catch any attrset with _type

     

       4
       4
       +
           result = lib.evalModules { modules = []; };

     

       5
       5
       +
         };

     

       6
       6
       +
       }

+5

lib/tests/modules/options-type-error-typical-nested.nix

···

       1
       1
       +
       { lib, ... }: {

     

       2
       2
       +
         options = {

     

       3
       3
       +
           result.here = lib.types.str;

     

       4
       4
       +
         };

     

       5
       5
       +
       }

+5

lib/tests/modules/options-type-error-typical.nix

···

       1
       1
       +
       { lib, ... }: {

     

       2
       2
       +
         options = {

     

       3
       3
       +
           result = lib.types.str;

     

       4
       4
       +
         };

     

       5
       5
       +
       }