Dot.Blog

C#, XAML, Xamarin, UWP/Android/iOS

Les papiers des lecteurs : Créer un template UAP (UWP) en VSIX pour Visual Studio

Inaugurée en 2014 la rubrique “Les papiers des lecteurs” permet aux fidèles lecteurs de Dot.Blog de publier ici leur articles ! Aujourd’hui Philippe Matray va nous expliquer comment créer des templates VS 2015 packagés en VSIX pour en simplifier l’installation dans l’EDI !

Les papiers des lecteurs

Tout le monde n’a pas forcément l’envie ou le temps d’alimenter un blog comme Dot.Blog avec une moyenne de 100 articles par an depuis 8 ans, des livres, etc. Mais j’en suis convaincu, tous les lecteurs ont des connaissances uniques, un savoir-faire, un truc qu’ils aiment et dont ils sont tout à fait capable de parler en quelques paragraphes

“Les papiers des lecteurs” est votre rubrique. Si vous avez une idée, l’envie de partager un truc, une astuce, ou  beaucoup plus sans pour autant vouloir créer un Blog avec tout ce que cela sous-entend, Dot.Blog vous offre la possibilité de publier vos papiers !

Comme vous le savez Dot.Blog fonctionne sans aucune publicité, je n’en tire aucun bénéfice autre que le plaisir de partager avec les autres une même passion. En publiant sur Dot.Blog vous n’alimenterez pas les caisses d’un site à votre dépens (si si, ça existe mais vous en connaissez déjà les noms…), vous partagerez tout aussi gratuitement votre connaissance, juste pour le plaisir !

Inaugurée pour les TechDays 2014 avec notre “envoyée spéciale” Alice Barralon (Que retenir des Techdays  2014 ?), j’ai envie de donner encore plus de vie à cette rubrique en lui donnant un nom et en faisant cet appel à tous ! Hier Alice, aujourd’hui Philippe, demain : vous ? ! Ne soyez pas timides on a tous quelque chose à partager !

Créer des templates VSIX avec Visual Studio 2015

Un article de Philippe Matray.

UWP, bien que très prometteuse, est une plateforme jeune. Elle est la dernière-née du fastueux mariage entre C# et XAML qui a donné naissance à des technologies incroyables telles que WPF, WinRT et le regretté Silverlight parti malheureusement trop jeune.

Comme toutes les jeunes plateformes, celle-ci a besoin d’outils divers afin de rendre le développeur plus productif.

Nous avons vu que créer un template est très facile mais comment le partager avec toute son équipe ? Comment le rendre disponible à tout le monde ? Et bien, Microsoft a pensé à tout.

Visual Studio SDK

Le kit de développement Visual Studio SDK s’installe en même que Visual Studio si vous avez coché la case pendant son installation. Si ce n’est pas le cas, pas de panique, il vous suffit d’aller dans le menu « Ajouter ou Supprimer un programme », de sélectionner Visual Studio et de cliquer sur le bouton modifier pour ajouter le SDK.

Création d’un template

MSDN nous donne la marche à suivre.

Commençons par ouvrir Visual Studio et créons un projet qui nous servira de modèle. Pour l’exemple, le projet que je créé est une Split View App UWP exploitant MVVM Light dans sa dernière version (5.2).

Editons-le jusqu’à ce qu’il soit propre au point d’être exportable en tant que template.

Créer un template est extrêmement simple. Une fois votre projet créé, un petit tour dans File > Export template… ouvrira le wizard suivant :

9

À partir de ce wizard, choisissez « Project template » et sélectionnez le projet que vous souhaitez exporter.

Sur la page suivante, il vous est demandé d’indiquer un nom pour votre template, une description de celui-ci, une photo pour la miniature et une seconde photo pour l’aperçu.

4

(Rappel : clic pour une vue à 100%)

Au terme de cette boite de dialogue, vous aurez à disposition un fichier zip qui est déjà un template exploitable. Mais on peut faire mieux et plus facilement partageable…

Gardez-le donc précieusement nous allons l’empaqueter dans un VSIX afin de pouvoir l’installer sur d’autres machines et/ou de le partager avec vos amis et collègues.

 

3

[NdlR]Il me semble bien en effet que le processus installe en même temps le template dans VS. Lorsqu’on créée ensuite le VSIX il est donc inutile d’installer à nouveau celui-ci sur la machine ayant servie à créer le template Zip.[fin de note]

Création du VSIX

Encore une fois MSDN nous mâche la besogne.

Désormais nous pouvons créer un second projet dans la solution de type VSIX Project. Ce type de projet est localisé sous Templates > Visual C# > Extensibility.

8

Déplacez le zip créé précédemment dans ce nouveau projet. Cliquez ensuite dessus et à la ligne « Copy to output Directory » des propriétés du fichier, sélectionnez l’option Copy Always.

Ouvrez ensuite le fichier vsixmanifest. Un designer s’ouvre et vous demande de renseigner le nom de votre extension, un identifiant unique pour celle-ci, votre nom, une description du plugin (pour faire simple, reprenez la même).

La licence s’enregistre dans un fichier texte et n’est pas obligatoire. Pour mon exemple, je me suis basé sur la MS-PL dont le texte est consultable ici.

http://directory.fsf.org/wiki/License:MsPL

Enfin, dans la section Assets, ajoutez un élément de type Microsoft.VisualStudio.ProjectTemplate et ciblez le chemin du fichier zip que vous avez ajouté à ce projet.

Vous pouvez maintenant sauver et fermer le fichier vsixmanifest, compilez le projet et récupérez votre fichier .vsix dans le répertoire de build.

Ca y est, vous disposez enfin d’un fichier .vsix partageable avec vos amis et vos collègues mais nous n’allons pas nous arrêter en si bon chemin et allons le rendre disponible sur internet.

1

2

Publication sur VisualStudioGallery

Un paquet VSIX peut être publié sur Visual Studio Gallery. Un bouton permettant l’upload est présent à partir de la page d’accueil.

https://visualstudiogallery.msdn.microsoft.com/

Un simple formulaire se présente à vous. Un fois votre paquet uploadé, la plupart des informations extraite de votre paquet seront renseignées.

 

5

 

Une fois uploadé, vous aurez la joie de constater que votre extension est directement accessible à la communauté à partir de la page d’accueil de la galerie.

7

Dans notre métier, développer n’est pas le seul élément plaisant. Le partage est lui aussi très enrichissant. Cela fait des années que je suis DotBlog et c’est en grande partie grâce à ses lignes que j’ai pu m’améliorer.

Bénéficier des efforts d’autrui gratuitement m’a incité à donner de mon temps à la communauté afin de rendre le travail de chacun plus agréable. VisualStudio Gallery symbolise parfaitement l’appartenance à une communauté.

Conclusion

Comme il a été vu dans un article précédent, créer un template est aisé et permet de simplifier le travail d’un développeur en lui faisant gagner du temps.

Ce gain de temps peut être étendu à toute une équipe de par la création d’un VSIX.

Enfin, le site Visual Studio Gallery permet d’offrir ce gain de temps à toute la communauté exploitant Visual Studio. N’hésitez-pas à proposer vos propres extensions, à en télécharger de nouvelles, à participer aux reviews de celles-ci. Bref faites vivre la communauté.

Bon dev et… comme dirait Olivier…

Stay Tuned !

[NdlR : je n’ai vraiment plus rien à ajouter ! Si : Merci Philippe ! Et merci d’avance à tous les lecteurs qui oseront se lancer comme lui !]

blog comments powered by Disqus