Настройка GitHub Copilot в вашей среде

Сведения оGitHub Copilot в интегрированной среде разработки JetBrains

Если вы используете интегрированную среду разработки JetBrains, GitHub Copilot поможет вам с различными задачами, включая создание предложений кода, объясняя работу кода в редакторе и предлагая исправления кода. После установки вы можете включить или отключить GitHub Copilot, а также настроить расширенные настройки внутри вашего IDE или на GitHub. В этой статье описывается настройка GitHub Copilot в интегрированной среде разработки IntelliJ, но пользовательские интерфейсы других IDE JetBrains могут отличаться.

Необходимые компоненты

Чтобы настроить GitHub Copilot в интегрированной среде разработки JetBrains, установите подключаемый модуль GitHub Copilot. Для получения дополнительной информации см. Установка расширения GitHub Copilot в вашей среде.

Включение или отключение GitHub Copilot

Вы можете включить или отключить GitHub Copilot в интегрированной среде разработки JetBrains. Значок состояния GitHub Copilot на нижней панели окна JetBrains указывает, включен или отключен параметр GitHub Copilot. Если этот параметр включен, значок выделен. Если он отключен, значок неактивен.

1. Чтобы включить или отключить GitHub Copilot, щелкните значок состояния в нижней панели справа от окна JetBrains.

   

2. Если вы отключаете GitHub Copilot, появится запрос, следует ли отключить их глобально или для языка файла, который вы редактируете. Для глобального отключения нажмите кнопку Отключить завершения. Или щелкните кнопку для конкретного языка, чтобы отключить GitHub Copilot только для него.

   

Повторная привязка сочетаний клавиш

Сочетания клавиш по умолчанию можно использовать для встроенных предложений в интегрированной среде разработки JetBrains при использовании GitHub Copilot. Список стандартных клавиш для клавиатуры см. Горячие клавиши для GitHub Copilot в IDE.

Кроме того, можно повторно указать предпочитаемые сочетания клавиш для каждой конкретной команды. Дополнительные сведения о повторной привязке сочетаний клавиш в интегрированной среде разработки JetBrains см. в документации по JetBrains. Например, можно просмотреть документацию по IntelliJ IDEA.

Настройка дополнительных параметров для GitHub Copilot

Вы можете управлять расширенными настройками для GitHub Copilot в интегрированной среде разработки JetBrains, например тем, как в ней отображаются встроенные предложения, а также языками, которые вы хотите включить или отключить для GitHub Copilot.

1. В интегрированной среде разработки JetBrains выберите меню "Файл " (Windows) или имя приложения в строке меню (macOS), а затем нажмите кнопку "Параметры".
2. В левой боковой панели нажмите «Инструменты», нажмите GitHub Copilot. и просмотр настроек Общие и Завершения .
3. Измените параметры в соответствии с вашими предпочтениями.
   • Чтобы настроить поведение и внешний вид предложений кода, а также автоматически проверять наличие обновлений, выбирать или отменять выбор соответствующих флажков.
   • Если вы решили получать автоматические обновления, вы можете выбрать, следует ли получать стабильные обновления, но редко, или каждую ночь, но менее стабильные. Щелкните раскрывающийся список Канал обновления и выберите Стабильные или Каждую ночь.

Настройка параметров языка для GitHub Copilot

Вы можете указать, для каких языков активировать или деактивировать GitHub Copilot либо в IDE, либо редактировать файл github-copilot.xml. Если вы вносите изменения в языковые параметры в интегрированной среде разработки, вы можете выбрать и отменить выбор языков, которые необходимо активировать или отключить.

Если вы внесёте изменения в языковые настройки в файле github-copilot.xml, вы можете указать отдельные языки или использовать джокер, чтобы активировать или деактивировать GitHub Copilot для всех языков. Можно также указать исключения, которые переопределяют параметр подстановочной карточки для указанных языков. Например, можно отключить GitHub Copilot для всех языков, кроме Python и YAML. По умолчанию при установке расширения GitHub Copilot активируется GitHub Copilot для всех языков.

