PublicApiAnalyzer refinements

.build/Build.CheckPublicApi.cs

@@ -0,0 +1,27 @@
+using Nuke.Common;
+using Nuke.Common.CI;
+using Nuke.Common.CI.AzurePipelines;
+using Nuke.Common.CI.GitHubActions;
+using Nuke.Common.Execution;
+using Nuke.Common.Tools.DotNet;
+using static Nuke.Common.Tools.DotNet.DotNetTasks;
+using static Helpers;
+
+partial class Build : NukeBuild
+{
+    Target CheckPublicApi => _ => _
+        .DependsOn(Restore)
+        .Executes(() =>
+        {
+            if (!InvokedTargets.Contains(Restore))
+            {
+                DotNetBuildSonarSolution(AllSolutionFile);
+            }
+
+            DotNetBuild(c => c
+                .SetProjectFile(AllSolutionFile)
+                .SetNoRestore(InvokedTargets.Contains(Restore))
+                .SetConfiguration(Configuration)
+                .SetProperty("RequireDocumentationOfPublicApiChanges", true));
+        });
+}

.build/Build.cs

@@ -69,7 +69,6 @@ partial class Build : NukeBuild
                 .SetAssemblyVersion(GitVersion.AssemblySemVer)
                 .SetFileVersion(GitVersion.AssemblySemFileVer)
                 .SetInformationalVersion(GitVersion.InformationalVersion)
-                .SetVersion(GitVersion.SemVer)
-                .SetProperty("RequireDocumentationOfPublicApiChanges", true));
+                .SetVersion(GitVersion.SemVer));
         });
 }

API-Baselines.md

@@ -93,6 +93,12 @@ It also takes care of removing lines marked with `*REMOVE*` (removals of APIs).
 
 This will output the contents of all `PublicAPI.Unshipped.txt` files throughout the project.
 
+If we only want to see the breaking changes, we can add the `breaking` flag:
+
+```sh
+display-unshipped-api.ps1 -breaking $true
+```
+
 ### diff-shipped-api.ps1
 
 This shows all changes of `PublicAPI.Shipped.txt` files between git refs. Tags, commit hashes and branch names are supported.

scripts/diff-shipped-api.ps1

