De package.json configureren

4 minuten

Welkom bij de wereld van Node.js-projectbeheer met npm en pakketbeheer. Laten we eens dieper ingaan op de essentie van verpakking en hoe het uw ontwikkelingsproces kan opladen.

Verpakkings- en pakketbeheer

NPM, de standaardpakketbeheerder voor Node.js, is uw geheime wapen voor het opnemen van externe code in uw projecten. Het is alsof u een persoonlijke assistent hebt om u te helpen sneller en efficiënter toepassingen te bouwen.

Verpakking is net als het verpakken van uw code voor distributie. Het bundelt uw code en de bijbehorende afhankelijkheden netjes in een pakket dat anderen eenvoudig kunnen installeren en gebruiken. Pakketbeheer is de kunst van het verwerken van deze pakketten en omvat:

Het bestand package.json , de blauwdruk van uw project. Het bevat metagegevens over uw project en zorgt voor het beheren van afhankelijkheden en pakketbestanden.
Het NPM CLI-hulpprogramma, uw persoonlijke handiger voor het installeren en beheren van pakketten vanuit het npm-register.
Het npm-register, een schatkamer van openbare pakketten die klaar zijn voor gebruik in uw projecten.

Uw package.json maken

Het maken van een package.json is net zo eenvoudig als het uitvoeren van de npm init opdracht. U kunt dit op twee manieren doen:

npm init: Deze opdracht is als een beschrijvende handleiding, die u door een stapsgewijs proces leidt dat vraagt om details over uw project, zoals de naam, versie en beschrijving.
npm init -y: Deze opdracht is de express train-versie van npm init. Het zipt de vragen en vult standaardwaarden voor u in.

Hier volgt een korte weergave van het package.json bestand dat u gaat genereren.

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

Inzicht in de bestandsgebieden package.json

Denk aan het package.json bestand als een schatkist, gevuld met kostbare edelstenen die uw project zijn sparkle geven. Deze juweeltjes zijn de eigenschappen in het package.json bestand en ze vallen in drie hoofdcategorieën:

Meta-informatie: Deze eigenschappen zijn net als de kroonjuwelen, die de meta-informatie over uw project definiëren. Ze bevatten de projectnaam, beschrijving, auteur, trefwoorden en meer.
Afhankelijkheden: Dit zijn de gouden en zilveren munten, die de pakketten vertegenwoordigen die uw project gebruikt. De dependencies en devDependencies eigenschappen houden deze schatten vast. Naarmate we verder gaan, leert u hoe u deze eigenschappen kunt gebruiken om uw afhankelijkheden te installeren, bij te werken en te beheren.
Scripts: dit zijn de terminalopdrachten waarmee uw projecttaken worden uitgevoerd. U kunt scripts weergeven voor taken zoals starten, bouwen, testen en linten.

Taken expediate met scripts

In uw package.json bestand moet u ten minste vier algemene scripts opnemen:

start: Dit script brengt uw project tot leven. Het kan bijvoorbeeld de opdracht node ./src/index.jsgebruiken.
build: Dit script bereidt uw project voor op het einddebuut. Het kan bijvoorbeeld TypeScript omzetten in JavaScript.
test: Met dit script wordt de status van uw project gecontroleerd, meestal met behulp van een testpakket.
lint: Met dit script wordt uw code opgegeruimd, waarbij u controleert op stijl- en opmaakproblemen met behulp van een hulpprogramma zoals ESLint.

Deze scriptnamen zijn als magische woorden, universeel herkend in de ontwikkelaarscommunity en essentieel voor het organiseren van uw project.

Scriptnamen standaardiseren

In het bestand package.json worden scripts gedefinieerd met een actie en een opdracht:

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

Hier volgt een voorbeeld:

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

Een script uitvoeren

Als u een script in een terminal wilt uitvoeren door de opdracht npm run <action>in te voeren. Bijvoorbeeld npm run lint.

De start en test actie zijn speciaal omdat u het woord run in de opdracht weglaat. In plaats van de opdracht npm run startin te voeren, kunt u invoeren npm start.

Een vooraf gedefinieerde ontwikkelomgeving gebruiken

Deze trainingsmodule biedt een ontwikkelcontainer in een browser of voor uw lokale computer. Deze container biedt alle benodigde omgevingen, zodat u deze trainingsmodule kunt gebruiken zonder dat u een IDE of Node.js hoeft te installeren. U hoeft niets te weten over de container om deze trainingsmodule te voltooien.

Doorgaan