chore: Remove options from MarkdigExtensionSetting (#9830)

yufeih · web-flow · commit c0cc51e21f05 · 2024-04-01T15:35:44.000+08:00
remove options, update emoji to use enum
diff --git a/src/Docfx.MarkdigEngine.Extensions/MarkdigExtensionSetting.cs b/src/Docfx.MarkdigEngine.Extensions/MarkdigExtensionSetting.cs
@@ -29,7 +29,7 @@ public class MarkdigExtensionSetting
     /// <summary>
     /// Initializes a new instance of the <see cref="MarkdigExtensionSetting"/> class.
     /// </summary>
-    public MarkdigExtensionSetting(string name, JsonObject? options = null)
+    public MarkdigExtensionSetting(string name, JsonNode? options = null)
     {
         Name = name;
         if (options != null)
@@ -58,49 +58,8 @@ public MarkdigExtensionSetting(string name, JsonObject? options = null)
     /// </summary>
     public T GetOptions<T>(T fallbackValue)
     {
-        if (Options == null)
-        {
-            return fallbackValue;
-        }
-
-        var jsonObject = JsonSerializer.SerializeToNode(Options)?.AsObject();
-
-        if (jsonObject != null
-         && jsonObject.TryGetPropertyValue("options", out var optionsNode)
-         && optionsNode != null)
-        {
-            return optionsNode.Deserialize<T>(DefaultSerializerOptions)!;
-        }
-        else
-        {
-            return fallbackValue;
-        }
-    }
-
-    /// <summary>
-    /// Gets markdig extension options as specified class object.
-    /// </summary>
-    public T GetOptionsValue<T>(string key, T fallbackValue)
-    {
-        if (Options == null)
-        {
-            return fallbackValue;
-        }
-
-        var jsonNode = JsonSerializer.SerializeToNode(Options)?.AsObject();
-
-        // Try to read options property that have specified key.
-        if (jsonNode != null
-         && jsonNode.TryGetPropertyValue("options", out var optionsNode)
-         && optionsNode != null
-         && optionsNode.AsObject().TryGetPropertyValue(key, out var valueNode))
-        {
-            return valueNode!.GetValue<T>()!;
-        }
-        else
-        {
-            return fallbackValue;
-        }
+        return Options is null ? fallbackValue
+            : JsonSerializer.Deserialize<T>(JsonSerializer.Serialize(Options), DefaultSerializerOptions) ?? fallbackValue;
     }
 
     /// <summary>
diff --git a/src/Docfx.MarkdigEngine.Extensions/MarkdownExtensions.cs b/src/Docfx.MarkdigEngine.Extensions/MarkdownExtensions.cs
@@ -2,7 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Diagnostics;
-using System.Text.Json;
 using Markdig;
 using Markdig.Extensions.AutoIdentifiers;
 using Markdig.Extensions.AutoLinks;
@@ -18,6 +17,8 @@ namespace Docfx.MarkdigEngine.Extensions;
 
 public static class MarkdownExtensions
 {
+    enum EmojiMappingOption { Default, DefaultAndSmileys }
+
     public static MarkdownPipelineBuilder UseDocfxExtensions(
         this MarkdownPipelineBuilder pipeline, MarkdownContext context,
         Dictionary<string, string> notes = null, PlantUmlOptions plantUml = null)
@@ -121,10 +122,11 @@ private static bool TryAddOrReplaceMarkdigExtension(
             // EmojiExtension (Docfx default: enableSmileys: false)
             case "emojis":
                 {
-                    var enableSmileys = extension.GetOptions(fallbackValue: true);
-                    EmojiMapping emojiMapping = enableSmileys
-                        ? EmojiMapping.DefaultEmojisAndSmileysMapping
-                        : EmojiMapping.DefaultEmojisOnlyMapping;
+                    var emojiMapping = extension.GetOptions(fallbackValue: EmojiMappingOption.DefaultAndSmileys) switch
+                    {
+                        EmojiMappingOption.DefaultAndSmileys => EmojiMapping.DefaultEmojisAndSmileysMapping,
+                        _ => EmojiMapping.DefaultEmojisOnlyMapping,
+                    };
                     pipeline.Extensions.ReplaceOrAdd<EmojiExtension>(new EmojiExtension(emojiMapping));
                     return true;
                 }
diff --git a/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/AutoIdentifierTest.cs b/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/AutoIdentifierTest.cs
@@ -1,7 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Text.Json.Nodes;
 using Markdig.Extensions.AutoIdentifiers;
 using Xunit;
 
@@ -23,10 +22,7 @@ public void AutoIdentifierTest_DocfxDefault()
 
         TestUtility.VerifyMarkup(content, expected);
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-           new("AutoIdentifiers", new JsonObject
-           {
-               ["options"] = "GitHub",
-           })
+           new("AutoIdentifiers", "GitHub")
         ]);
     }
 
@@ -40,17 +36,11 @@ public void AutoIdentifierTest_MarkdigDefault()
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: ["AutoIdentifiers"]);
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-           new("AutoIdentifiers", new JsonObject
-           {
-               ["options"] = "Default",
-           })
+           new("AutoIdentifiers", "Default")
         ]);
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-           new("AutoIdentifiers", new JsonObject
-           {
-               ["options"] = "AutoLink, AllowOnlyAscii", // Same as Default option.
-           })
+           new("AutoIdentifiers", "AutoLink, AllowOnlyAscii")
         ]);
     }
 
