Add PublicAPI analyzer to ensure we're aware of public changes (#1011)

dotnet · Oct 26, 2021 · d0182db · d0182db
1 parent af88cf7
commit d0182db
Show file tree

Hide file tree

Showing 44 changed files with 298,284 additions and 145 deletions.
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -77,6 +77,12 @@
     </PropertyGroup>
   </Target>
 
+  <PropertyGroup>
+    <IncludeFrameworkShims Condition=" '$(IncludeFrameworkShims)' == '' ">false</IncludeFrameworkShims>
+  </PropertyGroup>
+
+  <Import Condition="$(IncludeFrameworkShims)" Project="$(MSBuildThisFileDirectory)src\common\FrameworkShims.targets" />
+
   <PropertyGroup>
     <PackageOutputPath>$(MSBuildThisFileDirectory)bin\$(Configuration)\packages\</PackageOutputPath>
     <PackageOutputPath Condition="$(IsShipped)">$(PackageOutputPath)shipping\</PackageOutputPath>

diff --git a/Open-XML-SDK.sln b/Open-XML-SDK.sln
@@ -7,7 +7,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 	ProjectSection(SolutionItems) = preProject
 		.vsconfig = .vsconfig
 		CHANGELOG.md = CHANGELOG.md
-		compat.yml = compat.yml
 		Directory.Build.props = Directory.Build.props
 		Directory.Build.targets = Directory.Build.targets
 		DocumentFormat.OpenXml.Package.props = DocumentFormat.OpenXml.Package.props
@@ -28,6 +27,11 @@ EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DocumentFormat.OpenXml.Packaging.Tests", "test\DocumentFormat.OpenXml.Packaging.Tests\DocumentFormat.OpenXml.Packaging.Tests.csproj", "{B9138975-0D18-4EC7-92C3-A2DB71DF64E9}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{A4DF60EB-3AA5-48F0-B4D2-3F94B8E62F03}"
+	ProjectSection(SolutionItems) = preProject
+		src\Directory.Build.props = src\Directory.Build.props
+		src\Directory.Build.targets = src\Directory.Build.targets
+		src\common\FrameworkShims.targets = src\common\FrameworkShims.targets
+	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{0782A132-968D-4BDD-911A-2C3074EAF886}"
 EndProject

diff --git a/compat.yml b/compat.yml
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -40,5 +40,10 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.CodeAnalysis.PublicApiAnalyzers" Version="3.3.2">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
   </ItemGroup>
+
 </Project>
diff --git a/src/Directory.Build.targets b/src/Directory.Build.targets
@@ -0,0 +1,3 @@
+<Project>
+  <Import Project="..\Directory.Build.targets" />
+</Project>
diff --git a/...umentFormat.OpenXml.CodeGeneration.Linq/DocumentFormat.OpenXml.CodeGeneration.Linq.csproj b/...umentFormat.OpenXml.CodeGeneration.Linq/DocumentFormat.OpenXml.CodeGeneration.Linq.csproj
@@ -30,6 +30,10 @@
     </Otherwise>
   </Choose>
 
+  <ItemGroup>
+    <PackageReference Remove="Microsoft.CodeAnalysis.PublicApiAnalyzers" />
+  </ItemGroup>
+
   <!-- Elements required for Analyzer / C# Source Generator -->
   <!--<PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>

diff --git a/src/DocumentFormat.OpenXml.Features/DocumentFormat.OpenXml.Features.csproj b/src/DocumentFormat.OpenXml.Features/DocumentFormat.OpenXml.Features.csproj
@@ -2,13 +2,18 @@
 
   <PropertyGroup>
     <IsShipped>true</IsShipped>
+    <IncludeFrameworkShims>true</IncludeFrameworkShims>
   </PropertyGroup>
 
   <PropertyGroup>
     <Summary>Provides additional features that add functionality to the Open XML SDK.</Summary>
     <Description>Provides additional functionality to the Open XML SDK.</Description>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Compile Include="..\DocumentFormat.OpenXml\SimpleTypes\HexStringFactory.cs" Link="HexStringFactory.cs" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\DocumentFormat.OpenXml\DocumentFormat.OpenXml.csproj" />
   </ItemGroup>
@@ -17,14 +22,4 @@
     <PackageReference Include="System.Security.Cryptography.Algorithms" Version="4.3.1" />
   </ItemGroup>
 
