From db1380a346799cd00ef2a4a26227087cd5ae1d41 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Dach?= <dach.bartlomiej@gmail.com>
Date: Mon, 19 Dec 2022 20:16:36 +0100
Subject: [PATCH] Refactor markdown extension management

---
 .../Markdown/OsuMarkdownContainer.cs          | 48 +++------------
 .../Markdown/OsuMarkdownContainerOptions.cs   | 61 +++++++++++++++++++
 .../Comments/CommentMarkdownContainer.cs      |  5 +-
 .../Wiki/Markdown/WikiMarkdownContainer.cs    |  7 ++-
 4 files changed, 77 insertions(+), 44 deletions(-)
 create mode 100644 osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainerOptions.cs

diff --git a/osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainer.cs b/osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainer.cs
index e884b5db69..7e9581c056 100644
--- a/osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainer.cs
+++ b/osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainer.cs
@@ -4,10 +4,6 @@
 #nullable disable
 
 using Markdig;
-using Markdig.Extensions.AutoLinks;
-using Markdig.Extensions.CustomContainers;
-using Markdig.Extensions.EmphasisExtras;
-using Markdig.Extensions.Footnotes;
 using Markdig.Extensions.Tables;
 using Markdig.Extensions.Yaml;
 using Markdig.Syntax;
