Unity開発でのミスを未然に防ぐRoslynアナライザーのすゝめ【DeNA TechCon 2022】

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Unity開発でのミスを未然に防ぐ Roslynアナライザーのすゝめシステム本部品質統括部品質管理部SWET第二グループ Kazuma Inagaki

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。自己紹介 - Kazuma Inagaki - 21新卒
- SWETグループ所属 - Vimmer

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 - Roslynアナライザーの概要 - Roslynアナライザーができること、使い方 - カスタムルールの作り方
- カスタムアナライザーをテストする方法 - 作成したアナライザーをUPMパッケージに内包して配布、利用する NOTE: バージョンによってバグによる制約があるため、このスライドではUnity 2021.2 + Rider Editor package v3.0.9を基準に書いています。目次

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Roslynアナライザーの概要 - Roslynとは - Roslynアナライザーとは

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Roslynとは - C#6.0から導入された.NETコンパイラプラットフォームの通称 - 公開されているもの -
C#、VB向けコンパイラ - コード生成API - コード解析API

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Roslynアナライザーとは - Roslynのコード解析APIを用いて作成された、コードの問題を検出するプログラムのこと

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。コンパイラオレオレルール - 型違反 - 未定義関数
- 未定義変数 - etc... - コーディング規約 - 非推奨のAPIの使用 - etc... 一般的なルール

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。コンパイラオレオレルール - 型違反 - 未定義関数
- 未定義変数 - etc... Roslynアナライザーにやってもらおう！一般的なルール

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。どうやってやってもらうんだ..?

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 IDE上でRoslynアナライザーを使用 IDE上にレポートされる IDE上で欠陥を作り込む Unity上でRoslynアナライザーを使用ビルド時にUnityエディタ上にレポートされる Unityを開く

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。それだけではない！

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。コンパイラオレオレルール - コーディング規約 - 非推奨のAPIの使用
- etc...

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。コンパイラオレオレルール - コーディング規約 - 非推奨のAPIの使用
- etc... エンジニア誰でも診断ルールを自作できる

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Roslynアナライザーができること、使い方 - 様々な診断ルールを持つアナライザーの紹介 - Unity上でRoslynアナライザーを使う方法 -
JetBrains Rider上でRoslynアナライザーを使う方法 - アナライザーTips

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。様々な診断ルールを持つアナライザーの紹介 - Microsoft.CodeAnalysis.BannedApiAnalyzer - 汎用的に特定のAPIを使用禁止にできるアナライザー -
例: UniTaskでなくTaskを使用していたら怒るルール - codecracker.CSharp - dispose漏れを怒るルール（CS0022） - DeNA内で作成したアナライザー - Preserve属性のつけ忘れを怒るルール

例: UniTaskでなくTaskを使用していたら怒るルール - codecracker.CSharp - dispose漏れを怒るルール（CS0022） - DeNA内で作成したアナライザー - Preserveのつけ忘れを怒るルール

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 public async Task M() { await
Task.Delay(100); } Taskを使用した例 UniTaskを使用した例 public async UniTask M() { await UniTask.Delay(100); }

Task.Delay(100); } Taskを使用した例 UniTaskを使用した例 UniTaskでなく、Taskを使っている public async UniTask M() { await UniTask.Delay(100); }

Task.Delay(100); } Taskを使用した例 UniTaskを使用した例 Do not used banned APIs public async UniTask M() { await UniTask.Delay(100); }

例: UniTaskでなくTaskを使用していたら怒るルール - codecracker.CSharp - dispose漏れを怒るルール（CS0022） - DeNA内で作成したアナライザー - Preserveのつけ忘れを怒るルール

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 public class MustDisposeClass : IDisposable {
} void M() { var hoge = new MustDisposeClass(); }

} void M() { var hoge = new MustDisposeClass(); } Disposeができていない！

} void M() { var hoge = new MustDisposeClass(); } MustDisposeClass should be disposed.

} void M() { var hoge = new MustDisposeClass(); }

} void M() { var hoge = new MustDisposeClass(); } using (var hoge = new MustDisposeClass()) { } void M() { var hoge = new MustDisposeClass(); hoge.Dispose(); }

