Update README to document [Decimal] support for string/StringValue fields

Author: machibuse

README.md

@@ -1,6 +1,7 @@
 # Porticle.Grpc.TypeMapper
 
-A Roslyn-based post-processor for protoc-generated files that adds automatic mappings for `Guid`, `Guid?`, `string?` or nullable enums. By simply adding this package and adding
+A Roslyn-based post-processor for protoc-generated files that adds automatic mappings for `Guid`, `Guid?`, `decimal`, `decimal?`, `string?` or nullable enums. By simply adding this
+package and adding
 comments to
 your `.proto` file.
 
@@ -18,19 +19,21 @@ This library adds automatic conversion for:
 
 - Protobuf string to C# Guid
 - Protobuf google.Protobuf.StringValue to C# Guid?
+- Protobuf string to C# decimal
+- Protobuf google.Protobuf.StringValue to C# decimal?
 - Protobuf google.Protobuf.StringValue to C# string?
 - Protobuf optional enum to C# nullable enum
 
 This Library adds a Roslyn Postprocessing zu the c# files generated by the protoc compiler.
-Enabling seamless integration of Guid, Guid?, string?, nullable Enums and `NRT Support` in your gRPC services without manual conversion.
+Enabling seamless integration of Guid, Guid?, decimal, decimal?, string?, nullable Enums and `NRT Support` in your gRPC services without manual conversion.
 Code.
 
 ## TL/DR
 
 - Add `// [GrpcGuid]` as comment to a string or StringValue proto field to get Guid/Guid? in generated c# code
+- Add `// [Decimal]` as comment to a string or StringValue proto field to get decimal/decimal? in generated c# code
 - Add `// [NullableString]` as comment to a string or StringValue proto field to get string? in generated c# code
 - Add `// [NullableEnum]` as comment to an optional enum proto field to get MyEnum? in generated c# code
-- Add `// [NullableEnum]` as comment to an optional enum proto field to get MyEnum? in generated c# code
 - Add PorticleGrpcTypeMapper_WrapAllNonNullableStrings as Property to your Project to wrap all not nullable proto stings in #nullable enable/disable
 - Add PorticleGrpcTypeMapper_WrapAllNullableStrings as Property to your Project to wrap all proto StringValue fields in #nullable enable/disable and change `string` to `string?`
 
@@ -66,6 +69,8 @@ There are three things you can do in your .proto files:
 
 - Add `// [GrpcGuid]` as comment to a string field - Converts the corresponding c# string property to Guid
 - Add `// [GrpcGuid]` as comment to a StringValue field - Converts the corresponding c# string property to Guid?
+- Add `// [Decimal]` as comment to a string field - Converts the corresponding c# string property to decimal
+- Add `// [Decimal]` as comment to a StringValue field - Converts the corresponding c# string property to decimal?
 - Add `// [NullableString]` as comment to a StringValue field - Converts the corresponding c# string property to string?
 - Add `// [NullableEnum]` as comment to a optional enum field - Converts the corresponding optional proto enum to a C# nullable Enum
 
@@ -96,7 +101,10 @@ message User {
   // List of roles 
   repeated string role_ids = 4;
 
-  // Simple Enum  
+    // Price of the item
+    string price = 6;
+
+    // Simple Enum
   optional TestEnum foo_bar = 5;
 }
 ```
@@ -127,12 +135,18 @@ public pbc::RepeatedField<string> RoleIds {
   get { return roleIds_; }
 }
 
+/// <summary>Price of the item</summary>
+public string Price {
+  get { return price_; }
+  set { price_ = pb::ProtoPreconditions.CheckNotNull(value, "value"); }
+}
+
 public global::Porticle.Grpc.UnitTests.TestEnum FooBar {
-  get { 
-	if ((_hasBits0 & 1) != 0) 
-	  return fooBar_; 
-	else 
-	  return FooBarDefaultValue; 
+  get {
+	if ((_hasBits0 & 1) != 0)
+	  return fooBar_;
+	else
+	  return FooBarDefaultValue;
   }
   set {
 	_hasBits0 |= 1;
@@ -166,12 +180,15 @@ message User {
   // [GrpcGuid] List of roles 
   repeated string role_ids = 4;
 
-  // [NullableEnum] Simple Enum  
+    // [Decimal] Price of the item
+    string price = 6;
+
+    // [NullableEnum] Simple Enum
   optional TestEnum foo_bar = 5;
 }
 ```
 
-Will result in generated code like this, using string? Guid and Guid? and a nullable Enum
+Will result in generated code like this, using string?, Guid, Guid?, decimal and a nullable Enum
 
 ```csharp
 /// <summary>[GrpcGuid] Guid of the user object</summary>
@@ -222,6 +239,20 @@ public IList<Guid> RoleIds {
   }
 }
 
+/// <summary>[Decimal] Price of the item</summary>
+public decimal Price {
+  get
+  {
+      // Parse the internal string as decimal using InvariantCulture
+      return decimal.Parse(price_, System.Globalization.CultureInfo.InvariantCulture);
+  }
+  set
+  {
+      // Set the internal string from the given decimal
+      price_ = (value).ToString(System.Globalization.CultureInfo.InvariantCulture);
+  }
+}
+
 public global::Porticle.Grpc.UnitTests.TestEnum? FooBar {
   get { 
 	if ((_hasBits0 & 1) != 0)