feat(api): add configuration to specify that fields may also be included as well as properties using WithTypeMembers

Author: George Kinsman

README.md

@@ -61,6 +61,7 @@ public static TypeScriptGenerator CreateDefault() => new TypeScriptGenerator()
             .WithPropertyTypeFormatter<DateTimeOffset>(t => "string")
             .WithEnumFormatter(EnumFormatter.ValueNamedEnumFormatter, EnumFormatter.UnionStringEnumPropertyTypeFormatter)
             .WithQuoteStyle(QuoteStyle.Single)
+            .WithTypeMembers(MemberType.PropertiesOnly)
             .WithDictionaryPropertyFormatter(DictionaryPropertyFormatter.KeyValueFormatter)
             .WithCollectionPropertyFormatter(CollectionPropertyFormatter.Format)
             .WithNamespace("Api")

src/Typescript.Tests/Simple/SimpleGeneratorTests.cs

@@ -78,5 +78,42 @@ public void Generator_TypeWithCustomValueTypeProp_ShouldRenderCustomTypeSeparate
 
             this.Assent(generated.Types);
         }
+
+
+        class TestTypeWithFields
+        {
+#pragma warning disable 414
+            public string StringField = "123";
+            public int IntField = 4;
+#pragma warning restore 414
+        }
+
+        [Fact]
+        public void Generator_TypeWithFields_ShouldRenderFields()
+        {
+            var generator = TypeScriptGenerator.CreateDefault()
+                .WithTypeMembers(MemberType.PropertiesAndFields);
+            var generated = generator.Generate(new[] {typeof(TestTypeWithFields)});
+
+            this.Assent(generated.Types);
+        }
+        
+        class TestTypeWithFieldsAndProps
+        {
+#pragma warning disable 414
+            public string StringField = "123";
+            public int IntField = 4;
+#pragma warning restore 414
+            public string StringProp { get; set; }
+        }
+
+        [Fact]
+        public void Generator_TypeWithFieldsAndPropsButSetToPropsOnly_ShouldOnlyRenderProps()
+        {
+            var generator = TypeScriptGenerator.CreateDefault();
+            var generated = generator.Generate(new[] {typeof(TestTypeWithFieldsAndProps)});
+
+            this.Assent(generated.Types);
+        }
     }
 }

src/Typescriptr/MemberType.cs

@@ -0,0 +1,8 @@
+namespace Typescriptr
+{
+    public enum MemberType
+    {
+        PropertiesOnly,
+        PropertiesAndFields
+    }
+}

src/Typescriptr/TypeScriptGenerator.cs

@@ -2,6 +2,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection;
 using System.Security.Cryptography;
 using System.Text;
 using Typescriptr.Exceptions;
@@ -25,7 +26,9 @@ public class TypeScriptGenerator
         private FormatEnumProperty _enumPropertyFormatter;
         private FormatDictionaryProperty _dictionaryPropertyFormatter;
         private FormatCollectionProperty _collectionPropertyFormatter;
-
+        
+        private QuoteStyle _quoteStyle;
+        private MemberType _memberTypes;
         private bool _useCamelCasePropertyNames;
 
         private readonly Dictionary<Type, string> _propTypeMap = new Dictionary<Type, string>()
@@ -61,11 +64,18 @@ private TypeScriptGenerator()
             .WithEnumFormatter(EnumFormatter.ValueNamedEnumFormatter,
                 EnumFormatter.UnionStringEnumPropertyTypeFormatter)
             .WithQuoteStyle(QuoteStyle.Single)
+            .WithTypeMembers(MemberType.PropertiesOnly)
             .WithDictionaryPropertyFormatter(DictionaryPropertyFormatter.KeyValueFormatter)
             .WithCollectionPropertyFormatter(CollectionPropertyFormatter.Format)
             .WithNamespace("Api")
             .WithCamelCasedPropertyNames();
 
+        public TypeScriptGenerator WithTypeMembers(MemberType memberTypes)
+        {
+            _memberTypes = memberTypes;
+            return this;
+        }
+        
         public TypeScriptGenerator WithCamelCasedPropertyNames(bool useCamelCasedPropertyNames = true)
         {
             _useCamelCasePropertyNames = useCamelCasedPropertyNames;
@@ -118,7 +128,7 @@ public TypeScriptGenerator WithPropertyTypeFormatter<TType>(Func<Type, string> c
         private readonly HashSet<string> _enumNames = new HashSet<string>();
         private readonly Stack<Type> _typeStack = new Stack<Type>();
         private string _namespace;
-        private QuoteStyle _quoteStyle;
+        
 
         public GenerationResult Generate(IEnumerable<Type> types)
         {
@@ -159,18 +169,27 @@ private void RenderEnum(StringBuilder builder, Type enumType)
 
         private void RenderType(StringBuilder builder, Type type)
         {
-            var properties = type.GetProperties();
+            var memberTypesToInclude = _memberTypes == MemberType.PropertiesOnly
+                ? MemberTypes.Property
+                : MemberTypes.Property | MemberTypes.Field;
+
+            var members = type.GetMembers().Where(m => memberTypesToInclude.HasFlag(m.MemberType));
             builder.AppendLine($"interface {type.Name} {{");
 
-            foreach (var prop in properties)
+            foreach (var memberInfo in members)
             {
-                var propType = prop.PropertyType;
-                var propName = prop.Name;
-
+                Type memberType = null;
+                if (memberInfo is PropertyInfo p)
+                    memberType = p.PropertyType;
+                else if (memberInfo is FieldInfo f)
+                    memberType = f.FieldType;
+                if (memberType == null) throw new InvalidOperationException();
+                
+                var memberName = memberInfo.Name;
                 if (_useCamelCasePropertyNames)
-                    propName = propName.ToCamelCase();
+                    memberName = memberName.ToCamelCase();
 
-                RenderProperty(builder, propType, propName);
+                RenderProperty(builder, memberType, memberName);
             }
 
             builder.AppendLine("}");