Configuration de GitHub Copilot dans votre environnement

À propos de GitHub Copilot dans les IDE JetBrains

Si vous utilisez un IDE JetBrains, GitHub Copilot peut effectuer la saisie semi-automatique du code à mesure que vous tapez. Après l’installation, vous pouvez activer ou désactiver GitHub Copilot, et vous pouvez configurer des paramètres avancés dans votre IDE ou sur GitHub. Cet article explique comment configurer GitHub Copilot dans l’IDE IntelliJ, mais les interfaces utilisateur des autres IDE JetBrains peuvent différer.

Prérequis

Pour configurer GitHub Copilot dans un IDE JetBrains, vous devez installer le plug-in GitHub Copilot. Pour plus d’informations, consultez « Obtention de suggestions de code dans votre IDE avec GitHub Copilot ».

Utilisation ou réassociation des raccourcis clavier pour GitHub Copilot

Lorsque vous utilisez GitHub Copilot, vous pouvez utiliser les raccourcis clavier par défaut pour les suggestions inline dans votre IDE JetBrains. Vous pouvez également relier les raccourcis à vos raccourcis clavier préférés pour chaque commande. Pour plus d’informations sur la liaison des raccourcis clavier dans votre IDE JetBrains, consultez la documentation de JetBrains. Par exemple, vous pouvez consulter la documentation IntelliJ IDEA.

Raccourcis clavier pour macOS

Raccourcis clavier pour Windows

Raccourcis clavier pour Linux

Activation ou désactivation de GitHub Copilot

Vous pouvez activer ou désactiver GitHub Copilot dans votre IDE JetBrains. L’icône d’état GitHub Copilot dans le panneau inférieur de la fenêtre JetBrains indique si GitHub Copilot est activé ou désactivé. Quand cette option est activée, l’icône est mise en évidence. Quand elle est désactivée, l’icône est grisée.

1. Pour activer ou désactiver GitHub Copilot, cliquez sur l’icône d’état dans le panneau inférieur à droite de la fenêtre JetBrains.

   

2. Si vous désactivez GitHub Copilot, il vous sera demandé si vous souhaitez le désactiver entièrement ou seulement pour le langage du fichier que vous êtes en train de modifier. Pour désactiver l’option globalement, cliquez sur Désactiver les saisies semi-automatiques. Si vous souhaitez désactiver GitHub Copilot pour le langage spécifié, vous pouvez également cliquer sur le bouton correspondant au langage.

   

Configuration des paramètres avancés pour GitHub Copilot

Vous pouvez gérer les paramètres avancés pour GitHub Copilot dans votre IDE JetBrains, par exemple la façon dont votre IDE affiche les saisies semi-automatiques de code ou les langages que vous souhaitez activer ou désactiver pour GitHub Copilot.

1. Dans votre IDE JetBrains, cliquez sur le menu Fichier (Windows) ou sur le nom de l’application dans la barre de menus (macOS), puis cliquez sur Paramètres.
2. Sous Languages & Frameworks (Langages et frameworks), cliquez sur GitHub Copilot .
3. Modifiez les paramètres selon vos préférences personnelles.
   • Pour ajuster le comportement et l’apparence des suggestions de code et vérifier automatiquement les mises à jour, sélectionnez ou désélectionnez les cases correspondantes.
   • Si vous avez choisi de recevoir des mises à jour automatiques, vous pouvez choisir de recevoir des mises à jour stables, mais moins fréquentes, ou des mises à jour nocturnes, qui peuvent être moins stables. Cliquez sur la liste déroulante Update channel (Canal de mise à jour), puis sélectionnez Stable pour les mises à jour stables ou Nightly (Nocturne) pour les mises à jour nocturnes.

Configuration des paramètres de langage pour GitHub Copilot

Vous pouvez spécifier les langages que vous souhaitez activer ou désactiver GitHub Copilot soit dans l’IDE, soit en éditant votre fichier github-copilot.xml. Si vous apportez des modifications aux paramètres de langage dans votre IDE, vous pouvez sélectionner et désélectionner individuellement les langages que vous souhaitez activer ou désactiver.

