Merge pull request #117 from MarkAtRamp51/feature/supporting-schema-comments

tonysneed · web-flow · commit 8608acb0feca · 2020-05-04T16:43:19.000-05:00
Support for schema comments
diff --git a/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/CSharpEntityType/Class.hbs b/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/CSharpEntityType/Class.hbs
@@ -2,9 +2,14 @@
 
 namespace {{namespace}}
 {
-{{#if class-annotation}}
-{{spaces 4}}{{{class-annotation}}}
-{{/if}}
+    {{#if comment}}
+    /// <summary>
+    /// {{comment}}
+    /// </summary>
+    {{/if}}
+    {{#if class-annotation}}
+    {{{class-annotation}}}
+    {{/if}}
     public partial class {{class}}
     {
         {{{> constructor}}}
diff --git a/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/CSharpEntityType/Partials/Properties.hbs b/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/CSharpEntityType/Partials/Properties.hbs
@@ -1,4 +1,9 @@
 ﻿{{#each properties}}
+{{#if property-comment}}
+{{spaces 8}}/// <summary>
+{{spaces 8}}/// {{property-comment}}
+{{spaces 8}}/// </summary>
+{{/if}}
 {{#each property-annotations}}
 {{spaces 8}}{{{property-annotation}}}
 {{/each}}
diff --git a/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/TypeScriptEntityType/Class.hbs b/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/TypeScriptEntityType/Class.hbs
@@ -1,5 +1,10 @@
 ﻿{{> imports}}
 
+{{#if comment}}
+/**
+* {{comment}}
+*/
+{{/if}}
 export interface {{class}} {
     {{{> properties}}}
 }
diff --git a/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/TypeScriptEntityType/Partials/Properties.hbs b/src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/TypeScriptEntityType/Partials/Properties.hbs
@@ -1,4 +1,9 @@
 ﻿{{#each properties}}
+{{#if property-comment}}
+{{spaces 4}}/**
+{{spaces 4}}* {{property-comment}}
+{{spaces 4}}*/
+{{/if}}
 {{spaces 4}}{{property-name}}: {{property-type}};
 {{/each}}
 {{#if nav-properties}}
diff --git a/src/EntityFrameworkCore.Scaffolding.Handlebars/HbsCSharpEntityTypeGenerator.cs b/src/EntityFrameworkCore.Scaffolding.Handlebars/HbsCSharpEntityTypeGenerator.cs
@@ -152,7 +152,8 @@ protected override void GenerateClass(IEntityType entityType)
             }
 
             var transformedEntityName = EntityTypeTransformationService.TransformEntityName(entityType.Name);
-
+            
+            TemplateData.Add("comment", entityType.GetComment());
             TemplateData.Add("class", transformedEntityName);
 
             GenerateConstructor(entityType);
@@ -220,6 +221,7 @@ protected override void GenerateProperties(IEntityType entityType)
                     { "property-type", propertyType },
                     { "property-name", property.Name },
                     { "property-annotations",  PropertyAnnotationsData },
+                    { "property-comment", property.GetComment() },
                     { "property-isnullable", property.IsNullable },
                     { "nullable-reference-types", _options?.Value?.EnableNullableReferenceTypes == true }
                 });
diff --git a/src/EntityFrameworkCore.Scaffolding.Handlebars/HbsEntityTypeTransformationService.cs b/src/EntityFrameworkCore.Scaffolding.Handlebars/HbsEntityTypeTransformationService.cs
@@ -127,6 +127,7 @@ public List<Dictionary<string, object>> TransformProperties(List<Dictionary<stri
                     { "property-type", transformedProp.PropertyType },
                     { "property-name", transformedProp.PropertyName },
                     { "property-annotations", property["property-annotations"] },
+                    { "property-comment", property["property-comment"] },
                     { "property-isnullable", transformedProp.PropertyIsNullable },
                     { "nullable-reference-types", property["nullable-reference-types"] }
                 });
diff --git a/src/EntityFrameworkCore.Scaffolding.Handlebars/HbsTypeScriptEntityTypeGenerator.cs b/src/EntityFrameworkCore.Scaffolding.Handlebars/HbsTypeScriptEntityTypeGenerator.cs
@@ -125,6 +125,7 @@ protected override void GenerateClass(IEntityType entityType)
 
             var transformedEntityName = EntityTypeTransformationService.TransformEntityName(entityType.Name);
 
+            TemplateData.Add("comment", entityType.GetComment());
             TemplateData.Add("class", transformedEntityName);
 
             GenerateConstructor(entityType);
@@ -178,6 +179,7 @@ protected override void GenerateProperties(IEntityType entityType)
                     { "property-type", TypeScriptHelper.TypeName(property.ClrType) },
                     { "property-name",  TypeScriptHelper.ToCamelCase(property.Name) },
                     { "property-annotations",  new List<Dictionary<string, object>>() },
+                    { "property-comment", property.GetComment() },
                     { "property-isnullable", property.IsNullable },
                     { "nullable-reference-types",  _options?.Value?.EnableNullableReferenceTypes == true }
                 });
diff --git a/test/Scaffolding.Handlebars.Tests/CodeTemplates/CSharpEntityType/Class.hbs b/test/Scaffolding.Handlebars.Tests/CodeTemplates/CSharpEntityType/Class.hbs
@@ -2,9 +2,14 @@
 
 namespace {{namespace}}
 {
-{{#if class-annotation}}
-{{spaces 4}}{{{class-annotation}}}
-{{/if}}
+    {{#if comment}}
+    /// <summary>
+    /// {{comment}}
+    /// </summary>
+    {{/if}}
+    {{#if class-annotation}}
+    {{{class-annotation}}}
+    {{/if}}
     public partial class {{class}}
     {
         {{{> constructor}}}
diff --git a/test/Scaffolding.Handlebars.Tests/Contexts/NorthwindDbContext.cs b/test/Scaffolding.Handlebars.Tests/Contexts/NorthwindDbContext.cs
@@ -14,6 +14,10 @@ public NorthwindDbContext(DbContextOptions options) : base(options) { }
 
         protected override void OnModelCreating(ModelBuilder modelBuilder)
         {
+            modelBuilder.Entity<Category>()
+                .HasComment("A category of products")
+                .Property(category => category.CategoryName)
+                    .HasComment("The name of a category");
         }
     }
 }
diff --git a/test/Scaffolding.Handlebars.Tests/EmbeddedResourceTemplateFileServiceTests.ExpectedTemplates.cs b/test/Scaffolding.Handlebars.Tests/EmbeddedResourceTemplateFileServiceTests.ExpectedTemplates.cs
@@ -32,9 +32,14 @@ public partial class {{class}} : DbContext
 
 namespace {{namespace}}
 {
-{{#if class-annotation}}
-{{spaces 4}}{{{class-annotation}}}
-{{/if}}
+    {{#if comment}}
+    /// <summary>
+    /// {{comment}}
+    /// </summary>
+    {{/if}}
+    {{#if class-annotation}}
+    {{{class-annotation}}}
+    {{/if}}
     public partial class {{class}}
     {
         {{{> constructor}}}
diff --git a/test/Scaffolding.Handlebars.Tests/ExpectedContexts.cs b/test/Scaffolding.Handlebars.Tests/ExpectedContexts.cs
@@ -34,9 +34,12 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         {
             modelBuilder.Entity<Category>(entity =>
             {
+                entity.HasComment(""A category of products"");
+
                 entity.Property(e => e.CategoryName)
                     .IsRequired()
-                    .HasMaxLength(15);
+                    .HasMaxLength(15)
+                    .HasComment(""The name of a category"");
             });
 
             modelBuilder.Entity<Product>(entity =>
@@ -94,6 +97,13 @@ protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
 
         protected override void OnModelCreating(ModelBuilder modelBuilder)
         {
+            modelBuilder.Entity<Category>(entity =>
+            {
+                entity.HasComment(""A category of products"");
+
+                entity.Property(e => e.CategoryName).HasComment(""The name of a category"");
+            });
+
             modelBuilder.Entity<Product>(entity =>
             {
                 entity.HasIndex(e => e.CategoryId);
@@ -143,9 +153,12 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             {
                 entity.ToTable(""Category"");
 
+                entity.HasComment(""A category of products"");
+
                 entity.Property(e => e.CategoryName)
                     .IsRequired()
-                    .HasMaxLength(15);
+                    .HasMaxLength(15)
+                    .HasComment(""The name of a category"");
             });
 
             modelBuilder.Entity<Product>(entity =>
@@ -205,6 +218,13 @@ protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
 
         protected override void OnModelCreating(ModelBuilder modelBuilder)
         {
+            modelBuilder.Entity<Category>(entity =>
+            {
+                entity.HasComment(""A category of products"");
+
+                entity.Property(e => e.CategoryName).HasComment(""The name of a category"");
+            });
+
             modelBuilder.Entity<Product>(entity =>
             {
                 entity.HasIndex(e => e.CategoryId);
diff --git a/test/Scaffolding.Handlebars.Tests/ExpectedEntities.cs b/test/Scaffolding.Handlebars.Tests/ExpectedEntities.cs
@@ -10,6 +10,9 @@ private static class ExpectedEntities
 
 namespace FakeNamespace
 {
+    /// <summary>
+    /// A category of products
+    /// </summary>
     public partial class Category
     {
         public Category()
@@ -18,6 +21,9 @@ public Category()
         }
 
         public int CategoryId { get; set; }
+        /// <summary>
+        /// The name of a category
+        /// </summary>
         public string CategoryName { get; set; }
 
         public virtual ICollection<Product> Product { get; set; }
@@ -56,6 +62,9 @@ private static class ExpectedEntitiesWithAnnotations
 
 namespace FakeNamespace
 {
+    /// <summary>
+    /// A category of products
+    /// </summary>
     public partial class Category
     {
         public Category()
@@ -65,6 +74,9 @@ public Category()
 
         [Key]
         public int CategoryId { get; set; }
+        /// <summary>
+        /// The name of a category
+        /// </summary>
         [Required]
         [StringLength(15)]
         public string CategoryName { get; set; }
@@ -112,6 +124,9 @@ private static class ExpectedEntitiesPluralized
 
 namespace FakeNamespace
 {
+    /// <summary>
+    /// A category of products
+    /// </summary>
     public partial class Category
     {
         public Category()
@@ -120,6 +135,9 @@ public Category()
         }
 
         public int CategoryId { get; set; }
+        /// <summary>
+        /// The name of a category
+        /// </summary>
         public string CategoryName { get; set; }
 
         public virtual ICollection<Product> Products { get; set; }
@@ -158,6 +176,9 @@ private static class ExpectedEntitiesWithAnnotationsPluralized
 
 namespace FakeNamespace
 {
+    /// <summary>
+    /// A category of products
+    /// </summary>
     [Table(""Category"")]
     public partial class Category
     {
@@ -168,6 +189,9 @@ public Category()
 
         [Key]
         public int CategoryId { get; set; }
+        /// <summary>
+        /// The name of a category
+        /// </summary>
         [Required]
         [StringLength(15)]
         public string CategoryName { get; set; }
diff --git a/test/Scaffolding.Handlebars.Tests/ExpectedTypeScriptContexts.cs b/test/Scaffolding.Handlebars.Tests/ExpectedTypeScriptContexts.cs
@@ -34,9 +34,12 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
         {
             modelBuilder.Entity<Category>(entity =>
             {
+                entity.HasComment(""A category of products"");
+
                 entity.Property(e => e.CategoryName)
                     .IsRequired()
-                    .HasMaxLength(15);
+                    .HasMaxLength(15)
+                    .HasComment(""The name of a category"");
             });
 
             modelBuilder.Entity<Product>(entity =>
diff --git a/test/Scaffolding.Handlebars.Tests/ExpectedTypeScriptInterfaces.cs b/test/Scaffolding.Handlebars.Tests/ExpectedTypeScriptInterfaces.cs
@@ -7,8 +7,14 @@ private static class ExpectedEntities
             public const string CategoryClass =
 @"import { Product } from './Product';
 
+/**
+* A category of products
+*/
 export interface Category {
     categoryId: number;
+    /**
+    * The name of a category
+    */
     categoryName: string;
     product: Product[];
 }
diff --git a/test/Scaffolding.Handlebars.Tests/FileSystemTemplateFileServiceTests.ExpectedTemplates.cs b/test/Scaffolding.Handlebars.Tests/FileSystemTemplateFileServiceTests.ExpectedTemplates.cs
@@ -32,9 +32,14 @@ public partial class {{class}} : DbContext
 
 namespace {{namespace}}
 {
-{{#if class-annotation}}
-{{spaces 4}}{{{class-annotation}}}
-{{/if}}
+    {{#if comment}}
+    /// <summary>
+    /// {{comment}}
+    /// </summary>
+    {{/if}}
+    {{#if class-annotation}}
+    {{{class-annotation}}}
+    {{/if}}
     public partial class {{class}}
     {
         {{{> constructor}}}

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,10 @@ public NorthwindDbContext(DbContextOptions options) : base(options) { }`
`14`	`14`
`15`	`15`	`protected override void OnModelCreating(ModelBuilder modelBuilder)`
`16`	`16`	`{`
	`17`	`+ modelBuilder.Entity<Category>()`
	`18`	`+ .HasComment("A category of products")`
	`19`	`+ .Property(category => category.CategoryName)`
	`20`	`+ .HasComment("The name of a category");`
`17`	`21`	`}`
`18`	`22`	`}`
`19`	`23`	`}`