ensure code is nullable compliant

Author: dansiegel

CodeGenHelpers.sln

@@ -13,6 +13,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CodeGenHelpers.Tests", "tes
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{8F6F4081-C731-48F9-88C9-7AA98D7C265C}"
 	ProjectSection(SolutionItems) = preProject
+		global.json = global.json
 		version.json = version.json
 	EndProjectSection
 EndProject

global.json

@@ -1,7 +1,5 @@
 {
   "sdk": {
-    "version": "6.0.101",
-    "rollForward": "latestMinor",
-    "allowPrerelease": false
+    "version": "6.0.400"
   }
 }

src/CodeGenHelpers/AvantiPoint.CodeGenHelpers.csproj

@@ -13,6 +13,8 @@
     <DevelopmentDependency>true</DevelopmentDependency>
     <IncludeBuildOutput>false</IncludeBuildOutput>
     <TargetsForTfmSpecificContentInPackage>$(TargetsForTfmSpecificContentInPackage);_AddGeneratorsToOutput</TargetsForTfmSpecificContentInPackage>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <NoWarn>$(NoWarn);NU5128;</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

src/CodeGenHelpers/BuilderBase.cs

@@ -1,6 +1,9 @@
 using System.Collections.Generic;
 using System.Linq;
 
+#pragma warning disable IDE0008
+#pragma warning disable IDE0090
+#nullable enable
 namespace CodeGenHelpers
 {
     public abstract class BuilderBase : IBuilder

src/CodeGenHelpers/BuilderBase{T}.cs

@@ -1,5 +1,7 @@
-using Microsoft.CodeAnalysis;
+using System;
+using Microsoft.CodeAnalysis;
 
+#nullable enable
 namespace CodeGenHelpers
 {
     public abstract class BuilderBase<T> : BuilderBase
@@ -12,7 +14,10 @@ public abstract class BuilderBase<T> : BuilderBase
         public T DisableWarning(string buildCode)
         {
             _pragmaWarnings.Add(buildCode);
-            return this as T;
+            if (this is T thisAsT)
+                return thisAsT;
+
+            throw new InvalidOperationException($"The Builder must be of type {typeof(T).FullName}");
         }
     }
 }

src/CodeGenHelpers/ClassBuilder.cs

@@ -5,6 +5,11 @@
 using CodeGenHelpers.Internals;
 using Microsoft.CodeAnalysis;
 
