Como Desabilitar o GitHub Copilot em Repositórios Específicos
🔍 WiseChecker

Como Desabilitar o GitHub Copilot em Repositórios Específicos

O GitHub Copilot sugere código enquanto você digita, o que pode acelerar o desenvolvimento. No entanto, em alguns repositórios, você pode querer desabilitar essas sugestões. Isso pode ser por código proprietário, projetos sensíveis ou repositórios onde sugestões de IA não são permitidas por política.

O GitHub Copilot não possui uma opção por repositório em suas configurações principais. Em vez disso, você controla isso por meio de um arquivo de configuração em cada repositório ou pelas configurações do seu editor. O método exato depende se você usa o GitHub Copilot no Visual Studio Code, IDEs JetBrains ou outro editor.

Este artigo explica como desabilitar o GitHub Copilot para repositórios específicos usando o arquivo .copilotignore e as configurações de workspace específicas do editor. Você também aprenderá a verificar se o Copilot está desabilitado para o repositório desejado e o que fazer se a configuração não surtir efeito.

Principais Conclusões: Desabilitar o Copilot para um Único Repositório

  • Arquivo .copilotignore na raiz do repositório: Impede que o Copilot sugira código para arquivos que correspondam aos padrões que você definir.
  • Configurações de workspace do VS Code: Defina github.copilot.enable como false por workspace para desabilitar completamente o Copilot para aquele projeto.
  • Configurações de projeto do JetBrains IDE: Desabilite o plugin do Copilot para o projeto específico através do menu de configurações da IDE.

Como Funciona o Controle de Repositório do GitHub Copilot

O GitHub Copilot não oferece uma opção nativa para desabilitar sugestões para um único repositório. Em vez disso, o controle é baseado em arquivos e no editor. O método mais portátil é o arquivo .copilotignore, que funciona em editores que o suportam, incluindo VS Code, IDEs JetBrains e Neovim com o plugin do Copilot.

O arquivo .copilotignore usa a mesma sintaxe do .gitignore. Você lista padrões de arquivos, e o Copilot não fornecerá sugestões para nenhum arquivo que corresponda a esses padrões. Isso é útil quando você deseja excluir apenas determinados arquivos ou diretórios, como uma pasta secrets ou um arquivo de configuração específico.

Se você deseja desabilitar o Copilot para todo o repositório, pode usar um padrão que corresponda a todos os arquivos. No .copilotignore, o padrão corresponde a todos os arquivos do repositório. Alternativamente, você pode usar configurações de workspace específicas do editor para desabilitar completamente a extensão do Copilot para aquele projeto.

Quando Usar .copilotignore vs Configurações de Workspace

Use .copilotignore quando quiser excluir arquivos ou pastas específicos, mantendo o Copilot ativo para o restante do repositório. Use as configurações de workspace quando quiser desabilitar completamente o Copilot para o projeto. A configuração de workspace substitui a configuração global do Copilot; portanto, se você tiver o Copilot habilitado globalmente, a configuração de workspace o desligará apenas para aquele projeto.

Passos para Desabilitar o GitHub Copilot com .copilotignore

  1. Crie o arquivo .copilotignore
    No diretório raiz do repositório, crie um novo arquivo chamado .copilotignore. O arquivo deve estar na pasta raiz para que o Copilot o detecte.
  2. Adicione padrões de arquivos para excluir
    Abra o arquivo e adicione um padrão por linha. Para desabilitar o Copilot para todos os arquivos do repositório, adicione uma única linha:
    . Para excluir apenas uma pasta específica, adicione um padrão como config/ ou vendor/. A sintaxe segue as regras do .gitignore.
  3. Salve e recarregue o editor
    Salve o arquivo. No VS Code, talvez seja necessário recarregar a janela para que as alterações sejam aplicadas. Pressione Ctrl+Shift+P no Windows ou Cmd+Shift+P no Mac, digite Recarregar Janela e pressione Enter.
  4. Verifique se o Copilot está desabilitado
    Abra um arquivo que corresponda ao padrão adicionado. Comece a digitar. Se o Copilot estiver desabilitado corretamente, nenhuma sugestão inline aparecerá. O ícone de status do Copilot na barra de status pode ainda mostrar o Copilot como ativo, mas as sugestões não aparecerão para os arquivos excluídos.

