files: allow disabling creation of a file

PR #3622

modules/files.nix

@@ -4,7 +4,7 @@ with lib;
 
 let
 
-  cfg = config.home.file;
+  cfg = filterAttrs (n: f: f.enable) config.home.file;
 
   homeDirectory = config.home.homeDirectory;
 

modules/lib/file-type.nix

@@ -15,6 +15,14 @@ in
   fileType = basePathDesc: basePath: types.attrsOf (types.submodule (
     { name, config, ... }: {
       options = {
+        enable = mkOption {
+          type = types.bool;
+          default = true;
+          description = ''
+            Whether this file should be generated. This option allows specific
+            files to be disabled.
+          '';
+        };
         target = mkOption {
           type = types.str;
           apply = p:

tests/modules/files/default.nix

@@ -1,4 +1,5 @@
 {
+  files-disabled = ./disabled.nix;
   files-executable = ./executable.nix;
   files-hidden-source = ./hidden-source.nix;
   files-out-of-store-symlink = ./out-of-store-symlink.nix;

tests/modules/files/disabled.nix

@@ -0,0 +1,14 @@
+{ ... }:
+
+{
+  home.file."disabled" = {
+    enable = false;
+    text = ''
+      This file should not exist
+    '';
+  };
+
+  nmt.script = ''
+    assertPathNotExists home-files/disabled
+  '';
+}