How to use Banned API analyzers in my own code

Question

Roslyn has banned analyzers feature. I want to use in my own code that compiles code dynamically (own scripting engine based on C# lang) via CSharpCompilation class with WithAnalyzers extension method.

I tried to add the package reference on nuget — Microsoft.CodeAnalysis.BannedApiAnalyzers , but the package cannot use as a regular nuget package. Class CSharpSymbolIsBannedAnalyzer marked as unknown.

My code:

var compilation = CSharpCompilation.Create(/* made syntax tree + dll refs */);

var analyzers = ImmutableArray.Create<DiagnosticAnalyzer>(
    new CSharpSymbolIsBannedAnalyzer()); // <- unknown type

var compilationWithAnalyzers = compilation.WithAnalyzers(
    analyzers,
    new AnalyzerOptions(ImmutableArray.Create<AdditionalText>(new BannedSymbolsAdditionalText(@"T:System.Diagnostics.Process;Don't use Process"))),
    cancellationToken);

But when I try to compile, I get:

CSharpSymbolIsBannedAnalyzer is unknown type.

Interestingly, github.com/dotnet/roslyn-analyzers/blob/main/src/… is public. — MartyIX
– MartyIX, Commented Sep 3, 2024 at 11:58

Martin Costello · Accepted Answer · 2023-09-06 12:16:20Z

18

To use the Banned API analyzers in your own project, you don't need to use the analyzer in code, you just add a NuGet package reference:

Add a reference to the NuGet package to you project(s):

<ItemGroup>
  <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4" PrivateAssets="All" />
</ItemGroup>

Add a BannedSymbols.txt file to the compilation for your projects:

<ItemGroup>
  <AdditionalFiles Include="$(MSBuildThisFileDirectory)BannedSymbols.txt" />
</ItemGroup>

Populate your BannedSymbols.txt file with the APIs you want to ban and why, for example:

P:System.DateTime.Now; Use System.DateTime.UtcNow instead.
M:System.DateTimeOffset.op_Implicit(System.DateTime); Do not implicitly cast DateTime to DateTimeOffset.

answered Sep 6, 2023 at 12:16

Martin Costello

11.1k5 gold badges66 silver badges78 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Jun Over a year ago

This is not what I am looking for. I am create own scripting engine based on C# lang. And I wanna put some banned API for warning uses.

galdin Over a year ago

Documentation link: github.com/dotnet/roslyn-analyzers/blob/main/src/…

OronDF343 May 29 at 13:33

Updated documentation link: github.com/dotnet/roslyn/blob/main/src/RoslynAnalyzers/…

Collectives™ on Stack Overflow

How to use Banned API analyzers in my own code

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related