commit 0c156a71440105a9fe1fbc1d89275ff3fe94c92a · pyrox.dev/nixpkgs

+61

modules/generic/meta-maintainers.nix

···

       1
       1
       +
       # Test:

     

       2
       2
       +
       #   ./meta-maintainers/test.nix

     

       3
       3
       +
       { lib, ... }:

     

       4
       4
       +
       let

     

       5
       5
       +
         inherit (lib)

     

       6
       6
       +
           mkOption

     

       7
       7
       +
           mkOptionType

     

       8
       8
       +
           types

     

       9
       9
       +
           ;

     

       10
       10
       +
       

     

       11
       11
       +
         maintainer = mkOptionType {

     

       12
       12
       +
           name = "maintainer";

     

       13
       13
       +
           check = email: lib.elem email (lib.attrValues lib.maintainers);

     

       14
       14
       +
           merge =

     

       15
       15
       +
             loc: defs:

     

       16
       16
       +
             lib.listToAttrs (lib.singleton (lib.nameValuePair (lib.last defs).file (lib.last defs).value));

     

       17
       17
       +
         };

     

       18
       18
       +
       

     

       19
       19
       +
         listOfMaintainers = types.listOf maintainer // {

     

       20
       20
       +
           merge =

     

       21
       21
       +
             loc: defs:

     

       22
       22
       +
             lib.zipAttrs (

     

       23
       23
       +
               lib.flatten (

     

       24
       24
       +
                 lib.imap1 (

     

       25
       25
       +
                   n: def:

     

       26
       26
       +
                   lib.imap1 (

     

       27
       27
       +
                     m: def':

     

       28
       28
       +
                     maintainer.merge (loc ++ [ "[${toString n}-${toString m}]" ]) [

     

       29
       29
       +
                       {

     

       30
       30
       +
                         inherit (def) file;

     

       31
       31
       +
                         value = def';

     

       32
       32
       +
                       }

     

       33
       33
       +
                     ]

     

       34
       34
       +
                   ) def.value

     

       35
       35
       +
                 ) defs

     

       36
       36
       +
               )

     

       37
       37
       +
             );

     

       38
       38
       +
         };

     

       39
       39
       +
       in

     

       40
       40
       +
       {

     

       41
       41
       +
         _class = null; # not specific to NixOS

     

       42
       42
       +
         options = {

     

       43
       43
       +
           meta = {

     

       44
       44
       +
             maintainers = mkOption {

     

       45
       45
       +
               type = listOfMaintainers;

     

       46
       46
       +
               default = [ ];

     

       47
       47
       +
               example = lib.literalExpression ''[ lib.maintainers.alice lib.maintainers.bob ]'';

     

       48
       48
       +
               description = ''

     

       49
       49
       +
                 List of maintainers of each module.

     

       50
       50
       +
                 This option should be defined at most once per module.

     

       51
       51
       +
       

     

       52
       52
       +
                 The option value is not a list of maintainers, but an attribute set that maps module file names to lists of maintainers.

     

       53
       53
       +
               '';

     

       54
       54
       +
             };

     

       55
       55
       +
           };

     

       56
       56
       +
         };

     

       57
       57
       +
         meta.maintainers = with lib.maintainers; [

     

       58
       58
       +
           pierron

     

       59
       59
       +
           roberth

     

       60
       60
       +
         ];

     

       61
       61
       +
       }

+34

modules/generic/meta-maintainers/test.nix

···

       1
       1
       +
       # Run:

     

       2
       2
       +
       #   $ nix-instantiate --eval 'modules/generic/meta-maintainers/test.nix'

     

       3
       3
       +
       #

     

       4
       4
       +
       # Expected output:

     

       5
       5
       +
       #   { }

     

       6
       6
       +
       #

     

       7
       7
       +
       # Debugging:

     

       8
       8
       +
       #   drop .test from the end of this file, then use nix repl on it

     

       9
       9
       +
       rec {

     

       10
       10
       +
         lib = import ../../../lib;

     

       11
       11
       +
       

     

       12
       12
       +
         example = lib.evalModules {

     

       13
       13
       +
           modules = [

     

       14
       14
       +
             ../meta-maintainers.nix

     

       15
       15
       +
             {

     

       16
       16
       +
               _file = "eelco.nix";

     

       17
       17
       +
               meta.maintainers = [ lib.maintainers.eelco ];

     

       18
       18
       +
             }

     

       19
       19
       +
           ];

     

       20
       20
       +
         };

     

       21
       21
       +
       

     

       22
       22
       +
         test =

     

       23
       23
       +
           assert

     

       24
       24
       +
             example.config.meta.maintainers == {

     

       25
       25
       +
               ${toString ../meta-maintainers.nix} = [

     

       26
       26
       +
                 lib.maintainers.pierron

     

       27
       27
       +
                 lib.maintainers.roberth

     

       28
       28
       +
               ];

     

       29
       29
       +
               "eelco.nix" = [ lib.maintainers.eelco ];

     

       30
       30
       +
             };

     

       31
       31
       +
           { };

     

       32
       32
       +
       

     

       33
       33
       +
       }

     

       34
       34
       +
       .test

