Add GeneratedCode attribute (#121)

andrewlock · Dec 2, 2023 · abc8c7b · abc8c7b
1 parent e53602c
commit abc8c7b
Show file tree

Hide file tree

Showing 16 changed files with 36 additions and 0 deletions.
diff --git a/src/StronglyTypedIds/Constants.cs b/src/StronglyTypedIds/Constants.cs
@@ -2,6 +2,7 @@ namespace StronglyTypedIds
 {
     internal static class Constants
     {
+        public const string StronglyTypedIdsVersion = "1.0.0-beta6";
         public const string Usage = nameof(Usage);
     }
 }
diff --git a/src/StronglyTypedIds/SourceGenerationHelper.cs b/src/StronglyTypedIds/SourceGenerationHelper.cs
@@ -11,6 +11,7 @@ public static string CreateId(
             ParentClass? parentClass,
             string template,
             bool addDefaultAttributes,
+            bool addGeneratedCodeAttribute,
             StringBuilder? sb)
         {
             if (string.IsNullOrEmpty(idName))
@@ -43,6 +44,12 @@ public static string CreateId(
             }
 
             var hasGenericParent = false;
+            if (addGeneratedCodeAttribute && parentClass is not null)
+            {
+                addGeneratedCodeAttribute = false;
+                AddGeneratedCodeAttribute(sb);
+            }
+
             while (parentClass is { } parent)
             {
                 sb.Append("    ");
@@ -76,6 +83,11 @@ public static string CreateId(
                 sb.AppendLine("    [global::System.Text.Json.Serialization.JsonConverter(typeof(PLACEHOLDERIDSystemTextJsonConverter))]");
             }
 
+            if (addGeneratedCodeAttribute)
+            {
+                AddGeneratedCodeAttribute(sb);
+            }
+
             sb.AppendLine(template);
 
             sb.Replace("PLACEHOLDERID", idName);
@@ -91,6 +103,11 @@ public static string CreateId(
             }
 
             return sb.ToString();
+
+            static void AddGeneratedCodeAttribute(StringBuilder sb)
+            {
+                sb.AppendLine($"""    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "{Constants.StronglyTypedIdsVersion}")]""");
+            }
         }
 
         internal static string CreateSourceName(StringBuilder sb, string nameSpace, ParentClass? parent, string name, string template)

diff --git a/src/StronglyTypedIds/StronglyTypedIdGenerator.cs b/src/StronglyTypedIds/StronglyTypedIdGenerator.cs
@@ -97,6 +97,7 @@ private static void Execute(
                 return;
             }
 
+            var addGeneratedCodeAttribute = true;
             var sb = new StringBuilder();
             foreach (var (name, content) in templateContents.Distinct())
             {
@@ -106,8 +107,11 @@ private static void Execute(
                     idToGenerate.Parent,
                     content,
                     addDefaultAttributes: string.IsNullOrEmpty(name),
+                    addGeneratedCodeAttribute: addGeneratedCodeAttribute,
                     sb);
 
+                addGeneratedCodeAttribute = false; // We can only add it once, so just add to the first rendering
+
                 var fileName = SourceGenerationHelper.CreateSourceName(
                     sb,
                     idToGenerate.NameSpace,

diff --git a/...napshots/StronglyTypedIdGeneratorTests.CanGenerateDefaultIdInGlobalNamespace.verified.txt b/...napshots/StronglyTypedIdGeneratorTests.CanGenerateDefaultIdInGlobalNamespace.verified.txt
@@ -12,6 +12,7 @@
 #nullable enable
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId :
 #if NET6_0_OR_GREATER
         global::System.ISpanFormattable,

diff --git a/...s.Tests/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateForCustomTemplate.verified.txt b/...s.Tests/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateForCustomTemplate.verified.txt
@@ -12,6 +12,7 @@
 #nullable enable
 namespace SomeNamespace
 {
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
     [global::Newtonsoft.Json.JsonConverter(typeof(MyIdNewtonsoftJsonConverter))]

diff --git a/...nglyTypedIdGeneratorTests.CanGenerateGenericVeryNestedIdInFileScopeNamespace.verified.txt b/...nglyTypedIdGeneratorTests.CanGenerateGenericVeryNestedIdInFileScopeNamespace.verified.txt
@@ -12,6 +12,7 @@
 #nullable enable
 namespace SomeNamespace
 {
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     public partial class ParentClass<T> where T: new()
     {
     internal partial record InnerClass<TKey, TValue> 

diff --git a/...s/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateIdInFileScopedNamespace.verified.txt b/...s/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateIdInFileScopedNamespace.verified.txt
@@ -14,6 +14,7 @@ namespace SomeNamespace
 {
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId :
 #if NET6_0_OR_GREATER
         global::System.ISpanFormattable,

diff --git a/...edIds.Tests/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateIdInNamespace.verified.txt b/...edIds.Tests/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateIdInNamespace.verified.txt
@@ -14,6 +14,7 @@ namespace SomeNamespace
 {
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId :
 #if NET6_0_OR_GREATER
         global::System.ISpanFormattable,

diff --git a/...s/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateMultipleIdsWithSameName.verified.txt b/...s/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateMultipleIdsWithSameName.verified.txt
@@ -14,6 +14,7 @@ namespace MyContracts.V1
 {
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId :
 #if NET6_0_OR_GREATER
         global::System.ISpanFormattable,
@@ -248,6 +249,7 @@ namespace MyContracts.V2
 {
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId :
 #if NET6_0_OR_GREATER
         global::System.ISpanFormattable,

diff --git a/...pshots/StronglyTypedIdGeneratorTests.CanGenerateMultipleTemplatesWithBuiltIn.verified.txt b/...pshots/StronglyTypedIdGeneratorTests.CanGenerateMultipleTemplatesWithBuiltIn.verified.txt
@@ -10,6 +10,7 @@
 #pragma warning disable 1591 // publicly visible type or member must be documented
 
 #nullable enable
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId
     {
         public partial class EfCoreValueConverter : global::Microsoft.EntityFrameworkCore.Storage.ValueConversion.ValueConverter<MyId, global::System.Guid>

diff --git a/...ots/StronglyTypedIdGeneratorTests.CanGenerateMultipleTemplatesWithoutBuiltIn.verified.txt b/...ots/StronglyTypedIdGeneratorTests.CanGenerateMultipleTemplatesWithoutBuiltIn.verified.txt
@@ -10,6 +10,7 @@
 #pragma warning disable 1591 // publicly visible type or member must be documented
 
 #nullable enable
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId
     {
         public partial class EfCoreValueConverter : global::Microsoft.EntityFrameworkCore.Storage.ValueConversion.ValueConverter<MyId, global::System.Guid>

diff --git a/...pshots/StronglyTypedIdGeneratorTests.CanGenerateNestedIdInFileScopeNamespace.verified.txt b/...pshots/StronglyTypedIdGeneratorTests.CanGenerateNestedIdInFileScopeNamespace.verified.txt
@@ -12,6 +12,7 @@
 #nullable enable
 namespace SomeNamespace
 {
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     public partial class ParentClass 
     {
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]

diff --git a/...s/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateNonDefaultIdInNamespace.verified.txt b/...s/Snapshots/StronglyTypedIdGeneratorTests.CanGenerateNonDefaultIdInNamespace.verified.txt
@@ -14,6 +14,7 @@ namespace SomeNamespace
 {
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId :
 #if NET6_0_OR_GREATER
         global::System.ISpanFormattable,

diff --git a/...ts/StronglyTypedIdGeneratorTests.CanGenerateVeryNestedIdInFileScopeNamespace.verified.txt b/...ts/StronglyTypedIdGeneratorTests.CanGenerateVeryNestedIdInFileScopeNamespace.verified.txt
@@ -12,6 +12,7 @@
 #nullable enable
 namespace SomeNamespace
 {
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     public partial class ParentClass 
     {
     internal partial record InnerClass 

diff --git a/...edIdGeneratorTests.CanOverrideDefaultsWithCustomTemplateUsingGlobalAttribute.verified.txt b/...edIdGeneratorTests.CanOverrideDefaultsWithCustomTemplateUsingGlobalAttribute.verified.txt
@@ -10,6 +10,7 @@
 #pragma warning disable 1591 // publicly visible type or member must be documented
 
 #nullable enable
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
     [global::Newtonsoft.Json.JsonConverter(typeof(MyIdNewtonsoftJsonConverter))]

diff --git a/...glyTypedIdGeneratorTests.CanOverrideDefaultsWithTemplateUsingGlobalAttribute.verified.txt b/...glyTypedIdGeneratorTests.CanOverrideDefaultsWithTemplateUsingGlobalAttribute.verified.txt
@@ -12,6 +12,7 @@
 #nullable enable
     [global::System.ComponentModel.TypeConverter(typeof(MyIdTypeConverter))]
     [global::System.Text.Json.Serialization.JsonConverter(typeof(MyIdSystemTextJsonConverter))]
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("StronglyTypedId", "1.0.0-beta6")]
     partial struct MyId :
 #if NET6_0_OR_GREATER
         global::System.ISpanFormattable,