Fix typos in method names within PropertyVisitor and enhance nullable string property handling. Update README with detailed usage instructions. Adjust IntelliJ VCS configuration.

Author: machibuse

README.md

@@ -1,3 +1,138 @@
-# A Roslyn PostProcessor for protoc generated files to add Guid support
+# Porticle.Grpc.GuidMapper
 
-This library allows you to map string and StringValue to Guid and Guid?.
+A Roslyn-based post-processor for protoc-generated files that adds native Guid, Guid? and string? types in gRPC services.
+
+## Overview
+
+This library allows you to automatically convert PROTO string or StringValue fields to C# Guid, Guid? or string? types in protoc-generated files, enabling seamless integration of
+GUIDs in your gRPC services without manual conversion
+code.
+
+## Installation
+
+### Install the package via NuGet:
+```powershell
+dotnet add package Porticle.Grpc.GuidMapper
+```
+
+After installing the Package, this Post build step ist dynamically added to your build.
+
+```msbuild
+<Project>
+    <Target Name="RunProtoPostProcessing" AfterTargets="Protobuf_Compile">
+        <ItemGroup>
+            <_FilesToPostProcess Include="$(MSBuildProjectDirectory)\%(Protobuf_Compile.OutputDir)\%(Protobuf_Compile.Filename)" />
+        </ItemGroup>
+        <Message Text="Proto Postprocessing" Importance="high" />
+        <Exec Command="dotnet &quot;$(MSBuildThisFileDirectory)..\tools\$(TargetFramework)\Porticle.Grpc.GuidMapper.dll&quot; -- %(_FilesToPostProcess.Identity)" Condition="'@(_FilesToPostProcess)' != ''" />
+    </Target>
+</Project>
+```
+
+Dont wonder ist you cant se it in your csproj file. It is dynamically added when your build is processed.  
+
+## Usage
+
+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 `// [NullableString]` as comment to a StringValue field - Converts the corresponding c# string property to string?
+
+
+First an Example of a default .proto file
+
+### Without GuidMapper
+```protobuf
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+
+message User {
+  // Guid of the user object   
+  string id = 1;
+
+  // Optional reference ID
+  google.protobuf.StringValue optional_reference_id = 4;
+
+  // Name
+  string name = 2;
+
+  // Optional description
+  google.protobuf.StringValue description = 3;
+}
+```
+Will result in generated code like this
+```csharp
+/// <summary>Guid of the user object</summary>
+public string Id {
+  get { return id_; }
+  set { id_ = pb::ProtoPreconditions.CheckNotNull(value, "value"); }
+}
+
+/// <summary>Optional reference ID</summary>
+public string OptionalReferenceId {
+  get { return optionalReferenceId_; }
+  set { optionalReferenceId_ = value; }
+}
+
+/// <summary>Name</summary>
+public string Name {
+  get { return name_; }
+  set { name_ = pb::ProtoPreconditions.CheckNotNull(value, "value"); }
+}
+
+/// <summary>Optional description</summary>
+public string Description {
+  get { return description_; }
+  set { description_ = value; }
+}
+```
+
+### With GuidMapper
+```protobuf
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+
+message User {
+  // [GrpcGuid] Guid of the user object   
+  string id = 1;
+
+  // [GrpcGuid] Optional reference ID
+  google.protobuf.StringValue optional_reference_id = 4;
+
+  // Name
+  string name = 2;
+
+  // [NullableString] Optional description
+  google.protobuf.StringValue description = 3;
+}
+```
+Will result in generated code like this
+```csharp
+/// <summary>[GrpcGuid] Guid of the user object</summary>
+public global::System.Guid Id {
+  get {return global::System.Guid.Parse(id_); }
+  set { id_ = (value).ToString("D"); }
+}
+
+/// <summary>[GrpcGuid] Optional reference ID</summary>
+public global::System.Guid? OptionalReferenceId {
+  get {if(optionalReferenceId_==null)return default; return global::System.Guid.Parse(optionalReferenceId_); }
+  set { optionalReferenceId_ = (value)?.ToString("D"); }
+}
+
+/// <summary>Name</summary>
+public string Name {
+  get { return name_; }
+  set { name_ = pb::ProtoPreconditions.CheckNotNull(value, "value"); }
+}
+
+#nullable enable
+/// <summary>[NullableString] Optional description</summary>
+public string? Description {
+  get { return description_; }
+  set { description_ = value; }
+}
+#nullable disable
+```

Source/.idea/.idea.Porticle.Grpc/.idea/vcs.xml

@@ -41,18 +41,18 @@ public class PropertyVisitor : CSharpSyntaxRewriter
 
         if (property.GetLeadingTrivia().ToFullString().Contains("[GrpcGuid]"))
         {
-            return ConcertToGuidProperty(property);
+            return ConvertToGuidProperty(property);
         }
 
         if (property.GetLeadingTrivia().ToFullString().Contains("[NullableString]"))
         {
-            return ConcertToNullableStringProperty(property);
+            return ConvertToNullableStringProperty(property);
         }
 
         return null;
     }
 
-    private PropertyDeclarationSyntax? ConcertToNullableStringProperty(PropertyDeclarationSyntax property)
+    private PropertyDeclarationSyntax? ConvertToNullableStringProperty(PropertyDeclarationSyntax property)
     {
         var setter = property.AccessorList?.Accessors.FirstOrDefault(a => a.IsKind(SyntaxKind.SetAccessorDeclaration));
 
@@ -70,11 +70,19 @@ public class PropertyVisitor : CSharpSyntaxRewriter
             return null;
         }
 
-        // Change property type to string? 
-        return property.WithType(SyntaxFactory.ParseTypeName("global::System.String?").WithTrailingTrivia(SyntaxFactory.Space));
+        var enableDirective = SyntaxFactory.Trivia(SyntaxFactory.NullableDirectiveTrivia(SyntaxFactory.Token(SyntaxKind.EnableKeyword), true));
+        var disableDirective = SyntaxFactory.Trivia(SyntaxFactory.NullableDirectiveTrivia(SyntaxFactory.Token(SyntaxKind.DisableKeyword), true));
+
+        var leadingTrivia = SyntaxFactory.TriviaList(enableDirective, SyntaxFactory.ElasticCarriageReturnLineFeed);
+        var trailingTrivia = SyntaxFactory.TriviaList(SyntaxFactory.ElasticCarriageReturnLineFeed, disableDirective);
+
+        return property
+            .WithType(SyntaxFactory.ParseTypeName("string?").WithTrailingTrivia(SyntaxFactory.ElasticSpace))
+            .WithLeadingTrivia(leadingTrivia.AddRange(property.GetLeadingTrivia()))
+            .WithTrailingTrivia(property.GetTrailingTrivia().AddRange(trailingTrivia));        
     }
 
-    private PropertyDeclarationSyntax? ConcertToGuidProperty(PropertyDeclarationSyntax property)
+    private PropertyDeclarationSyntax? ConvertToGuidProperty(PropertyDeclarationSyntax property)
     {
         var setter = property.AccessorList?.Accessors.FirstOrDefault(a => a.IsKind(SyntaxKind.SetAccessorDeclaration));