@@ -61,10 +51,7 @@ public void AutoIdentifierTest_None()
         var expected = @"<h1 id=""this-is-a-heading_with.and"">This - is a &amp;@! heading _ with . and ! -</h1>";
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-           new("AutoIdentifiers", new JsonObject
-           {
-               ["options"] = "None",
-           })
+           new("AutoIdentifiers", "None")
         ]);
     }
 }
diff --git a/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/AutoLinkTest.cs b/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/AutoLinkTest.cs
@@ -2,7 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Text.Json;
-using System.Text.Json.Nodes;
 using Docfx.MarkdigEngine.Extensions;
 using Markdig.Extensions.AutoLinks;
 using Xunit;
@@ -41,10 +40,7 @@ public void AutoLinkTest_Custom()
         var expected = @"<p>Sample URL (<a href=""http://www.google.com"" target=""_blank"">http://www.google.com</a>)</p>";
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-           new("AutoLinks", new JsonObject
-           {
-               ["options"] = JsonSerializer.SerializeToNode(options, MarkdigExtensionSettingConverter.DefaultSerializerOptions),
-           })
+           new("AutoLinks", JsonSerializer.SerializeToNode(options, MarkdigExtensionSettingConverter.DefaultSerializerOptions))
         ]);
     }
 }
diff --git a/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/EmojiTest.cs b/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/EmojiTest.cs
@@ -1,7 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Text.Json.Nodes;
 using Markdig.Extensions.Emoji;
 using Xunit;
 
@@ -41,10 +40,7 @@ public void EmojiTest_Smileys_Enabled()
         var expected = @"<p>😃</p>";
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-            new("Emojis", new JsonObject
-            {
-                ["options"] = true
-            }),
+            new("Emojis", "DefaultAndSmileys"),
         ]);
     }
 
@@ -55,10 +51,7 @@ public void EmojiTest_Smileys_Disabled()
         var expected = @"<p>:)</p>";
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-            new("Emojis", new JsonObject
-            {
-                ["options"] = false,
-            }),
+            new("Emojis", "Default"),
         ]);
     }
 }
diff --git a/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/EmphasisExtraTest.cs b/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/EmphasisExtraTest.cs
@@ -1,7 +1,6 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Text.Json.Nodes;
 using Markdig.Extensions.EmphasisExtras;
 using Xunit;
 
@@ -63,10 +62,7 @@ public void EmphasisExtraTest_SuperscriptAndSubscript()
         {
             var expected = @"<p>H<sub>2</sub>O is a liquid. 2<sup>10</sup> is 1024</p>";
             TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-              new("EmphasisExtras", new JsonObject
-              {
-                  ["options"] = "Superscript, Subscript",
-              })]);
+              new("EmphasisExtras", "Superscript, Subscript")]);
         }
     }
 
