Merge pull request #771 from adamralph/verify-public-api

switch from PublicApiAnalyzers to PublicApiGenerator and Verify

Author: adamralph

.github/workflows/lint.yml

@@ -20,7 +20,7 @@ jobs:
       - uses: super-linter/super-linter@d5b0a2ab116623730dd094f15ddc1b6b25bf7b99 # v8.3.2
         env:
           DEFAULT_BRANCH: main
-          FILTER_REGEX_EXCLUDE: \bcodeql-analysis\.yml$|\bLICENSE$
+          FILTER_REGEX_EXCLUDE: \bcodeql-analysis\.yml$|\bLICENSE$|\.verified\.txt$
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VALIDATE_BIOME_FORMAT: false
           VALIDATE_DOTNET_SLN_FORMAT_ANALYZERS: false

SimpleExec/Command.cs

@@ -8,6 +8,7 @@ namespace SimpleExec;
 /// <summary>
 /// Contains methods for running commands and reading standard output (stdout).
 /// </summary>
+#pragma warning disable RS0026 // Do not add multiple overloads with optional parameters
 public static class Command
 {
     private static readonly Action<IDictionary<string, string?>> DefaultAction = _ => { };

SimpleExec/PublicAPI.Shipped.txt

@@ -4,6 +4,8 @@
     <Description>Runs external commands.</Description>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <IsPackable>true</IsPackable>
+    <NoWarn>$(NoWarn);RS0016</NoWarn>    <!-- Add public types and members to the declared API -->
+    <NoWarn>$(NoWarn);RS0037</NoWarn>    <!-- Enable tracking of nullability of reference types in the declared API -->
     <PackageIcon>simple-exec.png</PackageIcon>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/adamralph/simple-exec</PackageProjectUrl>

SimpleExec/PublicAPI.Unshipped.txt

@@ -0,0 +1,31 @@
+namespace SimpleExec
+{
+    public static class Command
+    {
+        [return: System.Runtime.CompilerServices.TupleElementNames(new string[] {
+                "StandardOutput",
+                "StandardError"})]
+        public static System.Threading.Tasks.Task<System.ValueTuple<string, string>> ReadAsync(string name, System.Collections.Generic.IEnumerable<string> args, string workingDirectory = "", System.Action<System.Collections.Generic.IDictionary<string, string?>>? configureEnvironment = null, System.Text.Encoding? encoding = null, System.Func<int, bool>? handleExitCode = null, string? standardInput = null, bool cancellationIgnoresProcessTree = false, System.Threading.CancellationToken cancellationToken = default) { }
+        [return: System.Runtime.CompilerServices.TupleElementNames(new string[] {
+                "StandardOutput",
+                "StandardError"})]
+        public static System.Threading.Tasks.Task<System.ValueTuple<string, string>> ReadAsync(string name, string args = "", string workingDirectory = "", System.Action<System.Collections.Generic.IDictionary<string, string?>>? configureEnvironment = null, System.Text.Encoding? encoding = null, System.Func<int, bool>? handleExitCode = null, string? standardInput = null, bool cancellationIgnoresProcessTree = false, System.Threading.CancellationToken cancellationToken = default) { }
+        public static void Run(string name, System.Collections.Generic.IEnumerable<string> args, string workingDirectory = "", System.Collections.Generic.IEnumerable<string>? secrets = null, bool noEcho = false, string? echoPrefix = null, System.Action<System.Collections.Generic.IDictionary<string, string?>>? configureEnvironment = null, bool createNoWindow = false, System.Func<int, bool>? handleExitCode = null, bool cancellationIgnoresProcessTree = false, System.Threading.CancellationToken cancellationToken = default) { }
+        public static void Run(string name, string args = "", string workingDirectory = "", System.Collections.Generic.IEnumerable<string>? secrets = null, bool noEcho = false, string? echoPrefix = null, System.Action<System.Collections.Generic.IDictionary<string, string?>>? configureEnvironment = null, bool createNoWindow = false, System.Func<int, bool>? handleExitCode = null, bool cancellationIgnoresProcessTree = false, System.Threading.CancellationToken cancellationToken = default) { }
+        public static System.Threading.Tasks.Task RunAsync(string name, System.Collections.Generic.IEnumerable<string> args, string workingDirectory = "", System.Collections.Generic.IEnumerable<string>? secrets = null, bool noEcho = false, string? echoPrefix = null, System.Action<System.Collections.Generic.IDictionary<string, string?>>? configureEnvironment = null, bool createNoWindow = false, System.Func<int, bool>? handleExitCode = null, bool cancellationIgnoresProcessTree = false, System.Threading.CancellationToken cancellationToken = default) { }
+        public static System.Threading.Tasks.Task RunAsync(string name, string args = "", string workingDirectory = "", System.Collections.Generic.IEnumerable<string>? secrets = null, bool noEcho = false, string? echoPrefix = null, System.Action<System.Collections.Generic.IDictionary<string, string?>>? configureEnvironment = null, bool createNoWindow = false, System.Func<int, bool>? handleExitCode = null, bool cancellationIgnoresProcessTree = false, System.Threading.CancellationToken cancellationToken = default) { }
+    }
+    public class ExitCodeException : System.Exception
+    {
+        public ExitCodeException(int exitCode) { }
+        public int ExitCode { get; }
+        public override string Message { get; }
+    }
+    public class ExitCodeReadException : SimpleExec.ExitCodeException
+    {
+        public ExitCodeReadException(int exitCode, string standardOutput, string standardError) { }
+        public override string Message { get; }
+        public string StandardError { get; }
+        public string StandardOutput { get; }
+    }
+}

SimpleExec/SimpleExec.csproj

@@ -0,0 +1,18 @@
+using SimpleExec;
+using PublicApiGenerator;
+using Xunit;
+
+namespace SimpleExecTests;
+
+public static class PublicApi
+{
+    [Fact]
+    public static async Task IsVerified()
+    {
+        var options = new ApiGeneratorOptions { IncludeAssemblyAttributes = false };
+
+        var publicApi = typeof(Command).Assembly.GeneratePublicApi(options);
+
+        _ = await Verify(publicApi);
+    }
+}

SimpleExecTests/PublicApi.IsVerified.verified.txt

@@ -10,6 +10,8 @@
   <ItemGroup>
     <PackageReference Include="GitHubActionsTestLogger" Version="3.0.1" />
     <PackageReference Include="Microsoft.Testing.Platform" Version="2.0.2" />
+    <PackageReference Include="PublicApiGenerator" Version="11.5.4" />
+    <PackageReference Include="Verify.XunitV3" Version="31.9.0" />
     <PackageReference Include="xunit.v3.mtp-v2" Version="3.2.1" />
   </ItemGroup>
 
@@ -18,10 +20,18 @@
     <ProjectReference Include="..\SimpleExecTester\SimpleExecTester.csproj" />
   </ItemGroup>
 
+  <ItemGroup Label="Clean up after Verify.Xunit">
+    <Using Remove="VerifyTests" />
+    <Using Remove="Xunit" />
+  </ItemGroup>
+
   <ItemGroup>
     <None Update="hello-world.cmd">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="PublicApi.*.verified.txt">
+      <DependentUpon>PublicApi.cs</DependentUpon>
+    </None>
   </ItemGroup>
 
 </Project>