output the footer

Author: smdn

src/Smdn.Reflection.ReverseGenerating.ListApi.Core/Smdn.Reflection.ReverseGenerating.ListApi/ApiListWriter.cs

@@ -110,6 +110,25 @@ private void WriteEmbeddedResources()
     }
   }
 
+  public void WriteFooter()
+  {
+    if (!options.Writer.WriteFooter)
+      return;
+
+    var callingAssemblyName = Assembly.GetCallingAssembly().GetName();
+
+    BaseWriter.WriteLine($"// API list generated by {callingAssemblyName?.Name} v{callingAssemblyName?.Version}.");
+
+    var executingAssembly = Assembly.GetExecutingAssembly();
+    var executingAssemblyName = executingAssembly?.GetName();
+    var repositoryUrl = executingAssembly
+      ?.GetCustomAttributes<AssemblyMetadataAttribute>()
+      ?.First(static a => a.Key.StartsWith("RepositoryUrl", StringComparison.Ordinal))
+      ?.Value;
+
+    BaseWriter.WriteLine($"// {executingAssemblyName?.Name} v{executingAssemblyName?.Version} ({repositoryUrl})");
+  }
+
   public void WriteExportedTypes()
   {
     var types = assembly.GetExportedTypes()

src/Smdn.Reflection.ReverseGenerating.ListApi.Core/Smdn.Reflection.ReverseGenerating.ListApi/ApiListWriterOptions.cs

@@ -10,5 +10,6 @@ public class WriterOptions {
     public bool WriteNullableAnnotationDirective { get; set; } = true;
     public bool WriteEmbeddedResources { get; set; } = true;
     public bool WriteReferencedAssemblies { get; set; } = true;
+    public bool WriteFooter { get; set; } = true;
   }
 }

src/Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks/Smdn.Reflection.ReverseGenerating.ListApi.MSBuild.Tasks/GenerateApiList.cs

@@ -186,6 +186,7 @@ private static void WriteApiListFile(
 
           writer.WriteAssemblyInfoHeader();
           writer.WriteExportedTypes();
+          writer.WriteFooter();
 
           return arg.outputApiListFilePath;
         }

src/Smdn.Reflection.ReverseGenerating.ListApi/Smdn.Reflection.ReverseGenerating.ListApi/RootCommandImplementation.cs

@@ -216,6 +216,7 @@ private void CommandMain(ParseResult parseResult, IConsole console)
 
             writer.WriteAssemblyInfoHeader();
             writer.WriteExportedTypes();
+            writer.WriteFooter();
 
             arg.logger?.LogDebug("generated API list {OutputFilePath}", outputFilePath);
             arg.logger?.LogInformation("{AssemblyFilePath} -> {OutputFilePath}", assm.Location, outputFilePath);

tests/Smdn.Reflection.ReverseGenerating.ListApi.Core/Smdn.Reflection.ReverseGenerating.ListApi/ApiListWriter.cs

@@ -145,6 +145,7 @@ private string WriteApiListFromSourceCode(
 
         writer.WriteAssemblyInfoHeader();
         writer.WriteExportedTypes();
+        writer.WriteFooter();
 
         return sb.ToString();
       },
@@ -429,6 +430,7 @@ string expectedOutput
     options.Writer.WriteNullableAnnotationDirective = false;
     options.Writer.WriteEmbeddedResources = false;
     options.Writer.WriteReferencedAssemblies = false;
+    options.Writer.WriteFooter = false;
 
     Assert.AreEqual(
       expectedOutput.Replace("\r\n", "\n").Replace("\r", "\n").TrimEnd(),
@@ -711,4 +713,30 @@ ApiListWriterOptions options
       return ret ?? string.Empty;
     }
   }
+
+  [Test]
+  public void WriteFooter(
+    [Values(true, false)] bool writeFooter
+  )
+  {
+    var options = new ApiListWriterOptions();
+
+    options.Writer.WriteNullableAnnotationDirective = false;
+    options.Writer.WriteEmbeddedResources = false;
+    options.Writer.WriteReferencedAssemblies = false;
+    options.Writer.WriteFooter = writeFooter;
+
+    var output = WriteApiListFromSourceCode("//", options).TrimEnd();
+    var executingAssemblyName = Assembly.GetExecutingAssembly().GetName()!;
+    var libraryAssemblyName = typeof(ApiListWriter).Assembly.GetName()!;
+
+    if (writeFooter) {
+      StringAssert.Contains($"// API list generated by {executingAssemblyName.Name} v{executingAssemblyName.Version}", output);
+      StringAssert.Contains($"// {libraryAssemblyName.Name} v{libraryAssemblyName.Version}", output);
+    }
+    else {
+      StringAssert.DoesNotContain("// API list generated by", output);
+      StringAssert.DoesNotContain($"// {libraryAssemblyName.Name} v{libraryAssemblyName.Version}", output);
+    }
+  }
 }