Hide irrelevant code snippet fragments in scaladoc

pikinier20 · Apr 28, 2021 · 57722c8 · 57722c8
1 parent 9b4ac4b
commit 57722c8
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 32 deletions.
diff --git a/scaladoc-js/resources/scaladoc-searchbar.css b/scaladoc-js/resources/scaladoc-searchbar.css
@@ -100,5 +100,10 @@
 
 .pull-right {
     float: right;
-    margin-left: auto
+    margin-left: auto;
+}
+
+.hide-snippet-comments-button {
+    position: absolute;
+    left: 90%;
 }
diff --git a/scaladoc-js/src/searchbar/code-snippets/CodeSnippets.scala b/scaladoc-js/src/searchbar/code-snippets/CodeSnippets.scala
@@ -4,14 +4,34 @@ import org.scalajs.dom._
 import org.scalajs.dom.ext._
 
 class CodeSnippets:
-  val replacePatternsAndResults = Seq(
-    // ("", ""), // hide block directives
-    ("""(\/\/.*)(\n|\$)""", ""), // single line comment
-    // ("", ""), // multi line comment
+  val replacePatternsAndResults: Seq[(String, String)] = Seq(
+    """(\/\/{{\n)((.|\n)*?)(\/\/}}\n)""" -> """<span class="hideable">$2</span>""", // wrap content of block directives
+    """(\/\/.*?)(\n|\$)""" -> """<span class="hideable">$1</span>$2""", // wrap single line comment
+    """(\/\*)((.|\n)*?)(\*\/)""" -> """<span class="hideable">$0</span>""", // wrap multi line comment
   )
 
   document.querySelectorAll("code").foreach {
     case e: html.Element => e.innerHTML = replacePatternsAndResults.foldLeft(e.innerHTML) {
-      case (acc, (pattern, result)) => acc.replaceAll(pattern, """<span class="hideable;">$1</span>""")
+      case (acc, (pattern, result)) =>
+        acc.replaceAll(pattern, result)
     }
   }
+
+  def toggleHide(e: html.Element | html.Document) = e.querySelectorAll("code span.hideable").foreach {
+    case e: html.Element if e.style.getPropertyValue("display").isEmpty => e.style.setProperty("display", "none")
+    case e: html.Element => e.style.removeProperty("display")
+  }
+
+  toggleHide(document)
+
+  document.querySelectorAll("pre").foreach {
+    case e: html.Element =>
+      val a = document.createElement("a")
+      a.textContent = "Show"
+      a.addEventListener("click", { (_: MouseEvent) =>
+        a.textContent = if a.textContent == "Show" then "Hide" else "Show"
+        toggleHide(e)
+      })
+      a.classList.add("hide-snippet-comments-button")
+      e.insertBefore(a, e.firstChild)
+  }
diff --git a/scaladoc-testcases/src/tests/methodsAndConstructors.scala b/scaladoc-testcases/src/tests/methodsAndConstructors.scala
@@ -1,27 +1,5 @@
 package tests.methodsAndConstructors
 
-
-/**
- * This is my codeblock
- * 
- * ```
- * //{{
- * import xd
- * import xd2
- * //}}
- *
- *
- * val x = 1 // This is my valid comment
- *
- * /*
- * Is this my comment?
- * */
- *
- * val y = 2
- * ```
- *
- * The end of my codeblock
- */
 class A
 class B extends A
 class C

diff --git a/scaladoc-testcases/src/tests/snippetComments.scala b/scaladoc-testcases/src/tests/snippetComments.scala
@@ -0,0 +1,31 @@
+package tests.snippetComments
+
+
+/**
+ * This is my codeblock
+ * 
+ * ```
+ * //{{
+ * import xd
+ * import xd2
+ * //}}
+ *
+ *
+ * val x = 1 // This is my valid comment
+ *
+ * /*
+ *  multi line comment
+ *  */
+ *
+ * val y = 2 // comment in the same line
+ * // comment in new line
+ * val z = 3
+ * 
+ * //{{
+ * val hideMe = 7
+ * //}}
+ * ```
+ *
+ * The end of my codeblock
+ */
+class A
diff --git a/scaladoc/src/dotty/tools/scaladoc/tasty/comments/MemberLookup.scala b/scaladoc/src/dotty/tools/scaladoc/tasty/comments/MemberLookup.scala
@@ -150,10 +150,7 @@ trait MemberLookup {
     }
 
     if owner.isPackageDef then
-      findMatch(hackMembersOf(owner).flatMap {
-        s =>
-          (if s.name.endsWith("package$") then hackMembersOf(s) else Iterator.empty) ++ Iterator(s)
-      })
+      findMatch(hackMembersOf(owner))
     else
       owner.tree match {
         case tree: TypeDef =>