Freigeben über


Verwalten von npm-Paketen in Visual Studio

npm ermöglicht es Ihnen, Pakete für die Verwendung in Node.js- und ASP.NET Core-Anwendungen zu installieren und zu verwalten. Visual Studio erleichtert die Interaktion mit npm und das Ausgeben von npm-Befehlen über die Benutzeroberfläche oder direkt. Wenn Sie mit npm nicht vertraut sind und mehr erfahren möchten, wechseln Sie zur npm-Dokumentation.

Die Visual Studio-Integration in npm unterscheidet sich je nach Projekttyp.

Von Bedeutung

npm erwartet den ordner node_modules und package.json im Projektstamm. Wenn sich die Ordnerstruktur Ihrer App unterscheidet, sollten Sie die Ordnerstruktur ändern, wenn Sie npm-Pakete mit Visual Studio verwalten möchten.

CLI-basiertes Projekt (.esproj)

Ab Visual Studio 2022 ist der npm-Paket-Manager für CLI-basierte Projekte verfügbar, sodass Sie npm-Module jetzt ähnlich herunterladen können, wie Sie NuGet-Pakete für ASP.NET Core-Projekte herunterladen. Anschließend können Sie package.json verwenden, um Pakete zu ändern und zu löschen.

Um den Paket-Manager zu öffnen, klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den npm-Knoten in Ihrem Projekt, und wählen Sie "npm-Paket hinzufügen" aus.

Paket-Manager im Projektmappen-Explorer öffnen

Als Nächstes können Sie nach npm-Paketen suchen, eines auswählen und installieren, indem Sie "Paket installieren" auswählen.

Installieren des neuen npm-Pakets für esproj

Node.js Projekte

Für Node.js Projekte (.njsproj) können Sie die folgenden Aufgaben ausführen:

Diese Features arbeiten zusammen und synchronisieren mit dem Projektsystem und der package.json Datei im Projekt.

Voraussetzungen

Sie benötigen die Node.js-Arbeitslast und müssen die Node.js-Laufzeit installiert haben, um npm-Unterstützung zu Ihrem Projekt hinzuzufügen. Ausführliche Schritte finden Sie unter Erstellen einer Node.js- und Express-App.

Hinweis

Verwenden Sie für vorhandene Node.js-Projekte die Vorlage 'Aus vorhandenem Node.js-Code' oder den Projekttyp 'Ordner öffnen (Node.js)', um npm in Ihrem Projekt zu aktivieren.

Installieren von Paketen aus dem Projektmappen-Explorer (Node.js)

Bei Node.js Projekten besteht die einfachste Möglichkeit zum Installieren von npm-Paketen im npm-Paketinstallationsfenster. Um auf dieses Fenster zuzugreifen, klicken Sie mit der rechten Maustaste auf den npm-Knoten im Projekt, und wählen Sie "Neue npm-Pakete installieren" aus.

Installieren des neuen npm-Pakets für Node.js

In diesem Fenster können Sie nach einem Paket suchen, Optionen angeben und installieren.

Screenshot des Dialogfelds

  • Abhängigkeitstyp – Wählen Sie zwischen Standard-, Entwicklungs- und optionalen Paketen aus. Standard gibt an, dass das Paket eine Laufzeitabhängigkeit ist, während Development angibt, dass das Paket nur während der Entwicklung erforderlich ist.
  • Zu package.json hinzufügen – Empfohlen. Diese konfigurierbare Option ist veraltet.
  • Ausgewählte Version – Wählen Sie die Version des Pakets aus, das Sie installieren möchten.
  • Andere npm-Argumente – Geben Sie andere standard npm-Argumente an. Sie können z. B. einen Versionswert wie @~0.8 eingeben, um eine bestimmte Version zu installieren, die in der Versionsliste nicht verfügbar ist.

Sie können den Fortschritt der Installation in der npm-Ausgabe im Ausgabefenster sehen (um das Fenster zu öffnen, wählen Sie "Ausgabe anzeigen">aus, oder drücken Sie STRG + ALT + O). Dies kann einige Zeit dauern.

npm-Ausgabe

Tipp

