Add banned API analyzers

Add to detect usage of problematic code patterns.
App-vNext · Sep 28, 2023 · c4eaa68 · c4eaa68
1 parent cf84069
commit c4eaa68
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -10,6 +10,7 @@
     <PackageVersion Include="FluentAssertions" Version="6.12.0" />
     <PackageVersion Include="GitHubActionsTestLogger" Version="2.3.3" />
     <PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="6.0.0" />
+    <PackageVersion Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4" />
     <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4" />
     <PackageVersion Include="Microsoft.Extensions.Caching.Memory" Version="$(MicrosoftExtensionsVersion)" />
     <PackageVersion Include="Microsoft.Extensions.Configuration" Version="$(MicrosoftExtensionsVersion)" />

diff --git a/eng/Analyzers.targets b/eng/Analyzers.targets
@@ -1,7 +1,9 @@
 <Project>
   <ItemGroup Label="Analyzers">
+    <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" PrivateAssets="All" />
     <PackageReference Include="SonarAnalyzer.CSharp" PrivateAssets="All" />
     <PackageReference Include="StyleCop.Analyzers" PrivateAssets="All" IncludeAssets="runtime; build; native; contentfiles; analyzers; buildtransitive" />
+    <AdditionalFiles Include="$(MSBuildThisFileDirectory)analyzers\BannedSymbols.txt" Condition=" '$(IsTestProject)' != 'true' " Visible="false" />
     <AdditionalFiles Include="$(MsBuildThisFileDirectory)analyzers\Stylecop.json" Visible="false" />
     <EditorConfigFiles Include="$(MsBuildThisFileDirectory)analyzers\Stylecop.globalconfig" />
     <EditorConfigFiles Include="$(MsBuildThisFileDirectory)analyzers\$(ProjectType).globalconfig" />

diff --git a/eng/analyzers/BannedSymbols.txt b/eng/analyzers/BannedSymbols.txt
@@ -0,0 +1,5 @@
+P:System.DateTime.Now; Use TimeProvider.GetLocalNow().DateTime instead.
+P:System.DateTime.Today; Use TimeProvider.GetLocalNow().DateTime.Date instead.
+P:System.DateTimeOffset.Now; Use TimeProvider.GetLocalNow() instead.
+P:System.DateTimeOffset.Today; Use TimeProvider.GetLocalNow().Date instead.
+M:System.DateTimeOffset.op_Implicit(System.DateTime); Do not implicitly cast DateTime to DateTimeOffset.