Настройка параметров языка в интегрированной среде разработки

1. В интегрированной среде разработки JetBrains выберите меню "Файл " (Windows) или имя приложения в строке меню (macOS), а затем нажмите кнопку "Параметры".
2. В левой боковой панели нажмите «Инструменты», нажмите GitHub Copilot., затем нажмите Completions.
3. В разделе "Языки" установите или отключите флажки для языков, для которых требуется активировать или отключить GitHub Copilot.
4. Щелкните Применить, затем щелкните ОК.
5. Перезапустите интегрированную среду разработки JetBrains, чтобы изменения вступили в силу.

Редактирование вашего файла github-copilot.xml

Чтобы настроить языковые настройки в файле github-copilot.xml, необходимо отредактировать languageAllowList. Каждая строка, добавляемая к ней languageAllowList , должна содержать ключ входа и значение. Ключ входа — это имя языка или (*) для подстановочного знака. Имеет значение true или false. Если значение равно true, активируется GitHub Copilot для указанного языка. Если значение равно false, GitHub Copilot деактивируется для указанного языка.

Файл расположен в следующем каталоге:

• macOS:~/Library/Application Support/JetBrains/<product><version>/options/github-copilot.xml
• Виндоус:%APPDATA%\JetBrains\<product><version>\options\github-copilot.xml
• Linux:~/.config/JetBrains/<product><version>/options/github-copilot.xml

Например, если вы используете IntelliJ IDEA 2021.1 на macOS, файл находится в ~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xml.

Файл github-copilot.xml может не быть сгенерирован, пока вы не измените стандартную языковую конфигурацию в настройках IDE. Если файл не удается найти, попробуйте изменить параметры языка по умолчанию в интегрированной среде разработки. Дополнительные сведения см. в разделе "Настройка параметров языка" в интегрированной среде разработки.

Кроме того, вы можете создать файл вручную и сохранить его в расположении операционной системы, указанной выше. Дополнительные сведения см. в разделе "Примеры языковых конфигураций".

1. Откройте файл github-copilot.xml в текстовом редакторе.

2.        `<map>` Между тегами добавьте строку или строки для языков, для которого требуется активировать или отключить GitHub Copilot для. Например, чтобы отключить GitHub Copilot для всех языков:
   

   XML

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

3. Сохраняйте изменения в файле github-copilot.xml.

4. Перезапустите интегрированную среду разработки JetBrains, чтобы изменения вступили в силу.

Примеры конфигураций языка

По умолчанию конфигурация файла github-copilot.xml, который позволяет GitHub Copilot для всех языков, выглядит следующим образом:

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

Чтобы отключить GitHub Copilot для всех языков, значение подстановочного знака (*) изменяется на 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>

Чтобы указать языки по отдельности, добавьте запись для каждого языка, для которого требуется активировать или отключить GitHub Copilot. Параметры конкретного языка переопределяют подстановочный знак. Например, чтобы активировать GitHub Copilot для Python и YAML, а также отключить GitHub Copilot для всех остальных языков, добавьте следующие записи:

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

Вы также можете добавить конфигурацию для чтения languageAllowList в параметрах интегрированной среды разработки. Это позволит предотвратить изменение параметров языка в интегрированной среде разработки. Например:

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

Настройка параметров Copilot для GitHub.com

Если вы используете план Copilot Pro, вы можете разрешить или заблокировать встроенные предложения, которые соответствуют общедоступному коду. Вы также можете разрешить или заблокировать сбор и хранение запросов, которые вы вводите, и Copilotпредложения. Это можно настроить в личных параметрах для GitHub.com. См . раздел AUTOTITLE.

Проверка подлинности в учетной записи в GHE.com

Если вы используете план Copilot для управляемая учетная запись пользователя на GHE.com, необходимо обновить некоторые параметры перед входом. См . раздел AUTOTITLE.

Дополнительные материалы

• GitHub Copilot FAQ