Merge pull request #337 from armanbilge/issue/323

Configure scaladoc3 `-source-links` and friends

Author: armanbilge

github/src/main/scala/org/typelevel/sbt/TypelevelGitHubPlugin.scala

@@ -16,11 +16,14 @@
 
 package org.typelevel.sbt
 
+import com.typesafe.sbt.SbtGit.git
+import org.typelevel.sbt.kernel.GitHelper
 import sbt._
 
 import scala.util.Try
 
 import Keys._
+import TypelevelKernelPlugin.autoImport._
 
 object TypelevelGitHubPlugin extends AutoPlugin {
 
@@ -51,6 +54,22 @@ object TypelevelGitHubPlugin extends AutoPlugin {
     homepage := homepage.value.orElse(scmInfo.value.map(_.browseUrl))
   )
 
+  override def projectSettings: Seq[Setting[_]] = Seq(
+    Compile / doc / scalacOptions ++= {
+      val tagOrHash =
+        GitHelper.getTagOrHash(git.gitCurrentTags.value, git.gitHeadCommit.value)
+      val userRepo = gitHubUserRepo.value
+
+      if (tlIsScala3.value)
+        tagOrHash.toSeq flatMap { vh =>
+          userRepo.toSeq flatMap {
+            case (user, repo) => Seq(s"-source-links:github://${user}/${repo}", "-revision", vh)
+          }
+        }
+      else Nil // TODO move from settings plugin
+    }
+  )
+
   private def gitHubScmInfo(user: String, repo: String) =
     ScmInfo(
       url(s"https://github.com/$user/$repo"),

settings/src/main/scala/org/typelevel/sbt/TypelevelSettingsPlugin.scala

@@ -177,25 +177,22 @@ object TypelevelSettingsPlugin extends AutoPlugin {
     ),
     Test / console / scalacOptions := (Compile / console / scalacOptions).value,
     Compile / doc / scalacOptions ++= {
-      if (tlIsScala3.value)
-        Seq("-sourcepath", (LocalRootProject / baseDirectory).value.getAbsolutePath)
-      else {
-
-        val tagOrHash =
-          GitHelper.getTagOrHash(git.gitCurrentTags.value, git.gitHeadCommit.value)
+      Seq("-sourcepath", (LocalRootProject / baseDirectory).value.getAbsolutePath)
+    },
+    Compile / doc / scalacOptions ++= {
+      val tagOrHash =
+        GitHelper.getTagOrHash(git.gitCurrentTags.value, git.gitHeadCommit.value)
+      val infoOpt = scmInfo.value
 
-        val infoOpt = scmInfo.value
+      if (tlIsScala3.value)
+        Seq("-project-version", version.value)
+      else // TODO move to GitHub plugin
         tagOrHash.toSeq flatMap { vh =>
           infoOpt.toSeq flatMap { info =>
             val path = s"${info.browseUrl}/blob/${vh}€{FILE_PATH}.scala"
-            Seq(
-              "-doc-source-url",
-              path,
-              "-sourcepath",
-              (LocalRootProject / baseDirectory).value.getAbsolutePath)
+            Seq("-doc-source-url", path)
           }
         }
-      }
     },
     javacOptions ++= Seq(
       "-encoding",