A package.json fájl konfigurálása

  • 4 perc

Üdvözöljük a Node.js projektfelügyelet világában az npm és a csomagkezelés segítségével. Vizsgáljuk meg a csomagolás alapjait, és hogy hogyan tudja feltöltődni a fejlesztési folyamat.

Csomagolás és csomagkezelés

A Node.js alapértelmezett csomagkezelője, az NPM a külső kód projektekbe való beépítéséhez használt titkos fegyvere. Ez olyan, mintha egy személyes asszisztenssel gyorsabban és hatékonyabban fejleszthet alkalmazásokat.

A csomagolás olyan, mint a kód ajándékcsomagolása a terjesztéshez. Szépen csomagolja a kódot és annak függőségeit egy olyan csomagba, amelyet mások egyszerűen telepíthetik és használhatnak. A csomagkezelés a csomagok kezelésének művészete, és a következőket foglalja magában:

  • A package.json fájl, a projekt tervrajza. Tele van a projekt metaadataival, és gondoskodik a függőségek és a csomagfájlok kezeléséről.
  • Az npm CLI-eszköz, az npm beállításjegyzékből származó csomagok telepítésének és kezelésének személyes ezermestere.
  • Az npm regisztrációs adatbázis, egy kincstár, amely nyilvános csomagokból áll, és készen áll a projektekben való használatra.

A package.json létrehozása

package.json A létrehozás olyan egyszerű, mint a npm init parancs futtatása. Ennek két fő módja van:

  • npm init: Ez a parancs olyan, mint egy rövid útmutató, amely végigvezeti egy lépésenkénti folyamaton, amely részletes információkat kér a projektről, például a nevét, verzióját és leírását.
  • npm init -y: Ez a parancs az npm init express train verziója. Áthúzhatja a kérdéseket, és kitölti az alapértelmezett értékeket.

Íme egy bepillantás a package.json létrehozott fájlba.

{
  "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"
}

A package.json fájlterület ismertetése

Gondoljon úgy a package.json fájlra, mint egy kincsesládára, tele értékes drágakövekkel, amelyek a projekt csillogását adják. Ezek a drágakövek a fájl tulajdonságai package.json , és három fő kategóriába sorolhatók:

  • Meta-információ: Ezek a tulajdonságok olyanok, mint a koronaékszerek, meghatározva a projekt metainformációit. Ezek közé tartozik a projekt neve, leírása, szerzője, kulcsszavak és egyebek.
  • Függőségek: Ezek az arany- és ezüstérmék, amelyek a projekt által használt csomagokat jelölik. A dependencies kincsek és devDependencies az ingatlanok tartják ezeket a kincseket. Ahogy haladunk tovább, megtanulhatja, hogyan használhatja ezeket a tulajdonságokat a függőségek telepítéséhez, frissítéséhez és kezeléséhez.
  • Szkriptek: Ezek a terminálparancsok hajtják végre a projekttevékenységeket. Az olyan feladatok szkriptjei is listázhatók, mint az indítás, a buildelés, a tesztelés és a lint.

Feladatok gyorsítása szkriptekkel

package.json A fájlban legalább négy gyakori szkriptet kell tartalmaznia:

  • start: Ez a szkript életre kelti a projektet. Használhatja például a parancsot node ./src/index.js.
  • build: Ez a szkript előkészíti a projektet a nagy debütáláshoz. A TypeScriptet például JavaScript-gé alakíthatja át.
  • test: Ez a szkript ellenőrzi a projekt állapotát, általában tesztelési csomag használatával.
  • lint: Ez a szkript rendszerezi a kódot, és stílus- és formázási problémákat keres egy olyan eszközzel, mint az ESLint.

Ezek a szkriptnevek olyanok, mint a varázsszavak, amelyek a fejlesztői közösségben általánosan elismertek, és nélkülözhetetlenek a projekt rendszerezéséhez.

Szkriptnevek szabványosítása

A package.json fájlban a szkriptek egy művelettel és egy paranccsal vannak definiálva:

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

Példa:

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

Szkript futtatása

Szkript futtatása terminálon a parancs npm run <action>beírásával. For example, npm run lint.

A start művelet különlegestest, mert kihagyhatja a szót run a parancsból. A parancs beírása helyett beírhatja a parancsotnpm run startnpm start.

Előre definiált fejlesztési környezet használata

Ez a képzési modul egy fejlesztői tárolót kínál egy böngészőben vagy a helyi számítógépen. Ez a tároló biztosítja az összes szükséges környezetet, így ezt a betanítási modult anélkül használhatja, hogy IDE-t vagy Node.js-t kellene telepítenie. A betanítási modul elvégzéséhez nem kell semmit sem tudnia a tárolóról.