+#pragma warning disable IDE0008
+#pragma warning disable IDE0079
+#pragma warning disable IDE0090
+#pragma warning disable IDE1006
+#nullable enable
 namespace CodeGenHelpers
 {
     public sealed class ClassBuilder : BuilderBase<ClassBuilder>
@@ -19,7 +24,7 @@ public sealed class ClassBuilder : BuilderBase<ClassBuilder>
         private readonly Queue<ClassBuilder> _nestedClass = new Queue<ClassBuilder>();
         private readonly GenericCollection _generics = new GenericCollection();
         private readonly bool _isPartial;
-        private readonly DocumentationComment _xmlDoc = new DocumentationComment();
+        private DocumentationComment? _xmlDoc;
 
         internal ClassBuilder(string className, CodeBuilder codeBuilder, bool partial = true)
         {
@@ -42,7 +47,7 @@ internal ClassBuilder(string className, CodeBuilder codeBuilder, bool partial =
 
         public CodeBuilder Builder { get; }
 
-        public string BaseClass { get; private set; }
+        public string? BaseClass { get; private set; }
 
         public Accessibility? AccessModifier { get; private set; }
 
@@ -56,22 +61,19 @@ internal ClassBuilder(string className, CodeBuilder codeBuilder, bool partial =
 
         public ClassBuilder WithSummary(string summary)
         {
-            _xmlDoc.Summary = summary;
-            _xmlDoc.InheritDoc = false;
+            _xmlDoc = new SummaryDocumentationComment { Summary = summary };
             return this;
         }
 
         public ClassBuilder WithInheritDoc(bool inherit = true)
         {
-            _xmlDoc.InheritDoc = inherit;
-            _xmlDoc.InheritFrom = null;
+            _xmlDoc = new InheritDocumentationComment();
             return this;
         }
 
         public ClassBuilder WithInheritDoc(string from)
         {
-            _xmlDoc.InheritDoc = true;
-            _xmlDoc.InheritFrom = from;
+            _xmlDoc = new InheritDocumentationComment { InheritFrom = from };
             return this;
         }
 
@@ -280,11 +282,9 @@ public ClassBuilder AddNestedClass(string name, Accessibility? accessModifier =
 
         public string Build() => Builder.Build();
 
-        public string BuildSafe() => Builder.BuildSafe();
-
         internal override void Write(in CodeWriter writer)
         {
-            _xmlDoc.Write(writer);
+            _xmlDoc?.Write(writer);
 
             WriteClassAttributes(_classAttributes, writer);
 
@@ -293,7 +293,7 @@ internal override void Write(in CodeWriter writer)
             var queue = new Queue<string>();
             if (!string.IsNullOrEmpty(BaseClass))
             {
-                queue.Enqueue(BaseClass);
+                queue.Enqueue(BaseClass!);
             }
 
             foreach (var inter in _interfaces.Where(x => !string.IsNullOrEmpty(x)).Distinct().OrderBy(x => x))
@@ -323,13 +323,41 @@ internal override void Write(in CodeWriter writer)
             {
                 var hadOutput = false;
                 hadOutput = InvokeBuilderWrite(_events, ref hadOutput, writer);
-                hadOutput = InvokeBuilderWrite(_properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Const && x.IsStatic == false), ref hadOutput, writer, true);
-                hadOutput = InvokeBuilderWrite(_properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Const && x.IsStatic == true), ref hadOutput, writer, true);
-                hadOutput = InvokeBuilderWrite(_properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.ReadOnly), ref hadOutput, writer, true);
-                hadOutput = InvokeBuilderWrite(_properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Default), ref hadOutput, writer, true);
-                hadOutput = InvokeBuilderWrite(_constructors, ref hadOutput, writer);
-                hadOutput = InvokeBuilderWrite(_properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Property), ref hadOutput, writer);
-                hadOutput = InvokeBuilderWrite(_methods, ref hadOutput, writer);
+                hadOutput = InvokeBuilderWrite(
+                    _properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Const && x.IsStatic == false)
+                        .OrderBy(x => x.Name),
+                    ref hadOutput,
+                    writer,
+                    true);
+                hadOutput = InvokeBuilderWrite(
+                    _properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Const && x.IsStatic == true)
+                        .OrderBy(x => x.Name),
+                    ref hadOutput,
+                    writer,
+                    true);
+                hadOutput = InvokeBuilderWrite(
+                    _properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.ReadOnly)
+                        .OrderBy(x => x.Name),
+                    ref hadOutput,
+                    writer,
+                    true);
+                hadOutput = InvokeBuilderWrite(
+                    _properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Default)
+                        .OrderBy(x => x.Name),
+                    ref hadOutput,
+                    writer,
+                    true);
+                hadOutput = InvokeBuilderWrite(_constructors.OrderBy(x => x.Parameters.Count), ref hadOutput, writer);
+                hadOutput = InvokeBuilderWrite(
+                    _properties.Where(x => x.FieldTypeValue == PropertyBuilder.FieldType.Property)
+                        .OrderBy(x => x.Name),
+                    ref hadOutput,
+                    writer);
+                hadOutput = InvokeBuilderWrite(
+                    _methods.OrderBy(x => x.Name)
+                        .ThenBy(x => x.Parameters.Count),
+                    ref hadOutput,
+                    writer);
                 InvokeBuilderWrite(_nestedClass, ref hadOutput, writer);
             }
         }

src/CodeGenHelpers/CodeBuilder.cs

@@ -4,6 +4,10 @@
 using System.Text.RegularExpressions;
 using Microsoft.CodeAnalysis;
 
+#pragma warning disable IDE0079
+#pragma warning disable IDE0090
+#pragma warning disable IDE1006
+#nullable enable
 namespace CodeGenHelpers
 {
     public sealed class CodeBuilder
@@ -12,7 +16,7 @@ public sealed class CodeBuilder
 
 Changes to this file may cause incorrect behavior and will be lost if
 the code is regenerated.";
-        private string _autoGeneratedMessage;
+        private string? _autoGeneratedMessage;
         private readonly List<string> _namespaceImports = new List<string>();
         private readonly List<string> _assemblyAttributes = new List<string>();
         private readonly Queue<IBuilder> _classes = new Queue<IBuilder>();
@@ -170,13 +174,6 @@ public string Build()
             return writer.ToString();
         }
 