@@ -21,24 +17,6 @@ namespace osu.Game.Graphics.Containers.Markdown
 {
     public partial class OsuMarkdownContainer : MarkdownContainer
     {
-        /// <summary>
-        /// Allows this markdown container to parse and link footnotes.
-        /// </summary>
-        /// <seealso cref="FootnoteExtension"/>
-        protected virtual bool Footnotes => false;
-
-        /// <summary>
-        /// Allows this markdown container to make URL text clickable.
-        /// </summary>
-        /// <seealso cref="AutoLinkExtension"/>
-        protected virtual bool Autolinks => false;
-
-        /// <summary>
-        /// Allows this markdown container to parse custom containers (used for flags and infoboxes).
-        /// </summary>
-        /// <seealso cref="CustomContainerExtension"/>
-        protected virtual bool CustomContainers => false;
-
         public OsuMarkdownContainer()
         {
             LineSpacing = 21;
@@ -99,25 +77,13 @@ protected virtual OsuMarkdownListItem CreateListItem(ListItemBlock listItemBlock
             return new OsuMarkdownUnorderedListItem(level);
         }
 
-        // reference: https://github.com/ppy/osu-web/blob/05488a96b25b5a09f2d97c54c06dd2bae59d1dc8/app/Libraries/Markdown/OsuMarkdown.php#L301
-        protected override MarkdownPipeline CreateBuilder()
-        {
-            var pipeline = new MarkdownPipelineBuilder()
-                           .UseAutoIdentifiers()
-                           .UsePipeTables()
-                           .UseEmphasisExtras(EmphasisExtraOptions.Strikethrough)
-                           .UseYamlFrontMatter();
+        protected sealed override MarkdownPipeline CreateBuilder()
+            => Options.BuildPipeline();
 
-            if (Footnotes)
-                pipeline = pipeline.UseFootnotes();
-
-            if (Autolinks)
-                pipeline = pipeline.UseAutoLinks();
-
-            if (CustomContainers)
-                pipeline.UseCustomContainers();
-
-            return pipeline.Build();
-        }
+        /// <summary>
+        /// Creates a <see cref="OsuMarkdownContainerOptions"/> instance which is used to determine
+        /// which CommonMark/Markdig extensions should be enabled for this <see cref="OsuMarkdownContainer"/>.
+        /// </summary>
+        protected virtual OsuMarkdownContainerOptions Options => new OsuMarkdownContainerOptions();
     }
 }
diff --git a/osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainerOptions.cs b/osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainerOptions.cs
new file mode 100644
index 0000000000..f2fd0e06a6
--- /dev/null
+++ b/osu.Game/Graphics/Containers/Markdown/OsuMarkdownContainerOptions.cs
@@ -0,0 +1,61 @@
+// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
+// See the LICENCE file in the repository root for full licence text.
+
+using Markdig;
+using Markdig.Extensions.AutoLinks;
+using Markdig.Extensions.CustomContainers;
+using Markdig.Extensions.EmphasisExtras;
+using Markdig.Extensions.Footnotes;
+
+namespace osu.Game.Graphics.Containers.Markdown
+{
+    /// <summary>
+    /// Groups options of customising the set of available extensions to <see cref="OsuMarkdownContainer"/> instances.
+    /// </summary>
+    public class OsuMarkdownContainerOptions
+    {
+        /// <summary>
+        /// Allows the <see cref="OsuMarkdownContainer"/> to parse and link footnotes.
+        /// </summary>
+        /// <seealso cref="FootnoteExtension"/>
+        public bool Footnotes { get; init; }
+
+        /// <summary>
+        /// Allows the <see cref="OsuMarkdownContainer"/> container to make URL text clickable.
+        /// </summary>
+        /// <seealso cref="AutoLinkExtension"/>
+        public bool Autolinks { get; init; }
+
+        /// <summary>
+        /// Allows the <see cref="OsuMarkdownContainer"/> to parse custom containers (used for flags and infoboxes).
+        /// </summary>
+        /// <seealso cref="CustomContainerExtension"/>
+        public bool CustomContainers { get; init; }
+
+        /// <summary>
+        /// Returns a prepared <see cref="MarkdownPipeline"/> according to the options specified by the current <see cref="OsuMarkdownContainerOptions"/> instance.
+        /// </summary>
+        /// <remarks>
+        /// Compare: https://github.com/ppy/osu-web/blob/05488a96b25b5a09f2d97c54c06dd2bae59d1dc8/app/Libraries/Markdown/OsuMarkdown.php#L301
+        /// </remarks>
+        public MarkdownPipeline BuildPipeline()
+        {
+            var pipeline = new MarkdownPipelineBuilder()
+                           .UseAutoIdentifiers()
+                           .UsePipeTables()
+                           .UseEmphasisExtras(EmphasisExtraOptions.Strikethrough)
+                           .UseYamlFrontMatter();
+
+            if (Footnotes)
+                pipeline = pipeline.UseFootnotes();
+
+            if (Autolinks)
+                pipeline = pipeline.UseAutoLinks();
+
+            if (CustomContainers)
+                pipeline.UseCustomContainers();
+
+            return pipeline.Build();
+        }
+    }
+}
diff --git a/osu.Game/Overlays/Comments/CommentMarkdownContainer.cs b/osu.Game/Overlays/Comments/CommentMarkdownContainer.cs
index 664946fc63..9cc20caa05 100644
--- a/osu.Game/Overlays/Comments/CommentMarkdownContainer.cs
+++ b/osu.Game/Overlays/Comments/CommentMarkdownContainer.cs
@@ -11,7 +11,10 @@ namespace osu.Game.Overlays.Comments
 {
     public partial class CommentMarkdownContainer : OsuMarkdownContainer
     {
-        protected override bool Autolinks => true;
+        protected override OsuMarkdownContainerOptions Options => new OsuMarkdownContainerOptions
+        {
+            Autolinks = true
+        };
 
         protected override MarkdownHeading CreateHeading(HeadingBlock headingBlock) => new CommentMarkdownHeading(headingBlock);
 
diff --git a/osu.Game/Overlays/Wiki/Markdown/WikiMarkdownContainer.cs b/osu.Game/Overlays/Wiki/Markdown/WikiMarkdownContainer.cs
index 4ef9be90c9..bb296c5d41 100644
--- a/osu.Game/Overlays/Wiki/Markdown/WikiMarkdownContainer.cs
+++ b/osu.Game/Overlays/Wiki/Markdown/WikiMarkdownContainer.cs
@@ -16,8 +16,11 @@ namespace osu.Game.Overlays.Wiki.Markdown
 {
     public partial class WikiMarkdownContainer : OsuMarkdownContainer
     {
-        protected override bool Footnotes => true;
-        protected override bool CustomContainers => true;
+        protected override OsuMarkdownContainerOptions Options => new OsuMarkdownContainerOptions
+        {
+            Footnotes = true,
+            CustomContainers = true
+        };
 
         public string CurrentPath
         {