Add git hooks checks for Node and Python (#22)

Author: vidya381

internal/check/githooks.go

@@ -0,0 +1,110 @@
+package check
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+)
+
+var lookPath = exec.LookPath
+
+type GitHooksCheck struct {
+	Dir   string
+	Stack string // "node" or "python"
+}
+
+func (c *GitHooksCheck) Name() string {
+	switch c.Stack {
+	case "node":
+		return "Git hooks configured for Node"
+	case "python":
+		return "Git hooks configured for Python"
+	default:
+		return "Git hooks configured"
+	}
+}
+
+func (c *GitHooksCheck) Run(_ context.Context) Result {
+	if !dirExists(filepath.Join(c.Dir, ".git")) {
+		return Result{
+			Name:    c.Name(),
+			Status:  StatusSkipped,
+			Message: "not a git repository (no .git directory)",
+		}
+	}
+
+	switch c.Stack {
+	case "node":
+		return c.runNode()
+	case "python":
+		return c.runPython()
+	default:
+		return Result{
+			Name:    c.Name(),
+			Status:  StatusSkipped,
+			Message: "unknown stack type for git hooks check",
+		}
+	}
+}
+
+func (c *GitHooksCheck) runNode() Result {
+	huskyDir := filepath.Join(c.Dir, ".husky")
+	if dirExists(huskyDir) {
+		return Result{
+			Name:    c.Name(),
+			Status:  StatusPass,
+			Message: ".husky directory exists; git hooks are configured",
+		}
+	}
+
+	return Result{
+		Name:    c.Name(),
+		Status:  StatusWarn,
+		Message: ".husky directory not found; git hooks for Node are not configured",
+		Fix:     "set up Husky (or another git hooks tool) to run linting/tests before commits",
+	}
+}
+
+func (c *GitHooksCheck) runPython() Result {
+	configPath := filepath.Join(c.Dir, ".pre-commit-config.yaml")
+	_, err := os.Stat(configPath)
+	configExists := err == nil
+
+	_, err = lookPath("pre-commit")
+	preCommitInstalled := err == nil
+
+	if configExists && preCommitInstalled {
+		return Result{
+			Name:    c.Name(),
+			Status:  StatusPass,
+			Message: "pre-commit is installed and .pre-commit-config.yaml exists",
+		}
+	}
+
+	var details string
+	if !configExists && !preCommitInstalled {
+		details = ".pre-commit-config.yaml not found and pre-commit is not installed"
+	} else if !configExists {
+		details = ".pre-commit-config.yaml not found"
+	} else {
+		details = "pre-commit is not installed"
+	}
+
+	return Result{
+		Name:    c.Name(),
+		Status:  StatusWarn,
+		Message: fmt.Sprintf("git hooks for Python are not fully configured: %s", details),
+		Fix:     "install pre-commit and add a .pre-commit-config.yaml so hooks can run linting/tests before commits",
+	}
+}
+
+func dirExists(path string) bool {
+	info, err := os.Stat(path)
+	if err != nil {
+		return false
+	}
+	return info.IsDir()
+}
+

internal/check/githooks_test.go

@@ -0,0 +1,76 @@
+package check
+
+import (
+	"context"
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func TestGitHooksCheck_Node_PassAndWarn(t *testing.T) {
+	dir := t.TempDir()
+
+	// ensure we are treated as a git repo
+	if err := os.Mkdir(filepath.Join(dir, ".git"), 0o755); err != nil {
+		t.Fatalf("failed to create .git directory: %v", err)
+	}
+
+	check := &GitHooksCheck{Dir: dir, Stack: "node"}
+
+	// Pass when .husky exists
+	if err := os.Mkdir(filepath.Join(dir, ".husky"), 0o755); err != nil {
+		t.Fatalf("failed to create .husky directory: %v", err)
+	}
+	result := check.Run(context.Background())
+	if result.Status != StatusPass {
+		t.Errorf("expected pass when .husky exists, got %v: %s", result.Status, result.Message)
+	}
+
+	// Warn when .husky is missing
+	if err := os.RemoveAll(filepath.Join(dir, ".husky")); err != nil {
+		t.Fatalf("failed to remove .husky directory: %v", err)
+	}
+	result = check.Run(context.Background())
+	if result.Status != StatusWarn {
+		t.Errorf("expected warn when .husky missing, got %v: %s", result.Status, result.Message)
+	}
+}
+
+func TestGitHooksCheck_Python_PassAndWarn(t *testing.T) {
+	dir := t.TempDir()
+
+	// ensure we are treated as a git repo
+	if err := os.Mkdir(filepath.Join(dir, ".git"), 0o755); err != nil {
+		t.Fatalf("failed to create .git directory: %v", err)
+	}
+
+	// override lookPath so tests don't depend on environment
+	origLookPath := lookPath
+	defer func() { lookPath = origLookPath }()
+
+	check := &GitHooksCheck{Dir: dir, Stack: "python"}
+
+	// Pass when config exists and pre-commit is "installed"
+	if err := os.WriteFile(filepath.Join(dir, ".pre-commit-config.yaml"), []byte("repos: []\n"), 0o644); err != nil {
+		t.Fatalf("failed to write .pre-commit-config.yaml: %v", err)
+	}
+	lookPath = func(string) (string, error) {
+		return "/usr/bin/pre-commit", nil
+	}
+
+	result := check.Run(context.Background())
+	if result.Status != StatusPass {
+		t.Errorf("expected pass when pre-commit and config present, got %v: %s", result.Status, result.Message)
+	}
+
+	// Warn when either piece is missing (simulate missing pre-commit)
+	lookPath = func(string) (string, error) {
+		return "", os.ErrNotExist
+	}
+
+	result = check.Run(context.Background())
+	if result.Status != StatusWarn {
+		t.Errorf("expected warn when pre-commit missing, got %v: %s", result.Status, result.Message)
+	}
+}
+

internal/check/registry.go

@@ -17,10 +17,12 @@ func Build(stack detector.DetectedStack) []Check {
 		cs = append(cs, &BinaryCheck{Binary: "node"})
 		cs = append(cs, &BinaryCheck{Binary: "npm"})
 		cs = append(cs, &NodeVersionCheck{Dir: "."})
+		cs = append(cs, &GitHooksCheck{Dir: ".", Stack: "node"})
 	}
 	if stack.Python {
 		cs = append(cs, &BinaryCheck{Binary: "python3"})
 		cs = append(cs, &BinaryCheck{Binary: "pip"})
+		cs = append(cs, &GitHooksCheck{Dir: ".", Stack: "python"})
 	}
 	if stack.Java {
 		cs = append(cs, &BinaryCheck{Binary: "java"})