Présentation du gestionnaire de packages .NET Nuget

La commande Get-Package permet d'effectuer la recherche du package à partir de la console de gestion de package.

"Get-Package -ListAvailable" affiche la liste de tous les packages Nuget avec leur version et une description de ceux-ci comme l'illustre l'image ci-dessous :

Pour effectuer un filtre et afficher uniquement les informations sur des packages précis, l'argument filter sera utilisé en supplément comme l'illustre l'exemple ci-dessous :

L'installation d'un package se fait avec la commande Installl-Package suivi du nom du package.

Exemple :

Install-Package EntityFramework

Lorsque cette commande est exécutée, Nuget télécharge le package à partir de la source spécifiée et l'installe automatiquement dans le projet qui est défini dans la liste déroulante " Default Project ". Si le package installé est dépendant d'autres packages, Nuget télécharge et installe également automatiquement ceux-ci.

Les fichiers téléchargés sont copiés dans un sous dossier " packages " dans votre solution/projet.

Les références à l'assembly sont ajoutées automatiquement au projet et si besoin, Nuget procède automatiquement à l'édition du fichier Web.config ou App.config pour inclure les références au package.

Et c'est tout, vous pouvez maintenant utiliser les fonctionnalités du composant dans votre application.

Vous pouvez consulter, parmi la liste des packages installés, ceux dont une mise à jour est disponible en utilisant la commande " Get-Package -Update ".

Pour mettre à jour un package dont une version plus récente est disponible en ligne, vous devez utiliser la commande Update-Package NomPackage.

Exemple :

Update-Package jQuery

Pendant une opération de mise à jour, Nuget désinstalle l'ancienne version du package et installe automatiquement la nouvelle version. Cette opération est effectuée également pour toutes les dépendances du package mis à jour.

Pour avoir la liste de tous les packages installés dans un projet, utilisez la commande Get-Package.

Pour supprimer un package, la commande Uninstall-Package suivie du nom du package doit être utilisée.

Lorsque le composant est supprimé, vous aurez le message de confirmation à l'écran.

La référence au package sera supprimée dans l'arborescence de votre explorateur de solution dans Visual Studio.

Dans la fenêtre graphique du gestionnaire de package, recherchez le composant que vous souhaitez installer en fonction de la source de packages et cliquez simplement sur le bouton installer pour lancer l'installation du package.

Pour certains composants, le processus d'installation oblige via une fenêtre de notification à accepter au préalable le contrat de licence.

Lorsque le téléchargement et l'installation de votre package sont achevés, le bouton " Install " se transforme en un check box vert pour indiquer que le package a été correctement installé.

Dans la liste des sources de packages, vous pouvez cliquer sur " Recent packages " pour visualiser les packages que vous avez installés récemment et sur " Installed packages " pour visualiser l'ensemble des packages présents dans votre projet/solution.

Si vous accédez à la fenêtre en faisant un clic droit sur votre solution, vous pouvez directement télécharger et installer un package pour tous les projets disponibles dans votre solution, ou pour certains projets de votre choix.

Lorsque vous cliquez sur le bouton Install, une fenêtre de sélection des projets dans lesquels seront installés les composants s'affiche comme l'illustre l'image ci-dessous :

Pour mettre à jour un package, ouvrez la fenêtre de gestion des packages. Dans la colonne " sources de packages ", sélectionnez " Updates ". La liste des composants installés dans votre application qui possèdent une nouvelle version en ligne s'affiche.

Sélectionnez le package que vous souhaitez mettre à jour et cliquez sur le bouton Update comme l'illustre la capture ci-dessous :

Pour supprimer un composant, dans la colonne " sources de packages ", sélectionnez " Installed packages " et cliquez sur le bouton " Uninstall ".

Si vous avez ouvert la fenêtre de gestion de packages en faisant un clic droit sur la solution, à la place du bouton " Uninstall " affiché sur les packages installés, vous aurez plutôt le bouton " Manage ", qui permet d'accéder à une fenêtre qui présente les projets de la solution dans lesquels sont installés le package.

À partir de cette fenêtre, vous pouvez désinstaller le composant dans un projet, sur tous les projets de la solution où encore l'installer dans un autre projet de la solution.

La suppression d'un package entraine la suppression de toutes les dépendances de ce package. Vous devez vous assurer lors de la suppression d'un package que les dépendances qui seront supprimées ne soient pas utilisées par un autre package ou votre projet.

Après avoir téléchargé Nuget.exe, vous devez le placer dans un dossier de votre choix. De préférence, utilisez le dossier C:\Nuget ou celui de votre projet/solution.

Maintenant, à partir de l'invite de commandes, nous allons générer dans un premier temps le fichier XML des spécifications.

Pour cela, en invite de commande, positionnez-vous dans le dossier contenant l'outil Nuget.exe et exécutez la commande suivante :

NuGet spec NomPackage

Dans le cas où vous ne fournissez pas le nom du package, le fichier de spécification sera créé avec comme nom par défaut Package.nuspec.

Le fichier de spécification est généré par défaut à la racine du dossier contenant le fichier Nuget.exe. Vous pouvez lors de la création de ce fichier, spécifier dans quel dossier vous souhaitez que celui-ci soit créé.

Le fichier XML généré contient par défaut les informations suivantes :

<?xml version="1.0"?>
<package >
  <metadata>
    <id>MyPackage</id>
    <version>1.0</version>
    <authors>Author here</authors>
    <owners>Owner here</owners>
    <licenseUrl>http://LICENSE_URL_HERE_OR_DELETE_THIS_LINE</licenseUrl>
    <projectUrl>http://PROJECT_URL_HERE_OR_DELETE_THIS_LINE</projectUrl>
    <iconUrl>http://ICON_URL_HERE_OR_DELETE_THIS_LINE</iconUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>Package description</description>
    <copyright>Copyright 2011</copyright>
    <tags>Tag1 Tag2</tags>
    <dependencies>
      <dependency id="SampleDependency" version="1.0" />
    </dependencies>
  </metadata>
