Déploiement MSI et VSIX d'un langage spécifique à un domaine

Article
06/19/2023

Vous pouvez installer un langage spécifique à un domaine sur votre propre ordinateur ou sur d’autres ordinateurs. Visual Studio doit déjà être installé sur l’ordinateur cible.

Choix entre le déploiement VSIX et MSI

Il existe deux méthodes de déploiement d’un langage spécifique à un domaine :

Méthode	Avantages
VSX (Visual Studio Extension)	Très facile à déployer : copiez et exécutez le fichier .vsix à partir du projet DslPackage. Pour plus d’informations, consultez Installation et désinstallation d’un DSL en utilisant l’extension VSX.
MSI (fichier de programme d’installation)	- Permet à l’utilisateur d’ouvrir Visual Studio en double-cliquant sur un fichier DSL. - Associe une icône au type de fichier DSL sur l’ordinateur cible. - Associe un XSD (schéma XML) au type de fichier DSL. Cela évite les avertissements lors du chargement du fichier dans Visual Studio. Vous devez ajouter un projet d’installation à votre solution pour créer un MSI. Pour plus d’informations, consultez Déploiement d’un DSL à l’aide d’un fichier MSI.

Méthode

Avantages

VSX (Visual Studio Extension)

Très facile à déployer : copiez et exécutez le fichier .vsix à partir du projet DslPackage.

Pour plus d’informations, consultez Installation et désinstallation d’un DSL en utilisant l’extension VSX.

MSI (fichier de programme d’installation)

- Permet à l’utilisateur d’ouvrir Visual Studio en double-cliquant sur un fichier DSL.
- Associe une icône au type de fichier DSL sur l’ordinateur cible.
- Associe un XSD (schéma XML) au type de fichier DSL. Cela évite les avertissements lors du chargement du fichier dans Visual Studio.

Vous devez ajouter un projet d’installation à votre solution pour créer un MSI.

Pour plus d’informations, consultez Déploiement d’un DSL à l’aide d’un fichier MSI.

Installer et désinstaller un DSL en utilisant l’extension VSX

Quand votre DSL est installé par cette méthode, l’utilisateur peut ouvrir un fichier DSL à partir de Visual Studio, mais il ne peut pas l’ouvrir à partir de l’Explorateur Windows.

Pour installer un DSL en utilisant l’extension VSX

Recherchez le fichier .vsix qui a été généré par votre projet de package DSL :
1. Dans l’Explorateur de solutions, cliquez avec le bouton droit sur le projet DslPackage, puis cliquez sur Ouvrir le dossier dans l’Explorateur de fichiers.
2. Recherchez le fichier bin\*\VotreProjet.DslPackage.vsix
Copiez le fichier .vsix sur l’ordinateur cible sur lequel vous souhaitez installer le DSL. Il peut s’agir de votre propre ordinateur ou d’un autre.
- L’ordinateur cible doit être doté d’une édition de Visual Studio qui prend en charge les DSL au moment de l’exécution. Pour plus d’informations, consultez Éditions de Visual Studio prises en charge pour le Kit de développement logiciel (SDK) Visualization et Modeling.
- L’ordinateur cible doit être doté d’une édition de Visual Studio spécifiée dans DslPackage\source.extensions.manifest.
Sur l’ordinateur cible, double-cliquez sur le fichier .vsix.

LeProgramme d’installation des extensions Visual Studio s’ouvre et installe l’extension.
Démarrez ou redémarrez Visual Studio.
Pour tester le DSL, utilisez Visual Studio pour créer un fichier avec l’extension que vous avez définie pour votre DSL.

Pour désinstaller un DSL qui a été installé en utilisant l’extension VSX

Dans le menu Outils , choisissez Extensions et mises à jour.
Développez Extensions installées.
Sélectionnez l’extension dans laquelle le DSL est défini, puis cliquez sur Désinstaller.

Exceptionnellement, une extension défaillante ne parvient pas à se charger et crée un rapport dans la fenêtre d’erreur, mais ne s’affiche pas dans le Gestionnaire d’extensions. Dans ce cas, vous pouvez supprimer l’extension en supprimant le fichier de l’emplacement suivant :

