|
| 1 | +# Demonstrates files.file attrset API, treefmt integration, |
| 2 | +# global formatters, per-file format overrides, and onChange hooks. |
| 3 | +{ |
| 4 | + perSystem = |
| 5 | + { pkgs, ... }: |
| 6 | + { |
| 7 | + files.generateApp = true; |
| 8 | + |
| 9 | + # --- treefmt integration --- |
| 10 | + # all files.file entries are auto-formatted through treefmt |
| 11 | + treefmt.programs.nixfmt.enable = true; |
| 12 | + files.treefmt.enable = true; |
| 13 | + |
| 14 | + # --- global formatter by extension --- |
| 15 | + # applied to all .json files unless overridden per-file |
| 16 | + files.formatters.json = |
| 17 | + name: drv: |
| 18 | + pkgs.runCommand "jqfmt-${name}" { nativeBuildInputs = [ pkgs.jq ]; } '' |
| 19 | + jq --sort-keys . < ${drv} > $out |
| 20 | + ''; |
| 21 | + |
| 22 | + # --- files.file attrset API --- |
| 23 | + |
| 24 | + # text content — auto-formatted by nixfmt via treefmt |
| 25 | + files.file."config.nix".text = "{foo=1;bar=2;}"; |
| 26 | + |
| 27 | + # source from structured data — formatted by global .json formatter |
| 28 | + files.file."data/config.json".source = pkgs.writers.writeJSON "config.json" { |
| 29 | + version = 1; |
| 30 | + features = { |
| 31 | + treefmt = true; |
| 32 | + formatters = true; |
| 33 | + }; |
| 34 | + }; |
| 35 | + |
| 36 | + # executable script |
| 37 | + files.file."scripts/greet.sh" = { |
| 38 | + text = '' |
| 39 | + #!/bin/sh |
| 40 | + echo "hello from files!" |
| 41 | + ''; |
| 42 | + executable = true; |
| 43 | + }; |
| 44 | + |
| 45 | + # onChange hook with runtimeInputs |
| 46 | + files.file.".envrc" = { |
| 47 | + text = "use flake"; |
| 48 | + onChange = { |
| 49 | + runtimeInputs = [ pkgs.direnv ]; |
| 50 | + script = "direnv allow || true"; |
| 51 | + }; |
| 52 | + }; |
| 53 | + |
| 54 | + # per-file format override — takes priority over treefmt and global formatters |
| 55 | + files.file."NOTICE".text = "generated by files"; |
| 56 | + files.file."NOTICE".format = |
| 57 | + name: drv: |
| 58 | + pkgs.runCommand "upper-${name}" { } '' |
| 59 | + tr '[:lower:]' '[:upper:]' < ${drv} > $out |
| 60 | + ''; |
| 61 | + |
| 62 | + # disable a file (useful for overriding shared module defaults) |
| 63 | + files.file."disabled-example.txt".text = "this won't be written"; |
| 64 | + files.file."disabled-example.txt".enable = false; |
| 65 | + |
| 66 | + # --- files.files list API --- |
| 67 | + # both APIs can be used together; list entries merge with attrset entries |
| 68 | + files.files = [ |
| 69 | + { |
| 70 | + path = "data/version.txt"; |
| 71 | + drv = pkgs.writeText "version.txt" "0.1.0"; |
| 72 | + } |
| 73 | + ]; |
| 74 | + }; |
| 75 | +} |
0 commit comments