</package>

V-A-1-a. Description du fichier de spécification▲

<?xml version="1.0"?>
<package >
  <metadata>
    <id>MyNugetPackage</id>
    <version>1.0</version>
    <authors>Romaric</authors>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>Mon premier package Nuget</description>
    <copyright>Copyright 2011</copyright>
  </metadata>
</package>

Après avoir créé et édité le fichier de spécification, nous pouvons maintenant générer le package Nuget.

Pour cela, en invite de commandes, nous allons exécuter la commande suivante :

Nuget pack fichierspecification.nuspec

Le fichier de package .nupkg sera créé à la racine du dossier contenant Nuget.exe avec comme nom par défaut l'ID du package concaténé au numéro de version renseigné dans le fichier de spécification. Copiez le fichier .nupkg généré à la racine du dossier contenant votre application.

Vous pouvez également spécifier l'emplacement ou sera créé le fichier de package (directement dans votre projet par exemple) en utilisant l'argument -o.

Exemple :

Nuget pack c:\MyNugetPackage\Mypackage.nuspec -o c:\MyNugetPackage\

Maintenant que nous avons créé notre package Nuget, comment allons-nous procéder pour le publier afin qu'il soit téléchargeable directement à partir d'un EDI (VS 2010, WebMatrix, etc.) prenant en charge Nuget.

A ce stade, nous avons deux possibilités :

• soit nous créons un dépôt spécifique de notre package avec sa propre source ;
• soit nous le référençons comme un dépôt officiel Nuget.

Nous verrons tout d'abord comment définir un dépôt spécifique de notre package. Dans la section suivante, nous reviendrons sur l'autre méthode.

Nous allons tout d'abord copier notre package dans un dossier local (pour une utilisation par exemple uniquement en local dans vos projets et par votre équipe de développeurs) ou sur un serveur distant.

Pour toute utilisation du package dans un projet avec Visual Studio, il suffira simplement de renseigner la source en procèdent comme suit : lancez Visual Studio, allez dans les options de l'EDI, dans la catégorie "Package Manager", ajoutez l'adresse de votre projet à la liste.

Validez ensuite sur OK.

Pour utiliser votre package, lancez la fenêtre d'administrations de Nuget en faisant simplement un clic droit sur votre projet/solution et en sélectionnant la commande Manage Nuget Packages.

Sélectionnez ensuite Online Package et cliquez sur le nom de la source que vous avez donné à votre package.

Après son installation, l'interface utilisateur suivante est affichée :

Cliquez sur la ligne " Create a new package ", pour créer votre package Nuget.

Le package est créé avec comme Meta données par défaut, des informations reprises directement depuis votre système.

Cliquez sur le menu " Edit ", ensuite sur " Edit Package Metadata " pour accéder à la fenêtre d'édition du package.

L'interface suivante s'affiche avec un formulaire qui vous permettra de renseigner les informations sur votre package.

Pour la description de ces informations, voir la section sur Nuget.exe.

Comme vous pouvez le constater, les informations importantes qu'il faut renseigner sont en gras. Lorsque vous avez achevé cette étape, validez votre saisie en cliquant sur le bouton OK.

Maintenant, nous allons définir le contenu de notre package Nuget.

Pour cela, nous allons cliquer sur le menu " Content " ensuite sur " Add ".

Dans le sous-menu qui s'affiche, nous allons dans un premier temps définir les dossiers que nous allons utiliser.

Nuget reconnait par défaut les dossiers : Content (pour les fichiers qui seront copiés à la racine de l'application lors de l'installation du package), Lib (pour les DLL) et Tools (pour les scripts PowerShell associés au package).

Pour notre cas, nous allons créer le dossier Lib pour les librairies constituant notre package Nuget.

En faisant un clic droit sur ce dossier, nous avons la possibilité de définir plusieurs sous dossiers en fonction des versions de notre plateforme de développement (ASP.NET, Silverlight, Windows Phone, etc.).

Supposons que notre DLL cible la version 4.0 du Framework .NET, nous allons créer un dossier net40. Nous allons ensuite faire un clic droit sur ce dossier et dans le menu contextuel qui s'affiche, nous allons cliquer sur " Add Existing File… ".

Nous allons ensuite rechercher notre fichier et l'ajouter comme contenu de notre package.

Nous pouvons également par un simple glisser/déposer sur l'espace de travail " Package contents ", ajouter un contenu à notre package.

Nous devons maintenant enregistrer nos informations en utilisant le raccourci clavier " Ctrl + S " ou le menu Fichier/Enregistrer.

Et c'est tout, il ne nous reste plus qu'à publier notre package.

Ce paragraphe décrit la seconde méthode qui consiste en la publication de son dépôt Nuget sur la galerie officielle Nuget.

Pour cela, nous allons cliquer sur la commande " Publish " du menu fichier.

La fenêtre qui s'affiche nous demande de renseigner notre clé de publication.

Nous pouvons obtenir cette information en nous inscrivant sur le site de la " NuGet Gallery" à partir de ce lien.

Et voilà, nous venons de créer et publier notre package Nuget sur la galerie officielle du projet.

Votre compte va vous permettre de gérer (édition, suppression, etc.) vos différents dépôts sur la galerie Nuget.

Si vous ne souhaitez pas publier votre dépôt sur la galerie officielle, exporter simplement celui-ci en utilisant la commande Export du menu Fichier, et copier le dossier qui sera généré à l'emplacement de votre choix.