Mapas de fornecedores da Microsoft CMakePresets.json e CMakeUserPresets.json Microsoft

CMake dá suporte a dois arquivos, CMakePresets.json e CMakeUserPresets.json, que permitem aos usuários especificar as opções comuns de configuração, construção e teste e compartilhá-las com outras pessoas.

CMakePresets.json e CMakeUserPresets.json podem ser usados para conduzir o CMake no Visual Studio, no Visual Studio Code, em um pipeline de CI (Integração Contínua) e a partir da linha de comando.

CMakePresets.json destina-se a salvar builds em todo o projeto e CMakeUserPresets.json é destinado a desenvolvedores para salvar os próprios builds locais. O esquema para ambos os arquivos é idêntico.

CMakePresets.json e CMakeUserPresets.json dão suporte a mapas de fornecedores para armazenar informações específicas de fornecedores. A Microsoft mantém dois mapas de fornecedores com opções específicas para Visual Studio e Visual Studio Code. Aqui documentamos dois mapas de fornecedores da Microsoft e macros de fornecedores. Para obter mais informações sobre o restante do esquema, consulte a Documentação oficial do CMake. Isso inclui informações sobre Predefinições de Configuração, Predefinições de Build e Predefinições de Teste.

Para obter mais informações sobre como usar CMakePresets.json no Visual Studio, consulte Configurar e compilar com Predefinições do CMake no Visual Studio

Para obter mais informações sobre como usar CMakePresets.json no Visual Studio Code, consulte Configurar e compilar com Predefinições do CMake no VS Code

Mapa de fornecedores de configurações do Visual Studio

Um mapa de fornecedor com o URI de fornecedor microsoft.com/VisualStudioSettings/CMake/<version> é permitido por Predefinição de Configuração e contém as opções específicas para a integração do CMake no Visual Studio e no Visual Studio Code. Todas as opções no mapa do fornecedor se aplicam ao Visual Studio. As opções que se aplicam ao Visual Studio e ao Visual Studio Code foram marcadas explicitamente.

Todas as configurações no mapa de fornecedores de Configurações do Visual Studio são opcionais e herdadas das Predefinições de Configuração especificadas pela chave inherits. Somente as opções que foram modificadas serão gravadas no arquivo. O Mapa de fornecedores de configurações do Visual Studio é compatível com ambos CMakePresets.json e CMakeUserPresets.json.

As opções no Mapa de fornecedores de configurações do Visual Studio não afetam a construção da linha de comando do CMake ou do CTest. É assim que o mesmo arquivo CMakePresets.json poderá ser utilizado para conduzir o CMake com o Visual Studio, Visual Studio Code e a partir da linha de comando. As exceções são as opções cacheRoot e cmakeGenerateCommand. Essas opções são específicas para o cenário Abrir Cache Existente no Visual Studio e não podem ser reproduzidas na linha de comando.

Mapa de fornecedores de configurações remotas do Visual Studio

Um mapa de fornecedor com o URI do fornecedor microsoft.com/VisualStudioRemoteSettings/CMake/<version> é permitido por Predefinição de Configuração e contém as opções específicas para o desenvolvimento remoto no Visual Studio. Desenvolvimento remoto significa o CMake está sendo invocado em uma conexão SSH remota ou WSL. Nenhuma das opções no mapa de fornecedor de configurações remotas do Visual Studio se aplica ao Visual Studio Code.

Todas as configurações no mapa de fornecedores de configurações remotas do Visual Studio são opcionais e herdadas das Predefinições de Configuração especificadas pela chave inherits. Somente as opções que foram modificadas serão gravadas no arquivo. O mapa de fornecedores de configurações remotas do Visual Studio tem suporte em ambos CMakePresets.json e CMakeUserPresets.json.

As opções no Mapa de fornecedores de configurações do Visual Studio não afetam a construção da linha de comando do CMake ou do CTest. É assim que o mesmo arquivo CMakePresets.json poderá ser utilizado para conduzir o CMake com o Visual Studio, Visual Studio Code e a partir da linha de comando.

Muitas das opções no mapa de fornecedores de Configurações Remotas do Visual Studio serão ignoradas ao direcionar o WSL1. Isso ocorre porque o conjunto de ferramentas do WSL1 executa todos os comandos localmente e depende de unidades do Windows montadas na pasta /mnt para acessar os arquivos de origem local do WSL1. Cópias do arquivo de origem não são necessárias. As opções que são ignoradas ao direcionar o WSL1 foram marcadas explicitamente.

Eventos remotos de pré-compilação e pós-compilação

As opções para remotePrebuildEvent e remotePostbuildEvent foram preteridas com a adoção de CMakePresets.json.

Codifique os eventos de pré-compilação, pré-vínculo e pós-compilação no CMakeLists.txt usando add_custom_command. Isso garantirá o mesmo comportamento ao compilar com o Visual Studio e a partir da linha de comando.

Se for necessário um comportamento específico para o Visual Studio, você poderá adicionar uma tarefa remota personalizada em tasks.vs.json. Para começar, clique com o botão direito do mouse na raiz CMakeLists.txt no Gerenciador de Soluções da Exibição de Pastas e selecione Configurar Tarefas. Em seguida, você poderá adicionar uma nova tarefa remota ao arquivo tasks.vs.json.

A seguinte tarefa remota cria um diretório chamado teste no sistema Linux remoto:

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

Clique com o botão direito do mouse em qualquer CMakeLists.txt e selecione a opção mkdir para executar esta tarefa.

O valor de remoteMachineName deverá corresponder ao nome do host de uma conexão no Gerenciador de Conexões.

Macros de fornecedores da Microsoft

Os dois mapas de fornecedores da Microsoft, Visual Studio Settings e Visual Studio Remote Settings, dão suporte a todas as macros definidas pelo CMake. Nossos mapas de fornecedores dão suporte a todas as macros definidas pelo CMake. Para obter mais informações, consulte Expansão de macro de predefinições cmake. Todas as macros e variáveis de ambiente serão expandidas antes de passadas para o CMake.

O Visual Studio dá suporte a macros de fornecedor com o prefixo ms. As macros de fornecedores da Microsoft somente poderão ser usadas em mapas de fornecedores da Microsoft. O CMake não poderá usar as predefinições que tenham macros de fornecedores fora de um mapa de fornecedores.

Variáveis de ambiente

Macros preteridas

Algumas macros que tinha suporte do CMakeSettings.json foram preteridas com a adoção de CMakePresets.json.

Use as macros com suporte do CMake para construir os caminhos de arquivo. Quando você usar as macros, isso garantirá que o mesmo arquivo CMakePresets.json funcione dentro do Visual Studio e a partir da linha de comando.

Sintaxe de shell aceita

Use a sintaxe $env{HOME} para fazer referência a $HOME ao construir caminhos do Linux nos mapas de fornecedores da Microsoft.