例: UniTaskでなくTaskを使用していたら怒るルール - codecracker.CSharp - dispose漏れを怒るルール（CS0022） - DeNA内で作成したアナライザー - Preserve属性のつけ忘れを怒るルール

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 var services = new ServiceCollection(); services.AddSingleton<IGoodService,
GoodService>(); services.AddSingleton<IBadServiceNoInject, BadServiceNoInject>(); DIコンテナへの登録

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 public class GoodService : IGoodService {
[Preserve] public GoodService() { } } public class BadServiceNoInject : IBadServiceNoInject { public BadServiceNoInject() { } } var services = new ServiceCollection(); services.AddSingleton<IGoodService, GoodService>(); services.AddSingleton<IBadServiceNoInject, BadServiceNoInject>(); DIコンテナへの登録

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Preserve属性あり Preserve属性なし public class GoodService :
IGoodService { [Preserve] public GoodService() { } } public class BadServiceNoInject : IBadServiceNoInject { public BadServiceNoInject() { } } var services = new ServiceCollection(); services.AddSingleton<IGoodService, GoodService>(); services.AddSingleton<IBadServiceNoInject, BadServiceNoInject>(); DIコンテナへの登録

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 var services = new ServiceCollection(); services.AddSingleton<IGoodService,
GoodService>(); services.AddSingleton<IBadServiceNoInject, BadServiceNoInject>(); DIコンテナへの登録 Preserve属性あり Preserve属性なし public class GoodService : IGoodService { [Preserve] public GoodService() { } } public class BadServiceNoInject : IBadServiceNoInject { public BadServiceNoInject() { } } IL2CPPでビルドした時に最適化によって、直接使用されない且つ Preserve 属性の無いコンストラクタを持つクラスはストリップされる。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。バグの混入ビルドするクラッシュする public class BadServiceNoInject
: IBadServiceNoInject { public BadServiceNoInject () { } } ビルドが成功する端末等で操作

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザなしアナライザありビルドが失敗するミスが早く見つかる public class
BadServiceNoInject : IBadServiceNoInject { public BadServiceNoInject () { } } クラッシュする public class BadServiceNoInject : IBadServiceNoInject { public BadServiceNoInject () { } } ビルドが成功する端末等で操作

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Unity上でRoslynアナライザーを使う方法 - Unityへの導入の仕方 - Unityエディター上でのアナライザーの振る舞い

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 dllを、Unityプロジェクト下の任意のフォルダに配置する Unity上で設定するアナライザーが動作する範囲の設定をする Unityへの導入の仕方

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Assets/Hoge/ ├── Editor │ └── YourLibrary.Editor.asmdef
├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Assets/Hoge/ ├── Editor │ └── YourLibrary.Editor.asmdef
├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef Assets/Hoge/ ├── Analyzers │ ├── your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef Assets下の任意のディレクトリにアナライザーのdllを配置する

Unity上での設定の仕方 1. アナライザーのDLLをProjectウィンドウで選択（インスペクタが開く） 2. Select Platforms for plugin下のチェックボックスをすべてoff
3. Applyボタンをクリック 4. 栞アイコンをクリック 5. ウィンドウに”RoslynAnalyzer”と入力し、Enterを押す

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザーが動作する範囲の設定をする Assets/Hoge/ ├── Analyzers │ ├──
your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef

your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef YourLibrary.Runtimeアセンブリに含まれる C#スクリプト（YourLibraryCode.cs）にアナライザーを適用したい

your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef Assets/Hoge/ ├── Analyzers │ ├── Analyzers.asmdef │ ├── dummyFile.cs │ ├── your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef Assets下のアナライザーDLLが含まれるディレクトリにasmdefとダミーのC#スクリプトを配置する

your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef Assets/Hoge/ ├── Analyzers │ ├── Analyzers.asmdef │ ├── dummyFile.cs │ ├── your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef Analyzersを別アセンブリから参照する際にはアセンブリの生成が必要です。そのため、何かしらのC#スクリプトを置く必要があります。