Sie können nach bereichsbezogenen Paketen suchen, indem Sie die Suchabfrage mit dem Bereich ausstellen, an dem Sie interessiert sind, z. B. eingeben @types/mocha , um nach TypeScript-Definitionsdateien für Mocha zu suchen. Außerdem können Sie beim Installieren von Typdefinitionen für TypeScript die TypeScript-Version, auf die Sie abzielen, angeben, indem Sie beispielsweise eine Version wie @ts2.6 im npm-Argumentfeld spezifizieren.

Verwalten von installierten Paketen im Projektmappen-Explorer (Node.js)

npm-Pakete werden im Projektmappen-Explorer angezeigt. Die Einträge unter dem npm-Knoten imitieren die Abhängigkeiten in der package.json Datei.

Screenshot des npm-Knotens im Lösungs-Explorer, der den Installationsstatus der npm-Pakete zeigt.

Paketstatus

  • Installiertes Paket – installiert und in package.json aufgeführt
  • Extraneous package - Installiert, aber nicht ausdrücklich in der package.json aufgeführt
  • Fehlendes Paket – nicht installiert, aber in package.json aufgeführt

Klicken Sie mit der rechten Maustaste auf den npm-Knoten , um eine der folgenden Aktionen auszuführen:

  • Installieren neuer npm-Pakete Öffnet die Benutzeroberfläche, um neue Pakete zu installieren.
  • Installieren von npm-Paketen Führt den npm-Installationsbefehl aus, um alle pakete zu installieren, die inpackage.jsonaufgeführt sind. (Führt npm install aus.)
  • Aktualisieren von npm-Paketen Aktualisiert Pakete auf die neuesten Versionen gemäß dem semantischen Versionsverwaltungsbereich (SemVer), der in package.jsonangegeben ist. (Führt npm update --save aus.) SemVer-Bereiche werden in der Regel mit "~" oder "^" angegeben. Weitere Informationen finden Sie in der package.json Konfiguration.

Klicken Sie mit der rechten Maustaste auf einen Paketknoten, um eine der folgenden Aktionen auszuführen:

  • Installieren von npm-Paketen Führt den npm-Installationsbefehl aus, um die paketversion zu installieren, die in package.jsonaufgeführt ist. (Führt npm install aus.)
  • Aktualisieren von npm-Paketen Aktualisiert das Paket entsprechend dem in package.jsonangegebenen SemVer-Bereich auf die neueste Version. (Run npm update --save.) SemVer-Bereiche werden in der Regel mit "~" oder "^" angegeben.
  • Deinstallieren von npm-Paketen Deinstalliert das Paket und entfernt es aus package.json (Runs npm uninstall --save.)

Hinweis

Hilfe zum Beheben von Problemen mit npm-Paketen finden Sie unter "Problembehandlung".

Verwenden Sie den NPM-Befehl im Node.js interaktiven Fenster (Node.js)

Sie können auch den .npm Befehl im Node.js interaktives Fenster verwenden, um npm-Befehle auszuführen. Klicken Sie zum Öffnen des Fensters im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt, und wählen Sie "Node.js interaktives Fenster öffnen" aus (oder drücken Sie STRG + K, N).

Im Fenster können Sie Befehle wie die folgenden verwenden, um ein Paket zu installieren:

.npm install azure@4.2.3

Tipp

Standardmäßig wird npm im Startverzeichnis Ihres Projekts ausgeführt. Wenn In Ihrer Projektmappe mehrere Projekte vorhanden sind, geben Sie den Namen oder den Pfad des Projekts in Klammern an. .npm [MyProjectNameOrPath] install azure@4.2.3

Tipp

Wenn Ihr Projekt keine package.json-Datei enthält, verwenden Sie .npm init -y, um eine neue package.json-Datei mit Standardeinträgen zu erstellen.

ASP.NET Kernprojekte

Für Projekte wie ASP.NET Core-Projekte können Sie npm-Unterstützung in Ihrem Projekt hinzufügen und npm zum Installieren von Paketen verwenden.

Hinweis

Für ASP.NET Core-Projekte können Sie auch Bibliotheks-Manager oder Yarn anstelle von npm verwenden, um clientseitige JavaScript- und CSS-Dateien zu installieren. Eine dieser Optionen kann erforderlich sein, wenn Sie eine Integration mit MSBuild oder der dotnet CLI für die Paketverwaltung benötigen, die von npm nicht bereitgestellt wird.

