Création d'un template de projet personnalisé dans Visual Studio .Net

Si le grand nombre de templates de Visual Studio permet de remplir la plupart des besoins des développeurs, il est possible pour de nouvelles technologies ou pour optimiser le temps de travail (projet répétitif), de créer des templates totalement personnalisés. En effet, l'extensibilité de Visual Studio est quasi infinie, elle peut être réalisée à l'aide d'add-ins, de macros, ou justement des templates.

Il existe différents types de templates que vous pourrez utiliser via l'interface de Visual Studio. Nous avons les templates de projet accessibles via le menu Fichier > Nouveau > Projet et les templates d'items accessibles via le menu Projet > Ajouter un nouvel élément.
Nous nous intéresserons ici qu'aux templates de projet, le template d'item étant une version simplifiée de ce dernier.

La création d'un template de projet pour visual studio se fait en plusieurs étapes :
- la création d'un fichier VDIR (ou modification d'un fichier existant) ;
- la création d'un fichier VSZ ;
- la personnalisation des fichiers JavaScript par défaut ;
- la création des fichiers templates (source).

Ce sont ces étapes que nous verrons tout du long de cet article.

Le fichier VSDIR est un simple fichier texte avec une extension .vsdir. Il contient des informations qu'utilise Visual Studio dans les fenêtres Nouveau Projet et Ajouter Item. Ces informations sont entre autres, le nom, la description, l'icône ou même l'ordre dans lequel le template apparaîtra.

En fonction du langage dans lequel vous voudrez créer votre template, le chemin où vous placerez vos fichiers changera. Nous prendrons ici, l'exemple d'un template de projet en C# et le chemin du fichier VSDIR sera donc :
…\Microsoft Visual Studio .NET 2003\VC#\CSharpProjects

Positionnez-vous donc dans le répertoire des projets C# (CSharpProjects) puis créez un fichier texte. Remplissez avec le texte suivant (sans les sauts de ligne !!!) et renommez-le en monTemplate.vsdir.

monTemplate.vsz|{FAE04EC1-301F-11d3-BF4B-00C04F79EFBC}|
Mon template|35|Description de mon template|
{FAE04EC1-301F-11d3-BF4B-00C04F79EFBC}|8224|0|
MonTemplateDefaultName

Voici le tableau descriptif des différents champs.

Voici un schéma représentant le résultat final en fonction des champs du fichier VSDIR :

Voici maintenant le tableau récapitulatif des différents flags (drapeaux). Dans le fichier VSZ, vous devrez indiquer la somme des chiffres individuels de chaque flag. Par exemple, un champ flags égal à 9 correspondra à VSDIRFLAG_NonLocalTemplate | VSDIRFLAG_DontAddDefExtension

Il existe néanmoins quelques règles à suivre :
- les champs optionnels ne contenant aucune information doivent être remplis avec 0. Note perso : s'ils sont vides, cela marche aussi ;
- si aucun LocalizedName n'est proposé, Visual Studio utilisera le nom du chemin relatif ;
- si aucune icône n'est proposée, Visual Studio utilisera l'icône par défaut pour l'extension de ce projet ou alors utilisera une icône vide ;
- si aucun SuggestedBaseName n'est proposé, Visual Studio le remplacera par « Project ».

Nous avons vu qu'il est possible d'utiliser les icônes déjà existantes des autres templates de Visual Studio. Nous allons maintenant voir comment utiliser nos propres icônes.
Cette étape est extrêmement simple puisqu'elle nécessite simplement de mettre une icône (32*32) dans le dossier des fichiers VSDIR et l'icône doit simplement avoir le même nom que le fichier VSDIR. Ici, nous la nommerons donc : monTemplate.ico.

Note: placer une icône dans le dossier des templates outrepasse des champs d'icônes spécifiés dans le fichier VSDIR. Cette icône est prioritaire.

Le wizard utilise alors le nom du template pour trouver le dossier correspondant. Créez alors le dossier :
…\Microsoft Visual Studio .NET 2003\VC#\VC#Wizards\monTemplate
Ce nom de dossier correspond au paramètre WIZARD_NAME du fichier VSZ.

Créez maintenant le dossier contenant les scripts :
…\Microsoft Visual Studio .NET 2003\VC#\VC#Wizards\monTemplate\Scripts\1033

Ainsi que le dossier qui contiendra les fichiers templates :
…\Microsoft Visual Studio .NET 2003\VC#\VC#Wizards\monTemplate\Templates\1033

