Replace roslyn PublicAPI analyzers with apicompat tool

Author: AArnott

.config/dotnet-tools.json

@@ -29,6 +29,13 @@
         "docfx"
       ],
       "rollForward": false
+    },
+    "microsoft.dotnet.apicompat.tool": {
+      "version": "9.0.304",
+      "commands": [
+        "apicompat"
+      ],
+      "rollForward": false
     }
   }
-}
+}

.github/workflows/build.yml

@@ -58,6 +58,13 @@ jobs:
     - name: 🧪 NativeAOT test
       run: dotnet publish -c Release -r ${{ matrix.rid }}-x64 -warnaserror
       working-directory: test/NativeAOTCompatibility
+    - name: 📋 API compat test
+      run: |
+        Invoke-WebRequest -Uri https://www.nuget.org/api/v2/package/nerdbank.streams -OutFile obj/nerdbank.streams.baseline.nupkg
+        $pkgPath = (gci ./bin/Packages/Release/NuGet/Nerdbank.Streams.*.nupkg).FullName
+        dotnet apicompat package $pkgPath --baseline-package obj/nerdbank.streams.baseline.nupkg --suppression-file ./src/Nerdbank.Streams/ApiCompatSuppressions.xml
+      shell: pwsh
+      if: runner.os == 'Linux'
 
     - name: ⚙️ Use Node.js 16.x
       uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4

Directory.Packages.props

@@ -14,7 +14,6 @@
     <PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="$(AspNetCoreVersion)" />
     <PackageVersion Include="Microsoft.AspNetCore" Version="$(AspNetCoreVersion)" />
     <PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" />
-    <PackageVersion Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.4" />
     <PackageVersion Include="Microsoft.VisualStudio.Threading.Analyzers" Version="$(VSThreadingVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Threading.Only" Version="$(VSThreadingVersion)" />
     <PackageVersion Include="Microsoft.VisualStudio.Threading" Version="$(VSThreadingVersion)" />

src/Nerdbank.Streams/ApiCompatSuppressions.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- https://learn.microsoft.com/dotnet/fundamentals/package-validation/diagnostic-ids -->
+<Suppressions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <Suppression>
+    <!-- False positive: https://github.com/dotnet/sdk/issues/50672 -->
+    <DiagnosticId>CP0001</DiagnosticId>
+    <Target>T:System.Buffers.SequenceReader`1</Target>
+    <Left>lib/netstandard2.0/Nerdbank.Streams.dll</Left>
+    <Right>lib/netstandard2.1/Nerdbank.Streams.dll</Right>
+  </Suppression>
+  <Suppression>
+    <!-- False positive: https://github.com/dotnet/sdk/issues/50672 -->
+    <DiagnosticId>CP0001</DiagnosticId>
+    <Target>T:System.Buffers.SequenceReaderExtensions</Target>
+    <Left>lib/netstandard2.0/Nerdbank.Streams.dll</Left>
+    <Right>lib/netstandard2.1/Nerdbank.Streams.dll</Right>
+  </Suppression>
+  <Suppression>
+    <!-- False positive: https://github.com/dotnet/sdk/issues/50671 -->
+    <DiagnosticId>CP0012</DiagnosticId>
+    <Target>M:Nerdbank.Streams.BufferTextWriter.Write(System.ReadOnlySpan{System.Char})</Target>
+    <Left>lib/netstandard2.0/Nerdbank.Streams.dll</Left>
+    <Right>lib/netstandard2.1/Nerdbank.Streams.dll</Right>
+  </Suppression>
+  <Suppression>
+    <!-- False positive: https://github.com/dotnet/sdk/issues/50671 -->
+    <DiagnosticId>CP0012</DiagnosticId>
+    <Target>M:Nerdbank.Streams.BufferTextWriter.WriteLine(System.ReadOnlySpan{System.Char})</Target>
+    <Left>lib/netstandard2.0/Nerdbank.Streams.dll</Left>
+    <Right>lib/netstandard2.1/Nerdbank.Streams.dll</Right>
+  </Suppression>
+</Suppressions>

src/Nerdbank.Streams/Nerdbank.Streams.csproj

@@ -12,7 +12,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Condition="'$(TargetFramework)' == 'netstandard2.0'" />
-    <PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" PrivateAssets="all" />
     <PackageReference Include="Microsoft.VisualStudio.Threading.Only" PrivateAssets="build;analyzers;compile" />
     <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" PrivateAssets="all" />
     <PackageReference Include="Microsoft.VisualStudio.Validation" />