環境での GitHub Copilot の構成

JetBrains IDE の GitHub Copilot について

JetBrains IDE を使う場合、GitHub Copilot は、入力時にコードをオートコンプリートできます。 インストール後、GitHub Copilot を有効または無効にしたり、IDE または GitHub.com で詳細設定を構成したりできます。 この記事では、IntelliJ IDE で GitHub Copilot を構成する方法について説明しますが、他の JetBrains IDE のユーザー インターフェイスは異なる場合があります。

前提条件

JetBrains IDE で GitHub Copilot を構成するには、GitHub Copilot プラグインをインストールする必要があります。 詳しくは、「Getting started with GitHub Copilot」を参照してください。

GitHub Copilot のキーボード ショートカットの使用または再バインド

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

macOS のキーボード ショートカット

Windows のキーボード ショートカット

Linux のキーボード ショートカット

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 では、コードの入力候補の表示方法や、GitHub Copilotで有効にする言語、無効にする言語など、GitHub Copilot の詳細設定を管理できます。

1. JetBrains IDE で、ファイル メニュー (Windows) またはメニュー バー (macOS) のアプリケーションの名前をクリックし、設定 をクリックします。
2. Languages & Frameworks で、 [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. Languages & Frameworks で、 [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
• Windows: %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 を有効にする github-copilot.xml ファイルの既定の構成は次のとおりです。

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

GitHub Copilot の設定を GitHub.com

で構成する

GitHub Copilot の使用を開始する前に、サブスクリプションを設定する必要があります。 詳細については、「個人アカウントの GitHub Copilot サブスクリプションの管理」または「組織またはエンタープライズの GitHub Copilot サブスクリプションを管理する」を参照してください。

アクティブな GitHub Copilot サブスクリプションがある場合、GitHub Copilot 設定で GitHub 上の個人用アカウントの GitHub Copilot 設定を調整できます。 この設定は、GitHub Copilot を使うすべての場所に適用されます。 GitHub Copilot が提示する候補と、GitHub がテレメトリ データを使う方法を構成できます。

重複検出の有効化または無効化

GitHub Copilot には、GitHub のパブリック コードと一致するコード候補を検出するフィルターが含まれています。 フィルターを有効または無効にすることを選択できます。 フィルターが有効になっていると、GitHub Copilot によって、周囲の約 150 文字のコードに関するコード候補が、GitHub でのパブリック コードに対してチェックされます。 一致または近い一致がある場合、候補は表示されません。

1. 任意のページで、右上隅にあるプロファイルの画像をクリックし、次に[設定]をクリックします。

   

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

3. Suggestions matching public code でドロップダウン メニューを選択し、 Allow をクリックして公開コードに一致する候補を許可するか、 Block をクリックして公開コードに一致する候補をブロックします。

4. 新しい設定を確認するには、 [保存] をクリックします。

参考資料

• GitHub Copilot FAQ