+6 -46

nixos/modules/misc/meta.nix

···

       1
       1
        
       { lib, ... }:

     

       2
       2
        
       let

     

       3
       3
       -
         maintainer = lib.mkOptionType {

     

       4
       4
       -
           name = "maintainer";

     

       5
       5
       -
           check = email: lib.elem email (lib.attrValues lib.maintainers);

     

       6
       6
       -
           merge =

     

       7
       7
       -
             loc: defs:

     

       8
       8
       -
             lib.listToAttrs (lib.singleton (lib.nameValuePair (lib.last defs).file (lib.last defs).value));

     

       9
       9
       -
         };

     

       10
       10
       -
       

     

       11
       11
       -
         listOfMaintainers = lib.types.listOf maintainer // {

     

       12
       12
       -
           # Returns list of

     

       13
       13
       -
           #   { "module-file" = [

     

       14
       14
       -
           #        "maintainer1 <first@nixos.org>"

     

       15
       15
       -
           #        "maintainer2 <second@nixos.org>" ];

     

       16
       16
       -
           #   }

     

       17
       17
       -
           merge =

     

       18
       18
       -
             loc: defs:

     

       19
       19
       -
             lib.zipAttrs (

     

       20
       20
       -
               lib.flatten (

     

       21
       21
       -
                 lib.imap1 (

     

       22
       22
       -
                   n: def:

     

       23
       23
       -
                   lib.imap1 (

     

       24
       24
       -
                     m: def':

     

       25
       25
       -
                     maintainer.merge (loc ++ [ "[${toString n}-${toString m}]" ]) [

     

       26
       26
       -
                       {

     

       27
       27
       -
                         inherit (def) file;

     

       28
       28
       -
                         value = def';

     

       29
       29
       -
                       }

     

       30
       30
       -
                     ]

     

       31
       31
       -
                   ) def.value

     

       32
       32
       -
                 ) defs

     

       33
       33
       -
               )

     

       34
       34
       -
             );

     

       35
       35
       -
         };

     

       36
       36
       -
       

     

       37
       3
        
         docFile = lib.types.path // {

     

       38
       4
        
           # Returns tuples of

     

       39
       5
        
           #   { file = "module location"; value = <path/to/doc.xml>; }

     
···

       42
       8
        
       in

     

       43
       9
        
       

     

       44
       10
        
       {

     

       11
       11
       +
         imports = [ ../../../modules/generic/meta-maintainers.nix ];

     

       12
       12
       +
       

     

       45
       13
        
         options = {

     

       46
       14
        
           meta = {

     

       47
       15
        
       

     

       48
       48
       -
             maintainers = lib.mkOption {

     

       49
       49
       -
               type = listOfMaintainers;

     

       50
       50
       -
               internal = true;

     

       51
       51
       -
               default = [ ];

     

       52
       52
       -
               example = lib.literalExpression ''[ lib.maintainers.alice ]'';

     

       53
       53
       -
               description = ''

     

       54
       54
       -
                 List of maintainers of each module.  This option should be defined at

     

       55
       55
       -
                 most once per module.

     

       56
       56
       -
               '';

     

       57
       57
       -
             };

     

       58
       58
       -
       

     

       59
       16
        
             doc = lib.mkOption {

     

       60
       17
        
               type = docFile;

     

       61
       18
        
               internal = true;

     
···

       84
       41
        
           };

     

       85
       42
        
         };

     

       86
       43
        
       

     

       87
       87
       -
         meta.maintainers = lib.singleton lib.maintainers.pierron;

     

       44
       44
       +
         meta.maintainers = with lib.maintainers; [

     

       45
       45
       +
           pierron

     

       46
       46
       +
           roberth

     

       47
       47
       +
         ];

     

       88
       48
        
       }