pre-commit
Jest kolejnym narzędziem, które ułatwia nam pracę poprzez agregację różnych funkcjonalności, a przy okazji blokuje nam możliwość przesyłania naszych zmian, jeśli nie spełniają one narzuconych wymagań.
W zależności od tego jak zostanie skonfigurowany, może nam pomagać z:
- Wyszukiwaniem błędów przed zatwierdzeniem kodu (
commit
) - np. zatwierdzanie kodu, który nie spełnia standardów stylu, importowanie nieużywanych bibliotek, niedokończone fragmenty kodu czy konflikty w merge'ach. - Powtarzalnymi procesami - np. manualnym sprawdzaniem stylu, uruchamianiem testów czy usuwaniem plików tymczasowych.
- Zapewnieniem spójności w kodzie od różnych deweloperów - np. różni członkowie zespołu mogą korzystać z różnych standardów.
- Wymaganiami projektowymi - wymusza stosowanie linterów, testów czy innych narzędzi.
Konfiguracja pre-commit
odbywa się poprzez plik .pre-commit-config.yaml
(zwykle w głównym katalogu repozytorium). Ten plik definiuje, jakie zadania (hooks
) mają być uruchamiane przed commitowaniem.
Zadania
- Zainicjuj
pre-commit
wykorzystując komendęmake setup-pre-commit
- Uruchom
pre-commit hooks
za pomocą kolejnej komendymake pc
- Ponownie popraw wszystkie wylistowane błędy.