Automatisierung von Code-Prüfungen mit Git Pre-Commit Hooks

Jeder Entwickler kennt die Frustration, Code zu pushen, nur um dann zu erleben, dass CI/CD-Pipelines aufgrund von Formatierungsproblemen oder Linting-Fehlern fehlschlagen. Was wäre, wenn Sie diese Probleme abfangen könnten, bevor sie überhaupt Ihr Repository erreichen? Git Pre-Commit Hooks bieten eine mächtige Lösung, die automatisierte Prüfungen lokal ausführt und dabei Zeit spart und eine konsistente Code-Qualität in Ihrem Team aufrechterhält.

Dieser Artikel führt Sie durch die Einrichtung von Git Pre-Commit Hooks mit dem pre-commit Framework, die Konfiguration essentieller Tools wie ESLint, Prettier und Black sowie die Implementierung bewährter Praktiken, die Ihren Entwicklungsworkflow reibungslos und effizient halten.

Was sind Git Pre-Commit Hooks?

Git Hooks sind Skripte, die Git vor oder nach Ereignissen wie Commit, Push und Receive ausführt. Ein Git Pre-Commit Hook läuft spezifisch, nachdem Sie Änderungen gestaged haben, aber bevor Git den Commit erstellt. Wenn der Hook mit einem Non-Zero-Status beendet wird, bricht Git den Commit ab und gibt Ihnen die Möglichkeit, Probleme zuerst zu beheben.

Während Sie Hooks als einfache Shell-Skripte in .git/hooks/ schreiben können, wird deren Verwaltung komplex, wenn Ihr Projekt wächst. Hier glänzt das pre-commit Framework—es bietet eine standardisierte Methode zur Verwaltung und gemeinsamen Nutzung von Hooks in Ihrem Team.

Warum das Pre-Commit Framework verwenden?

Das pre-commit Framework löst mehrere Schmerzpunkte nativer Git Hooks:

• Einfache Installation und Updates: Hooks sind versioniert und werden über eine einfache YAML-Konfiguration installiert
• Sprachunabhängig: Führen Sie Python-Linter, JavaScript-Formatter und Shell-Skripte von einer Konfiguration aus
• Selektive Ausführung: Hooks laufen nur auf geänderten Dateien und halten Commits schnell
• Team-Konsistenz: Teilen Sie dieselbe .pre-commit-config.yaml Datei in Ihrem gesamten Team

Einrichtung von Pre-Commit in Ihrem Projekt

Installieren Sie zunächst das pre-commit Paket:

pip install pre-commit

Erstellen Sie eine .pre-commit-config.yaml Datei in Ihrem Projektstamm. Hier ist eine praktische Konfiguration, die häufige Anforderungen abdeckt:

repos:
  # Basic file fixes
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.5.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
      - id: check-yaml
      - id: check-added-large-files

  # Python formatting with Black
  - repo: https://github.com/psf/black
    rev: 24.2.0
    hooks:
      - id: black
        files: \.py$

  # Python type checking with Mypy
  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v1.8.0
    hooks:
      - id: mypy
        additional_dependencies: [types-all]
        files: \.py$

  # JavaScript/TypeScript with Prettier
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: v3.1.0
    hooks:
      - id: prettier
        files: \.(js|jsx|ts|tsx|json|css|md)$

  # JavaScript/TypeScript linting with ESLint
  - repo: https://github.com/pre-commit/mirrors-eslint
    rev: v8.56.0
    hooks:
      - id: eslint
        files: \.(js|jsx|ts|tsx)$
        additional_dependencies:
          - eslint-config-standard
          - eslint-plugin-react

  # Run project tests
  - repo: local
    hooks:
      - id: pytest
        name: pytest
        entry: pytest
        language: system
        pass_filenames: false
        always_run: true

Installieren Sie die Git Hooks:

pre-commit install

Nun werden Ihre Hooks automatisch bei jedem Commit ausgeführt. Um sie manuell auf allen Dateien auszuführen:

pre-commit run --all-files

Optimierung der Hook-Performance

Geschwindigkeit ist wichtig—langsame Hooks entmutigen Entwickler davon, häufig zu committen. Befolgen Sie diese Praktiken:

