Pre Push Hooks

10. Pre-push Hooks

10.1 Beachte die in der package.json konfigurierten pre-push Hooks. Diese werden bei jedem git push ausgeführt und brechen im Falle eines Errors den push ab.

10.1.1 Linter: Halte die Linter Regeln ein. Ein Linter dient dazu den Code einheitlich zu strukturieren und Fehler zu vermeiden. Siehe dazu eslint

10.1.2 JSDoc: Schreibe valides JSDoc. JSDoc dient der Dokumentation von Javascript-Datein direkt im Quellcode. Es hilft besonders neuen aber auch erfahrenen Entwicklern den Quellcode zu verstehen. Aus einem validen JSDoc lässt sich eine Dokumentation als HTML erzeugen. Siehe dazu JSDoc

10.1.3 Unittests: Schreibe gültige Unittests. Durch Unittests werden geschriebene Funktionen des Quellcodes getestet. Außerdem wird durch Unittests sichergestellt, dass durch Änderungen des Quellcodes (z.B. bei Erweiterungen oder beim Refactoring) die vorhandene Funktionalität nicht kaputt geht. Dabei prüft ein Unittest den Rückgabewert einer Funktion, der konkrete Eingabewerte übergeben werden.