Was sind npm scripts und lifecycle hooks?

Question

Accepted Answer

**npm scripts** sind Befehle, die im Feld `scripts` in `package.json` definiert sind und mit `npm run ` ausgeführt werden. Sie standardisieren Projektaufgaben (start, build, test, lint), sodass das gesamte Team und CI dieselben Befehle verwenden. **Lifecycle hooks** sind spezielle Scripts, die npm automatisch zu bestimmten Zeitpunkten ausführt. ## Definieren und Ausführen von Scripts ```json { "scripts": { "start": "node server.js", "dev": "nodemon server.js", "build": "tsc && vite build", "test": "vitest", "lint": "eslint src", "format": "prettier --write ." } } ``` ```bash npm run dev # any script npm start # `start` and `test` have shortcuts (no "run" needed) npm test ``` Scripts können Befehle mit `&&` verketten (sequenziell ausführen, bei Fehler stoppen) und haben Zugriff auf lokal installierte Binärdateien (in `node_modules/.bin`) ohne Pfad — daher funktioniert `"test": "vitest"` auch wenn vitest nicht global ist. ## Pre und post hooks (automatisch) ```json { "scripts": { "prebuild": "rimraf dist", // runs AUTOMATICALLY before "build" "build": "tsc", "postbuild": "echo done" // runs AUTOMATICALLY after "build" } } ``` npm führt automatisch `pre` vor und `post` nach einem beliebigen Script `` aus. Daher führt `npm run build` `prebuild` → `build` → `postbuild` in der Reihenfolge aus — nützlich für Setup-/Bereinigungsschritte. ## Integrierte lifecycle hooks ```json { "scripts": { "postinstall": "node setup.js", // runs after `npm install` completes "prepare": "husky install" // runs after install (commonly sets up git hooks) } } ``` Hooks wie `postinstall` und `prepare` laufen zu definierten Zeitpunkten des Installationslebenszyklus — häufig zum Einrichten von Git Hooks (husky) oder zum Kompilieren von nativen Abhängigkeiten. (Seien Sie vorsichtig: `postinstall` Scripts in Abhängigkeiten sind auch eine Überlegung zur Sicherheit der Lieferkette.) ## Übergabe von Argumenten und Umgebungsvariablen ```bash npm run test -- --watch # pass args to the script after -- NODE_ENV=production npm start # set an env var for the run ``` ## Warum npm scripts statt Makefile/globale Tools ```text ✓ Self-documenting — `package.json` shows all available tasks ✓ Cross-platform-ish, no global installs needed (uses local node_modules/.bin) ✓ Standard across the JS ecosystem — every dev knows `npm run` ``` ## Warum es wichtig ist npm scripts sind der Standard task runner für Node/JS-Projekte — sie zentralisieren und dokumentieren, wie die App gestartet, erstellt, getestet und gepuffert wird, um sicherzustellen, dass alle (und CI) identische Befehle ausführen. Das Verstehen von Script-Komposition, automatischen `pre`/`post` Hooks (für Setup/Bereinigung) und Lifecycle Hooks wie `postinstall`/`prepare` ermöglicht es Ihnen, Projekt-Workflows sauber zu automatisieren. Sie sind der Kleber der Projekt-Tools und erscheinen in praktisch jedem Node-Repository.