commit 7d76b1a60f95b611748512eabf4b60a44b9a3206 · pyrox.dev/nixpkgs

+29

pkgs/by-name/tr/treefmt/build-config.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         formats,

     

       4
       4
       +
       }:

     

       5
       5
       +
       module:

     

       6
       6
       +
       let

     

       7
       7
       +
         settingsFormat = formats.toml { };

     

       8
       8
       +
         configuration = lib.evalModules {

     

       9
       9
       +
           modules = [

     

       10
       10
       +
             {

     

       11
       11
       +
               _file = ./build-config.nix;

     

       12
       12
       +
               freeformType = settingsFormat.type;

     

       13
       13
       +
             }

     

       14
       14
       +
             {

     

       15
       15
       +
               # Wrap user's modules with a default file location

     

       16
       16
       +
               _file = "<treefmt.buildConfig args>";

     

       17
       17
       +
               imports = lib.toList module;

     

       18
       18
       +
             }

     

       19
       19
       +
           ];

     

       20
       20
       +
         };

     

       21
       21
       +
         settingsFile = settingsFormat.generate "treefmt.toml" configuration.config;

     

       22
       22
       +
       in

     

       23
       23
       +
       settingsFile.overrideAttrs {

     

       24
       24
       +
         passthru = {

     

       25
       25
       +
           format = settingsFormat;

     

       26
       26
       +
           settings = configuration.config;

     

       27
       27
       +
           inherit (configuration) _module options type;

     

       28
       28
       +
         };

     

       29
       29
       +
       }

+38 -3

pkgs/by-name/tr/treefmt/package.nix

