Write "auto-generated" header comment, to prevent 3rd party analyzers from producing diagnostics

Author: bkoelman

src/JsonApiDotNetCore.SourceGenerators/SourceCodeWriter.cs

@@ -59,6 +59,8 @@ public string Write(INamedTypeSymbol resourceType, ITypeSymbol idType, JsonApiEn
  _sourceBuilder.Clear();
  _depth = 0;
 
+ WriteAutoGeneratedComment();
+
  if (idType.IsReferenceType && idType.NullableAnnotation == NullableAnnotation.Annotated)
  {
  WriteNullableEnable();
@@ -82,6 +84,12 @@ public string Write(INamedTypeSymbol resourceType, ITypeSymbol idType, JsonApiEn
  return _sourceBuilder.ToString();
  }
 
+ private void WriteAutoGeneratedComment()
+ {
+ _sourceBuilder.AppendLine("// <auto-generated />");
+ _sourceBuilder.AppendLine();
+ }
+
  private void WriteNullableEnable()
  {
  _sourceBuilder.AppendLine("#nullable enable");

test/SourceGeneratorTests/ControllerGenerationTests.cs

@@ -51,7 +51,9 @@ public sealed class Item : Identifiable<long>
  GeneratorDriverRunResult runResult = driver.GetRunResult();
  runResult.Should().NotHaveDiagnostics();
 
- runResult.Should().HaveProducedSourceCode(@"using Microsoft.Extensions.Logging;
+ runResult.Should().HaveProducedSourceCode(@"// <auto-generated />
+
+using Microsoft.Extensions.Logging;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
@@ -111,7 +113,9 @@ public sealed class Item : Identifiable<long>
  GeneratorDriverRunResult runResult = driver.GetRunResult();
  runResult.Should().NotHaveDiagnostics();
 
- runResult.Should().HaveProducedSourceCode(@"using Microsoft.Extensions.Logging;
+ runResult.Should().HaveProducedSourceCode(@"// <auto-generated />
+
+using Microsoft.Extensions.Logging;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
@@ -171,7 +175,9 @@ public sealed class Item : Identifiable<long>
  GeneratorDriverRunResult runResult = driver.GetRunResult();
  runResult.Should().NotHaveDiagnostics();
 
- runResult.Should().HaveProducedSourceCode(@"using Microsoft.Extensions.Logging;
+ runResult.Should().HaveProducedSourceCode(@"// <auto-generated />
+
+using Microsoft.Extensions.Logging;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
@@ -234,7 +240,9 @@ public sealed class Item : Identifiable<long>
  GeneratorDriverRunResult runResult = driver.GetRunResult();
  runResult.Should().NotHaveDiagnostics();
 
- runResult.Should().HaveProducedSourceCode(@"using Microsoft.Extensions.Logging;
+ runResult.Should().HaveProducedSourceCode(@"// <auto-generated />
+
+using Microsoft.Extensions.Logging;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
@@ -574,7 +582,9 @@ public sealed class Item : Identifiable<long>
  GeneratorDriverRunResult runResult = driver.GetRunResult();
  runResult.Should().NotHaveDiagnostics();
 
- runResult.Should().HaveProducedSourceCode(@"using Microsoft.Extensions.Logging;
+ runResult.Should().HaveProducedSourceCode(@"// <auto-generated />
+
+using Microsoft.Extensions.Logging;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
@@ -633,7 +643,9 @@ public sealed class Item : Identifiable<long>
  GeneratorDriverRunResult runResult = driver.GetRunResult();
  runResult.Should().NotHaveDiagnostics();
 
- runResult.Should().HaveProducedSourceCode(@"using Microsoft.Extensions.Logging;
+ runResult.Should().HaveProducedSourceCode(@"// <auto-generated />
+
+using Microsoft.Extensions.Logging;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;
@@ -691,7 +703,9 @@ public sealed class Item : Identifiable<long>
  GeneratorDriverRunResult runResult = driver.GetRunResult();
  runResult.Should().NotHaveDiagnostics();
 
- runResult.Should().HaveProducedSourceCode(@"using Microsoft.Extensions.Logging;
+ runResult.Should().HaveProducedSourceCode(@"// <auto-generated />
+
+using Microsoft.Extensions.Logging;
 using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Services;