Skip to content

Commit 010f8de

Browse files
Merge pull request #13242 from pikinier20/scaladoc/inkuire-warnings
Scaladoc: Stop attaching inkuire scripts to html
2 parents 3842ae1 + 3338473 commit 010f8de

File tree

3 files changed

+17
-10
lines changed

3 files changed

+17
-10
lines changed

scaladoc/src/dotty/tools/scaladoc/Inkuire.scala

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ object Inkuire {
1515
}
1616

1717
def generateInkuireConfig(externalMappings: Seq[String]): String = {
18-
val paths = ("../inkuire-db.json" +: externalMappings.map(_ + "../inkuire-db.json")).map(jsonString)
18+
val paths =
19+
List("../inkuire-db.json").map(jsonString)
20+
// TODO: #13243
21+
// ++ externalMappings.map(_ + "../inkuire-db.json")).map(jsonString)
1922
jsonObject(("inkuirePaths", jsonList(paths))).toString
2023
}
2124

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx
154154

155155
val siteResourcesPaths = allPages.toSet.flatMap(specificResources) ++ staticResources
156156

157-
val resources = siteResourcesPaths.toSeq.map(pathToResource) ++ allResources(allPages)
157+
val resources = siteResourcesPaths.toSeq.map(pathToResource) ++ allResources(allPages) ++ onlyRenderedResources
158158
resources.flatMap(renderResource)
159159

160160
def render(): Unit =

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

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,16 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
5252
case "js" => script(`type` := "text/javascript", src := resolveLink(dri, res), if (deferJs) Seq(defer := "true") else Nil)
5353
case _ => raw("")
5454

55+
val onlyRenderedResources: Seq[Resource] =
56+
List(
57+
("https://github.com/VirtusLab/Inkuire/releases/download/1.0.0-M2/inkuire.js", "scripts/inkuire.js"),
58+
).map { case (url, path) =>
59+
Resource.URLToCopy(url, path)
60+
} ++
61+
List(
62+
"scripts/inkuire-worker.js"
63+
).map(dottyRes)
64+
5565
val earlyMemberResources: Seq[Resource] =
5666
List(
5767
"scripts/theme.js"
@@ -78,8 +88,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
7888
"scripts/components/Input.js",
7989
"scripts/components/FilterGroup.js",
8090
"scripts/components/Filter.js",
81-
"scripts/searchbar.js",
82-
"scripts/inkuire-worker.js"
91+
"scripts/searchbar.js"
8392
).map(dottyRes)
8493

8594
val urls = List(
@@ -90,13 +99,8 @@ trait Resources(using ctx: DocContext) extends Locations, Writer:
9099
"https://cdnjs.cloudflare.com/ajax/libs/dagre-d3/0.6.1/dagre-d3.min.js",
91100
).map(Resource.URL.apply)
92101

93-
val urlToPathMappings = List(
94-
("https://github.com/VirtusLab/Inkuire/releases/download/1.0.0-M2/inkuire.js", "scripts/inkuire.js"),
95-
).map { case (url, path) =>
96-
Resource.URLToCopy(url, path)
97-
}
98102

99-
fromResources ++ urls ++ urlToPathMappings ++ projectLogo ++ Seq(scaladocVersionFile, dynamicJsData)
103+
fromResources ++ urls ++ projectLogo ++ Seq(scaladocVersionFile, dynamicJsData)
100104

101105
val searchDataPath = "scripts/searchData.js"
102106
val memberResourcesPaths = Seq(searchDataPath) ++ memberResources.map(_.path)

0 commit comments

Comments
 (0)