UnityではRoslynアナライザーのどのバージョンを使えばいいのか

Unity 2020.2 からUnityエディターでRoslynアナライザー（およびソースジェネレーター）がサポートされましたが、Unityエディタに同梱されているMicrosoft.CodeAnalysis.CSharpのバージョンよりも新しいバージョンでコンパイルされたアナライザーは動作しません。

どのバージョンが動作するのか、過去記事などで紹介したものもありますが、できるだけ最新のバージョンを使いたいと考えると都度確認せざるを得ず、とても面倒です。そこで、Unity の各バージョンに対してどのバージョンが使用できるかを網羅したリファレンスリポジトリを作りました。

github.com

アナライザーごとのUnityで動作するバージョン情報

たとえばIDisposableAnalyzersページを見ると、最新バージョンは4.0.8ですが、 Unity 2022.2以降ではv4.0.4、 Unity 2022.2未満ではv3.4.15 を使用しなければならないことがわかるようになっています。

Version	Microsoft.CodeAnalysis.CSharp	Unity 2020.2	Unity 2021.2	Unity 2022.2	Unity 6000.0
4.0.8	4.5.0.0	❌	❌	❌	❌
4.0.7	4.5.0.0	❌	❌	❌	❌
4.0.6	4.5.0.0	❌	❌	❌	❌
4.0.5	4.5.0.0	❌	❌	❌	❌
4.0.4	4.0.0.0	❌	❌	✅	✅
4.0.3	4.0.0.0	❌	❌	✅	✅
4.0.2	4.0.0.0	❌	❌	✅	✅
4.0.1	4.0.0.0	❌	❌	✅	✅
4.0.0	4.0.0.0	❌	❌	✅	✅
3.4.15	3.5.0.0	✅	✅	✅	✅

なお、Microsoft.CodeAnalysis.CSharp以外の依存はチェックしていませんのでご注意ください。たとえばNUnit.Analyzersは最新のv4.11.2までUnity 2022.2以降で動作するように見えますが、v4系はNUnit 4が前提であり、Unity Test FrameworkではNUnit 3ベースのv3.9.0*1までしか使えません。

アナライザーの追加・更新

アナライザーの検証および表の生成はGitHub Actionsワークフローになっており、リポジトリに無いアナライザも次の手順で確認できます。

リポジトリをフォークします
フォークリポジトリでGitHub Actions workflowを実行します
1. リポジトリのページで Actions > Check Roslyn Analyzer Versions を開く
2. Run workflow ドロップダウンをクリック
3. NuGetのパッケージIDを入力 (e.g., Microsoft.Unity.Analyzers)
4. Run workflow ボタンをクリック
ワークフローが実行され、新しいブランチにMarkdownファイルがpushされます