LocalAppData\Microsoft\VisualStudio\10.0\Extensions

Déploiement d’un DSL dans un MSI

En définissant un fichier MSI (Windows Installer) pour votre DSL, vous pouvez permettre aux utilisateurs d’ouvrir les fichiers DSL à partir de l’Explorateur Windows. Vous pouvez aussi associer une icône et une brève description à votre extension de nom de fichier. De plus, le MSI peut installer un XSD permettant de valider des fichiers DSL. Si vous le souhaitez, vous pouvez ajouter d’autres composants au MSI qui s’installeront en même temps.

Pour plus d’informations sur les fichiers MSI et les autres options de déploiement, consultez Déploiement d’applications, de services et de composants.

Pour générer un MSI, ajoutez un projet d’installation à votre solution Visual Studio. Pour créer un projet d’installation, la méthode la plus simple consiste à utiliser le modèle CreateMsiSetupProject.tt, que vous pouvez télécharger à partir du site VMSDK.

Pour déployer un DSL dans une MSI

Définissez InstalledByMsi dans le manifeste de l’extension. Cela empêche le VSX d’être installé et désinstallé, sauf par le MSI. Cela est important si vous voulez inclure d’autres composants dans la MSI.
1. Ouvrez DslPackage\source.extension.tt
2. Insérez la ligne suivante avant <SupportedProducts> :
```
<InstalledByMsi>true</InstalledByMsi>
```
Créez ou modifiez une icône qui représentera votre DSL dans l’Explorateur Windows. Par exemple, modifiez DslPackage\Resources\File.ico
Vérifiez que les attributs suivants de votre DSL sont corrects :
- Dans l’Explorateur DSL, cliquez sur le nœud racine puis, dans la fenêtre Propriétés, examinez les éléments suivants :
  - Description
  - Version
- Cliquez sur le nœud Éditeur puis, dans la fenêtre Propriétés, cliquez sur Icône. Définissez la valeur pour référencer un fichier d’icône dans DslPackage\Resources, par exemple File.ico
- Dans le menu Générer, ouvrez Gestionnaire de configurations, puis sélectionnez la configuration que vous souhaitez générer, par exemple Mise en production ou Débogage.
Accédez à la page d’accueil de Visualization and Modeling SDK puis, sous l’onglet Téléchargements, téléchargez CreateMsiSetupProject.tt.
Ajoutez CreateMsiSetupProject.tt à votre projet DSL.

Visual Studio crée un fichier nommé CreateMsiSetupProject.vdproj.
Dans l’Explorateur Windows, copiez Dsl\*.vdproj dans un nouveau dossier nommé Setup.

(Si vous le souhaitez, vous pouvez maintenant exclure CreateMsiSetupProject.tt de votre projet DSL.)
Dans l’Explorateur de solutions, ajoutez Setup\*.vdproj comme projet existant.
Dans le menu Projet, choisissez Dépendances du projet.

Dans la boîte de dialogue Dépendances du projet, sélectionnez le projet d’installation.

Cochez la case en regard de DslPackage.
Régénérez la solution.
Dans l’Explorateur Windows, recherchez le fichier MSI généré dans votre projet Setup.

Copiez le fichier MSI sur l’ordinateur où vous voulez installer le DSL. Double-cliquez sur le fichier MSI. Le programme d'installation s'exécute.
Sur l’ordinateur cible, créez un fichier qui possède l’extension de fichier de votre DSL. Vérifiez que :
- Dans le mode Liste de l’Explorateur Windows, le fichier apparaît avec l’icône et la description que vous avez définies.
- Quand vous double-cliquez sur le fichier, Visual Studio démarre et ouvre le fichier DSL dans votre éditeur DSL.
Si vous préférez, vous pouvez créer le projet Setup manuellement, au lieu d’utiliser le modèle de texte. Pour obtenir une procédure pas à pas qui comprend cette procédure, consultez le chapitre 5 du labo Visualization and Modeling SDK.

Pour désinstaller un DSL qui a été installé à partir d’un MSI

Dans Windows, ouvrez le panneau de configuration Programmes et fonctionnalités.
Désinstallez le DSL.
Démarrez Visual Studio.