-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
Doc.scala
208 lines (184 loc) · 7.41 KB
/
Doc.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*
* Copyright (C) 2009-2023 Lightbend Inc. <https://www.lightbend.com>
*/
package akka
import sbt._
import sbtunidoc.BaseUnidocPlugin.autoImport.{ unidoc, unidocAllSources, unidocProjectFilter }
import sbtunidoc.JavaUnidocPlugin.autoImport.JavaUnidoc
import sbtunidoc.ScalaUnidocPlugin.autoImport.ScalaUnidoc
import sbtunidoc.GenJavadocPlugin.autoImport._
import sbt.Keys._
import sbt.File
import scala.annotation.tailrec
import com.lightbend.sbt.publishrsync.PublishRsyncPlugin.autoImport.publishRsyncArtifacts
import sbt.ScopeFilter.ProjectFilter
object Scaladoc extends AutoPlugin {
object CliOptions {
val scaladocDiagramsEnabled = CliOption("akka.scaladoc.diagrams", true)
val scaladocAutoAPI = CliOption("akka.scaladoc.autoapi", true)
}
override def trigger = allRequirements
override def requires = plugins.JvmPlugin
val validateDiagrams = settingKey[Boolean]("Validate generated scaladoc diagrams")
override lazy val projectSettings = {
inTask(doc)(
Seq(
Compile / scalacOptions ++= scaladocOptions(version.value, (ThisBuild / baseDirectory).value),
// -release caused build failures when generating javadoc:
Compile / scalacOptions --= Seq("-release", "8"),
autoAPIMappings := CliOptions.scaladocAutoAPI.get)) ++
Seq(
// Publishing scala3 docs is broken (https://github.com/akka/akka/issues/30788),
// for now we just skip it:
Compile / doc / sources := (
if (scalaVersion.value.startsWith("3.")) Seq()
else (Compile / doc / sources).value
),
Compile / validateDiagrams := true) ++
CliOptions.scaladocDiagramsEnabled.ifTrue(Compile / doc := {
val docs = (Compile / doc).value
if ((Compile / validateDiagrams).value)
scaladocVerifier(docs)
docs
})
}
def scaladocOptions(ver: String, base: File): List[String] = {
val urlString = GitHub.url(ver) + "/€{FILE_PATH_EXT}#L€{FILE_LINE}"
val opts = List(
"-implicits",
"-groups",
"-doc-source-url",
urlString,
"-sourcepath",
base.getAbsolutePath,
"-doc-title",
"Akka",
"-doc-version",
ver,
"-doc-canonical-base-url",
"https://doc.akka.io/api/akka-core/current/")
CliOptions.scaladocDiagramsEnabled.ifTrue("-diagrams").toList ::: opts
}
def scaladocVerifier(file: File): File = {
@tailrec
def findHTMLFileWithDiagram(dirs: Seq[File]): Boolean = {
if (dirs.isEmpty) false
else {
val curr = dirs.head
val (newDirs, files) = curr.listFiles.partition(_.isDirectory)
val rest = dirs.tail ++ newDirs
val hasDiagram = files.exists { f =>
val name = f.getName
if (name.endsWith(".html") && !name.startsWith("index-") &&
!name.equals("index.html") && !name.equals("package.html")) {
val source = scala.io.Source.fromFile(f)(scala.io.Codec.UTF8)
val hd = try source
.getLines()
.exists(
lines =>
lines.contains(
"<div class=\"toggleContainer block diagram-container\" id=\"inheritance-diagram-container\">") ||
lines.contains("<svg id=\"graph"))
catch {
case e: Exception =>
throw new IllegalStateException("Scaladoc verification failed for file '" + f + "'", e)
} finally source.close()
hd
} else false
}
hasDiagram || findHTMLFileWithDiagram(rest)
}
}
// if we have generated scaladoc and none of the files have a diagram then fail
if (file.exists() && !findHTMLFileWithDiagram(List(file)))
sys.error("ScalaDoc diagrams not generated!")
else
file
}
}
/**
* For projects with few (one) classes there might not be any diagrams.
*/
object ScaladocNoVerificationOfDiagrams extends AutoPlugin {
override def trigger = noTrigger
override def requires = Scaladoc
override lazy val projectSettings = Seq(Compile / Scaladoc.validateDiagrams := false)
}
/**
* Unidoc settings for root project. Adds unidoc command.
*/
object UnidocRoot extends AutoPlugin {
object CliOptions {
val genjavadocEnabled = CliOption("akka.genjavadoc.enabled", false)
}
object autoImport {
val unidocRootIgnoreProjects = settingKey[Seq[ProjectReference]]("Projects to ignore when generating unidoc")
}
import autoImport._
override def trigger = noTrigger
override def requires =
UnidocRoot.CliOptions.genjavadocEnabled
.ifTrue(sbtunidoc.ScalaUnidocPlugin && sbtunidoc.JavaUnidocPlugin && sbtunidoc.GenJavadocPlugin)
.getOrElse(sbtunidoc.ScalaUnidocPlugin)
val akkaSettings = UnidocRoot.CliOptions.genjavadocEnabled
.ifTrue(Seq(
JavaUnidoc / unidoc / javacOptions := Seq("-Xdoclint:none", "--ignore-source-errors", "--no-module-directories"),
publishRsyncArtifacts ++= {
val releaseVersion = if (isSnapshot.value) "snapshot" else version.value
(Compile / unidoc).value match {
case Seq(japi, api) =>
Seq((japi -> s"www/japi/akka-core/$releaseVersion"), (api -> s"www/api/akka-core/$releaseVersion"))
}
}))
.getOrElse(Nil)
override lazy val projectSettings = {
def unidocRootProjectFilter(ignoreProjects: Seq[ProjectReference]): ProjectFilter =
ignoreProjects.foldLeft(inAnyProject) { _ -- inProjects(_) }
inTask(unidoc)(
Seq(
ScalaUnidoc / unidocProjectFilter := unidocRootProjectFilter(unidocRootIgnoreProjects.value),
JavaUnidoc / unidocProjectFilter := unidocRootProjectFilter(unidocRootIgnoreProjects.value),
ScalaUnidoc / apiMappings := (Compile / doc / apiMappings).value) ++
UnidocRoot.CliOptions.genjavadocEnabled
.ifTrue(Seq(JavaUnidoc / unidocAllSources ~= { v =>
v.map(
_.filterNot(
s =>
// akka.stream.scaladsl.GraphDSL.Implicits.ReversePortsOps
// contains code that genjavadoc turns into (probably
// incorrect) Java code that in turn confuses the javadoc
// tool.
s.getAbsolutePath.endsWith("scaladsl/GraphDSL.java") ||
// Since adding -P:genjavadoc:strictVisibility=true,
// the javadoc tool would NullPointerException while
// determining the upper bound for some generics:
s.getAbsolutePath.endsWith("TopicImpl.java") ||
s.getAbsolutePath.endsWith("PersistencePlugin.java") ||
s.getAbsolutePath.endsWith("GraphDelegate.java") ||
s.getAbsolutePath.contains("/impl/")))
}))
.getOrElse(Nil))
}
}
/**
* Unidoc settings for every multi-project. Adds genjavadoc specific settings.
*/
object BootstrapGenjavadoc extends AutoPlugin {
override def trigger = allRequirements
override def requires =
UnidocRoot.CliOptions.genjavadocEnabled
.ifTrue {
// require 11, fail fast for 9, 10
require(JdkOptions.isJdk11orHigher, "Javadoc generation requires at least jdk 11")
sbtunidoc.GenJavadocPlugin
}
.getOrElse(plugins.JvmPlugin)
override lazy val projectSettings = UnidocRoot.CliOptions.genjavadocEnabled
.ifTrue(Seq(
unidocGenjavadocVersion := "0.19",
Compile / scalacOptions ++= Seq(
"-P:genjavadoc:fabricateParams=false",
"-P:genjavadoc:suppressSynthetic=false",
"-P:genjavadoc:strictVisibility=true")))
.getOrElse(Nil)
}