-        public string BuildSafe()
-        {
-            var writer = BuildInternal();
-            writer.ToString();
-            return writer.SafeOutput;
-        }
-
         public override string ToString()
         {
             return Build();

src/CodeGenHelpers/ConstructorBuilder.cs

@@ -3,22 +3,27 @@
 using System.Linq;
 using Microsoft.CodeAnalysis;
 
+#pragma warning disable IDE0079
+#pragma warning disable IDE0090
+#pragma warning disable IDE1006
+#nullable enable
 namespace CodeGenHelpers
 {
     public sealed class ConstructorBuilder : BuilderBase<ConstructorBuilder>, IParameterized<ConstructorBuilder>
     {
         private readonly List<ParameterBuilder<ConstructorBuilder>> _parameters = new List<ParameterBuilder<ConstructorBuilder>>();
         private readonly List<string> _attributes = new List<string>();
-        private readonly DocumentationComment _xmlDoc = new DocumentationComment(true);
+        private DocumentationComment? _xmlDoc;
 
-        private Action<ICodeWriter> _methodBodyWriter;
+        private Action<ICodeWriter>? _methodBodyWriter;
 
         private Func<string> _baseCall;
 
         internal ConstructorBuilder(Accessibility? accessModifier, ClassBuilder classBuilder)
         {
             AccessModifier = accessModifier;
             Class = classBuilder;
+            _baseCall = () => string.Empty;
         }
 
         List<ParameterBuilder<ConstructorBuilder>> IParameterized<ConstructorBuilder>.Parameters => _parameters;
@@ -35,28 +40,35 @@ internal ConstructorBuilder(Accessibility? accessModifier, ClassBuilder classBui
 
         public ConstructorBuilder WithSummary(string summary)
         {
-            _xmlDoc.Summary = summary;
-            _xmlDoc.InheritDoc = false;
+            if (_xmlDoc is not null && _xmlDoc is SummaryDocumentationComment summaryComment)
+                summaryComment.Summary = summary;
+            else
+                _xmlDoc = new ParameterDocumentationComment { Summary = summary };
+
             return this;
         }
 
         public ConstructorBuilder WithInheritDoc(bool inherit = true)
         {
-            _xmlDoc.InheritDoc = inherit;
-            _xmlDoc.InheritFrom = null;
+            _xmlDoc = new InheritDocumentationComment();
             return this;
         }
 
         public ConstructorBuilder WithInheritDoc(string from)
         {
-            _xmlDoc.InheritDoc = true;
-            _xmlDoc.InheritFrom = from;
+            _xmlDoc = new InheritDocumentationComment { InheritFrom = from };
             return this;
         }
 
         public ConstructorBuilder WithParameterDoc(string paramName, string documentation)
         {
-            _xmlDoc.ParameterDoc[paramName] = documentation;
+            if (_xmlDoc is not null && _xmlDoc is not ParameterDocumentationComment)
+                throw new Exception("Documentation Comment has already been initialized using an InheritDoc.");
+
+            var parameterDoc = _xmlDoc as ParameterDocumentationComment;
+            if(parameterDoc is not null)
+                parameterDoc.AddParameter(paramName, documentation);
+
             return this;
         }
 
@@ -178,8 +190,10 @@ public ConstructorBuilder AddConstructor(Accessibility? accessModifier = null)
 
         internal override void Write(in CodeWriter writer)
         {
-            _xmlDoc.RemoveUnusedParameters(_parameters);
-            _xmlDoc.Write(writer);
+            if(_xmlDoc is ParameterDocumentationComment parameterDocumentation)
+                parameterDocumentation.RemoveUnusedParameters(_parameters);
+
+            _xmlDoc?.Write(writer);
 
             foreach (var attribute in _attributes)
                 writer.AppendLine($"[{attribute}]");
@@ -190,7 +204,7 @@ internal override void Write(in CodeWriter writer)
                 _ => AccessModifier.ToString().ToLower()
             };
             var parameters = _parameters.Any() ? string.Join(", ", _parameters.Select(x => x.ToString())) : string.Empty;
-            using(writer.Block($"{modifier} {Class.Name}({parameters})", _baseCall?.Invoke()))
+            using(writer.Block($"{modifier} {Class.Name}({parameters})", _baseCall.Invoke()))
             {
                 _methodBodyWriter?.Invoke(writer);
             }