Analyzers.asmdef │ ├── dummyFile.cs │ ├── your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef 1. アナライザーを適用したい asmdefをinspecterで開く（無い場合はasmdef作成する） 2. Assembly Defintion Reference にアナライザーを含むアセンブリ（Analyzers）を追加 3. applyを押す

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザーが動作する範囲の設定をする 1. アナライザーを適用したい asmdefをinspecterで開く（無い場合はasmdef作成する） 2.
Assembly Defintion Reference にアナライザーを含むアセンブリ（Analyzers）を追加 3. applyを押す

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Assets/Hoge/ ├── Analyzers │ ├── Analyzers.asmdef
│ ├── dummyFile.cs │ ├── your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef アナライザーが動作する範囲の設定をする Assets/your.library/ ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef YourLibrary.Runtimeアセンブリに含まれる C#コード（YourLibraryCode.cs）にアナライザーが適用されます。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Assets/Hoge/ ├── Analyzers │ ├── your.library.analyzers.asmdef
│ ├── your.library.analyzers.dll │ └── your.library.analyzers.dll.meta ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef アナライザーが動作する範囲の設定をする Assets/your.library/ ├── Editor │ └── YourLibrary.Editor.asmdef ├── Runtime │ ├── YourLibrary.Runtime.asmdef │ └── YourLibraryCode.cs └── Tests └── YourLibrary.Tests.asmdef YourLibrary.Runtimeアセンブリに含まれる C#コード（YourLibraryCode.cs）にアナライザーが適用されます。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Unity上でRoslynアナライザーを使う方法 - Unityへの導入の仕方 - Unityエディター上でのアナライザーの振る舞い

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Unityエディター上でのRoslynアナライザーの振る舞い ↑のように、重要度に応じた結果が出力される重要度がエラーなら、コンパイルエラーと同等の扱いになる

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 JetBrains Rider上でRoslynアナライザーを使う方法 Unity上にRoslynアナライザーを導入する Unityから、Assets |
Open C# Projectなどの操作をするだけ NOTE: Visual Studio、 VS Codeでの動作は未検証です。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 JetBrains Rider上でのRoslynアナライザーの振る舞いエディタ上に問題箇所がハイライトされ、修正ポップアップに詳細が表示される Code
| Inspect Code…から実行すれば、インスペクション結果ウィンドウに出力される NOTE: Visual Studio、 VS Codeでの動作は未検証です。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 RoslynアナライザーTips - 重要度の設定 - Roslynアナライザーの診断を抑制する方法 -
RoslynアナライザーをCI上で動かす NOTE: Visual Studio、VS Codeでの動作は未検証です。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザーの診断ルールごとに診断の重要度（severity）が設定されている - error - warning -
suggestion - silent - none

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 - CS1002: エラー - CS0219: 警告
各アナライザにはデフォルトの重要度が設定されている

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 - CS1002: エラー - CS0219: 警告
CS0219をエラーにしたいなぁ... 各アナライザにはデフォルトの重要度が設定されている

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 - ルールセットファイル - ルールセットファイル
- EditorConfig ファイル - DotSetting ファイル重要度設定の方法 Unity JetBrains Rider

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。ルールセットファイルによる重要度の設定 Assets/ ├── your.library.analyzers.dll ├──
your.library.analyzers.dll.meta ├── RethrowError.cs ├── Default.ruleset └── Subfolder ├── Subfoloder.asmdef └── RethrowError.cs Assets直下に Default.rulesetを配置する

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。ルールセットファイルによる重要度の設定 Assets/ ├── your.library.analyzers.dll ├──
your.library.analyzers.dll.meta ├── RethrowError.cs ├── Default.ruleset └── Subfolder ├── Subfoloder.asmdef └── RethrowError.cs Assets直下に ”Default.ruleset” という名前でファイルを配置する <?xml version="1.0" encoding="utf-8"?> <RuleSet Name="New Rule Set" Description=" " ToolsVersion="10.0"> <Rules AnalyzerId="your.library.analyzers" RuleNamespace="your.library.analyzers"> <Rule Id="YourAnalyzersID" Action="Error" /> </Rules> </RuleSet>

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。ルールセットファイルによる重要度の設定 <?xml version="1.0" encoding="utf-8"?> <RuleSet
Name="New Rule Set" Description=" " ToolsVersion="10.0"> <Rules AnalyzerId="your.library.analyzers" RuleNamespace="your.library.analyzers"> <Rule Id="YourAnalyzersID" Action="Error" /> </Rules> </RuleSet>

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。ルールセットファイルによる重要度の設定 <?xml version="1.0" encoding="utf-8"?> <RuleSet
Name="New Rule Set" Description=" " ToolsVersion="10.0"> <Rules AnalyzerId="your.library.analyzers" RuleNamespace="your.library.analyzers"> <Rule Id="YourAnalyzersID" Action="Error" /> </Rules> </RuleSet> アナライザーのIDを指定アナライザーの重要度を上書き

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザーに怒られるコードを仕方なく書いた自動生成されたコードに対してアナライザーが警告を出してしまうなぜ抑制するのか

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Roslynアナライザーの診断を抑制する方法 - ファイルパス、拡張子単位での抑制（Unityでは不可能） - クラス、メソッド単位での抑制 -
ステートメント単位での抑制

ファイルパス、拡張子単位の抑制 1. Preferences… | Editor | Inspection Settings を開く 2.
Elements to Skip で除外するフォルダや拡張子のパターンを追加する 3. Saveボタン右のプルダウンで、 Solution YOUR_PROJECT_NAME team-shared を選択して保存

Task.Delay(100); } Do not use Task. Use the UniTask

Task.Delay(100); } このメソッド内だけに限り使うことを許可したいなぁ ...

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 [SuppressMessage("ApiDesign", "RS0030")] public async Task M()
{ await Task.Delay(100); } このメソッド内だけに限り使うことを許可したいなぁ ...

{ await Task.Delay(100); } このメソッド内だけに限り使うことを許可したいなぁ ... アナライザーのID アナライザーのカテゴリー

{ await Task.Delay(100); } 警告を抑制出来る！アナライザーのID アナライザーのカテゴリー

Task.Delay(100); await Task.Delay(100); } Do not use Task. Use the UniTask.

Task.Delay(100); await Task.Delay(100); } Do not use Task. Use the UniTask. このステートメントに限り警告を抑制したい

Task.Delay(100); #pragma warning disable RS0030 await Task.Delay(100); #pragma warning restore RS0030 }

Task.Delay(100); #pragma warning disable RS0030 await Task.Delay(100); #pragma warning restore RS0030 } このステートメントに限り抑制出来る！

コマンドラインからバッチモードでUnityを起動コードをPush 注意: 一般的なlintツールとは異なり、コンパイルログに混ざってアナライザーの診断結果も出力される Copyright: Jenkins project
https://jenkins.io

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。目次 - Roslynアナライザーの概要 - Roslynアナライザーができること、使い方 -
カスタムルールの作り方 - カスタムアナライザをテストする方法 - 作成したアナライザーをUPMパッケージに内包して配布、利用する NOTE: バージョンによってバグによる制約があるため、このスライドではUnity 2021.2 + Rider Editor package v3.0.9を基準に書いています。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。カスタムルールの作り方 - ソリューションプロジェクトの作成 - 定義を検査する例 -
呼び出しを検査する例

ソリューション・プロジェクトを作成する 1. ソリューションを作成する 2. Analyzerのプロジェクトを作成する 3. プロジェクトをソリューションに追加する 4. 必要なパッケージをインストールする RoslynToyAnalyzer
├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.csproj │ └── RoslynToyAnalyzer.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet new sln -o RoslynToyAnalyzer

├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.csproj │ └── RoslynToyAnalyzer.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet new classlib -o RoslynToyAnalyzer

├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.csproj │ └── RoslynToyAnalyzer.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet sln add RoslynToyAnalyzer/RoslynToyAnalyzer.csproj

