Merge branch 'pre-commit' into 'master'

Draft: Formatter & Pre-Commit

See merge request simple-nixos-mailserver/nixos-mailserver!385

.envrc

@@ -0,0 +1,3 @@
+# shellcheck shell=bash
+
+use flake

.gitignore

@@ -1 +1,3 @@
 result
+.direnv
+.pre-commit-config.yaml

flake.lock

@@ -17,6 +17,22 @@
       }
     },
     "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1733328505,
+        "narHash": "sha256-NeCCThCEP3eCl2l/+27kNNK7QrwZB1IJCrXfrbv5oqU=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-compat_2": {
       "flake": false,
       "locked": {
         "lastModified": 1696426674,
@@ -32,13 +48,56 @@
         "type": "github"
       }
     },
+    "git-hooks": {
+      "inputs": {
+        "flake-compat": "flake-compat_2",
+        "gitignore": "gitignore",
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1742649964,
+        "narHash": "sha256-DwOTp7nvfi8mRfuL1escHDXabVXFGT1VlPD1JHrtrco=",
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "rev": "dcf5072734cb576d2b0c59b2ac44f5050b5eac82",
+        "type": "github"
+      },
+      "original": {
+        "owner": "cachix",
+        "repo": "git-hooks.nix",
+        "type": "github"
+      }
+    },
+    "gitignore": {
+      "inputs": {
+        "nixpkgs": [
+          "git-hooks",
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1709087332,
+        "narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=",
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "gitignore.nix",
+        "type": "github"
+      }
+    },
     "nixpkgs": {
       "locked": {
-        "lastModified": 1732014248,
+        "lastModified": 1745234285,
-        "narHash": "sha256-y/MEyuJ5oBWrWAic/14LaIr/u5E0wRVzyYsouYY3W6w=",
+        "narHash": "sha256-GfpyMzxwkfgRVN0cTGQSkTC0OHhEkv3Jf6Tcjm//qZ0=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "23e89b7da85c3640bbc2173fe04f4bd114342367",
+        "rev": "c11863f1e964833214b767f4a369c6e6a7aba141",
         "type": "github"
       },
       "original": {
@@ -49,11 +108,11 @@
     },
     "nixpkgs-24_11": {
       "locked": {
-        "lastModified": 1734083684,
+        "lastModified": 1745279238,
-        "narHash": "sha256-5fNndbndxSx5d+C/D0p/VF32xDiJCJzyOqorOYW4JEo=",
+        "narHash": "sha256-AQ7M9wTa/Pa/kK5pcGTgX/DGqMHyzsyINfN7ktsI7Fo=",
         "owner": "NixOS",
         "repo": "nixpkgs",
-        "rev": "314e12ba369ccdb9b352a4db26ff419f7c49fa84",
+        "rev": "9684b53175fc6c09581e94cc85f05ab77464c7e3",
         "type": "github"
       },
       "original": {
@@ -66,6 +125,7 @@
       "inputs": {
         "blobs": "blobs",
         "flake-compat": "flake-compat",
+        "git-hooks": "git-hooks",
         "nixpkgs": "nixpkgs",
         "nixpkgs-24_11": "nixpkgs-24_11"
       }

flake.nix

@@ -3,9 +3,14 @@
 
   inputs = {
     flake-compat = {
+      # for shell.nix compat
       url = "github:edolstra/flake-compat";
       flake = false;
     };
+    git-hooks = {
+      url = "github:cachix/git-hooks.nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
     nixpkgs.url = "flake:nixpkgs/nixos-unstable";
     nixpkgs-24_11.url = "flake:nixpkgs/nixos-24.11";
     blobs = {
@@ -14,7 +19,7 @@
     };
   };
 
-  outputs = { self, blobs, nixpkgs, nixpkgs-24_11, ... }: let
+  outputs = { self, blobs, git-hooks, nixpkgs, nixpkgs-24_11, ... }: let
     lib = nixpkgs.lib;
     system = "x86_64-linux";
     pkgs = nixpkgs.legacyPackages.${system};
@@ -112,16 +117,38 @@
     hydraJobs.${system} = allTests // {
       inherit documentation;
     };
-    checks.${system} = allTests;
+    checks.${system} = allTests // {
+      pre-commit = git-hooks.lib.${system}.run {
+        src = ./.;
+        hooks = {
+          # docs
+          markdownlint.enable = true;
+
+          # nix
+          nixfmt-rfc-style.enable = true;
+          statix.enable = true;
+
+          # python
+          pyright.enable = true;
+          ruff.enable = true;
+          ruff-format.enable = true;
+
+          # scripts
+          shellcheck.enable = true;
+        };
+      };
+    };
     packages.${system} = {
       inherit optionsDoc documentation;
     };
-    devShells.${system}.default = pkgs.mkShell {
+    devShells.${system}.default = pkgs.mkShellNoCC {
       inputsFrom = [ documentation ];
       packages = with pkgs; [
         clamav
-      ];
+      ] ++ self.checks.${system}.pre-commit.enabledPackages;
+      shellHook = self.checks.${system}.pre-commit.shellHook;
     };
     devShell.${system} = self.devShells.${system}.default; # compatibility
+    formatter.${system} = nixpkgs.legacyPackages.${system}.nixfmt-tree; # TODO: migrate to stable with 25.05
   };
 }