Merge pull request #639 from cachix/update-nixfmt

nixfmt: support the new official 1.0 release of nixfmt

Author: sandydoo

README.md

@@ -22,23 +22,34 @@
 
 {
   git-hooks.hooks = {
-    # lint shell scripts
+    # Format Nix code
+    nixfmt.enable = true;
+
+    # Format Python code
+    black.enable = true;
+
+    # Lint shell scripts
     shellcheck.enable = true;
-    # execute example shell from Markdown files
+
+    # Execute shell examples in Markdown files
     mdsh.enable = true;
-    # format Python code
-    black.enable = true;
 
-    # override a package with a different version
+    # Override a package with a different version
     ormolu.enable = true;
     ormolu.package = pkgs.haskellPackages.ormolu;
 
-    # some hooks have more than one package, like clippy:
+    # Some hooks have more than one package, like clippy:
     clippy.enable = true;
     clippy.packageOverrides.cargo = pkgs.cargo;
     clippy.packageOverrides.clippy = pkgs.clippy;
-    # some hooks provide settings
+    # Some hooks provide settings
     clippy.settings.allFeatures = true;
+
+    # Define your own custom hooks
+    my-custom-hook = {
+      name = "My own hook";
+      exec = "on-pre-commit.sh";
+    };
   };
 }
 ```
@@ -89,7 +100,7 @@ Given the following `flake.nix` example:
         pre-commit-check = inputs.git-hooks.lib.${system}.run {
           src = ./.;
           hooks = {
-            nixfmt-rfc-style.enable = true;
+            nixfmt.enable = true;
           };
         };
       });
@@ -371,6 +382,7 @@ use nix
 - [deadnix](https://github.com/astro/deadnix)
 - [flake-checker](https://github.com/DeterminateSystems/flake-checker)
 - [nil](https://github.com/oxalica/nil)
+- [nixfmt](https://github.com/NixOS/nixfmt/) (supports `nixfmt` >=v1.0)
 - [nixfmt-classic](https://github.com/NixOS/nixfmt/tree/v0.6.0)
 - [nixfmt-rfc-style](https://github.com/NixOS/nixfmt/)
 - [nixpkgs-fmt](https://github.com/nix-community/nixpkgs-fmt)

modules/hooks.nix

@@ -959,7 +959,7 @@ in
         };
       };
       nixfmt = mkOption {
-        description = "Deprecated nixfmt hook. Use nixfmt-classic or nixfmt-rfc-style instead.";
+        description = "nixfmt hook";
         visible = false;
         type = types.submodule {
           imports = [ hookModule ];
@@ -2143,10 +2143,19 @@ in
     lib.optional cfg.hooks.rome.enable ''
       The hook `hooks.rome` has been renamed to `hooks.biome`.
     ''
-    ++ lib.optional cfg.hooks.nixfmt.enable ''
+    ++ lib.optional (cfg.hooks.nixfmt.enable && lib.versionOlder cfg.hooks.nixfmt.package.version "1.0") ''
       The hook `hooks.nixfmt` has been renamed to `hooks.nixfmt-classic`.
 
       The new RFC 166-style nixfmt is available as `hooks.nixfmt-rfc-style`.
+    ''
+    ++ lib.optional (cfg.hooks.nixfmt-classic.enable && lib.versionAtLeast cfg.hooks.nixfmt-classic.package.version "1.0") ''
+      The hook `hooks.nixfmt-classic` is using an incompatible version of `nixfmt`.
+
+        Found: ${cfg.hooks.nixfmt-classic.package.version}.
+        Expected: < v1.0
+
+      `hooks.nixfmt-classic` supports versions of `nixfmt` up to `v1.0`.
+      For `nixfmt` `v1.0` and newer, switch to `hooks.nixfmt`.
     '';
 
   # PLEASE keep this sorted alphabetically.
@@ -3411,8 +3420,8 @@ lib.escapeShellArgs (lib.concatMap (ext: [ "--ghc-opt" "-X${ext}" ]) hooks.fourm
         };
       nixfmt =
         {
-          name = "nixfmt-deprecated";
-          description = "Deprecated Nix code prettifier. Use nixfmt-classic.";
+          name = "nixfmt";
+          description = "Official Nix code formatter.";
           package = tools.nixfmt;
           entry = "${hooks.nixfmt.package}/bin/nixfmt ${lib.optionalString (hooks.nixfmt.settings.width != null) "--width=${toString hooks.nixfmt.settings.width}"}";
           files = "\\.nix$";

nix/tools.nix

@@ -233,8 +233,16 @@ in
   # Disable tests as these take way to long on our infra.
   julia-bin = julia-bin.overrideAttrs (_: _: { doInstallCheck = false; });
 
-  # nixfmt was renamed to nixfmt-classic in 24.05.
-  # nixfmt may be replaced by nixfmt-rfc-style in the future.
-  nixfmt = if nixfmt-classic == null then nixfmt else nixfmt-classic;
+  # nixfmt 1.0 is now the official Nix formatter as of 25.11.
+  #
+  # In 24.05, the `nixfmt` package was deprecated and replaced with two separate packages:
+  #   - nixfmt-classic
+  #   - nixfmt-rfc-style
+  #
+  # Remove this block in 26.05
+  nixfmt =
+    if lib.versionOlder nixfmt.version "1.0" && nixfmt-classic != null
+    then nixfmt-classic
+    else nixfmt;
   inherit nixfmt-classic nixfmt-rfc-style;
 }