commit 0196e5372b8b7a282cb3bbe5cbf446617141ce38 · pyrox.dev/nixpkgs

lib/default.nix

···

       446
       446
        
               fixupOptionType

     

       447
       447
        
               mkIf

     

       448
       448
        
               mkAssert

     

       449
       449
       +
               mkDefinition

     

       449
       450
        
               mkMerge

     

       450
       451
        
               mkOverride

     

       451
       452
        
               mkOptionDefault

+16 -4

lib/modules.nix

···

       1097
       1097
        
               # Process mkMerge and mkIf properties.

     

       1098
       1098
        
               defs' = concatMap (

     

       1099
       1099
        
                 m:

     

       1100
       1100
       -
                 map (value: {

     

       1101
       1101
       -
                   inherit (m) file;

     

       1102
       1102
       -
                   inherit value;

     

       1103
       1103
       -
                 }) (addErrorContext "while evaluating definitions from `${m.file}':" (dischargeProperties m.value))

     

       1100
       1100
       +
                 map (

     

       1101
       1101
       +
                   value:

     

       1102
       1102
       +
                   if value._type or null == "definition" then

     

       1103
       1103
       +
                     value

     

       1104
       1104
       +
                   else

     

       1105
       1105
       +
                     {

     

       1106
       1106
       +
                       inherit (m) file;

     

       1107
       1107
       +
                       inherit value;

     

       1108
       1108
       +
                     }

     

       1109
       1109
       +
                 ) (addErrorContext "while evaluating definitions from `${m.file}':" (dischargeProperties m.value))

     

       1104
       1110
        
               ) defs;

     

       1105
       1111
        
       

     

       1106
       1112
        
               # Process mkOverride properties.

     
