Konfigurowanie pliku package.json

  • 4 min

Witamy w świecie zarządzania projektami Node.js za pomocą narzędzia npm i zarządzania pakietami. Przyjrzyjmy się podstawom tworzenia pakietów i sposobom, w jaki może on doładować proces programowania.

Zarządzanie pakietami i pakietami

NPM, domyślny menedżer pakietów dla środowiska Node.js, to tajna broń do dołączania kodu zewnętrznego do projektów. Jest to jak posiadanie osobistego asystenta, aby ułatwić szybsze i wydajniejsze tworzenie aplikacji.

Pakowanie jest podobne do opakowującego prezenty kodu do dystrybucji. Schludnie umieszcza kod i jego zależności w pakiecie, który inni mogą łatwo zainstalować i używać. Zarządzanie pakietami to sztuka obsługi tych pakietów i obejmuje:

  • Plik package.json, strategia projektu. Jest on pełen metadanych dotyczących projektu i zajmuje się zarządzaniem zależnościami i plikami pakietów.
  • Narzędzie interfejsu wiersza polecenia npm, twoja osobista pomocnicza do instalowania pakietów z rejestru npm i zarządzania nimi.
  • Rejestr npm, skarbnica publicznych pakietów gotowych do użycia w projektach.

Tworzenie pliku package.json

Tworzenie elementu package.json jest tak proste, jak uruchomienie npm init polecenia. Istnieją dwa główne sposoby, aby to zrobić:

  • npm init: To polecenie jest jak przyjazny przewodnik, który prowadzi Cię przez proces krok po kroku, który prosi o szczegółowe informacje o projekcie, takie jak jego nazwa, wersja i opis.
  • npm init -y: to polecenie to ekspresowa wersja narzędzia npm init. Plik zipuje obok pytań i wypełnia domyślne wartości.

Oto skradanie package.json się pliku, który zostanie wygenerowany.

{
  "name": "my project",
  "version": "1.0.0",
  "description": "",
  "main": "script.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

Omówienie obszarów plików package.json

Pomyśl o package.json pliku jako klatce piersiowej skarbowej, wypełnione cennymi klejnotami, które dają projektowi jego blask. Te klejnoty są właściwościami w package.json pliku i należą do trzech głównych kategorii:

  • Meta-information: Te właściwości są podobne do klejnotów koronnych, definiując meta-informacje o projekcie. Obejmują one nazwę projektu, opis, autora, słowa kluczowe i inne.
  • Zależności: są to złote i srebrne monety, reprezentujące pakiety używane przez projekt. Właściwości dependencies i devDependencies posiadają te skarby. W miarę dalszej podróży dowiesz się, jak używać tych właściwości do instalowania, aktualizowania i zarządzania zależnościami.
  • Skrypty: są to polecenia terminalu, które sprawiają, że zadania projektu są wykonywane. Możesz wyświetlić listę skryptów dla zadań, takich jak uruchamianie, kompilowanie, testowanie i lint.

Expediate tasks with scripts (Eksploatowanie zadań za pomocą skryptów)

W pliku package.json należy uwzględnić co najmniej cztery typowe skrypty:

  • start: ten skrypt umożliwia życie projektu. Na przykład może użyć polecenia node ./src/index.js.
  • build: Ten skrypt przygotowuje projekt do jego wielkiego debiutu. Na przykład może przekształcić język TypeScript w język JavaScript.
  • test: ten skrypt sprawdza kondycję projektu, zazwyczaj przy użyciu pakietu testowego.
  • lint: ten skrypt porządkuje kod, sprawdzając problemy ze stylem i formatowaniem przy użyciu narzędzia takiego jak ESLint.

Te nazwy skryptów są takie jak magiczne słowa, powszechnie rozpoznawane w społeczności deweloperów i niezbędne do organizowania projektu.

Standaryzacja nazw skryptów

W pliku package.json skrypty są definiowane za pomocą akcji i polecenia:

"scripts" : {
  "<action>" : "<command>"
}

Oto przykład:

"scripts" : {
  "start" : "node ./dist/index.js",
  "test": "jest",
  "build": "tsc",
  "lint": "eslint"
}

Uruchamianie skryptu

Aby uruchomić skrypt w terminalu, wprowadzając polecenie npm run <action>. Na przykład npm run lint.

Akcja start i test jest specjalna w tym, że można pominąć słowo run w poleceniu. Zamiast wprowadzać polecenie npm run start, możesz wprowadzić wartość npm start.

Korzystanie ze wstępnie zdefiniowanego środowiska projektowego

Ten moduł szkoleniowy oferuje kontener deweloperów w przeglądarce lub na komputerze lokalnym. Ten kontener udostępnia wszystkie środowiska potrzebne, dzięki czemu można użyć tego modułu szkoleniowego bez konieczności instalowania środowiska IDE lub Node.js. Nie musisz nic wiedzieć o kontenerze, aby ukończyć ten moduł szkoleniowy.