Fixed override of directories

Ellerbach · Nov 13, 2024 · 585ff32 · 585ff32
1 parent 8ebdbd1
commit 585ff32
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/src/DocFxTocGenerator/DocFxTocGenerator.Test/ContentInventoryActionTests.cs b/src/DocFxTocGenerator/DocFxTocGenerator.Test/ContentInventoryActionTests.cs
@@ -264,7 +264,8 @@ public async Task Run_WithOverrideOnly()
         current.Folders[0].Name.Should().Be("germany");
         current.Folders[0].DisplayName.Should().Be("Germany");
         current.Folders[1].Name.Should().Be("netherlands");
-        current.Folders[1].DisplayName.Should().Be("Netherlands");
+        // here is a folder title from .override 
+        current.Folders[1].DisplayName.Should().Be("The Netherlands");
         current.FileCount.Should().Be(1);
         current.Files[0].Name.Should().Be("README.md");
         current.Files[0].DisplayName.Should().Be($"Europe");

diff --git a/src/DocFxTocGenerator/DocFxTocGenerator.Test/Helpers/MockFileService.cs b/src/DocFxTocGenerator/DocFxTocGenerator.Test/Helpers/MockFileService.cs
@@ -101,6 +101,8 @@ public void FillDemoSet()
         AddFile(folder, "README.md", string.Empty
             .AddHeading("Europe", 1)
             .AddParagraphs(1));
+        AddFile(folder, ".override",
+@"netherlands;The Netherlands");
 
         folder = AddFolder("continents/europe/germany");
         AddFile(folder, "README.md", string.Empty

diff --git a/src/DocFxTocGenerator/DocFxTocGenerator.Test/TableOfContentsServiceTests.cs b/src/DocFxTocGenerator/DocFxTocGenerator.Test/TableOfContentsServiceTests.cs
@@ -183,7 +183,8 @@ public async Task GetTocItems_GetTocFolderReferenceFirst()
         toc.IsFolder.Should().BeTrue();
         toc.Depth.Should().Be(5);
         toc.Base.Should().Be(current);
-        toc.Name.Should().Be("Netherlands");
+        // override name
+        toc.Name.Should().Be("The Netherlands");
         toc.Sequence.Should().Be(current!.Sequence);
         toc.Href.Should().BeNull();
 
@@ -412,7 +413,7 @@ public async Task SerializeTocItem_Hierarchy()
         href: continents/europe/germany/berlin.md
       - name: München
         href: continents/europe/germany/munchen.md
-    - name: Netherlands
+    - name: The Netherlands
       items:
       - name: Noord holland
         items:
@@ -531,7 +532,7 @@ public async Task SerializeTocItem_Hierarchy_CamelCase()
         href: continents/europe/germany/berlin.md
       - name: münchen
         href: continents/europe/germany/munchen.md
-    - name: netherlands
+    - name: The Netherlands
       items:
       - name: noord holland
         items:

diff --git a/src/DocFxTocGenerator/DocFxTocGenerator/Actions/ContentInventoryAction.cs b/src/DocFxTocGenerator/DocFxTocGenerator/Actions/ContentInventoryAction.cs
@@ -121,6 +121,15 @@ public Task<ReturnCode> RunAsync()
             Parent = parent,
         };
 
+        if (parent != null)
+        {
+            // see if we have an override for the folder name
+            if (parent.OverrideList.TryGetValue(folder.Name, out string? name))
+            {
+                folder.DisplayName = name;
+            }
+        }
+
         // read config files
         if (_useOrder)
         {