Hooks nur auf gestagten Dateien ausführen: Das pre-commit Framework macht dies standardmäßig, aber stellen Sie sicher, dass Ihre benutzerdefinierten Hooks dieses Muster respektieren.

Schnelle Tools verwenden: Wählen Sie Ruff statt Flake8 für Python oder Biome statt ESLint für JavaScript, wenn Geschwindigkeit kritisch ist.

Teure Prüfungen lokal überspringen: Reservieren Sie umfassende Test-Suites für CI/CD. Lokale Hooks sollten sich auf schnelle Erfolge wie Formatierung und grundlegendes Linting konzentrieren.

Parallelisierung wenn möglich: Einige Tools unterstützen parallele Ausführung. Beispielsweise kann pytest Tests parallel mit pytest-xdist ausführen.

Bewährte Praktiken für Team-Adoption

Die Einführung von Pre-Commit Hooks in Ihrem Team erfordert durchdachte Implementierung:

Klein anfangen: Beginnen Sie mit nicht-intrusiven Hooks wie der Entfernung von Trailing Whitespace. Fügen Sie schrittweise strengere Prüfungen hinzu.

Setup dokumentieren: Fügen Sie Installationsanweisungen in Ihre README ein. Machen Sie es zu einem Teil Ihres Onboarding-Prozesses.

Umgebungsunterschiede handhaben: Verwenden Sie wo möglich sprachunabhängige Hooks. Für sprachspezifische Tools stellen Sie sicher, dass Ihre .pre-commit-config.yaml kompatible Versionen spezifiziert.

Notausgänge bereitstellen: Manchmal müssen Entwickler Hooks umgehen. Das --no-verify Flag überspringt alle Hooks:

git commit --no-verify -m "Emergency fix"

Verwenden Sie dies sparsam und dokumentieren Sie, wann es angemessen ist.

Alternative Ansätze

Während pre-commit das beliebteste Framework ist, existieren Alternativen:

Husky: Beliebt in JavaScript-Projekten, integriert sich gut mit npm-Skripten.

Native Git Hooks: Direkte Shell-Skripte in .git/hooks/ bieten maximale Kontrolle, aber mangelnde Portabilität.

Lefthook: Schnelle, plattformübergreifende Alternative mit Unterstützung für parallele Ausführung.

Für die meisten Teams bietet pre-commit die beste Balance aus Features, Performance und Ökosystem-Unterstützung.

Häufige Fallstricke und Lösungen

Hook-Fehler in CI: Stellen Sie sicher, dass CI-Umgebungen alle notwendigen Abhängigkeiten installiert haben. Erwägen Sie, pre-commit run --all-files als CI-Schritt auszuführen.

Plattformspezifische Probleme: Testen Sie Hooks auf allen Plattformen, die Ihr Team verwendet. Verwenden Sie Docker für konsistente Umgebungen, falls nötig.

Merge-Konflikte in Konfigurationsdateien: Halten Sie Änderungen an .pre-commit-config.yaml minimal und atomisch. Aktualisieren Sie Hook-Versionen in separaten Commits.

Fazit

Git Pre-Commit Hooks transformieren Code-Qualität von einem reaktiven zu einem proaktiven Prozess. Indem Sie Probleme abfangen, bevor sie Ihr Repository erreichen, sparen Sie Zeit, reduzieren Kontextwechsel und halten höhere Standards in Ihrer Codebasis aufrecht. Beginnen Sie mit grundlegenden Formatierungs-Hooks, fügen Sie schrittweise Linter und Type-Checker hinzu und priorisieren Sie immer Geschwindigkeit, um den Workflow Ihres Teams reibungslos zu halten.

Der Schlüssel zur erfolgreichen Adoption liegt darin, Gründlichkeit mit Entwicklererfahrung auszubalancieren. Schnelle, fokussierte Hooks, die sofortigen Wert bieten, werden zu einem unverzichtbaren Teil des Workflows Ihres Teams.

FAQs

Gain control over your UX

See how users are using your site as if you were sitting next to them, learn and iterate faster with OpenReplay. — the open-source session replay tool for developers. Self-host it in minutes, and have complete control over your customer data. Check our GitHub repo and join the thousands of developers in our community.