Adds support for JSONC in plugin files. Closes #1194 (#1195)

Author: waldekmastykarz

dev-proxy-abstractions/BaseLoader.cs

@@ -21,7 +21,7 @@ public abstract class BaseLoader(ILogger logger, bool validateSchemas) : IDispos
 
     private async Task<bool> ValidateFileContents(string fileContents)
     {
-        using var document = JsonDocument.Parse(fileContents);
+        using var document = JsonDocument.Parse(fileContents, ProxyUtils.JsonDocumentOptions);
         var root = document.RootElement;
 
         if (!root.TryGetProperty("$schema", out var schemaUrl))

dev-proxy-abstractions/BaseProxyPlugin.cs

@@ -74,7 +74,7 @@ public virtual async Task RegisterAsync()
             var configSectionName = ConfigSection.Key;
             var configFile = await File.ReadAllTextAsync(Context.Configuration.ConfigFile);
 
-            using var document = JsonDocument.Parse(configFile);
+            using var document = JsonDocument.Parse(configFile, ProxyUtils.JsonDocumentOptions);
             var root = document.RootElement;
 
             if (!root.TryGetProperty(configSectionName, out var configSection))

dev-proxy-abstractions/ProxyUtils.cs

@@ -355,13 +355,20 @@ public static void MergeHeaders(IList<MockResponseHeader> allHeaders, IList<Mock
     }
 
     public static JsonSerializerOptions JsonSerializerOptions => jsonSerializerOptions;
+    
+    public static JsonDocumentOptions JsonDocumentOptions { get; } = new()
+    {
+        AllowTrailingCommas = true,
+        CommentHandling = JsonCommentHandling.Skip
+    };
 
     public static bool MatchesUrlToWatch(ISet<UrlToWatch> watchedUrls, string url, bool evaluateWildcards = false)
     {
         if (evaluateWildcards && url.Contains('*'))
         {
             // url contains a wildcard, so convert it to regex and compare
-            var match = watchedUrls.FirstOrDefault(r => {
+            var match = watchedUrls.FirstOrDefault(r =>
+            {
                 var pattern = RegexToPattern(r.Url);
                 var result = UrlRegexComparer.CompareRegexPatterns(pattern, url);
                 return result != UrlRegexComparisonResult.PatternsMutuallyExclusive;

dev-proxy-plugins/Inspection/LanguageModelPricingLoader.cs

@@ -21,7 +21,7 @@ protected override void LoadData(string fileContents)
         {
             // we need to deserialize manually because standard deserialization
             // doesn't support nested dictionaries
-            using JsonDocument document = JsonDocument.Parse(fileContents);
+            using JsonDocument document = JsonDocument.Parse(fileContents, ProxyUtils.JsonDocumentOptions);
 
             if (document.RootElement.TryGetProperty("prices", out JsonElement pricesElement))
             {

dev-proxy-plugins/RequestLogs/OpenApiSpecGeneratorPlugin.cs

@@ -747,7 +747,7 @@ private static OpenApiSchema GetSchemaFromJsonString(string jsonString)
     {
         try
         {
-            using var doc = JsonDocument.Parse(jsonString);
+            using var doc = JsonDocument.Parse(jsonString, ProxyUtils.JsonDocumentOptions);
             JsonElement root = doc.RootElement;
             var schema = GetSchemaFromJsonElement(root);
             return schema;

dev-proxy-plugins/RequestLogs/TypeSpecGeneratorPlugin.cs

@@ -709,7 +709,7 @@ private async Task<Model[]> GetModelsFromStringAsync(string? str, string name, b
 
         try
         {
-            using var doc = JsonDocument.Parse(str);
+            using var doc = JsonDocument.Parse(str, ProxyUtils.JsonDocumentOptions);
             JsonElement root = doc.RootElement;
             await AddModelFromJsonElementAsync(root, name, isError, models);
         }