Display packages in nested way in sidebar

Author: Florian3k

scaladoc/src/dotty/tools/scaladoc/ScalaModuleProvider.scala

@@ -10,8 +10,31 @@ object ScalaModuleProvider:
   def mkModule()(using ctx: DocContext): Module =
     val (result, rootDoc) = ScaladocTastyInspector().result()
     val (rootPck, rest) = result.partition(_.name == "API")
-    val packageMembers = (rest ++ rootPck.flatMap(_.members))
+    val (emptyPackages, nonemptyPackages) = (rest ++ rootPck.flatMap(_.members))
       .filter(p => p.members.nonEmpty || p.docs.nonEmpty).sortBy(_.name)
+      .partition(_.name == "<empty>")
+
+    val groupedMembers =
+      def groupMembers(ms: List[Member], n: Int = 0): List[Member] =
+        ms.groupBy(_.name.split('.')(n)).values.map {
+          case m :: ms if m.name.count(_ == '.') == n =>
+            m.withMembers(groupMembers(ms, n + 1) ++ m.members)
+          case ms =>
+            groupMembers(ms, n + 1) match
+              case m :: Nil => m
+              case ms =>
+                val name = ms.head.name.split('.').take(n + 1).mkString(".")
+                Member(
+                  name = name,
+                  fullName = name,
+                  dri = DRI(location = name),
+                  kind = Kind.Package,
+                  members = ms,
+                )
+        }.toList.sortBy(_.name)
+      groupMembers(nonemptyPackages)
+
+    val packageMembers = groupedMembers ++ emptyPackages.flatMap(_.members)
 
     def flattenMember(m: Member): Seq[(DRI, Member)] = (m.dri -> m) +: m.members.flatMap(flattenMember)
 

scaladoc/src/dotty/tools/scaladoc/renderers/HtmlRenderer.scala

@@ -105,10 +105,16 @@ class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: Do
       case _ => Nil
     }
 
-    def renderNested(nav: Page, nestLevel: Int): (Boolean, AppliedTag) =
+    def renderNested(nav: Page, nestLevel: Int, prefix: String = ""): (Boolean, AppliedTag) =
       val isApi = nav.content.isInstanceOf[Member]
       val isSelected = nav.link.dri == pageLink.dri
       val isTopElement = nestLevel == 0
+      val name = nav.content match {
+        case m: Member if m.kind == Kind.Package =>
+          m.name.stripPrefix(prefix).stripPrefix(".")
+        case _ => nav.link.name
+      }
+      val newPrefix = if prefix == "" then name else s"$prefix.$name"
 
       def linkHtml(expanded: Boolean = false, withArrow: Boolean = false) =
         val attrs: Seq[String] = Seq(
@@ -124,14 +130,14 @@ class HtmlRenderer(rootPackage: Member, members: Map[DRI, Member])(using ctx: Do
         Seq(
           span(cls := s"nh " + attrs.mkString(" "))(
             if withArrow then Seq(button(cls := s"ar icon-button ${if isSelected || expanded then "expanded" else ""}")) else Nil,
-            a(href := pathToPage(pageLink.dri, nav.link.dri))(icon, span(nav.link.name))
+            a(href := pathToPage(pageLink.dri, nav.link.dri))(icon, span(name))
           )
         )
 
       nav.children.filterNot(_.hidden) match
         case Nil => isSelected -> div(cls := s"ni n$nestLevel ${if isSelected then "expanded" else ""}")(linkHtml())
         case children =>
-          val nested = children.map(renderNested(_, nestLevel + 1))
+          val nested = children.map(renderNested(_, nestLevel + 1, newPrefix))
           val expanded = nested.exists(_._1)
           val attr =
             if expanded || isSelected then Seq(cls := s"ni n$nestLevel expanded") else Seq(cls := s"ni n$nestLevel")

scaladoc/test/dotty/tools/scaladoc/site/NavigationTest.scala

@@ -30,6 +30,9 @@ class NavigationTest extends BaseHtmlTest:
 
     val apiNav = Seq(
       NavMenuTestEntry("tests.site", "site.html", Seq(
+        NavMenuTestEntry("some.other", "site/some/other.html", Seq(
+          NavMenuTestEntry("SomeOtherPackage", "site/some/other/SomeOtherPackage.html", Nil),
+        )),
         NavMenuTestEntry("BrokenLink", "site/BrokenLink.html", Nil),
         NavMenuTestEntry("BrokenLinkWiki", "site/BrokenLinkWiki.html", Nil),
         NavMenuTestEntry("OtherPackageLink", "site/OtherPackageLink.html", Nil),
@@ -38,9 +41,6 @@ class NavigationTest extends BaseHtmlTest:
         NavMenuTestEntry("SamePackageLinkWiki", "site/SamePackageLinkWiki.html", Nil),
         NavMenuTestEntry("SomeClass", "site/SomeClass.html", Nil)
       )),
-      NavMenuTestEntry("tests.site.some.other", "site/some/other.html", Seq(
-        NavMenuTestEntry("SomeOtherPackage", "site/some/other/SomeOtherPackage.html", Nil),
-      ))
     )
 
     testNavMenu("docs/Adoc.html", docsNav)