commit e2078ef31e1a02e23fe261a9a07fe419fd4a2192 · pyrox.dev/nixpkgs

nixos/lib/make-options-doc/default.nix

···

       1
       1
       +
       # Tests: ./tests.nix

     

       2
       2
       +
       

     

       1
       3
        
       /**

     

       2
       4
        
         Generates documentation for [nix modules](https://nix.dev/tutorials/module-system/index.html).

     

       3
       5

+59

nixos/lib/make-options-doc/tests.nix

···

       1
       1
       +
       # Run tests: nix-build -A tests.nixosOptionsDoc

     

       2
       2
       +
       

     

       3
       3
       +
       {

     

       4
       4
       +
         lib,

     

       5
       5
       +
         nixosOptionsDoc,

     

       6
       6
       +
         runCommand,

     

       7
       7
       +
       }:

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (lib) mkOption types;

     

       10
       10
       +
       

     

       11
       11
       +
         eval = lib.evalModules {

     

       12
       12
       +
           modules = [

     

       13
       13
       +
             {

     

       14
       14
       +
               options.foo.bar.enable = mkOption {

     

       15
       15
       +
                 type = types.bool;

     

       16
       16
       +
                 default = false;

     

       17
       17
       +
                 description = ''

     

       18
       18
       +
                   Enable the foo bar feature.

     

       19
       19
       +
                 '';

     

       20
       20
       +
               };

     

       21
       21
       +
             }

     

       22
       22
       +
           ];

     

       23
       23
       +
         };

     

       24
       24
       +
       

     

       25
       25
       +
         doc = nixosOptionsDoc {

     

       26
       26
       +
           inherit (eval) options;

     

       27
       27
       +
         };

     

       28
       28
       +
       in

     

       29
       29
       +
       {

     

       30
       30
       +
         /**

     

       31
       31
       +
           Test that

     

       32
       32
       +
             - the `nixosOptionsDoc` function can be invoked

     

       33
       33
       +
             - integration of the module system and `nixosOptionsDoc` (limited coverage)

     

       34
       34
       +
       

     

       35
       35
       +
           The more interesting tests happen in the `nixos-render-docs` package.

     

       36
       36
       +
         */

     

       37
       37
       +
         commonMark =

     

       38
       38
       +
           runCommand "test-nixosOptionsDoc-commonMark"

     

       39
       39
       +
             {

     

       40
       40
       +
               commonMarkDefault = doc.optionsCommonMark;

     

       41
       41
       +
               commonMarkAnchors = doc.optionsCommonMark.overrideAttrs {

     

       42
       42
       +
                 extraArgs = [

     

       43
       43
       +
                   "--anchor-prefix"

     

       44
       44
       +
                   "my-opt-"

     

       45
       45
       +
                   "--anchor-style"

     

       46
       46
       +
                   "legacy"

     

       47
       47
       +
                 ];

     

       48
       48
       +
               };

     

       49
       49
       +
             }

     

       50
       50
       +
             ''

     

       51
       51
       +
               env | grep ^commonMark | sed -e 's/=/ = /'

     

       52
       52
       +
               (

     

       53
       53
       +
                 set -x

     

       54
       54
       +
                 grep -F 'foo\.bar\.enable' $commonMarkDefault >/dev/null

     

       55
       55
       +
                 grep -F '{#my-opt-foo.bar.enable}' $commonMarkAnchors >/dev/null

     

       56
       56
       +
               )

     

       57
       57
       +
               touch $out

     

       58
       58
       +
             '';

     

       59
       59
       +
       }

pkgs/test/default.nix

···

       155
       155
        
       

     

       156
       156
        
         nixos-functions = callPackage ./nixos-functions { };

     

       157
       157
        
       

     

       158
       158
       +
         nixosOptionsDoc = callPackage ../../nixos/lib/make-options-doc/tests.nix { };

     

       159
       159
       +
       

     

       158
       160
        
         overriding = callPackage ./overriding.nix { };

     

       159
       161
        
       

     

       160
       162
        
         texlive = callPackage ./texlive { };