Merge pull request #4 from d1820/bug-fix-nullabletype

Bug fix nullable DateTime

Author: d1820

CodeDocumentor.Test/PropertyUnitTests.cs

@@ -182,6 +182,22 @@ public class PropertyTester
 	}
 }";
 
+        /// <summary>
+        /// The nullable datetime property test code.
+        /// </summary>
+        private const string NullableDateTimePropertyTestCode = @"
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ConsoleApp4
+{
+	public class PropertyTester
+	{
+		public DateTime? TestDateTime { get; set; }
+	}
+}";
+
         /// <summary>
         /// The boolean property test fix code.
         /// </summary>
@@ -217,6 +233,25 @@ public class PropertyTester
 	}
 }";
 
+        /// <summary>
+        /// The nullable date time property test fix code.
+        /// </summary>
+        private const string NullableDateTimePropertyTestFixCode = @"
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace ConsoleApp4
+{
+	public class PropertyTester
+	{
+        /// <summary>
+        /// Gets or Sets a test date time
+        /// </summary>
+        public DateTime? TestDateTime { get; set; }
+	}
+}";
+
         /// <summary>
         /// The nullable boolean property test fix code.
         /// </summary>
@@ -307,7 +342,8 @@ public void NoDiagnosticsShow(string testCode)
 		[DataRow(BooleanPropertyTestCode, BooleanPropertyTestFixCode, 10, 15)]
 		[DataRow(NullableBooleanPropertyTestCode, NullableBooleanPropertyTestFixCode, 10, 16)]
 		[DataRow(ExpressionBodyPropertyTestCode, ExpressionBodyPropertyTestFixCode, 10, 17)]
-		public void ShowDiagnosticAndFix(string testCode, string fixCode, int line, int column)
+        [DataRow(NullableDateTimePropertyTestCode, NullableDateTimePropertyTestFixCode, 10, 20)]
+        public void ShowDiagnosticAndFix(string testCode, string fixCode, int line, int column)
 		{
 			var expected = new DiagnosticResult
 			{

CodeDocumentor/Helper/CommentHelper.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Runtime;
 using CodeDocumentor.Vsix2022;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
@@ -20,6 +21,10 @@ public static class CommentHelper
         /// <returns> </returns>
         public static string WithPeriod(this string text)
         {
+            if (text.EndsWith("."))
+            {
+                return text;
+            }
             return text + ".";
         }
 
@@ -123,8 +128,11 @@ public static string CreatePropertyComment(ReadOnlySpan<char> name, bool isBoole
         public static string CreateMethodComment(ReadOnlySpan<char> name, TypeSyntax returnType)
         {
             List<string> parts = SpilitNameAndToLower(name, false, false);
-
-            parts[0] = Pluralizer.Pluralize(parts[0]);
+            var isBool2part = parts.Count == 2 && returnType.ToString().IndexOf("bool", StringComparison.InvariantCultureIgnoreCase) > -1;
+            if (!isBool2part)
+            {
+                parts[0] = Pluralizer.Pluralize(parts[0]);
+            }
             if (parts.Count == 1 || (parts.Count == 2 && parts.Last() == "asynchronously"))
             {
                 parts.Insert(1, "the");
@@ -163,9 +171,13 @@ public static string CreateMethodComment(ReadOnlySpan<char> name, TypeSyntax ret
             }
             else
             {
-                parts.Insert(1, "the");
+                var skipThe = Constants.INTERNAL_SPECIAL_WORD_LIST.Any(w => w.Equals(parts[0]));
+                if (!skipThe && !isBool2part)
+                {
+                    parts.Insert(1, "the");
+                }
             }
-            
+
             return string.Join(" ", parts).Translate().WithPeriod();
         }
 

CodeDocumentor/Helper/Pluralizer.cs

@@ -1,4 +1,6 @@
-using ThirdPartPluralizer = Pluralize.NET;
+using System.Linq;
+using CodeDocumentor.Vsix2022;
+using ThirdPartPluralizer = Pluralize.NET;
 
 namespace CodeDocumentor.Helper
 {
@@ -14,7 +16,13 @@ public static class Pluralizer
         /// <returns> A plural word. </returns>
         public static string Pluralize(string word)
         {
-            return new ThirdPartPluralizer.Pluralizer().Pluralize(word);
+            var skipPlural = Constants.INTERNAL_SPECIAL_WORD_LIST.Any(w => w.Equals(word));
+            if (!skipPlural)
+            {
+                var pl = new ThirdPartPluralizer.Pluralizer();
+                return pl.Pluralize(word);
+            }
+            return word;
         }
     }
 }

CodeDocumentor/Models/Constants.cs

@@ -21,7 +21,9 @@ public static class Constants
             new WordMap { Word = "OfCollection", Translation = "OfCollections" },
             new WordMap { Word = "IReadOnlyCollection", Translation = "Read Only Collection" },
             new WordMap { Word = "IReadOnlyDictionary", Translation = "Read Only Dictionary" },
-            new WordMap { Word = "Shoulds the", Translation = "Should" },
         };
+
+        public static string[] INTERNAL_SPECIAL_WORD_LIST = new[] { "Should", "Would", "Could", 
+                                                                    "Ensure", "Can", "Why", "Welcome" };
     }
 }

CodeDocumentor/PropertyCodeFixProvider.cs

@@ -86,7 +86,10 @@ private async Task<Document> AddDocumentationHeaderAsync(Document document, Synt
             else if (declarationSyntax.Type.IsKind(SyntaxKind.NullableType))
             {
                 var returnType = ((NullableTypeSyntax)declarationSyntax.Type).ElementType as PredefinedTypeSyntax;
-                isBoolean = returnType.ToString().IndexOf("bool", StringComparison.OrdinalIgnoreCase) > -1;
+                if(returnType != null)
+                {
+                    isBoolean = returnType.ToString().IndexOf("bool", StringComparison.OrdinalIgnoreCase) > -1;
+                }               
             }
 
             bool hasSetter = false;

Manifests/vs2022/source.extension.vsixmanifest

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="CodeDocumentor.2022.88F29096-CA4C-4F88-A260-705D8BBFCF2A" Version="1.1" Language="en-US" Publisher="Dan Turco"/>
+        <Identity Id="CodeDocumentor.2022.88F29096-CA4C-4F88-A260-705D8BBFCF2A" Version="1.1.2" Language="en-US" Publisher="Dan Turco"/>
         <DisplayName>CodeDocumentor</DisplayName>
         <Description xml:space="preserve">An Extension to generate XML documentation automatically using IntelliSense for interface,class,enum, field, constructor, property and method.</Description>
         <Icon>logo.png</Icon>

TestProject/Sample/Sample/Sample.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
   </PropertyGroup>
 
 </Project>

TestProject/Sample/Sample/protoTester.cs

@@ -0,0 +1,36 @@
+using ProtoBuf;
+namespace Sample;
+
+[ProtoContract]
+public class protoTester
+{
+    [ProtoMember(1)]
+    public int MyProperty { get; set; }
+
+    [ProtoMember(2)]
+    public int MyProperty1 { get; set; }
+
+    public DateTime? NullDateTime { get; set; }
+
+    public int? NullInt { get; set; }
+
+    public int?[] NullIntArray { get; set; }
+
+    public bool CanExecute() { return true; }
+
+    public bool ShouldHappen() { return true; }
+}
+
+namespace Sample.Other
+{
+
+    [ProtoContract]
+    public class protoTester
+    {
+        [ProtoMember(1)]
+        public int MyProperty { get; set; }
+
+        [ProtoMember(2)]
+        public int MyProperty1 { get; set; }
+    }
+}