Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix default scaladoc config, so that id doesn't break all scaladoc links #3041

Merged
merged 2 commits into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion build.sc
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,8 @@ object `scala-cli-bsp` extends JavaModule with ScalaCliPublishModule {
object integration extends CliIntegration {
object test extends IntegrationScalaTests {
def ivyDeps = super.ivyDeps() ++ Seq(
Deps.jgit
Deps.jgit,
Deps.jsoup
)
}
object docker extends CliIntegrationDocker {
Expand Down
4 changes: 2 additions & 2 deletions modules/cli/src/main/scala/scala/cli/commands/doc/Doc.scala
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ object Doc extends ScalaCommand[DocOptions] {
"-snippet-compiler:compile",
"-Ygenerate-inkuire",
"-external-mappings:" +
".*scala.*::scaladoc3::https://scala-lang.org/api/3.x/," +
".*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/",
".*/scala/.*::scaladoc3::https://scala-lang.org/api/3.x/," +
".*/java/.*::javadoc::https://docs.oracle.com/javase/8/docs/api/",
"-author",
"-groups"
)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
package scala.cli.integration

import com.eed3si9n.expecty.Expecty.expect
import org.jsoup._

import scala.jdk.CollectionConverters._

abstract class DocTestDefinitions extends ScalaCliSuite with TestScalaVersionArgs {
_: TestScalaVersion =>
Expand Down Expand Up @@ -55,8 +58,16 @@ abstract class DocTestDefinitions extends ScalaCliSuite with TestScalaVersionArg
"lib/Messages$.html"
)
val entries =
os.walk(root / dest).map(_.relativeTo(expectedDestDocPath)).map(_.toString()).toList
os.walk(root / dest).filter(!os.isDir(_)).map { path =>
path.relativeTo(expectedDestDocPath).toString() -> os.read(path)
}.toMap
expect(expectedEntries.forall(e => entries.contains(e)))

val documentableNameElement =
Jsoup.parse(entries("index.html")).select(".documentableName").asScala
documentableNameElement.filter(_.text().contains("lib")).foreach { element =>
expect(!element.attr("href").startsWith("http"))
}
}
}
}
2 changes: 2 additions & 0 deletions project/deps.sc
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ object Deps {
def coursierM1Cli = coursierDefault
def jsoniterScala = "2.23.2"
def jsoniterScalaJava8 = "2.13.5.2"
def jsoup = "1.18.1"
def scalaMeta = "4.9.8"
def scalaNative04 = "0.4.17"
def scalaNative05 = "0.5.4"
Expand Down Expand Up @@ -156,6 +157,7 @@ object Deps {
ivy"com.github.plokhotnyuk.jsoniter-scala::jsoniter-scala-macros:${Versions.jsoniterScalaJava8}"
def jsoniterMacrosJava8 =
ivy"com.github.plokhotnyuk.jsoniter-scala::jsoniter-scala-macros:${Versions.jsoniterScalaJava8}"
def jsoup = ivy"org.jsoup:jsoup:${Versions.jsoup}"
def libsodiumjni = ivy"org.virtuslab.scala-cli:libsodiumjni:0.0.4"
def macroParadise = ivy"org.scalamacros:::paradise:2.1.1"
def metaconfigTypesafe =
Expand Down
Loading