added overrides for AppendUrl & AppendLink IWriter extension methods (#…

…104 #107)
Doraku · Jun 20, 2022 · 3149b89 · 3149b89
1 parent 6d26601
commit 3149b89
Show file tree

Hide file tree

Showing 31 changed files with 108 additions and 43 deletions.
diff --git a/source/DefaultDocumentation.Api/DefaultDocumentation.json b/source/DefaultDocumentation.Api/DefaultDocumentation.json
@@ -9,8 +9,13 @@
 	],
 	"LinksOutputFilePath": "..\\..\\documentation\\DefaultDocumentation.Api.txt",
 	"LinksBaseUrl": "https://github.com/Doraku/DefaultDocumentation/blob/master/documentation/api/",
+	"Sections": [
+		"FolderFileNameOverrides",
+		"Default"
+	],
 	"NamespaceDocItem": {
 		"Sections": [
+			"FolderFileNameOverrides",
 			"Title",
 			"summary",
 			"TableOfContents"

diff --git a/source/DefaultDocumentation.Console/Properties/launchSettings.json b/source/DefaultDocumentation.Console/Properties/launchSettings.json
@@ -2,7 +2,7 @@
   "profiles": {
     "DefaultDocumentation.Console": {
       "commandName": "Project",
-      "commandLineArgs": "--ConfigurationFilePath D:\\Projects\\DefaultDocumentation\\source\\DefaultDocumentation.Api\\DefaultDocumentation.json",
+      "commandLineArgs": "--ConfigurationFilePath D:\\Projects\\DefaultDocumentation\\source\\DefaultDocumentation.Api\\DefaultDocumentation.json\r\n--Plugins \"D:\\Projects\\DefaultDocumentation\\source\\Sample\\DefaultDocumentation.PluginExample\\bin\\Debug\\netstandard2.0\\DefaultDocumentation.PluginExample.dll\"\r\n--FileNameFactory Folder",
       "workingDirectory": "D:\\Projects\\DefaultDocumentation"
     }
   }

diff --git a/source/DefaultDocumentation.Markdown/Elements/CodeElement.cs b/source/DefaultDocumentation.Markdown/Elements/CodeElement.cs
@@ -2,7 +2,6 @@
 using System.IO;
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Markdown.Internal;
 
 namespace DefaultDocumentation.Markdown.Elements

diff --git a/source/DefaultDocumentation.Markdown/Elements/ListElement.cs b/source/DefaultDocumentation.Markdown/Elements/ListElement.cs
@@ -2,7 +2,6 @@
 using System.Linq;
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Elements
 {

diff --git a/source/DefaultDocumentation.Markdown/Elements/NoteElement.cs b/source/DefaultDocumentation.Markdown/Elements/NoteElement.cs
@@ -1,7 +1,6 @@
 using System.Globalization;
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Elements
 {

diff --git a/source/DefaultDocumentation.Markdown/Elements/ParaElement.cs b/source/DefaultDocumentation.Markdown/Elements/ParaElement.cs
@@ -1,6 +1,5 @@
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Elements
 {

diff --git a/source/DefaultDocumentation.Markdown/Elements/ParamRefElement.cs b/source/DefaultDocumentation.Markdown/Elements/ParamRefElement.cs
@@ -1,6 +1,5 @@
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 using DefaultDocumentation.Models.Parameters;
 

diff --git a/source/DefaultDocumentation.Markdown/Elements/SeeElement.cs b/source/DefaultDocumentation.Markdown/Elements/SeeElement.cs
@@ -1,7 +1,6 @@
 using System;
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Elements
 {

diff --git a/source/DefaultDocumentation.Markdown/Elements/TypeParamRefElement.cs b/source/DefaultDocumentation.Markdown/Elements/TypeParamRefElement.cs
@@ -1,6 +1,5 @@
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 using DefaultDocumentation.Models.Parameters;
 

diff --git a/source/DefaultDocumentation.Markdown/Extensions/IWriterExtension.cs b/source/DefaultDocumentation.Markdown/Extensions/IWriterExtension.cs
@@ -10,7 +10,7 @@
 using ICSharpCode.Decompiler.TypeSystem;
 using ICSharpCode.Decompiler.TypeSystem.Implementation;
 
-namespace DefaultDocumentation.Markdown.Extensions
+namespace DefaultDocumentation.Api
 {
     /// <summary>
     /// Provides extension methods on the <see cref="IWriter"/> type.
@@ -27,6 +27,8 @@ public static class IWriterExtension
         private const string CurrentItemKey = "Markdown.CurrentItem";
         private const string DisplayAsSingleLineKey = "Markdown.DisplayAsSingleLine";
         private const string IgnoreLineBreakLineKey = "Markdown.IgnoreLineBreak";
+        private const string AppendLinkOverride = "Markdown.AppendLink(DocItem,string)";
+        private const string AppendUrlOverride = "Markdown.AppendUrl(string,string,string)";
 
         /// <summary>
         /// Gets the current item that is being processed by this <see cref="IWriter"/>.
@@ -98,6 +100,32 @@ public static IWriter SetIgnoreLineBreakLine(this IWriter writer, bool? value)
             return writer;
         }
 
+        /// <summary>
+        /// Sets an override of the default action for <see cref="AppendLink(IWriter, DocItem, string?)"/>.
+        /// </summary>
+        /// <param name="writer">The <see cref="IWriter"/> for which to set this override.</param>
+        /// <param name="value">The action to use.</param>
+        /// <returns>The given <see cref="IWriter"/>.</returns>
+        public static IWriter SetAppendLinkOverride(this IWriter writer, Action<IWriter, DocItem, string?>? value)
+        {
+            writer[AppendLinkOverride] = value;
+
+            return writer;
+        }
+
+        /// <summary>
+        /// Sets an override of the default action for <see cref="AppendUrl(IWriter, string, string?, string?)"/>.
+        /// </summary>
+        /// <param name="writer">The <see cref="IWriter"/> for which to set this override.</param>
+        /// <param name="value">The action to use.</param>
+        /// <returns>The given <see cref="IWriter"/>.</returns>
+        public static IWriter SetAppendUrlOverride(this IWriter writer, Action<IWriter, string, string?, string?>? value)
+        {
+            writer[AppendUrlOverride] = value;
+
+            return writer;
+        }
+
         /// <summary>
         /// Append an url in the markdown format.
         /// </summary>
@@ -108,22 +136,27 @@ public static IWriter SetIgnoreLineBreakLine(this IWriter writer, bool? value)
         /// <returns>The given <see cref="IWriter"/>.</returns>
         public static IWriter AppendUrl(this IWriter writer, string url, string? displayedName = null, string? tooltip = null)
         {
-            if (string.IsNullOrEmpty(url))
-            {
-                writer.Append((displayedName ?? "").Prettify());
-            }
-            else
+            static void Default(IWriter writer, string url, string? displayedName, string? tooltip)
             {
-                writer
-                    .Append("[")
-                    .Append((displayedName ?? url).Prettify())
-                    .Append("](")
-                    .Append(url)
-                    .Append(" '")
-                    .Append(tooltip ?? url)
-                    .Append("')");
+                if (string.IsNullOrEmpty(url))
+                {
+                    writer.Append((displayedName ?? "").Prettify());
+                }
+                else
+                {
+                    writer
+                        .Append("[")
+                        .Append((displayedName ?? url).Prettify())
+                        .Append("](")
+                        .Append(url)
+                        .Append(" '")
+                        .Append(tooltip ?? url)
+                        .Append("')");
+                }
             }
 
+            ((writer[AppendUrlOverride] as Action<IWriter, string, string?, string?>) ?? Default)(writer, url, displayedName, tooltip);
+
             return writer;
         }
 
@@ -134,7 +167,14 @@ public static IWriter AppendUrl(this IWriter writer, string url, string? display
         /// <param name="item">The <see cref="DocItem"/> to link to.</param>
         /// <param name="displayedName">The displayed name of the link.</param>
         /// <returns>The given <see cref="IWriter"/>.</returns>
-        public static IWriter AppendLink(this IWriter writer, DocItem item, string? displayedName = null) => writer.AppendUrl(writer.Context.GetUrl(item), displayedName ?? item.Name, item.FullName);
+        public static IWriter AppendLink(this IWriter writer, DocItem item, string? displayedName = null)
+        {
+            static void Default(IWriter writer, DocItem item, string? displayedName) => writer.AppendUrl(writer.Context.GetUrl(item), displayedName ?? item.Name, item.FullName);
+
+            ((writer[AppendLinkOverride] as Action<IWriter, DocItem, string?>) ?? Default)(writer, item, displayedName);
+
+            return writer;
+        }
 
         /// <summary>
         /// Append an link to an id using <see cref="IGeneralContext.GetUrl(string)"/> to resolve the url in the markdown format.

diff --git a/source/DefaultDocumentation.Markdown/Sections/ChildrenSection.cs b/source/DefaultDocumentation.Markdown/Sections/ChildrenSection.cs
@@ -3,7 +3,6 @@
 using System.Linq;
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 using DefaultDocumentation.Models.Members;
 using DefaultDocumentation.Models.Parameters;

diff --git a/source/DefaultDocumentation.Markdown/Sections/DefinitionSection.cs b/source/DefaultDocumentation.Markdown/Sections/DefinitionSection.cs
@@ -1,7 +1,6 @@
 using System;
 using System.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 using DefaultDocumentation.Models.Members;
 using DefaultDocumentation.Models.Parameters;

diff --git a/source/DefaultDocumentation.Markdown/Sections/DerivedSection.cs b/source/DefaultDocumentation.Markdown/Sections/DerivedSection.cs
@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models.Types;
 
 namespace DefaultDocumentation.Markdown.Sections

diff --git a/source/DefaultDocumentation.Markdown/Sections/EventTypeSection.cs b/source/DefaultDocumentation.Markdown/Sections/EventTypeSection.cs
@@ -1,5 +1,4 @@
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models.Members;
 
 namespace DefaultDocumentation.Markdown.Sections

diff --git a/source/DefaultDocumentation.Markdown/Sections/ExampleSection.cs b/source/DefaultDocumentation.Markdown/Sections/ExampleSection.cs
@@ -1,6 +1,5 @@
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Sections
 {

diff --git a/source/DefaultDocumentation.Markdown/Sections/ExceptionSection.cs b/source/DefaultDocumentation.Markdown/Sections/ExceptionSection.cs
@@ -1,7 +1,6 @@
 using System.Linq;
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Sections
 {

diff --git a/source/DefaultDocumentation.Markdown/Sections/FieldValueSection.cs b/source/DefaultDocumentation.Markdown/Sections/FieldValueSection.cs
@@ -1,5 +1,4 @@
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models.Members;
 
 namespace DefaultDocumentation.Markdown.Sections

diff --git a/source/DefaultDocumentation.Markdown/Sections/FooterSection.cs b/source/DefaultDocumentation.Markdown/Sections/FooterSection.cs
@@ -1,5 +1,4 @@
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Sections
 {

diff --git a/source/DefaultDocumentation.Markdown/Sections/HeaderSection.cs b/source/DefaultDocumentation.Markdown/Sections/HeaderSection.cs
@@ -1,6 +1,5 @@
 using System.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 
 namespace DefaultDocumentation.Markdown.Sections

diff --git a/source/DefaultDocumentation.Markdown/Sections/ImplementSection.cs b/source/DefaultDocumentation.Markdown/Sections/ImplementSection.cs
@@ -1,7 +1,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models.Members;
 using DefaultDocumentation.Models.Types;
 using ICSharpCode.Decompiler.Documentation;

diff --git a/source/DefaultDocumentation.Markdown/Sections/InheritanceSection.cs b/source/DefaultDocumentation.Markdown/Sections/InheritanceSection.cs
@@ -1,6 +1,5 @@
 using System.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models.Types;
 using ICSharpCode.Decompiler.TypeSystem;
 

diff --git a/source/DefaultDocumentation.Markdown/Sections/RemarksSection.cs b/source/DefaultDocumentation.Markdown/Sections/RemarksSection.cs
@@ -1,6 +1,5 @@
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Sections
 {

diff --git a/source/DefaultDocumentation.Markdown/Sections/ReturnsSection.cs b/source/DefaultDocumentation.Markdown/Sections/ReturnsSection.cs
@@ -1,5 +1,4 @@
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models.Members;
 using DefaultDocumentation.Models.Types;
 using ICSharpCode.Decompiler.TypeSystem;

diff --git a/source/DefaultDocumentation.Markdown/Sections/SeeAlsoSection.cs b/source/DefaultDocumentation.Markdown/Sections/SeeAlsoSection.cs
@@ -2,7 +2,6 @@
 using System.Linq;
 using System.Xml.Linq;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 
 namespace DefaultDocumentation.Markdown.Sections
 {

diff --git a/source/DefaultDocumentation.Markdown/Sections/SummarySection.cs b/source/DefaultDocumentation.Markdown/Sections/SummarySection.cs
@@ -1,5 +1,4 @@
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 using DefaultDocumentation.Models.Parameters;
 

diff --git a/source/DefaultDocumentation.Markdown/Sections/TableOfContentsSection.cs b/source/DefaultDocumentation.Markdown/Sections/TableOfContentsSection.cs
@@ -1,7 +1,6 @@
 using System;
 using System.Collections.Generic;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 using DefaultDocumentation.Models.Members;
 using DefaultDocumentation.Models.Parameters;

diff --git a/source/DefaultDocumentation.Markdown/Sections/TitleSection.cs b/source/DefaultDocumentation.Markdown/Sections/TitleSection.cs
@@ -1,6 +1,5 @@
 using System;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 using DefaultDocumentation.Models.Members;
 using DefaultDocumentation.Models.Parameters;

diff --git a/source/DefaultDocumentation.Markdown/Sections/ValueSection.cs b/source/DefaultDocumentation.Markdown/Sections/ValueSection.cs
@@ -1,5 +1,4 @@
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models.Members;
 
 namespace DefaultDocumentation.Markdown.Sections

diff --git a/source/DefaultDocumentation.Markdown/Writers/MarkdownWriter.cs b/source/DefaultDocumentation.Markdown/Writers/MarkdownWriter.cs
@@ -1,6 +1,5 @@
 using System;
 using DefaultDocumentation.Api;
-using DefaultDocumentation.Markdown.Extensions;
 using DefaultDocumentation.Models;
 
 namespace DefaultDocumentation.Markdown.Writers

diff --git a/source/Sample/DefaultDocumentation.PluginExample/DefaultDocumentation.PluginExample.csproj b/source/Sample/DefaultDocumentation.PluginExample/DefaultDocumentation.PluginExample.csproj
@@ -11,6 +11,10 @@
 	</ItemGroup>
 
 	<ItemGroup>
-		<PackageReference Include="DefaultDocumentation.Api" Version="0.8.1" />
+		<!--<PackageReference Include="DefaultDocumentation.Api" Version="0.8.1" />-->
+	</ItemGroup>
+
+	<ItemGroup>
+	  <ProjectReference Include="..\..\DefaultDocumentation.Markdown\DefaultDocumentation.Markdown.csproj" />
 	</ItemGroup>
 </Project>
diff --git a/source/Sample/DefaultDocumentation.PluginExample/FolderFileNameOverrides.cs b/source/Sample/DefaultDocumentation.PluginExample/FolderFileNameOverrides.cs
@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using DefaultDocumentation.Api;
+using DefaultDocumentation.Models;
+
+namespace DefaultDocumentation.PluginExample
+{
+    public sealed class FolderFileNameOverrides : ISection
+    {
+        private void AppendLink(IWriter writer, DocItem item, string displayedName)
+        {
+            if (item is ExternDocItem)
+            {
+                writer.AppendUrl(writer.Context.GetUrl(item), displayedName ?? item.Name, item.FullName);
+            }
+            else
+            {
+                string[] url = writer.Context.GetUrl(item).Split('/');
+                string[] pageUrl = writer.Context.GetUrl(writer.DocItem).Split('/');
+
+                List<string> relativeUrl = new();
+
+                int pathCount;
+                for (pathCount = 0; pathCount < pageUrl.Length && pathCount < url.Length && pageUrl[pathCount] == url[pathCount]; pathCount++)
+                { }
+
+                relativeUrl.AddRange(Enumerable.Repeat("..", Math.Max(0, pageUrl.Length - pathCount - 1)));
+                relativeUrl.AddRange(url.Skip(pathCount));
+
+                writer.AppendUrl(string.Join("/", relativeUrl), displayedName ?? item.Name, item.FullName);
+            }
+        }
+
+        public string Name => nameof(FolderFileNameOverrides);
+
+        public void Write(IWriter writer)
+        {
+            writer.SetAppendLinkOverride(AppendLink);
+        }
+    }
+}