@@ -84,10 +80,7 @@ public void EmphasisExtraTest_Inserted()
         {
             var expected = @"<p><ins>Inserted text</ins></p>";
             TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-              new("EmphasisExtras", new JsonObject
-              {
-                  ["options"] = "Inserted",
-              })]);
+              new("EmphasisExtras", "Inserted")]);
         }
     }
 
@@ -105,10 +98,7 @@ public void EmphasisExtraTest_Marked()
         {
             var expected = @"<p><mark>Marked text</mark></p>";
             TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-              new("EmphasisExtras", new JsonObject
-              {
-                  ["options"] = "Marked",
-              })]);
+              new("EmphasisExtras", "Marked")]);
         }
     }
 }
diff --git a/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/MediaLinksTest.cs b/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/MediaLinksTest.cs
@@ -2,7 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Text.Json;
-using System.Text.Json.Nodes;
 using Docfx.MarkdigEngine.Extensions;
 using Markdig.Extensions.MediaLinks;
 using Xunit;
@@ -44,10 +43,7 @@ public void MediaLinksTest_Custom()
         var expected = $"""<p><video class="{options.Class}" width="{options.Width}" height="{options.Height}"><source type="video/mp4" src="https://example.com/video.mp4"></source></video></p>""";
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-            new("MediaLinks", new JsonObject
-            {
-                ["options"] = JsonSerializer.SerializeToNode(options, MarkdigExtensionSettingConverter.DefaultSerializerOptions),
-            })
+            new("MediaLinks", JsonSerializer.SerializeToNode(options, MarkdigExtensionSettingConverter.DefaultSerializerOptions))
         ]);
     }
 }
diff --git a/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/PipeTableTest.cs b/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/PipeTableTest.cs
@@ -2,7 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Text.Json;
-using System.Text.Json.Nodes;
 using Docfx.MarkdigEngine.Extensions;
 using Markdig.Extensions.Tables;
 using Xunit;
@@ -86,10 +85,7 @@ public void PipeTableTest_Custom()
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: ["gfm-pipetables"]);
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-            new ("PipeTables", new JsonObject
-            {
-                ["options"] = JsonSerializer.SerializeToNode(options,  MarkdigExtensionSettingConverter.DefaultSerializerOptions),
-            })
+            new ("PipeTables", JsonSerializer.SerializeToNode(options,  MarkdigExtensionSettingConverter.DefaultSerializerOptions))
         ]);
     }
 }
diff --git a/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/SmartyPantsTest.cs b/test/Docfx.MarkdigEngine.Extensions.Tests/MarkdigBuiltinExtensionTests/SmartyPantsTest.cs
@@ -2,8 +2,6 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System.Text.Json;
-using System.Text.Json.Nodes;
-using System.Text.Json.Serialization;
 using Docfx.MarkdigEngine.Extensions;
 using Markdig.Extensions.SmartyPants;
 using Xunit;
@@ -52,10 +50,7 @@ public void SmartyPantsTest_Custom()
         string expected = "<p>This is a <<text with>> a another text'</p>";
 
         TestUtility.VerifyMarkup(content, expected, optionalExtensions: [
-            new("SmartyPants", new JsonObject
-            {
-                ["options"] = JsonSerializer.SerializeToNode(options, MarkdigExtensionSettingConverter.DefaultSerializerOptions),
-            })
+            new("SmartyPants", JsonSerializer.SerializeToNode(options, MarkdigExtensionSettingConverter.DefaultSerializerOptions))
         ]);
     }
 }
