rename filename to fileExtension

README.md

@@ -188,7 +188,7 @@ images can be built from that flake by running:
       formatConfigs.my-custom-format = {config, modulesPath, ...}: {
         imports = ["${toString modulesPath}/installer/cd-dvd/installation-cd-base.nix"];
         formatAttr = "isoImage";
-        filename = "*.iso";
+        fileExtension = ".iso";
         networking.wireless.networks = {
           # ...
         };

all-formats.nix

@@ -31,9 +31,9 @@
 
   # attrset of formats to be exposed under config.system.formats
   formats = lib.flip lib.mapAttrs allConfigs (
-    formatName: conf: pkgs.runCommand "${conf.config.system.build.${conf.config.formatAttr}.name}${conf.config.filename}" {} ''
+    formatName: conf: pkgs.runCommand "${conf.config.system.build.${conf.config.formatAttr}.name}${conf.config.fileExtension}" {} ''
       set -efu
-      target=$(find '${conf.config.system.build.${conf.config.formatAttr}}' -name '*${conf.config.filename}' -xtype f -print -quit)
+      target=$(find '${conf.config.system.build.${conf.config.formatAttr}}' -name '*${conf.config.fileExtension}' -xtype f -print -quit)
       ln -s "$target" "$out"
     ''
   );

checks/test-all-formats-flake/flake.nix

@@ -37,7 +37,7 @@ Tests using the all-formats module through a flake.
       }: {
         imports = ["${toString modulesPath}/installer/cd-dvd/installation-cd-base.nix"];
         formatAttr = "isoImage";
-        filename = "*.iso";
+        fileExtension = ".iso";
         networking.wireless.networks = {
           # ...
         };

format-module.nix

@@ -7,7 +7,7 @@
   key = "github:nix-community/nixos-generators/format-module.nix";
 
   options = {
-    filename = lib.mkOption {
+    fileExtension = lib.mkOption {
       type = lib.types.str;
       description = "Declare the path of the wanted file in the output directory";
       default = "";

formats-broken/kexec-bundle.nix

@@ -2,5 +2,5 @@
   imports = [./kexec.nix];
 
   formatAttr = lib.mkForce "kexec_bundle";
-  filename = lib.mkForce "*-kexec_bundle";
+  fileExtension = lib.mkForce "*-kexec_bundle";
 }

formats-broken/kexec.nix

@@ -67,5 +67,5 @@ in {
   networking.hostName = lib.mkDefault "kexec";
 
   formatAttr = "kexec_tarball";
-  filename = "*/tarball/*.tar.xz";
+  fileExtension = "*/tarball/*.tar.xz";
 }

formats/amazon.nix

@@ -4,5 +4,5 @@
   ];
 
   formatAttr = "amazonImage";
-  filename = ".vhd";
+  fileExtension = ".vhd";
 }

formats/do.nix

@@ -4,5 +4,5 @@
   ];
 
   formatAttr = "digitalOceanImage";
-  filename = ".qcow2.gz";
+  fileExtension = ".qcow2.gz";
 }

formats/docker.nix

@@ -11,5 +11,5 @@
   services.journald.console = "/dev/console";
 
   formatAttr = "tarball";
-  filename = ".tar.xz";
+  fileExtension = ".tar.xz";
 }

formats/gce.nix

@@ -4,5 +4,5 @@
   ];
 
   formatAttr = "googleComputeImage";
-  filename = ".raw.tar.gz";
+  fileExtension = ".raw.tar.gz";
 }

formats/hyperv.nix

@@ -4,5 +4,5 @@
   ];
 
   formatAttr = "hypervImage";
-  filename = ".vhdx";
+  fileExtension = ".vhdx";
 }

formats/install-iso-hyperv.nix

@@ -13,5 +13,5 @@
   virtualisation.hypervGuest.enable = true;
 
   formatAttr = "isoImage";
-  filename = ".iso";
+  fileExtension = ".iso";
 }

