Merge branch 'conventional-hook' into 'main'

chore: check commit messages

See merge request kernald/reddit-magnet!35

flake.nix

@@ -32,106 +32,8 @@
       };
     in
     {
-      checks = {
+      checks = import ./nix/git-hooks.nix { inherit inputs pkgs; };
-        pre-commit-check = inputs.pre-commit-hooks.lib.${system}.run {
+      devShells = import ./nix/shell.nix { inherit pkgs rust-toolchain self; };
-          src = ./.;
-          hooks = {
-            # TOML
-            check-toml.enable = true;
-
-            # YAML
-            check-yaml.enable = true;
-
-            # Nix
-            deadnix.enable = true;
-            flake-checker.enable = true;
-            nixpkgs-fmt.enable = true;
-            statix.enable = true;
-
-            # Rust
-            clippy = {
-              enable = true;
-              settings = {
-                denyWarnings = true;
-              };
-              extraPackages = with pkgs; [
-                openssl
-                pkg-config
-              ];
-            };
-            rustfmt.enable = true;
-            cargo-check = {
-              enable = true;
-              extraPackages = with pkgs; [
-                pkg-config
-                openssl
-              ];
-            };
-
-            # SQL
-            sqlfluff = {
-              enable = true;
-              name = "sqlfluff";
-              entry = "${pkgs.sqlfluff}/bin/sqlfluff lint --dialect sqlite";
-              files = "\\.sql$";
-              language = "system";
-            };
-
-            # Git
-            no-commit-to-branch = {
-              enable = true;
-              settings = {
-                branch = [ "main" ];
-              };
-            };
-          };
-
-          settings = {
-            rust.check.cargoDeps = pkgs.rustPlatform.importCargoLock {
-              lockFile = ./Cargo.lock;
-            };
-          };
-        };
-      };
-
-      devShells = {
-        default = pkgs.mkShell {
-          name = "reddit-magnet";
-          buildInputs = with pkgs; [
-            cargo
-            cargo-edit
-            cargo-insta
-            cargo-machete
-            cargo-release
-            cargo-sort
-            diesel-cli
-            git-cliff
-            openssl
-            pkg-config
-            rustc
-            rust-toolchain
-            sqlfluff
-            sqlite
-          ] ++ lib.optionals stdenv.isDarwin [
-            libiconv
-          ] ++ self.checks.${system}.pre-commit-check.enabledPackages;
-          RUST_BACKTRACE = 1;
-
-          # Copy rust-toolchain to project directory for easy use in IntelliJ
-          shellHook = ''
-            if [ -L ./.rust-toolchain ] && [ "$(readlink ./.rust-toolchain)" = "${rust-toolchain}" ]; then
-              echo "Rust toolchain symlink is already correct."
-            else
-              rm -f ./.rust-toolchain
-              ln -s ${rust-toolchain} ./.rust-toolchain
-              echo "Rust toolchain symlink updated."
-            fi
-
-            ${self.checks.${system}.pre-commit-check.shellHook}
-          '';
-        };
-      };
-
       formatter = pkgs.nixpkgs-fmt;
     });
 }

nix/git-hooks.nix

@@ -0,0 +1,74 @@
+{ inputs, pkgs, ... }:
+let
+  conventional-commit = pkgs.callPackage ./pkgs/conventional-pre-commit.nix { };
+in
+{
+  pre-commit-check = inputs.pre-commit-hooks.lib.${pkgs.system}.run {
+    src = ./..;
+    hooks = {
+      # TOML
+      check-toml.enable = true;
+
+      # YAML
+      check-yaml.enable = true;
+
+      # Nix
+      deadnix.enable = true;
+      flake-checker.enable = true;
+      nixpkgs-fmt.enable = true;
+      statix.enable = true;
+
+      # Rust
+      clippy = {
+        enable = true;
+        settings = {
+          denyWarnings = true;
+        };
+        extraPackages = with pkgs; [
+          openssl
+          pkg-config
+        ];
+      };
+      rustfmt.enable = true;
+      cargo-check = {
+        enable = true;
+        extraPackages = with pkgs; [
+          pkg-config
+          openssl
+        ];
+      };
+
+      # SQL
+      sqlfluff = {
+        enable = true;
+        name = "sqlfluff";
+        entry = "${pkgs.sqlfluff}/bin/sqlfluff lint --dialect sqlite";
+        files = "\\.sql$";
+        language = "system";
+      };
+
+      # Git
+      no-commit-to-branch = {
+        enable = true;
+        settings = {
+          branch = [ "main" ];
+        };
+      };
+      conventional-commit = {
+        enable = true;
+        name = "conventional-commit";
+        description = "A pre-commit hook that checks commit messages for Conventional Commits formatting";
+        package = conventional-commit;
+        entry = "${conventional-commit}/bin/conventional-pre-commit";
+        args = [ "--strict" "feat" "fix" "chore" "revert" "style" "docs" "build" "refactor" "test" "ci" "perf" ];
+        stages = [ "commit-msg" ];
+      };
+    };
+
+    settings = {
+      rust.check.cargoDeps = pkgs.rustPlatform.importCargoLock {
+        lockFile = ../Cargo.lock;
+      };
+    };
+  };
+}

nix/pkgs/conventional-pre-commit.nix

@@ -0,0 +1,20 @@
+{ python3Packages, fetchPypi, ... }:
+
+python3Packages.buildPythonApplication rec {
+  pname = "conventional_pre_commit";
+  version = "4.2.0";
+
+  src = fetchPypi {
+    inherit pname version;
+    hash = "sha256-a1ooZzOMWKHRTTAN5otWwXt8hAO7EiFV84Y5pCPSH/E=";
+  };
+
+  doCheck = false;
+  pyproject = true;
+
+  build-system = with python3Packages; [
+    setuptools
+    setuptools-scm
+    wheel
+  ];
+}

nix/shell.nix

@@ -0,0 +1,39 @@
+{ pkgs, rust-toolchain, self, ... }:
+
+{
+  default = pkgs.mkShell {
+    name = "reddit-magnet";
+    buildInputs = with pkgs; [
+      cargo
+      cargo-edit
+      cargo-insta
+      cargo-machete
+      cargo-release
+      cargo-sort
+      diesel-cli
+      git-cliff
+      openssl
+      pkg-config
+      rustc
+      rust-toolchain
+      sqlfluff
+      sqlite
+    ] ++ lib.optionals stdenv.isDarwin [
+      libiconv
+    ] ++ self.checks.${pkgs.system}.pre-commit-check.enabledPackages;
+    RUST_BACKTRACE = 1;
+
+    # Copy rust-toolchain to project directory for easy use in IntelliJ
+    shellHook = ''
+      if [ -L ./.rust-toolchain ] && [ "$(readlink ./.rust-toolchain)" = "${rust-toolchain}" ]; then
+        echo "Rust toolchain symlink is already correct."
+      else
+        rm -f ./.rust-toolchain
+        ln -s ${rust-toolchain} ./.rust-toolchain
+        echo "Rust toolchain symlink updated."
+      fi
+
+      ${self.checks.${pkgs.system}.pre-commit-check.shellHook}
+    '';
+  };
+}