Nous allons maintenant créer le fichier JavaScript. Son fonctionnement est plus difficile que les étapes précédentes. Contentez-vous pour le moment de copier le code JavaScript ci-dessous :

function OnFinish(selProj, selObj)
{
    var oldSuppressUIValue = true;
    try
    {
        oldSuppressUIValue = dte.SuppressUI;
        var strProjectPath = wizard.FindSymbol("PROJECT_PATH");
        var strProjectName = wizard.FindSymbol("PROJECT_NAME");
        var strSafeProjectName = CreateSafeName(strProjectName);
        wizard.AddSymbol("SAFE_PROJECT_NAME", strSafeProjectName);

        var bEmptyProject = 0; //wizard.FindSymbol("EMPTY_PROJECT");

        var proj = CreateCSharpProject(strProjectName, strProjectPath, "default.csproj");

        var InfFile = CreateInfFile();
        if (!bEmptyProject && proj)
        {
            AddReferencesForClass(proj);
            AddFilesToCSharpProject(proj, strProjectName, strProjectPath, InfFile, false);
        }
    }
    catch(e)
    {
        if( e.description.length > 0 )
            SetErrorInfo(e);
        return e.number;
    }
    finally
    {
           dte.SuppressUI = oldSuppressUIValue;
           if( InfFile )
            InfFile.Delete();
    }
}

function GetCSharpTargetName(strName, strProjectName)
{
    var strTarget = strName;

    switch (strName)
    {
        case "fichier1.cs":
            strTarget = "classe1.cs";
            break;
        case "TODO.txt":
            strTarget = "TODOlist.txt";
            break;
    }
    return strTarget; 
}
        
function DoOpenFile(strName)
{
    var bOpen = false;
    
    switch (strName)
    {
        case "classe1.cs":
            bOpen = true;
            break;
        case "fichier2.cs":
            bOpen = true;
            break;
        case "TODOlist.txt":
            bOpen = false;
            break;
    }
    return bOpen; 
}

function SetFileProperties(oFileItem, strFileName)
{
    if(strFileName == "classe1.cs" || strFileName == "fichier2.cs")
    {
        oFileItem.Properties("SubType").Value = "Code";
    }
}

Ce fichier est une copie modifiée du fichier script par défaut du template de création d'un projet console.

Je pense que même pour des personnes maitrisant bien le JavaScript, ce bout de code et son fonctionnement ne sont pas forcément clairs. Voyons donc comment fonctionne ce fichier JavaScript :
1- La méthode OnFinish est appelée lorsque l'utilisateur clique sur le bouton « Finir » de la fenêtre de dialogue de création d'un nouveau projet. La méthode récupère alors différentes variables « d'environnement » passées par le wizard via Visual Studio. Nous récupérons par exemple le nom et le chemin du projet.
Toujours à l'intérieur de cette méthode, nous appelons la méthode CreateCSharpProject. Cette dernière fait partie des fonctions de base qui sont contenues dans le fichier …\Microsoft Visual Studio .NET 2003\VC#\VC#Wizards\1036\common.js
Cette méthode exécute différentes actions comme supprimer la solution déjà ouverte (si option cochée par l'utilisateur), puis création du projet à partir du nom donné dans la fenêtre de création de projets.
Il utilise alors le fichier default.csproj pour créer le projet C#. Il est possible d'utiliser votre propre fichier csproj et de le personnaliser selon vos besoins.
Enfin, la méthode AddFilesToCSharpProject, lit le fichier Templates.inf et ajoute chaque fichier qu'il contient au projet ;

2- C'est au tour de la méthode GetCSharpTargetName. Cette méthode détermine le nom final du fichier dans l'application. Note, il suffit sinon, de bien nommer les fichiers templates dès le départ :) ;

3- La méthode DoOpenFile est alors appelée. Cette méthode boucle sur tous les items du projet et ouvre chacun d'entre eux ou non. Dans notre exemple: à la création du projet, les fichiers classe1.cs et fichier2.cs sont ouverts par l'éditeur de Visual Studio tandis que TODOlist.txt ne l'est pas. ;

4- Enfin la méthode SetFileProperties est appelée. Cette dernière définit le type de fichier. Ici, nos deux fichiers sont des fichiers de code, mais nous aurions pu avoir des fichiers de type « Form » par exemple.

Passons à la création propre des templates de fichiers source.