Een package.json bestand is een kernonderdeel van Node.js projecten en het is ontworpen om het eenvoudig te maken om pakketten te beheren voor je project. In de meest basic vorm, bevat een package.json bestand de metadata van het project en de afhankelijkheden, dit zijn modules die je project nodig heeft om te kunnen werken.
Een package.json bestand kan handmatig worden gemaakt of automatisch door gebruik te maken van de “npm init” commando form Node.js
Basisstructuur van een package.json bestand:
{
“name”: “my-project”,
“version”: “1.0.0”,
“description”: “Een korte omschrijving van mijn project”,
“main”: “index.js”,
“scripts”: {
“test”: “echo “Error: geen test gespecificeerd” && exit 1“
},
“author”: “Jouw Naam”,
“license”: “ISC”,
“dependencies”: {
“express”: “\*”,
“mongoose”: “^5.11.15“
}
}
- “name” en “version” velden zijn verplicht als het bestand bedoeld is voor publicatie. Samen vormen ze een unieke identifier.
- “main” veld bepaalt het invoerpunt van je applicatie.
- “scripts” veld is een plek waar je je testscripts en andere CLI opdrachten kunt scripten.
- “dependencies” en “devDependencies” zijn waarschijnlijk de twee velden die je het meest gebruikt. Dit zijn de plaatsen waar je de modules opsomt die je nodig hebt voor productie en ontwikkeling.
Om de packages die zijn opgegeven bij ‘dependencies’ te downloaden, moet je de “npm install” opdracht uitvoeren binnen dezelfde map als je package.json bestand. De commando zal lezen welke packages in je package.json bestand staan en ze vervolgens installeren.