-  <ItemGroup Condition=" '$(TargetFramework)' == 'net5.0' ">
-    <Compile Remove="System/Runtime/CompilerServices/IsExternalInit.cs" />
-  </ItemGroup>
-
-  <ItemGroup Condition=" '$(TargetFramework)' != 'net5.0' ">
-    <Compile Include="..\DocumentFormat.OpenXml\System\Span.cs" Link="System\Span.cs" />
-    <Compile Include="..\DocumentFormat.OpenXml\System\SpanExtensions.cs" Link="System\SpanExtensions.cs" />
-    <Compile Include="..\DocumentFormat.OpenXml\System\Diagnostics\CodeAnalysis\NullableAttributes.cs" Link="System\Diagnostics\CodeAnalysis\NullableAttributes.cs" />
-  </ItemGroup>
-
 </Project>
diff --git a/src/DocumentFormat.OpenXml.Features/PublicAPI.Shipped.txt b/src/DocumentFormat.OpenXml.Features/PublicAPI.Shipped.txt
@@ -0,0 +1 @@
+#nullable enable
diff --git a/src/DocumentFormat.OpenXml.Features/PublicAPI.Unshipped.txt b/src/DocumentFormat.OpenXml.Features/PublicAPI.Unshipped.txt
@@ -0,0 +1,34 @@
+DocumentFormat.OpenXml.Features.DisposableFeatureExtensions
+DocumentFormat.OpenXml.Features.IDisposableFeature
+DocumentFormat.OpenXml.Features.IDisposableFeature.Register(System.IDisposable! disposable) -> void
+DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature
+DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature.Contains(string! id) -> bool
+DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature.Count.get -> int
+DocumentFormat.OpenXml.Features.IParagraphIdGeneratorFeature
+DocumentFormat.OpenXml.Features.IParagraphIdGeneratorFeature.CreateUniqueParagraphId() -> string!
+DocumentFormat.OpenXml.Features.IRandomNumberGeneratorFeature
+DocumentFormat.OpenXml.Features.IRandomNumberGeneratorFeature.GetBytes(byte[]! bytes) -> void
+DocumentFormat.OpenXml.Features.ISharedFeature<T>
+DocumentFormat.OpenXml.Features.ISharedFeature<T>.Add(T feature) -> void
+DocumentFormat.OpenXml.Features.ISharedFeature<T>.Composite.get -> T
+DocumentFormat.OpenXml.Features.ISharedFeature<T>.Count.get -> int
+DocumentFormat.OpenXml.Features.ISharedFeature<T>.Remove(T feature) -> bool
+DocumentFormat.OpenXml.Features.ParagraphIdFeatureExtensions
+DocumentFormat.OpenXml.Features.ParagraphIdOptions
+DocumentFormat.OpenXml.Features.ParagraphIdOptions.AutoGenerateIds.get -> bool
+DocumentFormat.OpenXml.Features.ParagraphIdOptions.AutoGenerateIds.init -> void
+DocumentFormat.OpenXml.Features.ParagraphIdOptions.EnsureUniquenessOnExistingNodes.get -> bool
+DocumentFormat.OpenXml.Features.ParagraphIdOptions.EnsureUniquenessOnExistingNodes.init -> void
+DocumentFormat.OpenXml.Features.ParagraphIdOptions.ParagraphIdOptions() -> void
+DocumentFormat.OpenXml.Features.RandomNumberGeneratorFeatureExtensions
+DocumentFormat.OpenXml.Features.SharedParagraphIdFeatureExtensions
+static DocumentFormat.OpenXml.Features.DisposableFeatureExtensions.AddDisposableFeature(this DocumentFormat.OpenXml.Features.IFeatureCollection! features) -> void
+static DocumentFormat.OpenXml.Features.DisposableFeatureExtensions.AddDisposableFeature(this DocumentFormat.OpenXml.Packaging.OpenXmlPackage! package) -> void
+static DocumentFormat.OpenXml.Features.DisposableFeatureExtensions.AddDisposableFeature(this DocumentFormat.OpenXml.Packaging.OpenXmlPart! part) -> void
+static DocumentFormat.OpenXml.Features.DisposableFeatureExtensions.SetDisposable<TFeature>(this DocumentFormat.OpenXml.Features.IFeatureCollection! features, TFeature feature) -> void
+static DocumentFormat.OpenXml.Features.ParagraphIdFeatureExtensions.AddParagraphIdFeature(this DocumentFormat.OpenXml.Packaging.WordprocessingDocument! doc, DocumentFormat.OpenXml.Features.ParagraphIdOptions? options = null) -> void
+static DocumentFormat.OpenXml.Features.ParagraphIdFeatureExtensions.AddParagraphIdGeneratorFeature(this DocumentFormat.OpenXml.Packaging.WordprocessingDocument! doc) -> void
+static DocumentFormat.OpenXml.Features.RandomNumberGeneratorFeatureExtensions.AddRandomNumberGeneratorFeature(this DocumentFormat.OpenXml.Packaging.OpenXmlPackage! package) -> void
+static DocumentFormat.OpenXml.Features.SharedParagraphIdFeatureExtensions.Add(this DocumentFormat.OpenXml.Features.ISharedFeature<DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature!>! shared, DocumentFormat.OpenXml.Packaging.WordprocessingDocument! doc) -> DocumentFormat.OpenXml.Features.ISharedFeature<DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature!>!
+static DocumentFormat.OpenXml.Features.SharedParagraphIdFeatureExtensions.Add(this DocumentFormat.OpenXml.Features.ISharedFeature<DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature!>! shared, System.Collections.Generic.IEnumerable<string!>! paragraphIds) -> DocumentFormat.OpenXml.Features.ISharedFeature<DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature!>!
+static DocumentFormat.OpenXml.Features.SharedParagraphIdFeatureExtensions.AddSharedParagraphIdFeature(this DocumentFormat.OpenXml.Packaging.WordprocessingDocument! doc) -> DocumentFormat.OpenXml.Features.ISharedFeature<DocumentFormat.OpenXml.Features.IParagraphIdCollectionFeature!>!
diff --git a/src/DocumentFormat.OpenXml.Linq/DocumentFormat.OpenXml.Linq.csproj b/src/DocumentFormat.OpenXml.Linq/DocumentFormat.OpenXml.Linq.csproj
@@ -4,6 +4,8 @@
     <IsShipped>true</IsShipped>
     <Summary>Provides additional LINQ functionality to the Open XML SDK.</Summary>
     <Description>Provides additional LINQ functionality to the Open XML SDK to allow operations using XLINQ.</Description>
