Czym są npm scripts i lifecycle hooks?

Question

Accepted Answer

**npm scripts** to polecenia zdefiniowane w polu `scripts` pliku `package.json`, które uruchamiasz za pomocą `npm run `. Standaryzują zadania projektowe (start, build, test, lint), dzięki czemu cały zespół i CI używają tych samych poleceń. **Lifecycle hooks** to specjalne skrypty, które npm uruchamia automatycznie w określonych momentach. ## Definiowanie i uruchamianie skryptów ```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 ``` Skrypty mogą łańcuchować polecenia za pomocą `&&` (uruchamianie sekwencyjne, zatrzymanie przy błędzie) i mają dostęp do lokalnie zainstalowanych binariów (w `node_modules/.bin`) bez ścieżki — więc `"test": "vitest"` działa, mimo że vitest nie jest zainstalowany globalnie. ## Hooki pre i post (automatyczne) ```json { "scripts": { "prebuild": "rimraf dist", // runs AUTOMATICALLY before "build" "build": "tsc", "postbuild": "echo done" // runs AUTOMATICALLY after "build" } } ``` npm automatycznie uruchamia `pre` przed i `post` po dowolnym skrypcie ``. Dlatego `npm run build` uruchamia `prebuild` → `build` → `postbuild` w kolejności — przydatne do kroków konfiguracji/sprzątania. ## Wbudowane lifecycle hooki ```json { "scripts": { "postinstall": "node setup.js", // runs after `npm install` completes "prepare": "husky install" // runs after install (commonly sets up git hooks) } } ``` Hooki takie jak `postinstall` i `prepare` uruchamiają się w określonych momentach cyklu życia instalacji — często używane do konfiguracji git hooks (husky) lub kompilacji natywnych zależności. (Bądź ostrożny: skrypty `postinstall` w zależnościach to także kwestia bezpieczeństwa łańcucha dostaw.) ## Przekazywanie argumentów i zmiennych środowiskowych ```bash npm run test -- --watch # pass args to the script after -- NODE_ENV=production npm start # set an env var for the run ``` ## Dlaczego npm scripts zamiast Makefile/globalnych narzędzi ```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` ``` ## Dlaczego to ważne npm scripts to standardowy task runner dla projektów Node/JS — centralizują i dokumentują sposób uruchamiania, budowania, testowania i lintowania aplikacji, zapewniając, że wszyscy (i CI) uruchamiają identyczne polecenia. Zrozumienie kompozycji skryptów, automatycznych hooków `pre`/`post` (do konfiguracji/sprzątania) i lifecycle hooków takich jak `postinstall`/`prepare` pozwala ci automatyzować przepływy pracy projektowe w czysty sposób. Są one spoiwem toolingu projektowego i pojawiają się zasadniczo w każdym repozytorium Node.