Passos para Desabilitar o Copilot nas Configurações de Workspace do VS Code

  1. Abra o arquivo de configurações do workspace
    No VS Code, abra a paleta de comandos com Ctrl+Shift+P no Windows ou Cmd+Shift+P no Mac. Digite Preferências: Abrir Configurações do Workspace (JSON) e pressione Enter. Isso abre o arquivo .vscode/settings.json para o workspace atual.
  2. Adicione a configuração para desabilitar o Copilot
    Adicione a seguinte entrada JSON ao arquivo de configurações:
    "github.copilot.enable": {"": false}
    Isso desabilita o Copilot para todas as linguagens neste workspace. Se você quiser desabilitar apenas para uma linguagem específica, substitua
    pelo identificador da linguagem, como "python".
  3. Salve o arquivo
    Pressione Ctrl+S no Windows ou Cmd+S no Mac para salvar. A configuração entra em vigor imediatamente. Não é necessário recarregar o editor.
  4. Confirme que o Copilot está desligado
    Abra qualquer arquivo no workspace. O ícone de status do Copilot na barra de status inferior deve mostrar um círculo com uma barra, indicando que o Copilot está desabilitado para este workspace. Se o ícone ainda mostrar o Copilot como ativo, verifique se a configuração está no arquivo .vscode/settings.json correto e não nas configurações globais do usuário.

Passos para Desabilitar o Copilot em IDEs JetBrains

  1. Abra as configurações do projeto
    No IntelliJ IDEA, PyCharm ou outra IDE JetBrains, clique em File > Settings no Windows ou IntelliJ IDEA > Preferences no Mac. Isso abre a caixa de diálogo de configurações do projeto atual.
  2. Navegue até as configurações do Copilot
    No painel esquerdo, expanda Tools e selecione GitHub Copilot. A página de configurações mostra opções para habilitar o Copilot e configurar seu comportamento.
  3. Desabilite o Copilot para o projeto
    Desmarque a caixa rotulada Enable GitHub Copilot. Isso desabilita o Copilot apenas para o projeto atual. Outros projetos ainda usarão a configuração global.
  4. Aplique e feche
    Clique em Apply e depois em OK. O Copilot não fornecerá mais sugestões neste projeto. Para reativá-lo posteriormente, volte às mesmas configurações e marque a caixa.

Se o Copilot Ainda Mostrar Sugestões Após Desabilitar

Copilot sugere código apesar do .copilotignore

Se você adicionou um arquivo .copilotignore mas o Copilot ainda sugere código, verifique se o arquivo está nomeado exatamente como .copilotignore sem extensão. O arquivo deve estar na raiz do repositório, não em uma subpasta. Confirme também se a sintaxe do padrão está correta. Por exemplo, corresponde a todos os arquivos, mas txt corresponde apenas a arquivos de texto. Se você usar um padrão como src/, ele exclui apenas o diretório em si, não seu conteúdo. Use src/ para excluir todos os arquivos dentro do diretório src.

Configuração de workspace do VS Code não surte efeito

Se a configuração de workspace github.copilot.enable não desabilitar o Copilot, verifique se a configuração está no arquivo correto. A configuração deve estar em .vscode/settings.json dentro da pasta do seu projeto. Se você a colocou no settings.json global em %APPDATA%/Code/User/settings.json no Windows ou ~/Library/Application Support/Code/User/settings.json no Mac, ela se aplicará a todos os workspaces. Mova a configuração para o arquivo do workspace.

IDE JetBrains ainda mostra sugestões do Copilot

Em IDEs JetBrains, a configuração de nível de projeto substitui a configuração global apenas se você a alterar explicitamente nas configurações do projeto. Se você vir sugestões do Copilot após desabilitar, abra as configurações novamente e confirme se a caixa de seleção está desmarcada. Certifique-se também de ter clicado em Apply antes de fechar a caixa de diálogo. Se a configuração reverter, o projeto pode ter um arquivo de configurações compartilhado que impõe a preferência global. Verifique File > Settings > Tools > GitHub Copilot e procure um ícone de cadeado. Se o cadeado estiver fechado, a configuração é gerenciada pelo projeto e não pode ser alterada localmente.

Item Método .copilotignore Método Configurações de Workspace
Escopo Por padrão de arquivo ou pasta Workspace ou projeto inteiro
Arquivo necessário .copilotignore na raiz do repositório .vscode/settings.json ou configurações do projeto da IDE
Suporte do editor VS Code, JetBrains, Neovim VS Code, IDEs JetBrains
Controle de versão Arquivo pode ser commitado no repositório Arquivo de configurações pode ser commitado no repositório
Granularidade Fina por tipo de arquivo ou pasta Tudo ou nada por projeto
Substitui configuração global Sim Sim

Agora você pode desabilitar o GitHub Copilot para repositórios específicos usando o arquivo .copilotignore ou as configurações de workspace. Escolha o método que se adequa ao seu fluxo de trabalho. Se você usa vários editores, o arquivo .copilotignore é a opção mais portátil, pois funciona em editores que suportam a extensão do Copilot. Para uma desabilitação completa no VS Code, a configuração de workspace é mais simples e não requer um arquivo separado. Experimente adicionar o arquivo .copilotignore a um repositório de teste primeiro para confirmar se a sintaxe do padrão funciona conforme o esperado antes de aplicá-lo a projetos de produção.