Photo par pxhere.com

Créer votre propre template de projet Xamarin

Démarrer plus vite votre projet grâce à .Net Core !

Posted by Damien Aicheh on June 12, 2018 · 4 mins

Après de nombreux projets, vous avez probablement remarqué que vous utilisez toujours les mêmes Nugets packages, une structure de projet souvent similaire, vos propres classes d’extension, la même configuration pour la connexion à votre base de données… Toutes ces choses qui vous aident à construire votre projet plus facilement.

Ce travail s’avére être répétitif, ennuyeux et une perte de temps. Dans ce tutoriel nous allons donc voir comment créér facilement notre propre template de projet que nous pourrons ensuite utiliser à chaque démarrage de nouveau projet Xamarin.

Préparation

Notre template

Tout d’abord, il nous faut créer un nouveau projet Xamarin (Forms et/ou Native) et le configurer avec tous ce qui nous permettra ensuite de débuter un nouveau projet sans perte de temps. Le mien s’appelera Template.Xam. Une fois que ce projet est prêt nous pouvons passer à l’étape suivante.

Installer .Net Core

Pour générer notre template, il nous faut dans un premier temps installer .Net Core SDK.

Quelques commandes de base :

Ouvrons un terminal de commandes, et si tout s’est installé correctement, il nous est possible de véifier la version installée grâce à la commande :

dotnet --version

Pour consulter les templates disponibles, il suffit de lancer la commande :

dotnet new -l

Installation de notre template

Maintenant, il est temps de paramêtrer notre projet Template.Xam afin de pouvoir grâce à dotnet générer nos futurs projets.

Configuration du template

Nous devons créer à la racine de notre projet un dossier appelé .template.config. Dans ce dossier, nous créons un fichier de configuration pour notre template appelé template.json.

Voici la configuration à ajouter dans ce fichier :

{
    "$schema": "http://json.schemastore.org/template",
    "author": "Damien Aicheh",
    "classifications": [ "Xamarin" ],
    "identity": "MyXamarinTemplateProject",
    "shortName": "MyXamarinTemplate",
    "name": "Starter project for my Xamarin applications",
    "tags": {
	    "language": "C#",
	    "type": "project"
	  },
    "sourceName": "Template.Xam",
    "preferNameDirectory": true
}

Le résumé des différentes clés de ce JSON est le suivant :

shortName : C’est le nom de notre template que nous verrons dans la liste des templates disponibles. Cette clé sera utilisée pour générer notre projet, il vaut donc mieux garder sa valeur simple.
sourceName : Cela doit correspondre au nom de notre template : Template.Xam, ce nom sera remplacé par le générateur avec le nom du projet généré.
name : Cela correspond à la description du template que nous verrons dans la liste des templates disponibles.

Une fois la configuration du template faite, il faut l’installer :

dotnet new --install ./path/to/Template.Xam

Si tout s’est bien passé, le template est visible dans la liste des templates disponibles.

Géneration d’un nouveau projet

Nous pouvons donc générer un nouveau projet avec la ligne de commande suivante :

dotnet new MyXamarinTemplate -o MyProjectName

Happy coding !

N'hésitez pas à me suivre sur pour ne pas rater mon prochain tutoriel !