Como configurar o GitHub Copilot no seu ambiente

Sobre o GitHub Copilot nos IDEs da JetBrains

Se você usar um IDE da JetBrains, o GitHub Copilot pode fazer o preenchimento automático do código conforme você digita. Após a instalação, você poderá habilitar ou desabilitar o GitHub Copilot e definir configurações avançadas no IDE ou no GitHub. Este artigo descreve como configurar o GitHub Copilot no IDE IntelliJ, mas as interfaces de usuário de outros IDEs da JetBrains podem ser diferentes.

Pré-requisitos

Para configurar o GitHub Copilot em um IDE da JetBrains, você precisará instalar o plug-in do GitHub Copilot. Para saber mais, confira Obtendo sugestões de código em seu IDE com o GitHub Copilot.

Usar ou reassociar atalhos de teclado para GitHub Copilot

Você pode usar os atalhos de teclado padrão para sugestões embutidas no IDE da JetBrains usando o GitHub Copilot. Como alternativa, você pode reassociar os atalhos aos seus atalhos de teclado preferidos de cada comando específico. Para obter mais informações de como reassociar atalhos de teclado no IDE da JetBrains, confira a documentação da JetBrains. Por exemplo, você pode ver a documentação do IntelliJ IDEA.

Atalhos de teclado do macOS

Atalhos de teclado do Windows

Atalhos de teclado do Linux

Como habilitar ou desabilitar o GitHub Copilot

Você pode habilitar ou desabilitar o GitHub Copilot de dentro do IDE da JetBrains. O ícone de status do GitHub Copilot no painel inferior da janela do JetBrains indica se o GitHub Copilot está habilitado ou desabilitado. Quando habilitado, o ícone fica realçado. Quando desabilitado, o ícone fica esmaecido.

1. Para habilitar ou desabilitar o GitHub Copilot, clique no ícone de status no painel inferior à direita da janela do JetBrains.

   

2. Se você estiver desabilitando o GitHub Copilot, será perguntado se deseja desabilitá-lo globalmente ou para a linguagem do arquivo que está editando no momento. Para desabilitar globalmente, clique em Desabilitar Conclusões. Como alternativa, clique no botão específico da linguagem para desabilitar o GitHub Copilot para a linguagem especificada.

   

Como definir configurações avançadas para o GitHub Copilot

Você pode gerenciar as configurações avançadas do GitHub Copilot no IDE do JetBrains. Por exemplo, como o IDE exibe conclusões de código e quais linguagens você quer habilitar ou desabilitar para o GitHub Copilot.

1. No seu IDE JetBrains, clique no menu Arquivo (Windows) ou no nome do aplicativo na barra de menus (macOS) e clique em Configurações.
2. Em Linguagens e Estruturas, clique em GitHub Copilot .
3. Edite as configurações de acordo com suas preferências pessoais.
   • Para ajustar o comportamento e a aparência das sugestões de código e se você quiser verificar automaticamente se há atualizações, marque ou desmarque as caixas de seleção correspondentes.
   • Se você selecionar que deseja receber atualizações automáticas, escolha se quer receber atualizações estáveis, mas menos frequentes, ou atualizações noturnas, que podem ser menos estáveis. Clique na lista suspensa Atualizar canal e selecione Estável para atualizações estáveis ou Noturnas para atualizações noturnas.

Como definir configurações de linguagens para o GitHub Copilot

Você pode especificar em quais linguagens deseja ativar ou desativar o GitHub Copilot no IDE ou editando o arquivo github-copilot.xml. Se você fizer alterações nas configurações de linguagem no IDE, poderá selecionar e desmarcar individualmente as linguagens que deseja ativar ou desativar.

Se você fizer alterações nas configurações de linguagens do arquivo github-copilot.xml, poderá especificar linguagens individuais ou usar um curinga para ativar ou desativar GitHub Copilot para todas as linguagens. Você também pode especificar exceções, que substituirão a configuração curinga para as linguagens especificadas. Por exemplo, você pode desativar GitHub Copilot para todas as linguagens, exceto Python e YAML. Por padrão, quando você instala a extensão GitHub Copilot, o GitHub Copilot é ativado para todas as linguagens.

Definindo configurações de linguagens no IDE

