New BannedSymbols feature

scottbilas · Dec 1, 2024 · 76c2bc1 · 76c2bc1
1 parent f161aac
commit 76c2bc1
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 2 deletions.
diff --git a/src/Core/BannedSymbols.txt b/src/Core/BannedSymbols.txt
@@ -0,0 +1 @@
+// https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md
diff --git a/src/Core/Core.csproj b/src/Core/Core.csproj
@@ -1,5 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <PropertyGroup><OkFeatures>T4;NetMulti</OkFeatures></PropertyGroup>
+  <PropertyGroup><OkFeatures>T4;NetMulti;BannedSymbols</OkFeatures></PropertyGroup>
   <Import Project="$(OkTargetsRoot)Library.targets" />
 
   <PropertyGroup>

diff --git a/src/Terminal/BannedSymbols.txt b/src/Terminal/BannedSymbols.txt
@@ -0,0 +1,6 @@
+// https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md
+
+T:System.IO.Path;Use NiceIO NPath instead
+T:System.IO.Directory;Use NiceIO NPath instead
+M:System.Text.StringBuilder.AppendLine;Use AppendLf instead
+M:System.Text.StringBuilder.AppendLine(System.String);Use AppendLf instead
diff --git a/src/Terminal/Terminal.csproj b/src/Terminal/Terminal.csproj
@@ -1,5 +1,5 @@
 <Project Sdk="Microsoft.NET.Sdk">
-  <PropertyGroup><OkFeatures>Core;NetMulti</OkFeatures></PropertyGroup>
+  <PropertyGroup><OkFeatures>Core;NetMulti;BannedSymbols</OkFeatures></PropertyGroup>
   <Import Project="$(OkTargetsRoot)Library.targets" />
 
   <PropertyGroup>
@@ -25,6 +25,7 @@
     <None Include="../../LICENSE.md" Pack="true" PackagePath="/" />
   </ItemGroup>
 
+  <!-- dependencies -->
   <ItemGroup>
     <PackageReference Include="docopt.net" />
     <PackageReference Include="Spectre.Console" />

diff --git a/targets/Library.targets b/targets/Library.targets
@@ -91,6 +91,16 @@
     <NoWarn>$(NoWarn);RS0030</NoWarn>
   </PropertyGroup>
 
+  <!-- Feature: BannedSymbols -->
+
+  <ItemGroup Condition=" $(OkFeatures.Contains(';BannedSymbols;')) ">
+    <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <!-- put this in the csproj also: <AdditionalFiles Include="BannedSymbols.txt"/> -->
+  </ItemGroup>
+
   <!-- Feature: T4 -->
   <!-- TEMPORARILY DISABLED - T4.Build does not support .NET 8 SDK, gets an error from a missing assembly.
        just go with manual Rider-based T4 for now. -->
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		// https://github.com/dotnet/roslyn-analyzers/blob/main/src/Microsoft.CodeAnalysis.BannedApiAnalyzers/BannedApiAnalyzers.Help.md