├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.csproj │ └── RoslynToyAnalyzer.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet add RoslynToyAnalyzer package Microsoft.CodeAnalysis.Analyzers --version 3.3.2 dotnet add RoslynToyAnalyzer package Microsoft.CodeAnalysis.CSharp --version 3.5.0

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。定義を検査する例 public class Foo { }
NamedTypeのシンボル名に小文字を含む命名に対して警告を出す

NamedTypeのシンボル名に小文字を含んだ名前 Foo が使用されています。

NamedTypeって何？

NamedTypeはclass、Enum、struct、 Interfaceを含んだシンボルの名前を意味します。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CSharp; using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics; using System.Collections.Immutable; using System.Linq; namespace RoslynToyAnalyzer { [DiagnosticAnalyzer(LanguageNames.CSharp)] public class RoslynToyAnalyzer : DiagnosticAnalyzer { private static readonly DiagnosticDescriptor _toyRule = new DiagnosticDescriptor( id: "TOY001", title: "NamedTypeのシンボルに小文字を含む命名を禁止するアナライザー", messageFormat: "NamedTypeのシンボルに小文字を含んだ命名 {0} が使用されています", category: "RoslynToyAnalyzer", defaultSeverity: DiagnosticSeverity.Error, isEnabledByDefault: true); public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(_toyRule); } } public override void Initialize(AnalysisContext context) { context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); context.EnableConcurrentExecution(); context.RegisterSymbolAction(AnalyzeSymbol, SymbolKind.NamedType); } private static void AnalyzeSymbol(SymbolAnalysisContext context) { var namedTypeSymbol = (INamedTypeSymbol)context.Symbol; if (namedTypeSymbol.Name.ToCharArray().Any(char.IsLower)) { var diagnostic = Diagnostic.Create( _toyRule, namedTypeSymbol.Locations[0], namedTypeSymbol.Name); context.ReportDiagnostic(diagnostic); } } }

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CSharp; using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics; using System.Collections.Immutable; using System.Linq; namespace RoslynToyAnalyzer { [DiagnosticAnalyzer(LanguageNames.CSharp)] public class RoslynToyAnalyzer : DiagnosticAnalyzer { private static readonly DiagnosticDescriptor _toyRule = new DiagnosticDescriptor( id: "TOY001", title: "NamedTypeのシンボルに小文字を含む命名を禁止するアナライザー", messageFormat: "NamedTypeのシンボルに小文字を含んだ命名 {0} が使用されています", category: "RoslynToyAnalyzer", defaultSeverity: DiagnosticSeverity.Error, isEnabledByDefault: true); public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(_toyRule); } } public override void Initialize(AnalysisContext context) { context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); context.EnableConcurrentExecution(); context.RegisterSymbolAction(AnalyzeSymbol, SymbolKind.NamedType); } private static void AnalyzeSymbol(SymbolAnalysisContext context) { var namedTypeSymbol = (INamedTypeSymbol)context.Symbol; if (namedTypeSymbol.Name.ToCharArray().Any(char.IsLower)) { var diagnostic = Diagnostic.Create( _toyRule, namedTypeSymbol.Locations[0], namedTypeSymbol.Name); context.ReportDiagnostic(diagnostic); } } } アナライザークラスアナライザーの診断ルールの宣言 SupportedDiagnosticsプロパティ（必須プロパティ） Initializeメソッド（必須メソッド）実際の診断を行うメソッドの実装

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 [DiagnosticAnalyzer(LanguageNames.CSharp)] public class RoslynToyAnalyzer : DiagnosticAnalyzer
{ public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { } public override void Initialize(AnalysisContext context) { } } アナライザーのベースとなるクラスを継承 DiagnosticAnalyzer属性をつける SupportedDiagnosticsメソッドの実装が必要（後述） Initializeメソッドの実装が必要（後述）アナライザークラスの作成

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 private static readonly DiagnosticDescriptor _toyRule =
new DiagnosticDescriptor( id: "TOY001", title: "NamedTypeのシンボルに小文字を含む命名を禁止するアナライザー ", messageFormat: "NamedTypeのシンボルに小文字を含んだ命名 {0} が使用されています ", category: "RoslynToyAnalyzer", defaultSeverity: DiagnosticSeverity.Error, isEnabledByDefault: true); アナライザーのカテゴリを指定診断時に出力する警告文のテンプレートを定義デフォルトの重要度を設定デフォルトで診断が有効な場合はtrueを返すアナライザーの診断ルールの宣言アナライザーのIDを指定診断内容を説明するタイトル

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get
{ return ImmutableArray.Create(_toyRule); } } 作成したアナライザが提供するアナライザーの一覧を配列で返す SupportedDiagnosticsプロパティの実装（必須） DiagnosticAnalyzerを継承したので、SupportedDiagnosticsプロパティの実装が必要

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 public override void Initialize(AnalysisContext context) {
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); context.EnableConcurrentExecution(); context.RegisterSymbolAction(AnalyzeSymbol, SymbolKind.NamedType); } コールバックを受け取りたい契機をAnalysisContextに登録する Initializeメソッドの実装（必須） Roslynコンパイラによってアナライザーがロードされると呼ばれるメソッド DiagnosticAnalyzerを継承したので、Initializeメソッドの実装が必要シンボルの意味解析ごとに動作させたいメソッド ”AnalyzeSymbol”を、”RegisterSymbolAction”で登録

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 private static void AnalyzeSymbol(SymbolAnalysisContext context) {
var namedTypeSymbol = (INamedTypeSymbol)context.Symbol; if (namedTypeSymbol.Name.ToCharArray().Any(char.IsLower)) { var diagnostic = Diagnostic.Create( _toyRule, namedTypeSymbol.Locations[0], namedTypeSymbol.Name); context.ReportDiagnostic(diagnostic); } } 診断に必要な情報を取得実際の診断を行うメソッドの実装診断結果を作成して返すシンボルの名前に小文字を含むか判定

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。呼び出しを検査する例 var hoge = new ArrayList();
System.Collections.ArrayListをインスタンス化しています。 System.Collections.Generic.Listを代わりに使用してください。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 using System.Collections.Generic; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics;
using System.Collections.Immutable; using Microsoft.CodeAnalysis.Operations; namespace RoslynToyAnalyzer { [DiagnosticAnalyzer(LanguageNames.CSharp)] public class RoslynToyAnalyzer : DiagnosticAnalyzer { private static readonly DiagnosticDescriptor _toyRule2 = new DiagnosticDescriptor( id: "TOY002", title: "System.Collections.ArrayListのインスタンス作成を禁止するアナライザー ", messageFormat: "System.Collections.ArrayListをインスタンス化しています。 System.Collections.Generic.Listを代わりに使用してください。", category: "RoslynToyAnalyzer", defaultSeverity: DiagnosticSeverity.Error, isEnabledByDefault: true); public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(_toyRule2); } } public override void Initialize(AnalysisContext context) { context.RegisterOperationAction(AnalyzeCreationObject, OperationKind.ObjectCreation); } private static void AnalyzeCreationObject(OperationAnalysisContext context) { var operation = (IObjectCreationOperation)context.Operation; var symbol = operation.Type; var symbolFullName = GetSymbolFullName(symbol); if (symbolFullName != "System.Collections.ArrayList") return; var diagnostic = Diagnostic.Create( _toyRule2, operation.Syntax.GetLocation(), symbol.Name); context.ReportDiagnostic(diagnostic); } private static string GetSymbolFullName(INamespaceOrTypeSymbol symbol) { var collectedNamespace = new List<string>(); while (symbol.Name != "") { collectedNamespace.Add(symbol.Name); symbol = symbol.ContainingNamespace; } collectedNamespace.Reverse(); return string.Join(".", collectedNamespace); } } }

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 using System.Collections.Generic; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Diagnostics;
using System.Collections.Immutable; using Microsoft.CodeAnalysis.Operations; namespace RoslynToyAnalyzer { [DiagnosticAnalyzer(LanguageNames.CSharp)] public class RoslynToyAnalyzer : DiagnosticAnalyzer { private static readonly DiagnosticDescriptor _toyRule2 = new DiagnosticDescriptor( id: "TOY002", title: "System.Collections.ArrayListのインスタンス作成を禁止するアナライザー ", messageFormat: "System.Collections.ArrayListをインスタンス化しています。 System.Collections.Generic.Listを代わりに使用してください。", category: "RoslynToyAnalyzer", defaultSeverity: DiagnosticSeverity.Error, isEnabledByDefault: true); public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(_toyRule2); } } public override void Initialize(AnalysisContext context) { context.RegisterOperationAction(AnalyzeCreationObject, OperationKind.ObjectCreation); } private static void AnalyzeCreationObject(OperationAnalysisContext context) { var operation = (IObjectCreationOperation)context.Operation; var symbol = operation.Type; var symbolFullName = GetSymbolFullName(symbol); if (symbolFullName != "System.Collections.ArrayList") return; var diagnostic = Diagnostic.Create( _toyRule2, operation.Syntax.GetLocation(), symbol.Name); context.ReportDiagnostic(diagnostic); } private static string GetSymbolFullName(INamespaceOrTypeSymbol symbol) { var collectedNamespace = new List<string>(); while (symbol.Name != "") { collectedNamespace.Add(symbol.Name); symbol = symbol.ContainingNamespace; } collectedNamespace.Reverse(); return string.Join(".", collectedNamespace); } } } Initializeメソッド（必須メソッド）実際の診断を行うメソッド完全修飾型名の取得