formats/install-iso.nix

@@ -13,5 +13,5 @@
   systemd.services.sshd.wantedBy = lib.mkForce ["multi-user.target"];
 
   formatAttr = "isoImage";
-  filename = ".iso";
+  fileExtension = ".iso";
 }

formats/iso.nix

@@ -14,5 +14,5 @@
   isoImage.makeUsbBootable = true;
 
   formatAttr = "isoImage";
-  filename = ".iso";
+  fileExtension = ".iso";
 }

formats/kubevirt.nix

@@ -4,5 +4,5 @@
   ];
 
   formatAttr = "kubevirtImage";
-  filename = ".qcow2";
+  fileExtension = ".qcow2";
 }

formats/linode.nix

@@ -10,7 +10,7 @@
   ];
 
   formatAttr = "linode";
-  filename = ".img.gz";
+  fileExtension = ".img.gz";
 
   system.build.linode = import "${toString modulesPath}/../lib/make-disk-image.nix" {
     inherit lib config pkgs;

formats/lxc-metadata.nix

@@ -9,5 +9,5 @@
   ];
 
   formatAttr = "metadata";
-  filename = ".tar.xz";
+  fileExtension = ".tar.xz";
 }

formats/lxc.nix

@@ -10,5 +10,5 @@
   ];
 
   formatAttr = "tarball";
-  filename = ".tar.xz";
+  fileExtension = ".tar.xz";
 }

formats/openstack.nix

@@ -16,5 +16,5 @@ else {
     "${toString modulesPath}/../maintainers/scripts/openstack/openstack-image.nix"
   ];
   formatAttr = "openstackImage";
-  filename = ".qcow2";
+  fileExtension = ".qcow2";
 }

formats/proxmox-lxc.nix

@@ -3,5 +3,5 @@
     "${toString modulesPath}/virtualisation/proxmox-lxc.nix"
   ];
   formatAttr = "tarball";
-  filename = ".tar.xz";
+  fileExtension = ".tar.xz";
 }

formats/proxmox.nix

@@ -3,5 +3,5 @@
     "${toString modulesPath}/virtualisation/proxmox-image.nix"
   ];
   formatAttr = "VMA";
-  filename = ".vma.zst";
+  fileExtension = ".vma.zst";
 }

formats/qcow.nix

@@ -35,5 +35,5 @@
   };
 
   formatAttr = "qcow";
-  filename = ".qcow2";
+  fileExtension = ".qcow2";
 }

formats/raw.nix

@@ -26,5 +26,5 @@
   };
 
   formatAttr = "raw";
-  filename = ".img";
+  fileExtension = ".img";
 }

formats/virtualbox.nix

@@ -4,5 +4,5 @@
   ];
 
   formatAttr = "virtualBoxOVA";
-  filename = ".ova";
+  fileExtension = ".ova";
 }

formats/vmware.nix

@@ -4,5 +4,5 @@
   ];
 
   formatAttr = "vmwareImage";
-  filename = ".vmdk";
+  fileExtension = ".vmdk";
 }

nixos-generate

@@ -163,13 +163,13 @@ if [[ -n $cores ]]; then
 fi
 
 formatAttr=$(nix-instantiate "${nix_args[@]}" --eval --json -A config.formatAttr | jq -r .)
-filename=$(nix-instantiate "${nix_args[@]}" --eval --json -A config.filename | jq -r .)
+fileExtension=$(nix-instantiate "${nix_args[@]}" --eval --json -A config.fileExtension | jq -r .)
 
 out=$(nix-build "${nix_args[@]}" "${nix_build_args[@]}" -A "config.system.build.$formatAttr")
 
 if [[ -z $run ]]; then
   # show the first file, ignoring nix-support
-  find "$out" -name "*$filename" -xtype f -print -quit
+  find "$out" -name "*$fileExtension" -xtype f -print -quit
 else
   runner=$(find "$out"/bin -type l -print -quit)
   exec "$runner"