1. No seu IDE JetBrains, clique no menu Arquivo (Windows) ou no nome do aplicativo na barra de menus (macOS) e clique em Configurações.
2. Em Linguagens e Estruturas, clique em GitHub Copilot .
3. Em "Linguagens desabilitadas", use as caixas de seleção para marcar ou desmarcar as linguagens para as quais deseja desativar o GitHub Copilot.
4. Clique em Aplicar e em OK.
5. Reinicie seu IDE da JetBrains para que as alterações entrem em vigor.

Editear seu arquivo github-copilot.xml

Para definir as configurações de linguagens no arquivo github-copilot.xml, você deve editar o arquivo languageAllowList. Cada linha que você adiciona ao languageAllowList deve conter uma chave de entrada e um valor. A chave de entrada é o nome da linguagem ou (*) para um curinga. O valor é true ou false. Se o valor for true, o GitHub Copilot será ativado para a linguagem especificada. Se o valor for false, o GitHub Copilot será desativado para a linguagem especificada.

O arquivo está localizado no seguinte diretório:

• macOS: ~/Library/Application Support/JetBrains/<product><version>/options/github-copilot.xml
• Windows: %APPDATA%\JetBrains\<product><version>\options\github-copilot.xml
• Linux: ~/.config/JetBrains/<product><version>/options/github-copilot.xml

Por exemplo, se você estiver usando o IntelliJ IDEA 2021.1 no macOS, o arquivo estará localizado em ~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xml.

O arquivo github-copilot.xml pode não ser gerado até que você faça uma alteração na configuração de linguagem padrão nas configurações do IDE. Se não conseguir localizar o arquivo, tente modificar as configurações de linguagem padrão no IDE. Para obter mais informações, confira Definir configurações de linguagem no IDE.

Como alternativa, você pode criar o arquivo manualmente e salvá-lo no local do seu sistema operacional listado acima. Para obter mais informações, confira Exemplo de configurações de linguagem.

1. Abra o arquivo github-copilot.xml em um editor de texto.

2. Entre as etiquetas <map>, adicione a linha ou linhas referentes às linguagens para as quais deseja ativar ou desativar o GitHub Copilot. Por exemplo, para desativar o GitHub Copilot para todas as linguagens:

   XML

   <entry key="*" value="false" />
   

3. Salve as alterações no arquivo github-copilot.xml.

4. Reinicie seu IDE da JetBrains para que as alterações entrem em vigor.

Exemplo de configurações de linguagem

A configuração padrão do arquivo github-copilot.xml, que ativa o GitHub Copilot para todas as linguagens, é a seguinte:

<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

Para desativar o GitHub Copilot para todas as linguagens, o valor curinga (*) é alterado para false:

<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
      </map>
    </languageAllowList>
  </component>
</application>

Para especificar linguagens individualmente, adicione uma entrada para cada linguagem para a qual deseja ativar ou desativar o GitHub Copilot. As configurações específicas de linguagens substituirão o curinga. Por exemplo, para ativar o GitHub Copilot para Python e YAML e desativar o GitHub Copilot para todas as outras linguagens, adicione as seguintes entradas:

<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
        <entry key="Python" value="true" />
        <entry key="YAML" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="github-copilot">
    <languageAllowList>
      <map>
        <entry key="*" value="false" />
        <entry key="Python" value="true" />
        <entry key="YAML" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

Você também pode adicionar uma configuração para tornar o languageAllowList somente leitura nas configurações do IDE. Isso impedirá que você altere as configurações de linguagens no IDE. Por exemplo:

<application>
  <component name="github-copilot">
    <option name="languageAllowListReadOnly" value="true" />
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

<application>
  <component name="github-copilot">
    <option name="languageAllowListReadOnly" value="true" />
    <languageAllowList>
      <map>
        <entry key="*" value="true" />
      </map>
    </languageAllowList>
  </component>
</application>

Como definir as configurações do GitHub Copilot no GitHub.com

Se você estiver usando uma assinatura do GitHub Copilot Pro, poderá optar por permitir ou bloquear sugestões de preenchimento de código que correspondam ao código disponível publicamente. Você configura isso em suas configurações pessoais em GitHub.com. Confira Como gerenciar políticas do Copilot como um assinante individual.

Leitura adicional

• Perguntas frequentes do GitHub Copilot