Wenn Ihr Projekt noch keine package.json Datei enthält, können Sie eine hinzufügen, um die npm-Unterstützung zu aktivieren, indem Sie dem Projekt eine package.json Datei hinzufügen.

  1. Um die package.json-Datei hinzuzufügen, klicken Sie mit der rechten Maustaste im Projektmappen-Explorer auf das Projekt und wählen Sie Hinzufügen>Neues Element aus (oder drücken Sie Ctrl + UMSCHALT + A). Verwenden Sie das Suchfeld, um die npm-Datei zu finden, wählen Sie die npm-Konfigurationsdateiaus, verwenden Sie den Standardnamen, und klicken Sie auf Hinzufügen.

  2. Schließen Sie ein oder mehrere npm-Pakete in den dependencies- oder devDependencies-Abschnitt von package.json ein. Beispielsweise können Sie der Datei Folgendes hinzufügen:

    "devDependencies": {
       "gulp": "4.0.2",
       "@types/jquery": "3.5.29"
    }
    

    Wenn Sie die Datei speichern, fügt Visual Studio das Paket unter dem Knoten "Abhängigkeiten/npm" im Projektmappen-Explorer hinzu. Wenn der Knoten nicht angezeigt wird, klicken Sie mit der rechten Maustaste auf package.json , und wählen Sie "Pakete wiederherstellen" aus. Um den Installationsstatus des Pakets anzuzeigen, wählen Sie die npm-Ausgabe im Ausgabefenster aus.

    Hinweis

    Der npm-Knoten ist für die meisten ASP.NET Core-Projekttypen verfügbar, einschließlich Blazor. Für MAUI Blazor-Projekte müssen Sie die npm-Befehlszeile verwenden, da im Projektmappen-Explorer kein npm-Knoten vorhanden ist.

    Mit package.json können Sie npm-Pakete konfigurieren. Öffnen Sie package.json direkt oder klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den npm-Knoten und wählen Sie „package.json öffnen“ aus.

Problembehandlung bei npm-Paketen

  • Wenn beim Erstellen ihrer App oder beim Transpilieren von TypeScript-Code Fehler auftreten, überprüfen Sie, ob npm-Paketkompatibilitäten als potenzielle Fehlerquelle vorliegen. Um Fehler zu erkennen, überprüfen Sie das npm-Ausgabefenster bei der Installation der Pakete, wie zuvor in diesem Artikel beschrieben. Wenn beispielsweise mindestens eine npm-Paketversion veraltet ist und zu einem Fehler führt, müssen Sie möglicherweise eine neuere Version installieren, um Fehler zu beheben. Informationen zur Verwendung vonpackage.json zum Steuern von npm-Paketversionen finden Sie unter package.json Konfiguration.

  • In einigen ASP.NET Kernszenarien zeigt der Projektmappen-Explorer möglicherweise aufgrund eines bekannten Problems, das hier beschrieben wurde, möglicherweise nicht den richtigen Status für installierte npm-Pakete an. Beispielsweise kann das Paket bei der Installation als nicht installiert angezeigt werden. In den meisten Fällen können Sie den Projektmappen-Explorer aktualisieren, indem Sie package.jsonlöschen, Visual Studio neu starten und die package.json Datei wie weiter oben in diesem Artikel beschrieben erneut hinzufügen. Alternativ können Sie beim Installieren von Paketen das npm-Ausgabefenster verwenden, um den Installationsstatus zu überprüfen.

  • In einigen ASP.NET Kernszenarien ist der npm-Knoten im Projektmappen-Explorer nach dem Erstellen des Projekts möglicherweise nicht sichtbar. Um den Knoten wieder sichtbar zu machen, klicken Sie mit der rechten Maustaste auf den Projektknoten, und wählen Sie "Projekt entladen" aus. Klicken Sie dann mit der rechten Maustaste auf den Projektknoten, und wählen Sie "Projekt erneut laden" aus.

  • Für Node.js-Projekte müssen Sie das Node.js-Entwicklungspaket für die npm-Unterstützung installiert haben. npm erfordert Node.js. Wenn Sie Node.js nicht installiert haben, empfehlen wir, die LTS-Version von der Node.js Website zu installieren, um optimale Kompatibilität mit externen Frameworks und Bibliotheken zu erzielen.