Escape strings when creating descriptions (#39)

* Escape strings when creating descriptions

Descriptions are just splatted into the generated code wholesale, not fixing up any characters that are invalid C#, such as newlines, backslashes, and the like. These are now appropriately escaped for use in a C# string without errors.

* Remove unnecessary using

Author: 333fred

src/libs/CSharpToJsonSchema.Generators/Sources.Method.Tools.cs

@@ -45,7 +45,7 @@ private static void AddAllTools()
             tool = new global::CSharpToJsonSchema.Tool
             {{
                 Name = ""{method.Name}"",
-                Description = ""{method.Description}"",
+                Description = ""{GetDescriptionStringAsValidCSharp(method.Description)}"",
                 Strict = {(method.IsStrict ? "true" : "false")},
                 Parameters = global::CSharpToJsonSchema.SchemaBuilder.ConvertToSchema(global::{@interface.Namespace}.{extensionsClassName}JsonSerializerContext.Default.{method.Name}Args,{"\""}{GetDictionaryString(method)}{"\""}),
             }};
@@ -108,4 +108,4 @@ private static string GetDelegateInputsTypes(MethodData first, bool addReturnTyp
             f.Add(first.ReturnType.ToDisplayString());
         return string.Join(", ", f);
     }
-}
+}

src/libs/CSharpToJsonSchema.Generators/Sources.Tools.cs

@@ -3,6 +3,7 @@
 using CSharpToJsonSchema.Generators.Models;
 using H.Generators;
 using H.Generators.Extensions;
+using Microsoft.CodeAnalysis.CSharp;
 
 namespace CSharpToJsonSchema.Generators;
 
@@ -42,7 +43,7 @@ public static string GenerateOpenApiSchema(OpenApiSchema parameter, int depth =
                                     .Select(static x => $"\"{x.Name}\""))} }},
 {indent}                    }}";
         }
-        
+
         if (parameter.EnumValues.Count != 0)
         {
             return $@"new {name}
@@ -52,7 +53,7 @@ public static string GenerateOpenApiSchema(OpenApiSchema parameter, int depth =
 {indent}                        Enum = new string[] {{ {string.Join(", ", parameter.EnumValues.Select(static x => $"\"{x}\""))} }},
 {indent}                    }}";
         }
-        
+
         return $@"new {name}
 {indent}                    {{
 {indent}                        Type = ""{parameter.SchemaType}"",{(parameter.Format != null ? $@"
@@ -80,7 +81,7 @@ public static partial class {extensionsClassName}
                 new global::CSharpToJsonSchema.Tool
                 {{
                     Name = ""{method.Name}"",
-                    Description = ""{method.Description}"",
+                    Description = ""{GetDescriptionStringAsValidCSharp(method.Description)}"",
                     Strict = {(method.IsStrict ? "true" : "false")},
                     Parameters = global::CSharpToJsonSchema.SchemaBuilder.ConvertToSchema(global::{@interface.Namespace}.{extensionsClassName}JsonSerializerContext.Default.{method.Name}Args,{"\""}{GetDictionaryString(method)}{"\""}),
                 }},
@@ -91,19 +92,24 @@ public static partial class {extensionsClassName}
 }}";
     }
 
-   
+
 
     private static string GetDictionaryString(MethodData data)
     {
         StringBuilder sb = new StringBuilder();
 
         var methodDescriptions = new Dictionary<string, string>();
-        methodDescriptions.Add("MainFunction_Desc", data.Description);
-        sb.Append("{");
+        methodDescriptions.Add("MainFunction_Desc", GetDescriptionStringAsValidCSharp(data.Description));
+        sb.Append('{');
         var lst = methodDescriptions.Select(s => $"\"{s.Key.ToCamelCase()}\":\"{s.Value}\"");
         sb.Append(string.Join(", ", lst));
-        sb.Append("}");
-        
-        return sb.ToString().Replace("\"","\\\"");
+        sb.Append('}');
+
+        return sb.ToString().Replace("\"", "\\\"");
+    }
+
+    public static string GetDescriptionStringAsValidCSharp(string description)
+    {
+        return SymbolDisplay.FormatLiteral(description, quote: false);
     }
 }

src/tests/CSharpToJsonSchema.IntegrationTests/VariousTypesTools.cs

@@ -30,6 +30,15 @@ public bool GetCurrentWeather3(
 
     [Description("Gets the value")]
     public Task<int> GetValueAsync(CancellationToken cancellationToken = default);
+
+    [Description("Gets the value\nWith multiple lines")]
+    public Task<int> GetValueAsync2(CancellationToken cancellationToken = default);
+
+    [Description("""
+        Gets the value
+        With multiple lines
+        """)]
+    public Task<int> GetValueAsync3(CancellationToken cancellationToken = default);
 }
 
 public class VariousTypesService : IVariousTypesTools
@@ -65,4 +74,14 @@ public Task<int> GetValueAsync(CancellationToken cancellationToken = default)
     {
         throw new NotImplementedException();
     }
-}
+
+    public Task<int> GetValueAsync2(CancellationToken cancellationToken = default)
+    {
+        throw new NotImplementedException();
+    }
+
+    public Task<int> GetValueAsync3(CancellationToken cancellationToken = default)
+    {
+        throw new NotImplementedException();
+    }
+}