+    <NoWarn>$(NoWarn);RS0041</NoWarn>
+    <IncludeFrameworkShims>true</IncludeFrameworkShims>
   </PropertyGroup>
 
   <ItemGroup>
@@ -18,10 +20,6 @@
         <Reference Include="System.Xml" />
         <Reference Include="System.Xml.Linq" />
       </ItemGroup>
-
-      <ItemGroup>
-        <Compile Include="..\DocumentFormat.OpenXml\System\Diagnostics\CodeAnalysis\NullableAttributes.cs" Link="System\Diagnostics\CodeAnalysis\NullableAttributes.cs" />
-      </ItemGroup>
     </When>
 
     <When Condition=" '$(TargetFramework)' == 'net40'">
@@ -30,10 +28,6 @@
         <Reference Include="System.Xml" />
         <Reference Include="System.Xml.Linq" />
       </ItemGroup>
-
-      <ItemGroup>
-        <Compile Include="..\DocumentFormat.OpenXml\System\Diagnostics\CodeAnalysis\NullableAttributes.cs" Link="System\Diagnostics\CodeAnalysis\NullableAttributes.cs" />
-      </ItemGroup>
     </When>
 
     <When Condition=" '$(TargetFramework)' == 'net46'">
@@ -42,28 +36,13 @@
         <Reference Include="System.Xml" />
         <Reference Include="System.Xml.Linq" />
       </ItemGroup>
-
-      <ItemGroup>
-        <Compile Include="..\DocumentFormat.OpenXml\System\Diagnostics\CodeAnalysis\NullableAttributes.cs" Link="System\Diagnostics\CodeAnalysis\NullableAttributes.cs" />
-      </ItemGroup>
     </When>
 
     <When Condition=" '$(TargetFramework)' == 'netstandard1.3' ">
       <ItemGroup>
         <PackageReference Include="System.Xml.ReaderWriter" Version="4.3.1" />
       </ItemGroup>
-
-      <ItemGroup>
-        <Compile Include="..\DocumentFormat.OpenXml\System\Diagnostics\CodeAnalysis\NullableAttributes.cs" Link="System\Diagnostics\CodeAnalysis\NullableAttributes.cs" />
-      </ItemGroup>
-    </When>
-
-    <When Condition=" '$(TargetFramework)' == 'netstandard2.0' ">
-      <ItemGroup>
-        <Compile Include="..\DocumentFormat.OpenXml\System\Diagnostics\CodeAnalysis\NullableAttributes.cs" Link="System\Diagnostics\CodeAnalysis\NullableAttributes.cs" />
-      </ItemGroup>
     </When>
-
   </Choose>
 
 </Project>
diff --git a/src/DocumentFormat.OpenXml.Linq/PublicAPI.Shipped.txt b/src/DocumentFormat.OpenXml.Linq/PublicAPI.Shipped.txt
@@ -0,0 +1 @@
+#nullable enable