···

       1364
       1370
        
           _type = "merge";

     

       1365
       1371
        
           inherit contents;

     

       1366
       1372
        
         };

     

       1373
       1373
       +
       

     

       1374
       1374
       +
         /**

     

       1375
       1375
       +
           Return a definition with file location information.

     

       1376
       1376
       +
         */

     

       1377
       1377
       +
         mkDefinition = args@{ file, value, ... }: args // { _type = "definition"; };

     

       1367
       1378
        
       

     

       1368
       1379
        
         mkOverride = priority: content: {

     

       1369
       1380
        
           _type = "override";

     
···

       2095
       2106
        
           mkBefore

     

       2096
       2107
        
           mkChangedOptionModule

     

       2097
       2108
        
           mkDefault

     

       2109
       2109
       +
           mkDefinition

     

       2098
       2110
        
           mkDerivedConfig

     

       2099
       2111
        
           mkFixStrictness

     

       2100
       2112
        
           mkForce

lib/tests/modules.sh

···

       673
       673
        
       # types.pathWith { inStore = true; absolute = false; }

     

       674
       674
        
       checkConfigError 'In pathWith, inStore means the path must be absolute' config.impossiblePathOptionType ./pathWith.nix

     

       675
       675
        
       

     

       676
       676
       +
       # mkDefinition

     

       677
       677
       +
       # check that mkDefinition 'file' is printed in the error message

     

       678
       678
       +
       checkConfigError 'Cannot merge definitions.*\n\s*- In .file.*\n\s*- In .other.*' config.conflict ./mkDefinition.nix

     

       679
       679
       +
       checkConfigError 'A definition for option .viaOptionDefault. is not of type .boolean.*' config.viaOptionDefault ./mkDefinition.nix

     

       680
       680
       +
       checkConfigOutput '^true$' config.viaConfig ./mkDefinition.nix

     

       681
       681
       +
       checkConfigOutput '^true$' config.mkMerge ./mkDefinition.nix

     

       682
       682
       +
       checkConfigOutput '^true$' config.mkForce ./mkDefinition.nix

     

       683
       683
       +
       

     

       676
       684
        
       cat <<EOF

     

       677
       685
        
       ====== module tests ======

     

       678
       686
        
       $pass Pass

+71

lib/tests/modules/mkDefinition.nix

···

       1
       1
       +
       { lib, ... }:

     

       2
       2
       +
       let

     

       3
       3
       +
         inherit (lib)

     

       4
       4
       +
           mkOption

     

       5
       5
       +
           mkDefinition

     

       6
       6
       +
           mkOptionDefault

     

       7
       7
       +
           ;

     

       8
       8
       +
       in

     

       9
       9
       +
       {

     

       10
       10
       +
         imports = [

     

       11
       11
       +
           {

     

       12
       12
       +
             _file = "file";

     

       13
       13
       +
             options.conflict = mkOption {

     

       14
       14
       +
               default = 1;

     

       15
       15
       +
             };

     

       16
       16
       +
             config.conflict = mkDefinition {

     

       17
       17
       +
               file = "other";

     

       18
       18
       +
               value = mkOptionDefault 42;

     

       19
       19
       +
             };

     

       20
       20
       +
           }

     

       21
       21
       +
           {

     

       22
       22
       +
             # Check that mkDefinition works within 'config'

     

       23
       23
       +
             options.viaConfig = mkOption { };

     

       24
       24
       +
             config.viaConfig = mkDefinition {

     

       25
       25
       +
               file = "other";

     

       26
       26
       +
               value = true;

     

       27
       27
       +
             };

     

       28
       28
       +
           }

     

       29
       29
       +
           {

     

       30
       30
       +
             # Check mkMerge can wrap mkDefinitions

     

       31
       31
       +
             # Not the other way around

     

       32
       32
       +
             options.mkMerge = mkOption {

     

       33
       33
       +
               type = lib.types.bool;

     

       34
       34
       +
             };

     

       35
       35
       +
             config.mkMerge = lib.mkMerge [

     

       36
       36
       +
               (mkDefinition {

     

       37
       37
       +
                 file = "a.nix";

     

       38
       38
       +
                 value = true;

     

       39
       39
       +
               })

     

       40
       40
       +
               (mkDefinition {

     

       41
       41
       +
                 file = "b.nix";

     

       42
       42
       +
                 value = true;

     

       43
       43
       +
               })

     

       44
       44
       +
             ];

     

       45
       45
       +
           }

     

       46
       46
       +
           {

     

       47
       47
       +
             # Check mkDefinition can use mkForce on the value

     

       48
       48
       +
             # Not the other way around

     

       49
       49
       +
             options.mkForce = mkOption {

     

       50
       50
       +
               type = lib.types.bool;

     

       51
       51
       +
               default = false;

     

       52
       52
       +
             };

     

       53
       53
       +
             config.mkForce = mkDefinition {

     

       54
       54
       +
               file = "other";

     

       55
       55
       +
               value = lib.mkForce true;

     

       56
       56
       +
             };

     

       57
       57
       +
           }

     

       58
       58
       +
           {

     

       59
       59
       +
             # Currently expects an error

     

       60
       60
       +
             # mkDefinition doesn't work on option default

     

       61
       61
       +
             # This is a limitation and might be resolved in the future

     

       62
       62
       +
             options.viaOptionDefault = mkOption {

     

       63
       63
       +
               type = lib.types.bool;

     

       64
       64
       +
               default = mkDefinition {

     

       65
       65
       +
                 file = "other";

     

       66
       66
       +
                 value = true;

     

       67
       67
       +
               };

     

       68
       68
       +
             };

     

       69
       69
       +
           }

     

       70
       70
       +
         ];

     

       71
       71
       +
       }

+62

nixos/doc/manual/development/option-def.section.md

···

       123
       123
        
           ];

     

       124
       124
        
       }

     

       125
       125
        
       ```

     

       126
       126
       +
       

     

       127
       127
       +
       ## Free-floating definitions {#sec-option-definitions-definitions}

     

       128
       128
       +
       

     

       129
       129
       +
       :::{.note}

     

       130
       130
       +
       The module system internally transforms module syntax into definitions. This always happens internally.

     

       131
       131
       +
       :::

     

       132
       132
       +
       

     

       133
       133
       +
       It is possible to create first class definitions which are not transformed _again_ into definitions by the module system.

     

       134
       134
       +
       

     

       135
       135
       +
       Usually the file location of a definition is implicit and equal to the file it came from.

     

       136
       136
       +
       However, when manipulating definitions, it may be useful for them to be completely self-contained (or "free-floating").

     

       137
       137
       +
       

     

       138
       138
       +
       A free-floating definition is created with `mkDefinition { file = ...; value = ...; }`.

     

       139
       139
       +
       

     

       140
       140
       +
       Preserving the file location creates better error messages, for example when copying definitions from one option to another.

     

       141
       141
       +
       

     

       142
       142
       +
       Other properties like `mkOverride` `mkMerge` `mkAfter` can be used in the `value` attribute but not on the entire definition.

     

       143
       143
       +
       

     

       144
       144
       +
       This is what would work

     

       145
       145
       +
       

     

       146
       146
       +
       ```nix

     

       147
       147
       +
       mkDefinition {

     

       148
       148
       +
          value = mkForce 42;

     

       149
       149
       +
          file = "somefile.nix";

     

       150
       150
       +
       }

     

       151
       151
       +
       ```

     

       152
       152
       +
       

     

       153
       153
       +
       While this would NOT work.

     

       154
       154
       +
       

     

       155
       155
       +
       ```nix

     

       156
       156
       +
       mkForce (mkDefinition {

     

       157
       157
       +
          value = 42;

     

       158
       158
       +
          file = "somefile.nix";

     

       159
       159
       +
       })

     

       160
       160
       +
       ```

     

       161
       161
       +
       

     

       162
       162
       +
       The following shows an example configuration that yields an error with the custom position information:

     

       163
       163
       +
       

     

       164
       164
       +
       ```nix

     

       165
       165
       +
       {

     

       166
       166
       +
         _file = "file.nix";

     

       167
       167
       +
         options.foo = mkOption {

     

       168
       168
       +
           default = 13;

     

       169
       169
       +
         };

     

       170
       170
       +
         config.foo = lib.mkDefinition {

     

       171
       171
       +
           file = "custom place";

     

       172
       172
       +
           # mkOptionDefault creates a conflict with the option foo's `default = 1` on purpose

     

       173
       173
       +
           # So we see the error message below contains the conflicting values and different positions

     

       174
       174
       +
           value = lib.mkOptionDefault 42;

     

       175
       175
       +
         };

     

       176
       176
       +
       }

     

       177
       177
       +
       ```

     

       178
       178
       +
       

     

       179
       179
       +
       evaluating the module yields the following error:

     

       180
       180
       +
       

     

       181
       181
       +
       ```

     

       182
       182
       +
       error: Cannot merge definitions of `foo'. Definition values:

     

       183
       183
       +
       - In `file.nix': 13

     

       184
       184
       +
       - In `custom place': 42

     

       185
       185
       +
       ```

     

       186
       186
       +
       

     

       187
       187
       +
       To set the file location for all definitions in a module, you may add the `_file` module syntax attribute, which has a similar effect to using `mkDefinition` on all definitions in the module, without the hassle.

nixos/doc/manual/redirects.json

···

       1664
       1664
        
         "sec-option-definitions-merging": [

     

       1665
       1665
        
           "index.html#sec-option-definitions-merging"

     

       1666
       1666
        
         ],

     

       1667
       1667
       +
         "sec-option-definitions-definitions": [

     

       1668
       1668
       +
           "index.html#sec-option-definitions-definitions"

     

       1669
       1669
       +
         ],

     

       1667
       1670
        
         "sec-assertions": [

     

       1668
       1671
        
           "index.html#sec-assertions"

     

       1669
       1672
        
         ],