context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); context.EnableConcurrentExecution(); context.RegisterOperationAction(AnalyzeCreationObject, OperationKind.ObjectCreation); } コールバックを受け取りたい契機をAnalysisContextに登録する Initializeメソッドの実装（必須） Roslynコンパイラによってアナライザーがロードされると呼ばれるメソッド DiagnosticAnalyzerを継承したので、Initializeメソッドの実装が必要オブジェクトのインスタンスが作成されるごとに動作させたいメソッド ”AnalyzeCreationObject”を、”RegisterOperationAction”で登録

context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None); context.EnableConcurrentExecution(); context.RegisterOperationAction(AnalyzeCreationObject, OperationKind.ObjectCreation); } Initializeメソッドの実装（必須） - メソッド呼び出し（Invocation） - 変数初期化（VariableInitializer） - 配列の作成（ArrayCreation） - Etc… See also: https://docs.microsoft.com/ja-jp/dotnet/api/microsoft.codeanalysis.operationkind

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 private static void AnalyzeCreationObject(OperationAnalysisContext context) {
var operation = (IObjectCreationOperation)context.Operation; var symbol = operation.Type; var symbolFullName = GetSymbolFullName(symbol); if (symbolFullName != "System.Collections.ArrayList") return; var diagnostic = Diagnostic.Create( _toyRule2, operation.Syntax.GetLocation(), symbol.Name); context.ReportDiagnostic(diagnostic); } 診断に必要な情報を取得実際の診断を行うメソッドの実装診断結果を作成して返すシンボルの完全修飾型名を取得（後述）シンボルの型を取得

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 private static string GetSymbolFullName(INamespaceOrTypeSymbol symbol) {
var collectedNamespace = new List<string>(); while (symbol.Name != "") { collectedNamespace.Add(symbol.Name); symbol = symbol.ContainingNamespace; } collectedNamespace.Reverse(); return string.Join(".", collectedNamespace); } シンボルの完全修飾型名を取得するメソッドの実装 .を連結して文字列として返すシンボルの型を再帰的にたどる NOTE: .NETでは完全修飾型名には”.”以外の文字列が含まれますが、Roslynの既存実装では”+”を使っていないため、それに合わせています。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。目次 - Roslynアナライザーの概要 - Roslynアナライザーができること、使い方 -
カスタムルールの作り方 - カスタムアナライザをテストする方法 - 作成したアナライザーをUPMパッケージに内包して配布、利用する NOTE: バージョンによってバグによる制約があるため、このスライドではUnity 2021.2 + Rider Editor package v3.0.9を基準に書いています。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。カスタムアナライザーをテストする - ソリューションプロジェクトの作成 - テストコードの解説 -
テストを簡単に書くTips

