opt: 优化插值字符串的处理

Author: stratosblue

Directory.Build.props

@@ -10,7 +10,7 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <Version>1.0.1</Version>
+    <Version>1.1.0</Version>
 
     <Description>Code fix provider for `C#` code log diagnosis `CA1727`, `CA2253`, `CA2254`. 针对 `C#` 代码日志诊断 `CA1727`, `CA2253`, `CA2254` 的代码修复提供程序</Description>
 

src/Cuture.CodeAnalysis.LoggingCodeFixes/LoggingInvocationFixer.cs

@@ -184,6 +184,8 @@ private static InterpolatedStringTextSyntax CreateHolderInterpolatedStringTextSy
 
     private static IEnumerable<InterpolatedStringContentSyntaxDescriptor> EnumerateProcessedInterpolatedStringContentSyntaxes(IEnumerable<InterpolatedStringContentSyntax> contentSyntaxes)
     {
+        var argumentCount = 0;
+
         foreach (var contentSyntax in contentSyntaxes)
         {
             if (contentSyntax is not InterpolationSyntax interpolationSyntax)
@@ -239,6 +241,37 @@ private static IEnumerable<InterpolatedStringContentSyntaxDescriptor> EnumerateP
                     }
                     break;
 
+                case ConditionalAccessExpressionSyntax conditionalAccessExpressionSyntax:   //eg: xxx?.Xxx()
+                    {
+                        //TODO 递归展开处理多级 ToString()
+                        if (conditionalAccessExpressionSyntax.WhenNotNull is not InvocationExpressionSyntax invocationExpressionSyntax
+                            || invocationExpressionSyntax.Expression is not MemberBindingExpressionSyntax memberBindingExpressionSyntax)
+                        {
+                            yield return (CreateHolderInterpolatedStringTextSyntax(interpolationSyntax.ToString()), CreateArgumentSyntax(interpolationSyntax.Expression));
+                            break;
+                        }
+                        if (memberBindingExpressionSyntax.Name.Identifier.ValueText == "ToString")  //ToString
+                        {
+                            if (invocationExpressionSyntax.ArgumentList.Arguments.Count == 0)   //无参ToString()
+                            {
+                                yield return (CreateHolderInterpolatedStringTextSyntax(conditionalAccessExpressionSyntax.Expression.ToString()), CreateArgumentSyntax(conditionalAccessExpressionSyntax.Expression), conditionalAccessExpressionSyntax);
+                            }
+                            else
+                            {
+                                yield return (CreateHolderInterpolatedStringTextSyntax(conditionalAccessExpressionSyntax.Expression.ToString()), CreateArgumentSyntax(conditionalAccessExpressionSyntax), conditionalAccessExpressionSyntax);
+                            }
+                        }
+                        else
+                        {
+                            yield return (CreateHolderInterpolatedStringTextSyntax(interpolationSyntax.ToString()), CreateArgumentSyntax(interpolationSyntax.Expression));
+                        }
+                    }
+                    break;
+
+                case InterpolatedStringExpressionSyntax interpolatedStringExpressionSyntax: //插值字符串 $"xxxx: {1}"
+                    yield return (CreateHolderInterpolatedStringTextSyntax($"Value_{argumentCount++}"), CreateArgumentSyntax(interpolationSyntax.Expression));
+                    break;
+
                 default:
                     yield return (CreateHolderInterpolatedStringTextSyntax(interpolationSyntax.ToString()), CreateArgumentSyntax(interpolationSyntax.Expression));
                     break;

test/Cuture.CodeAnalysis.LoggingCodeFixes.Test/StructuredLoggingFixTest.cs

@@ -135,6 +135,65 @@ public async Task Should_Success()
         await VerifyCS.VerifyCodeFixAsync(test, expected, fixtest);
     }
 
+    [TestMethod]
+    public async Task Should_Success_For_Escape_Interpolation_String()
+    {
+        LoggingCodeTemplate test =
+            """
+            var type = _logger.GetType();
+            _logger.LogInformation({|#0:$"Value: \"{$"Score: {50}"}\" - \"{nameof(type)}\" - \"{$"Today: {DateTime.Now}"}\""|});
+            """;
+
+        LoggingCodeTemplate fixtest =
+            """
+            var type = _logger.GetType();
+            _logger.LogInformation($"Value: \"{{Value_0}}\" - \"{nameof(type)}\" - \"{{Value_1}}\"", $"Score: {50}", $"Today: {DateTime.Now}");
+            """;
+
+        var expected = GetExpected();
+        await VerifyCS.VerifyCodeFixAsync(test, expected, fixtest);
+    }
+
+    [TestMethod]
+    public async Task Should_Success_For_Escape_String()
+    {
+        LoggingCodeTemplate test =
+            """
+            var type = _logger.GetType();
+            _logger.LogInformation({|#0:$"Value: \"{type.Name}\""|});
+            """;
+
+        LoggingCodeTemplate fixtest =
+            """
+            var type = _logger.GetType();
+            _logger.LogInformation("Value: \"{Name}\"", type.Name);
+            """;
+
+        var expected = GetExpected();
+        await VerifyCS.VerifyCodeFixAsync(test, expected, fixtest);
+    }
+
+    [TestMethod]
+    public async Task Should_Success_For_NullCheck_ToString()
+    {
+        LoggingCodeTemplate test =
+            """
+            var type = _logger.GetType();
+            float? value = 1f;
+            _logger.LogInformation({|#0:$"Value: \"{type?.ToString()}\" - {value?.ToString("D2")} - {type?.Name?.ToString()}"|});
+            """;
+
+        LoggingCodeTemplate fixtest =
+            """
+            var type = _logger.GetType();
+            float? value = 1f;
+            _logger.LogInformation("Value: \"{Type}\" - {Value} - {Name}", type, value?.ToString("D2"), type?.Name?.ToString());
+            """;
+
+        var expected = GetExpected();
+        await VerifyCS.VerifyCodeFixAsync(test, expected, fixtest);
+    }
+
     [TestMethod]
     public async Task Should_Success_With_Log_Exception()
     {