···

       1
       1
        
       {

     

       2
       2
        
         lib,

     

       3
       3
        
         buildGoModule,

     

       4
       4
       +
         callPackage,

     

       5
       5
       +
         callPackages,

     

       4
       6
        
         fetchFromGitHub,

     

       5
       7
        
       }:

     

       6
       8
        
       buildGoModule rec {

     
···

       27
       29
        
           "-X github.com/numtide/treefmt/v2/build.Version=v${version}"

     

       28
       30
        
         ];

     

       29
       31
        
       

     

       32
       32
       +
         passthru = {

     

       33
       33
       +
           /**

     

       34
       34
       +
             Wrap treefmt, configured  using structured settings.

     

       35
       35
       +
       

     

       36
       36
       +
             # Type

     

       37
       37
       +
       

     

       38
       38
       +
             ```

     

       39
       39
       +
             AttrSet -> Derivation

     

       40
       40
       +
             ```

     

       41
       41
       +
       

     

       42
       42
       +
             # Inputs

     

       43
       43
       +
       

     

       44
       44
       +
             - `name`: `String` (default `"treefmt-configured"`)

     

       45
       45
       +
             - `settings`: `Module` (default `{ }`)

     

       46
       46
       +
             - `runtimeInputs`: `[Derivation]` (default `[ ]`)

     

       47
       47
       +
           */

     

       48
       48
       +
           withConfig = callPackage ./with-config.nix { };

     

       49
       49
       +
       

     

       50
       50
       +
           /**

     

       51
       51
       +
             Build a treefmt config file from structured settings.

     

       52
       52
       +
       

     

       53
       53
       +
             # Type

     

       54
       54
       +
       

     

       55
       55
       +
             ```

     

       56
       56
       +
             Module -> Derivation

     

       57
       57
       +
             ```

     

       58
       58
       +
           */

     

       59
       59
       +
           buildConfig = callPackage ./build-config.nix { };

     

       60
       60
       +
       

     

       61
       61
       +
           tests = callPackages ./tests.nix { };

     

       62
       62
       +
         };

     

       63
       63
       +
       

     

       30
       64
        
         meta = {

     

       31
       65
        
           description = "one CLI to format the code tree";

     

       32
       66
        
           homepage = "https://github.com/numtide/treefmt";

     

       33
       67
        
           license = lib.licenses.mit;

     

       34
       34
       -
           maintainers = [

     

       35
       35
       -
             lib.maintainers.brianmcgee

     

       36
       36
       -
             lib.maintainers.zimbatm

     

       68
       68
       +
           maintainers = with lib.maintainers; [

     

       69
       69
       +
             brianmcgee

     

       70
       70
       +
             MattSturgeon

     

       71
       71
       +
             zimbatm

     

       37
       72
        
           ];

     

       38
       73
        
           mainProgram = "treefmt";

     

       39
       74
        
         };

+110

pkgs/by-name/tr/treefmt/tests.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         runCommand,

     

       4
       4
       +
         testers,

     

       5
       5
       +
         treefmt,

     

       6
       6
       +
         nixfmt-rfc-style,

     

       7
       7
       +
       }:

     

       8
       8
       +
       let

     

       9
       9
       +
         inherit (treefmt) buildConfig withConfig;

     

       10
       10
       +
       

     

       11
       11
       +
         testEqualContents =

     

       12
       12
       +
           args:

     

       13
       13
       +
           testers.testEqualContents (

     

       14
       14
       +
             args

     

       15
       15
       +
             // lib.optionalAttrs (builtins.isString args.expected) {

     

       16
       16
       +
               expected = builtins.toFile "expected" args.expected;

     

       17
       17
       +
             }

     

       18
       18
       +
           );

     

       19
       19
       +
       

     

       20
       20
       +
         nixfmtExampleConfig = {

     

       21
       21
       +
           on-unmatched = "info";

     

       22
       22
       +
           tree-root-file = ".git/index";

     

       23
       23
       +
       

     

       24
       24
       +
           formatter.nixfmt = {

     

       25
       25
       +
             command = "nixfmt";

     

       26
       26
       +
             includes = [ "*.nix" ];

     

       27
       27
       +
           };

     

       28
       28
       +
         };

     

       29
       29
       +
       

     

       30
       30
       +
         nixfmtExamplePackage = withConfig {

     

       31
       31
       +
           settings = nixfmtExampleConfig;

     

       32
       32
       +
           runtimeInputs = [ nixfmt-rfc-style ];

     

       33
       33
       +
         };

     

       34
       34
       +
       in

     

       35
       35
       +
       {

     

       36
       36
       +
         buildConfigEmpty = testEqualContents {

     

       37
       37
       +
           assertion = "`buildConfig { }` builds an empty config file";

     

       38
       38
       +
           actual = buildConfig { };

     

       39
       39
       +
           expected = "";

     

       40
       40
       +
         };

     

       41
       41
       +
       

     

       42
       42
       +
         buildConfigExample = testEqualContents {

     

       43
       43
       +
           assertion = "`buildConfig` builds the example config";

     

       44
       44
       +
           actual = buildConfig nixfmtExampleConfig;

     

       45
       45
       +
           expected = ''

     

       46
       46
       +
             on-unmatched = "info"

     

       47
       47
       +
             tree-root-file = ".git/index"

     

       48
       48
       +
             [formatter.nixfmt]

     

       49
       49
       +
             command = "nixfmt"

     

       50
       50
       +
             includes = ["*.nix"]

     

       51
       51
       +
           '';

     

       52
       52
       +
         };

     

       53
       53
       +
       

     

       54
       54
       +
         buildConfigModules = testEqualContents {

     

       55
       55
       +
           assertion = "`buildConfig` evaluates modules to build a config";

     

       56
       56
       +
           actual = buildConfig [

     

       57
       57
       +
             nixfmtExampleConfig

     

       58
       58
       +
             { tree-root-file = lib.mkForce "overridden"; }

     

       59
       59
       +
           ];

     

       60
       60
       +
           expected = ''

     

       61
       61
       +
             on-unmatched = "info"

     

       62
       62
       +
             tree-root-file = "overridden"

     

       63
       63
       +
             [formatter.nixfmt]

     

       64
       64
       +
             command = "nixfmt"

     

       65
       65
       +
             includes = ["*.nix"]

     

       66
       66
       +
           '';

     

       67
       67
       +
         };

     

       68
       68
       +
       

     

       69
       69
       +
         runNixfmtExample =

     

       70
       70
       +
           runCommand "run-nixfmt-example"

     

       71
       71
       +
             {

     

       72
       72
       +
               nativeBuildInputs = [ nixfmtExamplePackage ];

     

       73
       73
       +
               passAsFile = [

     

       74
       74
       +
                 "input"

     

       75
       75
       +
                 "expected"

     

       76
       76
       +
               ];

     

       77
       77
       +
               input = ''

     

       78
       78
       +
                 {

     

       79
       79
       +
                   foo="bar";

     

       80
       80
       +
                   attrs={};

     

       81
       81
       +
                   list=[];

     

       82
       82
       +
                 }

     

       83
       83
       +
               '';

     

       84
       84
       +
               expected = ''

     

       85
       85
       +
                 {

     

       86
       86
       +
                   foo = "bar";

     

       87
       87
       +
                   attrs = { };

     

       88
       88
       +
                   list = [ ];

     

       89
       89
       +
                 }

     

       90
       90
       +
               '';

     

       91
       91
       +
             }

     

       92
       92
       +
             ''

     

       93
       93
       +
               export XDG_CACHE_HOME=$(mktemp -d)

     

       94
       94
       +
               # The example config assumes the tree root has a .git/index file

     

       95
       95
       +
               mkdir .git && touch .git/index

     

       96
       96
       +
       

     

       97
       97
       +
               # Copy the input file, then format it using the wrapped treefmt

     

       98
       98
       +
               cp $inputPath input.nix

     

       99
       99
       +
               treefmt

     

       100
       100
       +
       

     

       101
       101
       +
               # Assert that input.nix now matches expected

     

       102
       102
       +
               if diff -u $expectedPath input.nix; then

     

       103
       103
       +
                 touch $out

     

       104
       104
       +
               else

     

       105
       105
       +
                 echo

     

       106
       106
       +
                 echo "treefmt did not format input.nix as expected"

     

       107
       107
       +
                 exit 1

     

       108
       108
       +
               fi

     

       109
       109
       +
             '';

     

       110
       110
       +
       }