Si vous apportez des modifications aux paramètres de langage dans votre fichier github-copilot.xml, vous pouvez spécifier des langages individuels, ou vous pouvez utiliser un caractère générique pour activer ou désactiver GitHub Copilot pour tous les langages. Vous pouvez également spécifier des exceptions, qui remplacent le paramètre de cartcaractère générique pour les langages spécifiés. Par exemple, vous pouvez désactiver GitHub Copilot pour tous les langages, à l’exception de Python et YAML. Par défaut, lorsque vous installez l’extension GitHub Copilot, GitHub Copilot est activé pour tous les langages.

Configuration des paramètres de langage dans l’IDE

1. Dans votre IDE JetBrains, cliquez sur le menu Fichier (Windows) ou sur le nom de l’application dans la barre de menus (macOS), puis cliquez sur Paramètres.
2. Sous Languages & Frameworks (Langages et frameworks), cliquez sur GitHub Copilot .
3. Sous « Langages », sélectionnez ou désélectionnez les cases à cocher pour le langages pour lesquels vous souhaitez activer ou désactiver GitHub Copilot.
4. Cliquez sur Appliquer, puis sur OK.
5. Redémarrez votre IDE JetBrains pour que ces modifications prennent effet.

Modification de votre fichier github-copilot.xml

Pour configurer les paramètres de langages dans le fichiergithub-copilot.xml, vous devez modifier le languageAllowList. Chaque ligne que vous ajoutez au languageAllowList doit contenir une clé d’entrée et une valeur. La clé d’entrée est le nom du langage, ou (*) pour un caractère générique. La valeur est soit true, soit false. Si la valeur est true, GitHub Copilot est activée pour le langage spécifié. Si la valeur est false, GitHub Copilot est désactivée pour le langage spécifié.

Le fichier se trouve dans l’annuaire suivant :

• 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

Par exemple, si vous utilisez IntelliJ IDEA 2021.1 sur macOS, le fichier se trouve sur ~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xml.

Le fichier github-copilot.xml peut ne pas être généré tant que vous n’avez pas apporté de modification à votre configuration de langage par défaut dans les paramètres de l’IDE. Si vous ne pouvez pas localiser le fichier, vous devez essayer de modifier les paramètres de langage par défaut dans l’IDE. Pour plus d’informations, consultez « Configuration des paramètres de langage dans l’IDE ».

Vous pouvez également créer le fichier manuellement et l’enregistrer à l’emplacement de votre système d’exploitation répertorié ci-dessus. Pour plus d’informations, consultez « Exemple de configuration de langages ».

1. Ouvrez le fichier github-copilot.xml dans un éditeur de texte.

2. Entre les balises <map>, ajoutez la ligne ou les lignes pour les langages pour lesquelles vous souhaitez activer ou désactiver GitHub Copilot Par exemple, pour désactiver GitHub Copilot pour tous les langages :

   XML

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

3. Enregistrez les modifications dans le fichier github-copilot.xml.

4. Redémarrez votre IDE JetBrains pour que ces modifications prennent effet.

Exemples de configurations de langage

La configuration par défaut du fichier github-copilot.xml, qui active GitHub Copilot pour tous les langages est la suivante :

<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>

Pour désactiver GitHub Copilot pour tous les langages, la valeur de caractère générique (*) est remplacée par 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>

Pour spécifier des langages individuellement, ajoutez une entrée pour chaque langage pour lequel vous souhaitez activer ou désactiver GitHub Copilot. Les paramètres de langage spécifiques remplacent le caractère générique. Par exemple, pour activer GitHub Copilot pour Python et YAML, et désactiver GitHub Copilot pour tous les autres langages, ajoutez les entrées suivantes :

<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>

Vous pouvez également ajouter une configuration pour mettre le languageAllowList en lecture seule dans les paramètres de l’IDE. Cela vous empêchera de modifier les paramètres de langage dans l’IDE. Par exemple :

<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>

Configuration des paramètres de GitHub Copilot sur GitHub.com

Si vous utilisez un abonnement GitHub Copilot Individual, vous pouvez choisir d’autoriser ou de bloquer les suggestions de saisie semi-automatique du code qui correspondent au code disponible publiquement. Vous pouvez également autoriser ou bloquer la collecte et la rétention des invites que vous entrez et des suggestions Copilot. Vous configurez cela dans vos paramètres personnels sur GitHub.com. Consultez « Gestion des stratégies de Copilot en tant qu’abonné individuel ».

Pour aller plus loin

• FAQ sur GitHub Copilot