Package.json ist eine Konfigurationsdatei, die in Projekten auf Node verwendet wird.js zum Verwalten von Abhängigkeiten und Skripten. Diese Datei enthält Informationen über das Projekt, seine Abhängigkeiten und Befehle zum Ausführen verschiedener Skripts. Package anpassen.json mag für Anfänger eine entmutigende Aufgabe sein, aber es ist eigentlich ziemlich einfach.
Zunächst einmal, um eine Package-Datei zu erstellen.json muss in der Befehlszeile in den Ordner Ihres Projekts navigieren und den Befehl ausführen npm init. Danach werden Ihnen eine Reihe von Fragen gestellt, die Sie beantworten müssen. Zum Beispiel der Name Ihres Projekts, die Version, die Beschreibung und so weiter. Wenn Sie nicht alle Fragen beantworten möchten, können Sie die Flagge verwenden -y, die automatisch alle Felder mit dem Standardwert ausfüllt.
Es ist wichtig, sich daran zu erinnern, dass package.json ist eine erforderliche Datei für Projekte auf dem Node.js. Seine Verfügbarkeit ermöglicht es anderen Entwicklern, die Abhängigkeiten Ihres Projekts einfach zu installieren und zu verwenden sowie verschiedene Skriptausführungsbefehle auszuführen.
In der package-Datei.json Es gibt einige grundlegende Abschnitte, die Sie ausfüllen müssen. Einer der wichtigsten Abschnitte ist "dependencies". Dieser Abschnitt listet alle Ihre Abhängigkeiten auf, dh die Module, die Ihr Projekt verwendet. Die Liste der Abhängigkeiten sieht ungefähr so aus:
"dependencies": "express": "^4.17.1",
"lodash": "^4.17.21"
>
Auch im Paket.json hat Abschnitte für andere Abhängigkeitstypen wie "devDependencies" (Entwicklerabhängigkeiten) und "peerDependencies" (Abhängigkeiten, die auf der Ebene des übergeordneten Pakets festgelegt werden müssen). Jeder Abschnitt hat seine eigene Struktur und kann andere Felder enthalten.
Wie kann ich ein Paket einrichten?json: ein einfacher Leitfaden
Schritt 1: Erstellen Sie eine Package-Datei.json
Zunächst müssen Sie eine package-Datei erstellen.json im Stammordner Ihres Projekts. Dazu können Sie die Eingabeaufforderung verwenden und den folgenden Befehl ausführen:
npm init
Nachdem Sie diesen Befehl ausgeführt haben, werden Sie aufgefordert, einige Informationen zu Ihrem Projekt einzugeben, einschließlich Name, Version, Autor und Beschreibung. Sie können auch einige Optionen überspringen, indem Sie die Eingabetaste drücken.
Schritt 2: Hinzufügen von Abhängigkeiten
Einer der wichtigsten Parameter von package.json ist eine dependencies - Liste der Projektabhängigkeiten. Abhängigkeiten sind Pakete, die Ihr Projekt für seine Arbeit verwendet. Sie können Abhängigkeiten hinzufügen, indem Sie ihre Namen und Versionen im Feld "dependencies" der package-Datei angeben.json.
"dependencies":
Im obigen Beispiel sind express und Lodash die Namen und Versionen der Pakete, die Ihr Projekt verwenden wird. Das "^" -Zeichen vor der Version bedeutet, dass Ihr Projekt möglicherweise eine neuere Version verwendet, die mit der angegebenen Version kompatibel ist.
Schritt 3: Installieren von Abhängigkeiten
Nach dem Hinzufügen von Abhängigkeiten zum package.json Sie müssen sie so einstellen, dass sie für die Verwendung in Ihrem Projekt verfügbar sind. Verwenden Sie dazu den folgenden Befehl:
npm install
Dieser Befehl installiert alle im package angegebenen Abhängigkeiten.json, in den Ordner node_modules Ihres Projekts.
Schritt 4: Verwenden Sie package.json
Nach der Konfiguration des package.mit json können Sie damit die Abhängigkeiten Ihres Projekts verwalten. Wenn Sie eine neue Abhängigkeit hinzufügen möchten, führen Sie einfach den folgenden Befehl aus:
npm install --save
Dadurch wird das Paket installiert und im Feld "dependencies" Ihrer Package-Datei hinzugefügt.json.
Sie können Abhängigkeiten mithilfe des Befehls aktualisieren:
npm update
Dadurch werden alle Projektabhängigkeiten auf die neuesten Versionen aktualisiert, die mit den im package angegebenen kompatibel sind.json.
Jetzt haben Sie einen einfachen Leitfaden zum Einrichten von package.json. Mit dieser Datei können Sie die Abhängigkeiten Ihres Projekts einfach verwalten und sicherstellen, dass es auf jedem Computer ordnungsgemäß funktioniert.
Die Grundlagen der Package-Konfiguration.json
Folgendes sollten Sie wissen, wenn Sie ein package einrichten.json:
name: Im Feld "name" wird der Name Ihres Projekts angegeben. Es muss einzigartig sein. Es ist üblich, nur Kleinbuchstaben und Bindestriche zu verwenden.
version: Das Feld "Version" gibt die aktuelle Version Ihres Projekts an. Das Format "X.Y." wird häufig verwendet.Z", wobei X - Dur-Version, Y- Moll-Version, Z-Patch ist.
description: Im Feld "description" können Sie eine Beschreibung Ihres Projekts hinzufügen. Normalerweise wird hier eine kurze Beschreibung der Projektfunktionalität angegeben.
main: Das Feld "main" gibt den Pfad zur Hauptdatei Ihres Projekts an. Häufig wird der Wert "index" verwendet.js" oder "app.js".
scripts: Im Feld "scripts" können Sie Skripte hinzufügen, um verschiedene Aufgaben zu automatisieren. Zum Beispiel können Sie ein "Start" -Skript hinzufügen, um Ihre Anwendung zu starten.
keywords: Im Feld "Keywords" können Sie Schlüsselwörter angeben, die mit Ihrem Projekt verknüpft sind. Dies wird anderen Entwicklern helfen, Ihr Projekt leichter zu finden.
author: Im Feld "author" können Sie den Namen des Autors Ihres Projekts angeben.
license: Im Feld "Lizenz" wird die Lizenz angegeben, unter der Ihr Projekt verteilt wird.
dependencies: Im Feld "dependencies" werden die Abhängigkeiten Ihres Projekts angegeben. Hier können Sie andere Pakete angeben, die Ihr Projekt verwendet.
devDependencies: Das Feld "devDependencies" gibt Abhängigkeiten an, die nur zur Entwurfszeit verwendet werden. Dies können Tools sein, mit denen Sie Ihr Projekt entwickeln und debuggen können.
Es ist wichtig, sich daran zu erinnern, dass package.json muss sich im Stammverzeichnis Ihres Projekts befinden und muss im JSON-Format geschrieben werden.