+31

pkgs/by-name/tr/treefmt/with-config.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         lib,

     

       3
       3
       +
         runCommand,

     

       4
       4
       +
         treefmt,

     

       5
       5
       +
         makeBinaryWrapper,

     

       6
       6
       +
       }:

     

       7
       7
       +
       {

     

       8
       8
       +
         name ? "treefmt-with-config",

     

       9
       9
       +
         settings ? { },

     

       10
       10
       +
         runtimeInputs ? [ ],

     

       11
       11
       +
       }:

     

       12
       12
       +
       runCommand name

     

       13
       13
       +
         {

     

       14
       14
       +
           nativeBuildInputs = [ makeBinaryWrapper ];

     

       15
       15
       +
           treefmtExe = lib.getExe treefmt;

     

       16
       16
       +
           binPath = lib.makeBinPath runtimeInputs;

     

       17
       17
       +
           configFile = treefmt.buildConfig {

     

       18
       18
       +
             # Wrap user's modules with a default file location

     

       19
       19
       +
             _file = "<treefmt.withConfig settings arg>";

     

       20
       20
       +
             imports = lib.toList settings;

     

       21
       21
       +
           };

     

       22
       22
       +
           inherit (treefmt) meta version;

     

       23
       23
       +
         }

     

       24
       24
       +
         ''

     

       25
       25
       +
           mkdir -p $out/bin

     

       26
       26
       +
           makeWrapper \

     

       27
       27
       +
             $treefmtExe \

     

       28
       28
       +
             $out/bin/treefmt \

     

       29
       29
       +
             --prefix PATH : "$binPath" \

     

       30
       30
       +
             --add-flags "--config-file $configFile"

     

       31
       31
       +
         ''