diff --git a/test/docfx.Tests/Api.verified.cs b/test/docfx.Tests/Api.verified.cs
@@ -3572,11 +3572,10 @@ public void Setup(Markdig.MarkdownPipeline pipeline, Markdig.Renderers.IMarkdown
     [System.Diagnostics.DebuggerDisplay("Name = {Name}")]
     public class MarkdigExtensionSetting
     {
-        public MarkdigExtensionSetting(string name, System.Text.Json.Nodes.JsonObject? options = null) { }
+        public MarkdigExtensionSetting(string name, System.Text.Json.Nodes.JsonNode? options = null) { }
         public string Name { get; init; }
         public System.Text.Json.JsonElement? Options { get; init; }
         public T GetOptions<T>(T fallbackValue) { }
-        public T GetOptionsValue<T>(string key, T fallbackValue) { }
         public static Docfx.MarkdigEngine.Extensions.MarkdigExtensionSetting op_Implicit(string name) { }
     }
     public class MarkdownContext

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`// Licensed to the .NET Foundation under one or more agreements.`
`2`	`2`	`// The .NET Foundation licenses this file to you under the MIT license.`
`3`	`3`
`4`		`-using System.Text.Json.Nodes;`
`5`	`4`	`using Markdig.Extensions.EmphasisExtras;`
`6`	`5`	`using Xunit;`
`7`	`6`
`@@ -63,10 +62,7 @@ public void EmphasisExtraTest_SuperscriptAndSubscript()`
`63`	`62`	`{`
`64`	`63`	`var expected = @"<p>H<sub>2</sub>O is a liquid. 2<sup>10</sup> is 1024</p>";`
`65`	`64`	`TestUtility.VerifyMarkup(content, expected, optionalExtensions: [`
`66`		`- new("EmphasisExtras", new JsonObject`
`67`		`- {`
`68`		`- ["options"] = "Superscript, Subscript",`
`69`		`- })]);`
	`65`	`+ new("EmphasisExtras", "Superscript, Subscript")]);`
`70`	`66`	`}`
`71`	`67`	`}`
`72`	`68`
`@@ -84,10 +80,7 @@ public void EmphasisExtraTest_Inserted()`
`84`	`80`	`{`
`85`	`81`	`var expected = @"<p><ins>Inserted text</ins></p>";`
`86`	`82`	`TestUtility.VerifyMarkup(content, expected, optionalExtensions: [`
`87`		`- new("EmphasisExtras", new JsonObject`
`88`		`- {`
`89`		`- ["options"] = "Inserted",`
`90`		`- })]);`
	`83`	`+ new("EmphasisExtras", "Inserted")]);`
`91`	`84`	`}`
`92`	`85`	`}`
`93`	`86`
`@@ -105,10 +98,7 @@ public void EmphasisExtraTest_Marked()`
`105`	`98`	`{`
`106`	`99`	`var expected = @"<p><mark>Marked text</mark></p>";`
`107`	`100`	`TestUtility.VerifyMarkup(content, expected, optionalExtensions: [`
`108`		`- new("EmphasisExtras", new JsonObject`
`109`		`- {`
`110`		`- ["options"] = "Marked",`
`111`		`- })]);`
	`101`	`+ new("EmphasisExtras", "Marked")]);`
`112`	`102`	`}`
`113`	`103`	`}`
`114`	`104`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3572,11 +3572,10 @@ public void Setup(Markdig.MarkdownPipeline pipeline, Markdig.Renderers.IMarkdown`
`3572`	`3572`	`[System.Diagnostics.DebuggerDisplay("Name = {Name}")]`
`3573`	`3573`	`public class MarkdigExtensionSetting`
`3574`	`3574`	`{`
`3575`		`- public MarkdigExtensionSetting(string name, System.Text.Json.Nodes.JsonObject? options = null) { }`
	`3575`	`+ public MarkdigExtensionSetting(string name, System.Text.Json.Nodes.JsonNode? options = null) { }`
`3576`	`3576`	`public string Name { get; init; }`
`3577`	`3577`	`public System.Text.Json.JsonElement? Options { get; init; }`
`3578`	`3578`	`public T GetOptions<T>(T fallbackValue) { }`
`3579`		`- public T GetOptionsValue<T>(string key, T fallbackValue) { }`
`3580`	`3579`	`public static Docfx.MarkdigEngine.Extensions.MarkdigExtensionSetting op_Implicit(string name) { }`
`3581`	`3580`	`}`
`3582`	`3581`	`public class MarkdownContext`