Konfigurieren der package.json-Datei

4 Minuten

Willkommen in der Welt des Node.js-Projektmanagements mit npm und Paketmanagement. Lassen Sie uns die Grundlagen der Verpackung erkunden und wie sie Ihren Entwicklungsprozess verbessern kann.

Verpacken und Paketverwaltung

NPM, der Standardpaket-Manager für Node.js, ist Ihre geheime Waffe zum Integrieren von externem Code in Ihre Projekte. Es ist wie ein persönlicher Assistent, der Ihnen hilft, Anwendungen schneller und effizienter zu erstellen.

Das Verpacken ist wie Ihren Code als Geschenk zu verpacken für den Versand. Es bündelt Ihren Code und seine Abhängigkeiten ordentlich in ein Paket, das andere problemlos installieren und verwenden können. Die Paketverwaltung ist die Kunst, diese Pakete zu behandeln, und umfasst:

Die package.json-Datei, der Bauplan Ihres Projekts. Es beinhaltet Metadaten zu Ihrem Projekt und kümmert sich um die Verwaltung von Abhängigkeiten und Paketdateien.
Das npm CLI-Tool, Ihr persönlicher Handwerker zum Installieren und Verwalten von Paketen aus der npm-Registrierung.
Die npm-Registrierung, eine Schatzkammer öffentlicher Pakete, die in Ihren Projekten verwendet werden können.

Ihre package.json erstellen

Das Erstellen einer package.json ist so einfach wie das Ausführen des npm init-Befehls. Hierfür gibt es zwei Hauptmöglichkeiten:

npm init: Dieser Befehl ist wie ein freundlicher Leitfaden, der Sie durch einen schrittweisen Prozess führt, der Angaben zu Ihrem Projekt wie Name, Version und Beschreibung abfragt.
npm init -y: Dieser Befehl ist die Express-Version von npm init. Er überspringt die Fragen und füllt Standardwerte für Sie aus.

Hier sehen Sie einen kurzen Einblick in die package.json-Datei, die Sie generieren.

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

Grundlegendes zu den Dateibereichen in „package.json“

Stellen Sie sich die package.json-Datei als Schatztruhe vor, gefüllt mit wertvollen Edelsteinen, die Ihr Projekt zum Funkeln bringen. Diese Edelsteine sind die Eigenschaften in der package.json-Datei und fallen in drei Hauptkategorien:

Metainformationen: Diese Eigenschaften ähneln den Kronjuwelen und definiert die Metainformationen zu Ihrem Projekt. Dazu gehören der Projektname, die Beschreibung, der Autor, die Schlüsselwörter und so weiter.
Abhängigkeiten: Dies sind die Gold- und Silbermünzen, welche die Pakete darstellen, die Ihr Projekt verwendet. Die Eigenschaften dependencies und devDependencies halten diese Schätze. Während wir weitermachen, erfahren Sie, wie Sie diese Eigenschaften zum Installieren, Aktualisieren und Verwalten Ihrer Abhängigkeiten verwenden können.
Skripts: Dies sind die Terminalbefehle, mit denen Ihre Projektaufgaben ausgeführt werden. Sie können Skripts für Aufgaben wie Start, Build, Test und Lint auflisten.

Aufgaben mit Skripts schneller ausführen

Ihre package.json-Datei sollte mindestens vier gängige Skripts umfassen:

start: Dieses Skript erweckt Ihr Projekt zum Leben. Beispielsweise kann es den Befehl node ./src/index.js verwenden.
build: Dieses Skript bereitet Ihr Projekt auf sein großes Debüt vor. Es kann TypeScript beispielsweise in JavaScript transformieren.
test: Dieses Skript überprüft die Integrität Ihres Projekts, in der Regel mithilfe eines Testpakets.
lint: Dieses Skript räumt Ihren Code auf und sucht nach Format- und Formatierungsproblemen mithilfe eines Tools wie ESLint.

Diese Skriptnamen sind wie Zauberwörter, die in der Entwicklercommunity universell anerkannt sind und unerlässlich sind, um Ihr Projekt organisiert aufzubauen.

Standardisieren von Skriptnamen

In der Datei „package.json“ werden Skripts mit einer Aktion und einem Befehl definiert:

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

Hier sehen Sie ein Beispiel:

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

Ausführen eines Skripts

Um ein Skript in einem Terminal auszuführen, indem Sie den Befehl npm run <action> eingeben. Beispielsweise npm run lint.

Die Aktionen start und test sind besonders, da Sie das Wort run im Befehl weglassen können. Statt den Befehl npm run starteinzugeben, können Sie npm start eingeben.

Verwenden einer vordefinierten Entwicklungsumgebung

Dieses Schulungsmodul bietet einen Entwicklungscontainer, entweder in einem Browser oder für Ihren lokalen Computer. Dieser Container bietet alle erforderlichen Umgebungen, damit Sie dieses Schulungsmodul verwenden können, ohne eine IDE oder Node.js installieren zu müssen. Sie müssen nichts über den Container wissen, um dieses Schulungsmodul abzuschließen.

Weiter