@@ -1,4 +1,4 @@
-[CmdletBinding(PositionalBinding=$false)]
+[CmdletBinding(PositionalBinding = $false)]
 param (
     [string]$from,
     [string]$to = "main"

scripts/display-unshipped-api.ps1

@@ -1,17 +1,25 @@
 [CmdletBinding(PositionalBinding = $false)]
-param ()
+param (
+    [bool]$breaking = $false
+)
 
 Set-StrictMode -version 2.0
 $ErrorActionPreference = "Stop"
+$removedPrefix = "*REMOVED*";
 
 function ShowUnshipped([string]$file, [string]$src_dir) {
     [string[]]$unshipped = Get-Content $file
 
+    if ($breaking) {
+        $unshipped = $unshipped | Where-Object { $_.StartsWith($removedPrefix) }
+    }
+
     if ([string]::IsNullOrWhiteSpace($unshipped)) {
         return
     }
 
     $dir = (Split-Path -parent $file) -replace [regex]::escape($src_dir + [IO.Path]::DirectorySeparatorChar), ""
+
     Write-Host -Foreground green "## ${dir}"
 
     foreach ($item in $unshipped) {
@@ -24,6 +32,10 @@ function ShowUnshipped([string]$file, [string]$src_dir) {
 try {
     $src_dir = Resolve-Path -Path "../src"
 
+    if ($breaking) {
+        Write-Host "Breaking changes:"
+    }
+
     foreach ($file in Get-ChildItem -Path "$src_dir" -Recurse -Include "PublicApi.Unshipped.txt") {
         ShowUnshipped $file $src_dir
     }

scripts/mark-api-shipped.ps1

@@ -3,6 +3,7 @@ param ()
 
 Set-StrictMode -version 2.0
 $ErrorActionPreference = "Stop"
+$removedPrefix = "*REMOVED*";
 
 function MarkShipped([string]$dir) {
     $shippedFilePath = Join-Path $dir "PublicAPI.Shipped.txt"
@@ -18,7 +19,6 @@ function MarkShipped([string]$dir) {
     }
 
     $removed = @()
-    $removedPrefix = "*REMOVED*";
 
     Write-Host "Processing $dir"
 
@@ -43,6 +43,8 @@ try {
         $dir = Split-Path -parent $file
         MarkShipped $dir
     }
+
+    Write-Host "Marked unshipped API as shipped!"
 }
 catch {
     Write-Host $_

src/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "search.exclude": {
+    "**/node_modules": true,
+    "**/bower_components": true,
+    "**/*.code-search": true,
+    "**/PublicAPI*.txt": true
+  }
+}

src/Directory.Build.props

@@ -57,6 +57,9 @@
       <ExcludeAssets>compile</ExcludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
+
+    <AdditionalFiles Include="PublicAPI.Shipped.txt" />
+    <AdditionalFiles Include="PublicAPI.Unshipped.txt" />
   </ItemGroup>
 
   <Target Name="_CheckIgnoredPublicApiFiles"

src/HotChocolate/Core/src/Core/HotChocolate.Core.csproj

@@ -41,4 +41,8 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <PropertyGroup>
+    <AddPublicApiAnalyzers>false</AddPublicApiAnalyzers>
+  </PropertyGroup>
+
 </Project>

src/HotChocolate/Core/src/Types.Scalars/PublicAPI.Unshipped.txt

@@ -1 +1,18 @@
-
+HotChocolate.Types.LatitudeType
+HotChocolate.Types.LatitudeType.LatitudeType() -> void
+HotChocolate.Types.LatitudeType.LatitudeType(HotChocolate.NameString name, string? description = null, HotChocolate.Types.BindingBehavior bind = HotChocolate.Types.BindingBehavior.Explicit) -> void
+HotChocolate.Types.LongitudeType
+HotChocolate.Types.LongitudeType.LongitudeType() -> void
+HotChocolate.Types.LongitudeType.LongitudeType(HotChocolate.NameString name, string? description = null, HotChocolate.Types.BindingBehavior bind = HotChocolate.Types.BindingBehavior.Explicit) -> void
+override HotChocolate.Types.LatitudeType.IsInstanceOfType(double runtimeValue) -> bool
+override HotChocolate.Types.LatitudeType.ParseLiteral(HotChocolate.Language.StringValueNode! valueSyntax) -> double
+override HotChocolate.Types.LatitudeType.ParseResult(object? resultValue) -> HotChocolate.Language.IValueNode!
+override HotChocolate.Types.LatitudeType.ParseValue(double runtimeValue) -> HotChocolate.Language.StringValueNode!
+override HotChocolate.Types.LatitudeType.TryDeserialize(object? resultValue, out object? runtimeValue) -> bool
+override HotChocolate.Types.LatitudeType.TrySerialize(object? runtimeValue, out object? resultValue) -> bool
+override HotChocolate.Types.LongitudeType.IsInstanceOfType(double runtimeValue) -> bool
+override HotChocolate.Types.LongitudeType.ParseLiteral(HotChocolate.Language.StringValueNode! valueSyntax) -> double
+override HotChocolate.Types.LongitudeType.ParseResult(object? resultValue) -> HotChocolate.Language.IValueNode!
+override HotChocolate.Types.LongitudeType.ParseValue(double runtimeValue) -> HotChocolate.Language.StringValueNode!
+override HotChocolate.Types.LongitudeType.TryDeserialize(object? resultValue, out object? runtimeValue) -> bool
+override HotChocolate.Types.LongitudeType.TrySerialize(object? runtimeValue, out object? resultValue) -> bool

src/HotChocolate/Core/src/Types/Types/Descriptors/InterfaceTypeDescriptor.cs

@@ -113,8 +113,8 @@ public IInterfaceTypeDescriptor Interface<TInterface>(
             => Implements(type);
 
         [Obsolete("Use Implements.")]
-        public IInterfaceTypeDescriptor Interface(NamedTypeNode type)
-            => Implements(type);
+        public IInterfaceTypeDescriptor Interface(NamedTypeNode namedType)
+            => Implements(namedType);
 
         public IInterfaceTypeDescriptor Implements<T>()
             where T : InterfaceType