Partager via


Gérer les packages npm dans Visual Studio

npm vous permet d’installer et de gérer des packages à utiliser dans les applications Node.js et ASP.NET Core. Visual Studio facilite l’interaction avec npm et émet des commandes npm via l’interface utilisateur ou directement. Si vous n’êtes pas familiarisé avec npm et que vous souhaitez en savoir plus, accédez à la documentation npm.

L’intégration de Visual Studio à npm est différente en fonction du type de projet.

Important

npm attend le dossier node_modules et package.json dans la racine du projet. Si la structure de dossiers de votre application est différente, vous devez modifier votre structure de dossiers si vous souhaitez gérer les packages npm à l’aide de Visual Studio.

Projet basé sur l’interface CLI (.esproj)

À compter de Visual Studio 2022, le gestionnaire de package npm est disponible pour les projets basés sur l’interface CLI. Vous pouvez donc télécharger des modules npm de la même façon que vous téléchargez des packages NuGet pour ASP.NET projets principaux. Vous pouvez ensuite utiliser package.json pour modifier et supprimer des packages.

Pour ouvrir le gestionnaire de package, à partir de l’Explorateur de solutions, cliquez avec le bouton droit sur le nœud npm dans votre projet, puis choisissez Ajouter un package npm.

Ouvrir le gestionnaire de package à partir de l’Explorateur de solutions

Ensuite, vous pouvez rechercher des packages npm, en sélectionner un et l’installer en sélectionnant Installer le package.

Installer le nouveau package npm pour esproj

projets Node.js

Pour les projets Node.js (.njsproj), vous pouvez effectuer les tâches suivantes :

Ces fonctionnalités fonctionnent ensemble et se synchronisent avec le système de projet et le fichier package.json dans le projet.

Conditions préalables

Vous avez besoin de la charge de travail de développementNode.js et du runtime Node.js installé pour ajouter la prise en charge de npm à votre projet. Pour obtenir des instructions détaillées, consultez Créer une application Node.js et Express.

Remarque

Pour les projets Node.js existants, utilisez le modèle de solution de code From existing Node.js ou le type de projet Open folder (Node.js) pour activer npm dans votre projet.

Installer des packages à partir de l’Explorateur de solutions (Node.js)

Pour Node.js projets, le moyen le plus simple d’installer les packages npm est via la fenêtre d’installation du package npm. Pour accéder à cette fenêtre, cliquez avec le bouton droit sur le nœud npm dans le projet, puis sélectionnez Installer les nouveaux packages npm.

Installer le nouveau package npm pour Node.js

Dans cette fenêtre, vous pouvez rechercher un package, spécifier des options et installer.

Capture d’écran de la boîte de dialogue Installer les nouveaux packages npm.

  • Type de dépendance : choisissez entre les packages Standard, Développement et Facultatif . Standard spécifie que le package est une dépendance d’exécution, tandis que le développement spécifie que le package n’est requis que pendant le développement.
  • Ajouter à package.json - Recommandé. Cette option configurable est déconseillée.
  • Version sélectionnée : sélectionnez la version du package que vous souhaitez installer.
  • Autres arguments npm : spécifiez d’autres arguments npm standard. Par exemple, vous pouvez entrer une valeur de version telle que @~0.8 l’installation d’une version spécifique qui n’est pas disponible dans la liste des versions.

Vous pouvez voir la progression de l’installation dans la sortie npm dans la fenêtre Sortie (pour ouvrir la fenêtre, choisir Afficher> lasortie ou appuyer sur Ctrl + Alt + O). Cela peut prendre un certain temps.

sortie npm

Conseil / Astuce

Vous pouvez rechercher des packages délimités en prédéfinissant la requête de recherche avec l’étendue qui vous intéresse, par exemple, @types/mocha pour rechercher les fichiers de définition TypeScript pour mocha. En outre, lors de l’installation de définitions de type pour TypeScript, vous pouvez spécifier la version TypeScript que vous ciblez en spécifiant une version, telle que @ts2.6, dans le champ d’argument npm.

Gérer les packages installés dans l’Explorateur de solutions (Node.js)

Les packages npm sont affichés dans l’Explorateur de solutions. Les entrées sous le nœud npm imitent les dépendances dans le fichier package.json .

Capture d’écran du nœud npm dans l’Explorateur de solutions montrant l’état d’installation des packages npm.

État du package

  • Package installé - Installé et répertorié dans package.json
  • Package superflu - Installé, mais pas explicitement répertorié dans package.json
  • Package manquant - Non installé, mais répertorié dans package.json

Cliquez avec le bouton droit sur le nœud npm pour effectuer l’une des actions suivantes :

  • Installer de nouveaux packages npm Ouvre l’interface utilisateur pour installer de nouveaux packages.
  • Installer des packages npm Exécute la commande npm install pour installer tous les packages répertoriés dans package.json. (Exécute npm install.)
  • Mettre à jour les packages npm Met à jour les packages vers les dernières versions, en fonction de la plage de version sémantique (SemVer) spécifiée dans package.json. (Exécute npm update --save.). Les plages SemVer sont généralement spécifiées à l’aide de « ~ » ou « ^ ». Pour plus d’informations, package.json configuration.

Cliquez avec le bouton droit sur un nœud de package pour effectuer l’une des actions suivantes :

  • Installer le ou les packages npm Exécute la commande npm install pour installer la version du package répertoriée dans package.json. (Exécute npm install.)
  • Mettre à jour le ou les packages npm Met à jour le package vers la dernière version, selon la plage SemVer spécifiée dans package.json. (Exécuter npm update --save.) Les plages SemVer sont généralement spécifiées à l’aide de « ~ » ou « ^ ».
  • Désinstaller le ou les packages npm Désinstalle le package et le supprime de package.json (Exécute npm uninstall --save.)