ソリューション・プロジェクトを作成する 1. テストのプロジェクトを作成 2. テストプロジェクトをソリューションに追加 3. テストコードプロジェクトからの参照を追加 4. テストに必要なパッケージをインストール RoslynToyAnalyzer
├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.cs │ └── RoslynToyAnalyzer.csproj ├── RoslynToyAnalyzer.Test │ ├── RoslynToyAnalyzer.Test.csproj │ └── RoslynToyAnalyzerTest.cs └── RoslynToyAnalyzers.sln 実行コマンド

ソリューション・プロジェクトを作成する 1. テストのプロジェクトを作成 2. テストプロジェクトをソリューションに追加 3. テストコードプロジェクトからの参照を追加 4. テストに必要なパッケージをインストール RoslynToyAnalyzer
├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.cs │ └── RoslynToyAnalyzer.csproj ├── RoslynToyAnalyzer.Test │ ├── RoslynToyAnalyzer.Test.csproj │ └── RoslynToyAnalyzerTest.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet new nunit -o RoslynToyAnalyzer.Test

ソリューション・プロジェクトを作成する 1. テストのプロジェクトを作成 2. テストプロジェクトをソリューションへ追加 3. テストコードプロジェクトからの参照を追加 4. テストに必要なパッケージをインストール RoslynToyAnalyzer
├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.cs │ └── RoslynToyAnalyzer.csproj ├── RoslynToyAnalyzer.Test │ ├── RoslynToyAnalyzer.Test.csproj │ └── RoslynToyAnalyzerTest.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet sln RoslynToyAnalyzers.sln add RoslynToyAnalyzer.Test/RoslynToyAnalyzer.Test.csproj

├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.cs │ └── RoslynToyAnalyzer.csproj ├── RoslynToyAnalyzer.Test │ ├── RoslynToyAnalyzer.Test.csproj │ └── RoslynToyAnalyzerTest.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet add RoslynToyAnalyzer.Test/RoslynToyAnalyzer.Test.csproj reference RoslynToyAnalyzer/RoslynToyAnalyzer.csproj

├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.cs │ └── RoslynToyAnalyzer.csproj ├── RoslynToyAnalyzer.Test │ ├── RoslynToyAnalyzer.Test.csproj │ └── RoslynToyAnalyzerTest.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.Analyzers --version 3.3.2 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp --version 3.5.0 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.Workspaces --version 3.5.0 dotnet add RoslynToyAnalyzer.Test package Dena.CodeAnalysis.Testing --version 2.0.0

├── RoslynToyAnalyzer │ ├── RoslynToyAnalyzer.cs │ └── RoslynToyAnalyzer.csproj ├── RoslynToyAnalyzer.Test │ ├── RoslynToyAnalyzer.Test.csproj │ └── RoslynToyAnalyzerTest.cs └── RoslynToyAnalyzers.sln 実行コマンド dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.Analyzers --version 3.3.2 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp --version 3.5.0 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.Workspaces --version 3.5.0 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.Analyzer.Testing.MSTest --version 1.1.0 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.CodeFix.Testing.MSTest --version 1.1.0 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.CodeRefactoring.Testing.MSTest --version 1.1.0 dotnet add RoslynToyAnalyzer.Test package Dena.CodeAnalysis.Testing --version 2.0.0 実行コマンド dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.Analyzers --version 3.3.2 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp --version 3.5.0 dotnet add RoslynToyAnalyzer.Test package Microsoft.CodeAnalysis.CSharp.Workspaces --version 3.5.0 dotnet add RoslynToyAnalyzer.Test package Dena.CodeAnalysis.Testing --version 2.0.0

