環境内GitHub Copilot の構成

JetBrains IDE の GitHub Copilot について

JetBrains IDE を使用する場合、 GitHub Copilot は、コード提案の生成、エディターでのコードの動作の説明、コード修正の提案など、さまざまなタスクに役立ちます。 インストール後、 GitHub Copilotを有効または無効にしたり、IDE 内または GitHub で詳細設定を構成したりできます。 この記事では、IntelliJ IDE で GitHub Copilot を構成する方法について説明しますが、他の JetBrains IDE のユーザー インターフェイスは異なる場合があります。

前提条件

JetBrains IDE で GitHub Copilot を構成するには、 GitHub Copilot プラグインをインストールする必要があります。 詳細については、「環境内に GitHub Copilot 拡張機能をインストールする」を参照してください。

有効化または無効化 GitHub Copilot

JetBrains IDE 内から GitHub Copilot を有効または無効にすることができます。 JetBrains ウィンドウの下部パネルの GitHub Copilot 状態アイコンは、 GitHub Copilot が有効か無効かを示します。 有効の場合、アイコンが強調表示されます。 無効の場合、アイコンは淡色表示されます。

1. GitHub Copilotを有効または無効にするには、JetBrains ウィンドウの右側にある下部パネルにある状態アイコンをクリックします。

   

2. GitHub Copilotを無効にする場合は、グローバルに無効にするか、現在編集しているファイルの言語を無効にするかを確認するメッセージが表示されます。 グローバルに無効にするには、 [Disable Completions](入力候補を無効にする) をクリックします。 または、言語固有のボタンをクリックして、指定した言語の GitHub Copilot を無効にします。

   

キーボード ショートカットの再設定

GitHub Copilotを使用する場合は、JetBrains IDE のインライン候補に既定のキーボード ショートカットを使用できます。 既定のキーボード ショートカットの一覧については、「IDE の GitHub Copilot のキーボード ショートカットを参照してください。

また、特定のコマンドごとに、ショートカットを任意のキーボード ショートカットに再バインドすることもできます。 JetBrains IDE でキーボード ショートカットを再バインドする方法の詳細については、JetBrains のドキュメントを参照してください。 たとえば、IntelliJ IDEA のドキュメントなどがあります。

GitHub Copilot の詳細設定を構成する

JetBrains IDE で GitHub Copilot の詳細設定 (IDE でのインライン候補の表示方法、 GitHub Copilotに対して有効または無効にする言語など) を管理できます。

1. JetBrains IDE で、ファイル メニュー (Windows) またはメニュー バー (macOS) のアプリケーションの名前をクリックし、設定 をクリックします。

2. 左側のサイドバーで[ツール]をクリックし、[GitHub Copilot]をクリックします。をクリックし、全般 と 完了 の設定を確認します。

3. 自分の好みに合わせて設定を編集します。

   • コード候補の動作と外観、および更新を自動的に確認するかどうかを調整するには、対応するチェックボックスを選択または選択解除してください。
   • 自動更新を受信するように選んだ場合、安定版の更新プログラム (ただし頻度は低い) か、または夜間版の更新プログラム (安定性が低い場合がある) を受け取るかを選択できます。 [Update channel](更新プログラム チャネル) ドロップダウンをクリックして、安定版の更新を受け取る場合は Stable を、夜間版の更新を受け取る場合は Nightly を選びます。

GitHub Copilot の言語設定

IDE で、またはGitHub Copilot ファイルを編集して、github-copilot.xmlをアクティブ化または非アクティブ化する言語を指定できます。 IDE で言語設定を変更する場合は、アクティブ化または非アクティブ化する言語を個別に選択および選択解除できます。

github-copilot.xml ファイルの言語設定を変更する場合は、個々の言語を指定することも、ワイルドカードを使用してすべての言語のGitHub Copilotをアクティブ化または非アクティブ化することもできます。 また、例外を指定することもできます。これにより、指定した言語のワイルドカード設定がオーバーライドされます。 たとえば、Pythonと YAML を除くすべての言語のGitHub Copilotを非アクティブ化できます。 既定では、 GitHub Copilot 拡張機能をインストールすると、 GitHub Copilot はすべての言語に対してアクティブ化されます。

IDE での言語設定の構成

1. JetBrains IDE で、ファイル メニュー (Windows) またはメニュー バー (macOS) のアプリケーションの名前をクリックし、設定 をクリックします。

2. 左側のサイドバーで[ツール]をクリックし、[GitHub Copilot]をクリックします。をクリックし、[ 完了] をクリックします。

3. [言語] で、 GitHub Copilot をアクティブ化または非アクティブ化する言語のチェック ボックスをオンまたはオフにします。

4. 適用をクリックし、OK をクリックします。

5. 変更を有効にするには、JetBrains IDEを再起動します。

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

たとえば、macOS で IntelliJ IDEA 2021.1 を使用している場合、ファイルは ~/Library/Application Support/JetBrains/IdeaIC2021.1/options/github-copilot.xml にあります。

IDE の設定で既定の言語構成を変更するまで、github-copilot.xml ファイルが生成されない場合があります。 ファイルが見つからない場合は、IDE で既定の言語設定を変更してみてください。 詳細については、「IDE での言語設定の構成」を参照してください。

または、ファイルを手動で作成し、上記のオペレーティング システムの場所に保存することもできます。 詳細については、「言語構成の例」を参照してください。

1. テキスト エディターで github-copilot.xml ファイルを開きます。

2. <map>タグの間に、GitHub Copilotをアクティブ化または非アクティブ化する言語の行を追加します。 たとえば、すべての言語の GitHub Copilot を非アクティブ化するには、次のようにします。

   XML

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

3. 変更を github-copilot.xml ファイルに保存します。

4. 変更を有効にするには、JetBrains IDEを再起動します。

言語構成の例

すべての言語の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 をアクティブ化または非アクティブ化する言語ごとにエントリを追加します。 特定の言語設定は、ワイルドカードをオーバーライドします。 たとえば、Pythonと YAML のGitHub Copilotをアクティブ化し、他のすべての言語の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>

IDE の設定で読み取り languageAllowList 専用にする構成を追加することもできます。 これにより、IDE の言語設定は変更できなくなります。 次に例を示します。

<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 Pro+、またはCopilot Max（コパイロット・マックス）プランを使用している場合は、一般公開されているコードに一致するインライン提案を許可またはブロックすることができます。 これは、 GitHub.comの個人用設定で構成します。 「個々のサブスクライバーとしてのGitHub Copilot ポリシーの管理」を参照してください。

GHE.com 上のアカウントの認証

Copilot 上の マネージド ユーザー アカウント 用に GHE.com プランをお使いの場合は、サインインする前にいくつかの設定を更新する必要があります。 「AUTOTITLE」を参照してください。

参考資料

• GitHub Copilot FAQ