Merge pull request #148 from TrackableEntities/fix-comments

Support Line Characters in Generated Comments

Author: tonysneed

sample/ScaffoldingSample/CodeTemplates/CSharpEntityType/Class.hbs

@@ -2,9 +2,14 @@
 
 namespace {{namespace}}
 { // Comment
-{{#if class-annotation}}
+    {{#if comment}}
+    /// <summary>
+{{comment}}
+    /// </summary>
+    {{/if}}
+    {{#each class-annotations}}
     {{{class-annotation}}}
-{{/if}}
+    {{/each}}
     public partial class {{class}} : {{base-class}} {{my-helper}}
     {
         {{{> constructor}}}

sample/ScaffoldingSample/CodeTemplates/CSharpEntityType/Partials/Properties.hbs

@@ -1,4 +1,10 @@
 {{#each properties}}
+{{#if property-comment}}
+
+        /// <summary>
+{{property-comment}}
+        /// </summary>
+{{/if}}
 {{#each property-annotations}}
         {{{property-annotation}}}
 {{/each}}

sample/ScaffoldingSample/Contexts/NorthwindSlimContext.cs

@@ -41,12 +41,12 @@ protected override void OnModelCreating(ModelBuilder modelBuilder)
             {
                 entity.ToTable("Category");
 
-                entity.HasComment("hello table Customer");
+                entity.HasComment("Hello table Customer\r\n(Currently not used.)");
 
                 entity.Property(e => e.CategoryName)
                     .IsRequired()
                     .HasMaxLength(15)
-                    .HasComment("hello CompanyName");
+                    .HasComment("Hello CompanyName\r\n(Currently not used.)");
             });
 
             modelBuilder.Entity<dbo.Customer>(entity =>

sample/ScaffoldingSample/Sample.ReadMe.md

@@ -13,7 +13,7 @@ Demonstrates how to reverse engineer an existing database using the EF Core tool
     - The easiest is to use **LocalDb**, which is installed with Visual Studio.  
     Connect to: `(localdb)\MsSqlLocalDb`.
     - Create a new database named **NorthwindSlim**.
-    - Download the data file from <http://bit.ly/northwind-slim>.
+    - Download the `NorthwindSlim.sql` file from <https://github.com/TrackableEntities/northwind-slim>.
     - Unzip **NorthwindSlim.sql** and run the script to create tables and populate them with data.
 
 ## Setup

sample/ScaffoldingSample/ScaffoldingDesignTimeServices.cs

@@ -21,7 +21,7 @@ public class ScaffoldingDesignTimeServices : IDesignTimeServices
         public void ConfigureDesignTimeServices(IServiceCollection services)
         {
             // Uncomment to launch JIT debugger and hit breakpoints
-            //Debugger.Launch();
+            Debugger.Launch();
 
             // Add Handlebars scaffolding templates
             services.AddHandlebarsScaffolding(options =>
@@ -44,6 +44,9 @@ public void ConfigureDesignTimeServices(IServiceCollection services)
                     { "models-namespace", "ScaffoldingSample.Models" },
                     { "base-class", "EntityBase" }
                 };
+
+                // Disable comments generation
+                options.GenerateComments = false;
             });
 
             // Register Handlebars helper

src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/CSharpEntityType/Class.hbs

@@ -4,7 +4,7 @@ namespace {{namespace}}
 {
     {{#if comment}}
     /// <summary>
-    /// {{comment}}
+{{comment}}
     /// </summary>
     {{/if}}
     {{#each class-annotations}}

src/EntityFrameworkCore.Scaffolding.Handlebars/CodeTemplates/CSharpEntityType/Partials/Properties.hbs

@@ -1,7 +1,8 @@
 {{#each properties}}
 {{#if property-comment}}
+
         /// <summary>
-        /// {{property-comment}}
+{{property-comment}}
         /// </summary>
 {{/if}}
 {{#each property-annotations}}

src/EntityFrameworkCore.Scaffolding.Handlebars/EntityFrameworkCore.Scaffolding.Handlebars.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.1</TargetFramework>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <Version>5.0.0</Version>
+    <Version>5.0.1</Version>
     <Authors>Tony Sneed</Authors>
     <Company>Tony Sneed</Company>
     <Title>Entity Framework Core Scaffolding with Handlebars</Title>
@@ -12,7 +12,7 @@
     <PackageProjectUrl>https://github.com/TrackableEntities/EntityFrameworkCore.Scaffolding.Handlebars</PackageProjectUrl>
     <PackageIcon>icon.png</PackageIcon>
     <PackageTags>scaffolding reverse-engineer entity-framework-core handlebars</PackageTags>
-    <PackageReleaseNotes>See: https://github.com/TrackableEntities/EntityFrameworkCore.Scaffolding.Handlebars/releases/tag/v5.0.0</PackageReleaseNotes>
+    <PackageReleaseNotes>See: https://github.com/TrackableEntities/EntityFrameworkCore.Scaffolding.Handlebars/releases/tag/v5.0.1</PackageReleaseNotes>
     <LangVersion>latest</LangVersion>
     <IncludeSource>true</IncludeSource>
     <SignAssembly>true</SignAssembly>

src/EntityFrameworkCore.Scaffolding.Handlebars/HandlebarsScaffoldingOptions.cs

@@ -56,5 +56,10 @@ public class HandlebarsScaffoldingOptions
         /// https://docs.microsoft.com/en-us/ef/core/miscellaneous/nullable-reference-types
         /// </summary>
         public bool EnableNullableReferenceTypes { get; set; }
+
+        /// <summary>
+        /// Gets or sets whether table and column descriptions generate XML comments.
+        /// </summary>
+        public bool GenerateComments { get; set; } = true;
     }
 }

src/EntityFrameworkCore.Scaffolding.Handlebars/HbsCSharpEntityTypeGenerator.cs

@@ -12,6 +12,7 @@
 using JetBrains.Annotations;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.EntityFrameworkCore.Design;
+using Microsoft.EntityFrameworkCore.Infrastructure;
 using Microsoft.EntityFrameworkCore.Metadata;
 using Microsoft.EntityFrameworkCore.Metadata.Internal;
 using Microsoft.EntityFrameworkCore.Scaffolding.Internal;
@@ -173,7 +174,8 @@ protected override void GenerateClass(IEntityType entityType)
 
             var transformedEntityName = EntityTypeTransformationService.TransformTypeEntityName(entityType.Name);
 
-            TemplateData.Add("comment", entityType.GetComment());
+            if (_options?.Value?.GenerateComments == true)
+                TemplateData.Add("comment", GenerateComment(entityType.GetComment(), 1));
             TemplateData.Add("class", transformedEntityName);
 
             GenerateConstructor(entityType);
@@ -241,7 +243,7 @@ protected override void GenerateProperties(IEntityType entityType)
                     { "property-type", propertyType },
                     { "property-name", property.Name },
                     { "property-annotations",  PropertyAnnotationsData },
-                    { "property-comment",  property.GetComment() },
+                    { "property-comment", _options?.Value?.GenerateComments == true ? GenerateComment(property.GetComment(), 2) : null },
                     { "property-isnullable", property.IsNullable },
                     { "nullable-reference-types", _options?.Value?.EnableNullableReferenceTypes == true }
                 });
@@ -567,6 +569,23 @@ private void GenerateInversePropertyAttribute(INavigation navigation)
             }
         }
 
+        private string GenerateComment(string comment, int indents)
+        {
+            var sb = new IndentedStringBuilder();
+            if (!string.IsNullOrWhiteSpace(comment))
+            {
+                for (int i = 0; i < indents; i++)
+                    sb.IncrementIndent();
+                foreach (var line in comment.Split(new[] { "\r\n", "\r", "\n" }, StringSplitOptions.None))
+                {
+                    sb.AppendLine($"/// {System.Security.SecurityElement.Escape(line)}");
+                }
+                for (int i = 0; i < indents; i++)
+                    sb.DecrementIndent();
+            }
+            return sb.ToString().Trim(Environment.NewLine.ToCharArray());
+        }
+
         private class AttributeWriter
         {
             private readonly string _attibuteName;