CMakePresets.json et cartes CMakeUserPresets.json des fournisseurs Microsoft

CMake prend en charge deux fichiers et CMakePresets.json CMakeUserPresets.json, qui permettent aux utilisateurs de spécifier des options courantes de configuration, de génération et de test, et de les partager avec d’autres utilisateurs.

CMakePresets.json et CMakeUserPresets.json peut être utilisé pour piloter CMake dans Visual Studio, dans Visual Studio Code, dans un pipeline d’intégration continue (CI) et à partir de la ligne de commande.

CMakePresets.json est destiné à enregistrer des builds à l’échelle du projet et CMakeUserPresets.json est destiné aux développeurs d’enregistrer leurs propres builds locales. Le schéma des deux fichiers est identique.

CMakePresets.json et CMakeUserPresets.json de prendre en charge les mappages des fournisseurs pour stocker des informations spécifiques au fournisseur. Microsoft gère deux mappages de fournisseurs avec des options spécifiques à Visual Studio et Visual Studio Code. Ici, nous documentons deux cartes de fournisseurs Microsoft et macros de fournisseur. Pour plus d’informations sur le reste du schéma, consultez la documentation CMake officielle. Il inclut des informations sur la configuration des présélections, des présélections de build et des présélections de test.

Pour plus d’informations sur l’utilisation CMakePresets.json dans Visual Studio, consultez Configurer et générer avec des présélections CMake dans Visual Studio

Pour plus d’informations sur l’utilisation CMakePresets.json dans Visual Studio Code, consultez Configurer et générer avec des présélections CMake dans VS Code

Carte du fournisseur Paramètres Visual Studio

Un fournisseur mappé avec l’URI microsoft.com/VisualStudioSettings/CMake/<version> du fournisseur est autorisé par présélection de configuration et contient des options spécifiques à l’intégration CMake dans Visual Studio et Visual Studio Code. Toutes les options de la carte fournisseur s’appliquent à Visual Studio. Les options qui s’appliquent à Visual Studio et Visual Studio Code ont été marquées explicitement.

Tous les paramètres de la carte fournisseur visual Studio Paramètres sont facultatifs et hérités des présélections spécifiées par la inherits clé. Seules les options qui ont été modifiées sont écrites dans le fichier. La carte du fournisseur Paramètres Visual Studio est prise en charge par les deux CMakePresets.json et CMakeUserPresets.jsonles deux.

Les options de visual Studio Paramètres carte fournisseur n’affectent pas la construction de la ligne de commande CMake ou CTest. Il est donc possible d’utiliser le même CMakePresets.json fichier pour piloter CMake avec Visual Studio, Visual Studio Code et à partir de la ligne de commande. Les exceptions sont les options et cmakeGenerateCommand les cacheRoot options. Ces options sont spécifiques au scénario Open Existing Cache dans Visual Studio et ne peuvent pas être reproduites à partir de la ligne de commande.

Carte du fournisseur Paramètres à distance visual Studio

Un fournisseur mappé avec l’URI microsoft.com/VisualStudioRemoteSettings/CMake/<version> du fournisseur est autorisé par présélection de configuration et contient des options spécifiques au développement à distance dans Visual Studio. Le développement à distance signifie que vous appelez CMake sur une connexion SSH distante ou WSL. Aucune des options de la carte fournisseur Paramètres à distance visual Studio ne s’applique à Visual Studio Code.

Tous les paramètres de la carte fournisseur Paramètres à distance visual Studio sont facultatifs et hérités des présélections spécifiées par la inherits clé. Seules les options qui ont été modifiées sont écrites dans le fichier. La carte du fournisseur Paramètres remote visual Studio est prise en charge par les deux CMakePresets.json et CMakeUserPresets.jsonles deux.

Les options de visual Studio Paramètres carte fournisseur n’affectent pas la construction de la ligne de commande CMake ou CTest. Il est donc possible d’utiliser le même CMakePresets.json fichier pour piloter CMake avec Visual Studio, Visual Studio Code et à partir de la ligne de commande.

La plupart des options de la carte fournisseur Paramètres à distance visual Studio sont ignorées lors du ciblage de WSL1. C’est parce que l’ensemble d’outils WSL1 exécute toutes les commandes localement et s’appuie sur les lecteurs Windows montés sous le /mnt dossier pour accéder aux fichiers sources locaux à partir de WSL1. Aucune copie de fichier source n’est requise. Les options qui sont ignorées lors du ciblage de WSL1 ont été marquées explicitement.

Événements de pré-génération et de post-build distants

Les options d’un remotePrebuildEvent et remotePostbuildEvent ont été déconseillées avec l’adoption de CMakePresets.json.

Encoder des événements de pré-génération, de pré-liaison et de post-génération dans votre CMakeLists.txt utilisation add_custom_command. Il garantit le même comportement lors de la génération avec Visual Studio et à partir de la ligne de commande.

Si vous avez besoin d’un comportement spécifique à Visual Studio, vous pouvez ajouter une tâche distante personnalisée dans tasks.vs.json. Pour commencer, cliquez avec le bouton droit sur votre racine CMakeLists.txt dans le Explorateur de solutions à partir de l’affichage dossier, puis sélectionnez Configurer les tâches. Vous pouvez ensuite ajouter une nouvelle tâche distante à votre tasks.vs.json fichier.

La tâche distante suivante crée un répertoire appelé test sur le système Linux distant :

{
      "taskLabel": "mkdir",
      "appliesTo": "CMakeLists.txt",
      "type": "remote",
      "command": "mkdir test",
      "remoteMachineName": "localhost"
  }

Cliquez avec le bouton droit sur n’importe quelle CMakeLists.txt option et sélectionnez l’option mkdir pour exécuter cette tâche.

La valeur de remoteMachineName doit correspondre au nom d’hôte d’une connexion dans le gestionnaire Connecter ion.

Macros du fournisseur Microsoft

Les deux fournisseurs Microsoft mappent et Visual Studio Settings Visual Studio Remote Settingsprennent en charge toutes les macros définies par CMake. Nos cartes fournisseur prennent en charge toutes les macros définies par CMake. Pour plus d’informations, consultez l’extension macro cmake-presets. Toutes les macros et variables d’environnement sont développées avant d’être passées à CMake.

Visual Studio prend en charge les macros de fournisseur avec le préfixe ms. Les macros de fournisseur Microsoft ne peuvent être utilisées que dans les cartes des fournisseurs Microsoft. CMake ne peut pas utiliser de présélections qui ont des macros de fournisseur en dehors d’une carte de fournisseur.

Variables d'environnement

Macros déconseillées

Quelques macros prises en charge par CMakeSettings.json ont été dépréciées avec l’adoption de CMakePresets.json.

Utilisez les macros prises en charge par CMake pour construire vos chemins de fichier. Lorsque vous utilisez les macros, cela garantit que le même CMakePresets.json fichier fonctionne à l’intérieur de Visual Studio et à partir de la ligne de commande.

Syntaxe d’interpréteur de commandes acceptée

Utilisez la syntaxe pour référencer $HOME lors de la $env{HOME} construction de chemins Linux dans les mappages du fournisseur Microsoft.