commit 96f041725f6e92f7159b6d2913f07c18101d92dc · pyrox.dev/nixpkgs

+38
pkgs/by-name/tr/treefmt/functions-doc.nix
···

       1
       1
        
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         writers,

     

       2
       4
        
         nixdoc,

     

       3
       5
        
         runCommand,

     

       6
       6
       +
         treefmt,

     

       4
       7
        
       }:

     

       8
       8
       +
       let

     

       9
       9
       +
         root = toString ./.;

     

       10
       10
       +
         revision = lib.trivial.revisionWithDefault "master";

     

       11
       11
       +
         removeRoot = file: lib.removePrefix "/" (lib.removePrefix root file);

     

       12
       12
       +
       

     

       13
       13
       +
         # Import and apply `./lib.nix`, which contains treefmt's public functions

     

       14
       14
       +
         #

     

       15
       15
       +
         # NOTE: we cannot access them via `treefmt.passthru` or `callPackages ./lib.nix { }`,

     

       16
       16
       +
         # because that would be opaque to `unsafeGetAttrPos`.

     

       17
       17
       +
         attrs =

     

       18
       18
       +
           let

     

       19
       19
       +
             fn = import ./lib.nix;

     

       20
       20
       +
             args = builtins.mapAttrs (_: _: null) (builtins.functionArgs fn);

     

       21
       21
       +
           in

     

       22
       22
       +
           fn args;

     

       23
       23
       +
       in

     

       5
       24
        
       {

     

       25
       25
       +
         locations = lib.pipe attrs [

     

       26
       26
       +
           builtins.attrNames

     

       27
       27
       +
           (builtins.map (

     

       28
       28
       +
             name:

     

       29
       29
       +
             let

     

       30
       30
       +
               pos = builtins.unsafeGetAttrPos name attrs;

     

       31
       31
       +
               file = removeRoot pos.file;

     

       32
       32
       +
               line = toString pos.line;

     

       33
       33
       +
               subpath = "pkgs/by-name/tr/treefmt/${file}";

     

       34
       34
       +
               url = "https://github.com/NixOS/nixpkgs/blob/${revision}/${subpath}#L${line}";

     

       35
       35
       +
             in

     

       36
       36
       +
             assert lib.hasPrefix root pos.file;

     

       37
       37
       +
             lib.nameValuePair "pkgs.treefmt.${name}" "[${subpath}:${line}](${url}) in `<nixpkgs>`"

     

       38
       38
       +
           ))

     

       39
       39
       +
           builtins.listToAttrs

     

       40
       40
       +
           (writers.writeJSON "treefmt-function-locations")

     

       41
       41
       +
         ];

     

       42
       42
       +
       

     

       6
       43
        
         markdown =

     

       7
       44
        
           runCommand "treefmt-functions-doc"

     

       8
       45
        
             {

     
···

       10
       47
        
             }

     

       11
       48
        
             ''

     

       12
       49
        
               nixdoc --file ${./lib.nix} \

     

       50
       50
       +
                 --locs ${treefmt.functionsDoc.locations} \

     

       13
       51
        
                 --description "Functions Reference" \

     

       14
       52
        
                 --prefix "pkgs" \

     

       15
       53
        
                 --category "treefmt" \