GitHub Copilotのコンテキストスコープを調べる

はじめに

こんにちは、ACS事業部の瀧澤です。
普段Copilotを使っている中で、コード提案の元になるコンテキストはどのファイルまでを読み込んでいるのか、ふと疑問に思いました。

公式ページには以下のような記載があります。

GitHub Copilot は、編集中のファイルや関連ファイルのコンテキストを分析し、テキスト エディター内から候補の提示を行います。

今回はこの「関連ファイル」がどこまでの範囲を指すのか、確認してみます。

検証環境

OS: macOS
IDE: VSCode(Version: 1.79.2)
- GitHub Copilot(v1.94.220)
言語: python

IDEによって挙動が違うかもしれませんが、今回は個人的に普段使っているVSCodeでの検証をします。

準備

コンテキストとして読み込ませる事前情報を用意します。 github-copilotという空ディレクトリの直下にcontext.pyという名前でファイルを作成、以下のような簡単なコードを記述します。

context.py

def add_numbers_with_print(a, b):
    print("aとbの足し算を行います")
    return a + b

※このコードを元に提案していると判断できるよう、日本語のprint文をつけています。

似たような名前で関数を定義しようとした時、上記コードを踏まえた内容を提案してくれるかどうかでファイルがコンテキストに含まれているか判断します。

同ファイル内だともちろんですが以下のように提案をしてくれます。

検証

同ワークスペース配下の別ファイル

github-copilotディレクトリをルートとしてVSCodeワークスペースを開きます。まずはcontext.pyと同じ階層にファイルを作成した場合です。（サジェストを表示させたい方のファイル名はsuggest.pyにしています） context.pyの内容を踏まえて提案してくれました。

次に適当なディレクトリ配下にsuggest.pyを置いた場合です。
github-copilot配下に適当な複数階層ディレクトリ（a/b/c、d/e）を作成、その配下にそれぞれsuggest.pyとcontext.pyを配置してみます。（最初に作ったsuggest.pyは削除済）ディレクトリを跨いでいてもcontext.pyの内容を汲み取ってくれました。
VSCodeのワークスペースで開かれている範囲のファイルはディレクトリの深い階層にあってもコンテキストに含まれる様です。

ワークスペース外のファイル

今度はワークスペース外のファイルについても確認してみます。
先程作成したディレクトリaをワークスペースのルートとしてVSCodeを開きなおします。
context.pyはワークスペースに含まれていません。当然と言えば当然ですが、context.pyの内容を反映した提案はされなくなりました。（ここで反映されていたらローカルのファイルシステムを全部読み込もうとしていることになってしまいますね）