テストを簡単に書くTips 今回はNUnitを用いて説明します

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 using System.Linq; using System.Threading.Tasks; using Dena.CodeAnalysis.CSharp.Testing;
using Microsoft.CodeAnalysis.Text; using NUnit.Framework; namespace RoslynToyAnalyzer.Test { public class RoslynToyAnalyzerTest { 　　　　[Test] public async Task RoslynToyAnalyzer_クラスのシンボル名に小文字を含む_Toy001がレポートされる() { const string testData = @" /// public static class Foo { } "; var analyzer = new RoslynToyAnalyzer(); var actual = await DiagnosticAnalyzerRunner.Run(analyzer, testData); Assert.AreEqual(1, actual.Length); Assert.AreEqual("TOY001", actual.First().Id); Assert.AreEqual("NamedTypeのシンボルに小文字を含んだ命名 Foo が使用されています", actual.First().GetMessage()); LocationAssert.HaveTheSpan( new LinePosition(2, 20), new LinePosition(2, 23), actual.First().Location); } } }

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 using System.Linq; using System.Threading.Tasks; using Dena.CodeAnalysis.CSharp.Testing;
using Microsoft.CodeAnalysis.Text; using NUnit.Framework; namespace RoslynToyAnalyzer.Test { public class RoslynToyAnalyzerTest { 　　　　[Test] public async Task RoslynToyAnalyzer_クラスのシンボル名に小文字を含む_Toy001がレポートされる() { const string testData = @" /// public static class Foo { } "; var analyzer = new RoslynToyAnalyzer(); var actual = await DiagnosticAnalyzerRunner.Run(analyzer, testData); Assert.AreEqual(1, actual.Length); Assert.AreEqual("TOY001", actual.First().Id); Assert.AreEqual("NamedTypeのシンボルに小文字を含んだ命名 Foo が使用されています", actual.First().GetMessage()); LocationAssert.HaveTheSpan( new LinePosition(2, 20), new LinePosition(2, 23), actual.First().Location); } } } テストメソッドの準備テストデータの準備テストの実行期待値と実測値の比較

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 public class RoslynToyAnalyzerTest { 　　　　[Test] public
async Task RoslynToyAnalyzer_クラスのシンボル名に小文字を含む _Toy001がレポートされる() { // ここにテストを書いていく } } テストメソッドの準備テストメソッドに[Test]属性をつける

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 const string testData = @" ///
public static class Foo { } "; テストデータの準備アナライザーの診断対象として渡すC#のコードを記述

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 var analyzer = new RoslynToyAnalyzer(); var
actual = await DiagnosticAnalyzerRunner.Run(analyzer, testData); テストの実行テスト対象のアナライザーのインスタンスを作成アナライザーのインスタンスとテストデータを渡し、実測値を取得（DeNAがOSSとして公開しているパッケージです） See also: https://github.com/DeNA/Dena.CodeAnalysis.Testing

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Assert.AreEqual(1, actual.Length); Assert.AreEqual("TOY001", actual.First().Id); Assert.AreEqual("NamedTypeのシンボルに小文字を含んだ命名 Foo
が使用されています ", actual.First().GetMessage()); LocationAssert.HaveTheSpan( new LinePosition(2, 20), // 期待する始点 new LinePosition(2, 23), // 期待する終点 actual.First().Location); 実測値と期待値の比較アナライザーが出力した警告の数と期待値を比較診断結果に含まれる解析対象の位置と期待値（始点と終点）を比較（DeNAがOSSとして公開しているパッケージです） See also: https://github.com/DeNA/Dena.CodeAnalysis.Testing アナライザーのIDと期待値を比較アナライザーが出力した警告文と期待値を比較差分表示例

テストを簡単に書くTips

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。これまでに紹介したテストの問題点 - 警告される位置がわかりにくい - 一度にAssertをたくさんしている

public static class Foo { } "; テストデータの準備アナライザーの診断対象として渡すC#のコードを記述

public static class Foo { } "; テストデータの準備どの部分がアナライザーに怒られることを期待するのかわからない... テストの意図が、テストデータを見ただけで分かりづらい...

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 public static class {|Foo|TOY001|クラス名のシンボルに小文字を含んだ命名 Foo が使用されています
|} { } public static class Foo { } 参考 https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/UnitTests/SymbolIsBannedAnalyzerTests.cs

|} { } public static class Foo { } 警告が出る箇所の期待値警告が出る位置期待するアナライザーのID 期待する警告文参考 https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/UnitTests/SymbolIsBannedAnalyzerTests.cs

|} { } public static class Foo { } 警告が出る箇所の期待値警告が出る位置期待するアナライザーのID 期待する警告文マーカーを抽出する参考 https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/UnitTests/SymbolIsBannedAnalyzerTests.cs

|} { } public static class Foo { } 警告が出る箇所の期待値警告が出る位置期待するアナライザーのID 期待する警告文マーカーを抽出するマーカーを除外し、ソースコードを作成マーカーから期待値（DiagnosticのList）を作成参考 https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/UnitTests/SymbolIsBannedAnalyzerTests.cs