Remarque

Pour obtenir de l’aide sur la résolution des problèmes liés aux packages npm, consultez Résolution des problèmes.

Utilisez la commande .npm dans la fenêtre interactive Node.js (Node.js)

Vous pouvez également utiliser la .npm commande dans la fenêtre interactive Node.js pour exécuter des commandes npm. Pour ouvrir la fenêtre, cliquez avec le bouton droit sur le projet dans l’Explorateur de solutions, puis choisissez Ouvrir Node.js fenêtre interactive (ou appuyez sur Ctrl + K, N).

Dans la fenêtre, vous pouvez utiliser des commandes telles que les suivantes pour installer un package :

.npm install azure@4.2.3

Conseil / Astuce

Par défaut, npm s’exécute dans le répertoire de base de votre projet. Si vous avez plusieurs projets dans votre solution, spécifiez le nom ou le chemin d’accès du projet entre crochets. .npm [MyProjectNameOrPath] install azure@4.2.3

Conseil / Astuce

Si votre projet ne contient pas de fichier package.json, utilisez cette option .npm init -y pour créer un fichier package.json avec des entrées par défaut.

projets ASP.NET Principaux

Pour les projets tels que ASP.NET Projets Principaux, vous pouvez ajouter la prise en charge de npm dans votre projet et utiliser npm pour installer des packages.

Remarque

Pour ASP.NET projets principaux, vous pouvez également utiliser gestionnaire de bibliothèques ou yarn au lieu de npm pour installer des fichiers JavaScript et CSS côté client. L’une de ces options peut être nécessaire si vous avez besoin d’une intégration avec MSBuild ou de l’interface CLI dotnet pour la gestion des packages, qui n’est pas fournie par npm.

Si votre projet n’inclut pas encore de fichier package.json , vous pouvez en ajouter un pour activer la prise en charge de npm en ajoutant un fichier package.json au projet.

  1. Pour ajouter le fichier package.json , cliquez avec le bouton droit sur le projet dans l’Explorateur de solutions, puis choisissez Ajouter>un nouvel élément (ou appuyez sur Ctrl + Maj + A). Utilisez la zone de recherche pour rechercher le fichier npm, choisissez le fichier de configuration npm, utilisez le nom par défaut, puis cliquez sur Ajouter.

  2. Incluez un ou plusieurs packages npm dans la ou devDependencies la dependencies section de package.json. Par exemple, vous pouvez ajouter ce qui suit au fichier :

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

    Lorsque vous enregistrez le fichier, Visual Studio ajoute le package sous le nœud Dépendances /npm dans l’Explorateur de solutions. Si vous ne voyez pas le nœud, cliquez avec le bouton droit surpackage.json et choisissez Restaurer les packages. Pour afficher l’état d’installation du package, sélectionnez la sortie npm dans la fenêtre Sortie.

    Remarque

    Le nœud npm est disponible pour la plupart des types de projets principaux ASP.NET, y compris Blazor. Pour les projets MAUI Blazor, vous devez utiliser la ligne de commande npm, car aucun nœud npm n’est présent dans l’Explorateur de solutions.

    Vous pouvez configurer des packages npm à l’aide package.jsonde . Ouvrez package.json directement ou cliquez avec le bouton droit sur le nœud npm dans l’Explorateur de solutions, puis choisissez Ouvrir package.json.

Résolution des problèmes liés aux packages npm

  • Si vous voyez des erreurs lors de la génération de votre application ou de la transpilation du code TypeScript, recherchez les incompatibilités de package npm comme source potentielle d’erreurs. Pour identifier les erreurs, consultez la fenêtre sortie npm lors de l’installation des packages, comme décrit précédemment dans cet article. Par exemple, si une ou plusieurs versions de package npm ont été dépréciées et entraînent une erreur, vous devrez peut-être installer une version plus récente pour corriger les erreurs. Pour plus d’informations sur l’utilisation depackage.json pour contrôler les versions du package npm, consultez package.json configuration.

  • Dans certains scénarios ASP.NET Principaux, l’Explorateur de solutions peut ne pas afficher l’état correct des packages npm installés en raison d’un problème connu décrit ici. Par exemple, le package peut apparaître comme n’étant pas installé lorsqu’il est installé. Dans la plupart des cas, vous pouvez mettre à jour l’Explorateur de solutions en supprimant package.json, en redémarrant Visual Studio et en ajoutant à nouveau le fichier package.json , comme décrit précédemment dans cet article. Ou, lors de l’installation de packages, vous pouvez utiliser la fenêtre sortie npm pour vérifier l’état de l’installation.

  • Dans certains scénarios ASP.NET Principaux, le nœud npm dans l’Explorateur de solutions peut ne pas être visible après avoir généré le projet. Pour rendre le nœud visible à nouveau, cliquez avec le bouton droit sur le nœud du projet et choisissez Décharger le projet. Cliquez ensuite avec le bouton droit sur le nœud du projet, puis choisissez Recharger le projet.

  • Pour Node.js projets, vous devez disposer de la charge de travail de développementNode.js installée pour la prise en charge de npm. npm nécessite Node.js. Si vous n’avez pas Node.js installé, nous vous recommandons d’installer la version LTS à partir du site web Node.js pour une meilleure compatibilité avec les infrastructures et bibliothèques externes.