|} { } public static class Foo { } 警告が出る箇所の期待値警告が出る位置期待するアナライザーのID 期待する警告文マーカーを除外し、ソースコードを作成マーカーから期待値（DiagnosticのList）を作成アサーションで実測値と比較するアナライザーに渡し、実測値を作成する参考 https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/UnitTests/SymbolIsBannedAnalyzerTests.cs

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。　　　　var analyzer = new RoslynToyAnalyzer(); 　　　　var
(source, expectedDiagnostics) = 　　　　ReadAndParseTestData.CreateSourceAndExpectedDiagnosticFromFile(@" /// public static class {|Foo|TOY001|NamedTypeのシンボルに小文字を含んだ命名 Foo が使用されています |} { } "); 　　　　var actualDiagnostics = await DiagnosticAnalyzerRunner.Run( analyzer, source 　　　　); テストの意図が、テストデータを見ただけでわかる！テストの期待値をマーカーから自動で生成できる！

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。これまでに紹介したテストの問題点 - 警告される位置がわかりにくい - 一度にAssertをたくさんしている

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Assert.AreEqual(expectedDiagnostics.Count, actualDiagnostics.Length); Assert.AreEqual(expectedDiagnostics.First().Id, actualDiagnostics.First().Id); Assert.AreEqual(expectedDiagnostics.First().GetMessage(), actualDiagnostics.First().GetMessage());
Assert.AreEqual(expectedDiagnostics.First().Location.GetLineSpan(), actualDiagnostics.First().Location.GetLineSpan()); Assertを一度にたくさんしている

Assert.AreEqual(expectedDiagnostics.First().Location.GetLineSpan(), actualDiagnostics.First().Location.GetLineSpan()); - レポートされた問題の数 - レポートされた問題のファイル内の位置 - アナライザーの ID - レポートされた問題を人間にわかりやすく説明したメッセージを比較している。

Assert.AreEqual(expectedDiagnostics.First().Location.GetLineSpan(), actualDiagnostics.First().Location.GetLineSpan()); これらを一度に比較したい！

Assert.AreEqual(expectedDiagnostics.First().Location.GetLineSpan(), actualDiagnostics.First().Location.GetLineSpan());

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 DiagnosticsAssert.AreEqual(IEnumerable<Diagnostic> expected, IEnumerable<Diagnostic> actual); レポートされた問題の数（ DiagnosticのIEnumerableの個数）
レポートされた問題のファイル内の位置（ファイルパス含む）アナライザーの ID メッセージの4つの観点を比較している Assert.AreEqual(expectedDiagnostics.Count, actualDiagnostics.Length); Assert.AreEqual(expectedDiagnostics.First().Id, actualDiagnostics.First().Id); Assert.AreEqual(expectedDiagnostics.First().GetMessage(), actualDiagnostics.First().GetMessage()); Assert.AreEqual(expectedDiagnostics.First().Location.GetLineSpan(), actualDiagnostics.First().Location.GetLineSpan());

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 DiagnosticsAssert.AreEqual(IEnumerable<Diagnostic> expected, IEnumerable<Diagnostic> actual); レポートされた問題の数（ DiagnosticのIEnumerableの個数）
レポートされた問題のファイル内の位置（ファイルパス含む）アナライザーの ID メッセージの4つの観点を比較している Assert.Fail failed. Missing 1 diagnostics, extra 1 diagnostics of all 1 diagnostics: missing path/to/file1.cs: (1,2)-(3,4), CS1001, Identifier expected extra path/to/file2.cs: (5,6)-(7,8), CS1002, ; expected 出力例 Assert.AreEqual(expectedDiagnostics.Count, actualDiagnostics.Length); Assert.AreEqual(expectedDiagnostics.First().Id, actualDiagnostics.First().Id); Assert.AreEqual(expectedDiagnostics.First().GetMessage(), actualDiagnostics.First().GetMessage()); Assert.AreEqual(expectedDiagnostics.First().Location.GetLineSpan(), actualDiagnostics.First().Location.GetLineSpan());

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザーをUPMパッケージとして配布、利用する - 配布する方法 - 利用する方法

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザを作成楽に配布したい気軽に使ってほしい

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。配布する方法 UPMパッケージを配布用に作成する Roslynアナライザーのdllを内包する OpenUPM、gitリポジトリ等で配布する自作UPMパッケージ Roslynアナライザーのdllを同梱する

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。アナライザーをUPMパッケージとして配布、利用する - 配布する方法 - 利用する方法

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 UPMパッケージをインストールする Asmdefの参照によるスコープ設定 NOTE: 既出のスライドを参照 NOTE:
Code Editor Package for VS v1.2.4以降、Code Editor Package for VSCode v2.0.11以降でも利用可能利用する方法

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。 Roslynアナライザーは... コンパイラが検知できない欠陥を検知できる自作、配布が簡単にできるニーズに合った
利用ができる

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。参考にしたサイト - Unityプロジェクト向けRoslynアナライザの作り方 - https://swet.dena.com/entry/2021/05/25/100000 -
カスタムRoslyn AnalyzerをUPMパッケージとして配布する - https://www.nowsprinting.com/entry/2021/11/01/083258 - Unity 2020.時点のRoslyn Analyzerサポート状況まとめ - https://www.nowsprinting.com/entry/2021/04/18/200619 - Microsoft.CodeAnalysis.BannedApiAnalyzer - https://github.com/dotnet/roslyn-analyzers/tree/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers - codecracker.CSharp - https://github.com/code-cracker/code-cracker - UniTask - https://github.com/Cysharp/UniTask

こちらに登壇時の映像をいれるので、文字を載せないようにして下さい。

Unity開発でのミスを未然に防ぐRoslynアナライザーのすゝめ【DeNA TechCon 2022】

Unity開発でのミスを未然に防ぐRoslynアナライザーのすゝめ【DeNA TechCon 2022】

More Decks by DeNA_Tech

Other Decks in Technology

Featured

Transcript