Skip to content

Commit ff188f3

Browse files
scalafmt-core 2.6.1 (was 2.4.2) (#158)
Co-authored-by: Arnout Engelen <[email protected]>
1 parent 339d6fb commit ff188f3

File tree

5 files changed

+49
-51
lines changed

5 files changed

+49
-51
lines changed

.scalafmt.conf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version = 2.4.2
1+
version = 2.6.1
22

33
maxColumn = 120
44
docstrings = JavaDoc

project/Dependencies.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import sbt._
22

33
object Library {
4-
val classgraph = "io.github.classgraph" % "classgraph" % "4.8.87"
5-
val sbtParadox = "com.lightbend.paradox" % "sbt-paradox" % "0.8.0"
6-
val scalatest = "org.scalatest" %% "scalatest" % "3.2.0"
7-
val paradoxTestkit = "com.lightbend.paradox" %% "testkit" % "0.8.0"
4+
val classgraph = "io.github.classgraph" % "classgraph" % "4.8.87"
5+
val sbtParadox = "com.lightbend.paradox" % "sbt-paradox" % "0.8.0"
6+
val scalatest = "org.scalatest" %% "scalatest" % "3.2.0"
7+
val paradoxTestkit = "com.lightbend.paradox" %% "testkit" % "0.8.0"
88
}

src/main/scala/com/lightbend/paradox/apidoc/ApidocDirective.scala

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,14 @@ class ApidocDirective(scanner: ScanResult, allClassesAndObjects: IndexedSeq[Stri
4444
}
4545

4646
private def errorForStaticForwardersOnly(query: Query, node: DirectiveNode, classname: String) =
47-
if (!query.linkToObject && containsOnlyStaticForwarders(classname) &&
48-
allClassesAndObjects.contains(classname + "$")) {
47+
if (
48+
!query.linkToObject && containsOnlyStaticForwarders(classname) &&
49+
allClassesAndObjects.contains(classname + "$")
50+
)
4951
ctx.error(
5052
s"Class `$classname` matches @apidoc[$query], but is empty, did you intend to link to the object?",
5153
node
5254
)
53-
}
5455

5556
private case class Query(label: Option[String], pattern: String, generics: String, linkToObject: Boolean) {
5657
def scalaLabel(matched: String): String =
@@ -112,9 +113,9 @@ class ApidocDirective(scanner: ScanResult, allClassesAndObjects: IndexedSeq[Stri
112113
}
113114
if (query.pattern.contains('.')) {
114115
val classNameWithDollarForInnerClasses = query.pattern.replaceAll("(\\b[A-Z].+)\\.", "$1\\$")
115-
if (allClasses.contains(classNameWithDollarForInnerClasses)) {
116+
if (allClasses.contains(classNameWithDollarForInnerClasses))
116117
renderMatches(query, Seq(query.pattern), node, visitor, printer)
117-
} else {
118+
else
118119
allClasses.filter(_.endsWith(classNameWithDollarForInnerClasses)) match {
119120
case Seq() =>
120121
// No matches? then try globbing
@@ -128,7 +129,6 @@ class ApidocDirective(scanner: ScanResult, allClassesAndObjects: IndexedSeq[Stri
128129
case results =>
129130
renderMatches(query, results, node, visitor, printer)
130131
}
131-
}
132132
} else { // only a classname
133133
val className = '.' + query.pattern
134134
val classMatches = allClasses.filter(_.endsWith(className))
@@ -172,9 +172,8 @@ class ApidocDirective(scanner: ScanResult, allClassesAndObjects: IndexedSeq[Stri
172172
): DirectiveNode = {
173173
val attributes = new org.pegdown.ast.DirectiveAttributes.AttributeMap()
174174
val theUrl = fqcn + anchor
175-
try {
176-
ParadoxUrl(theUrl)
177-
} catch {
175+
try ParadoxUrl(theUrl)
176+
catch {
178177
case ParadoxUrl.Error(reason) =>
179178
val suggestedUrl = theUrl
180179
.replace("<", "%3C")
@@ -231,9 +230,9 @@ class ApidocDirective(scanner: ScanResult, allClassesAndObjects: IndexedSeq[Stri
231230
errorForStaticForwardersOnly(query, node, query.scalaFqcn(pkg))
232231
scaladocNode("scala", query.scalaLabel(pkg), query.scalaFqcn(pkg) + scalaClassSuffix, sAnchor, node)
233232
.accept(visitor)
234-
if (hasJavadocUrl(pkg)) {
233+
if (hasJavadocUrl(pkg))
235234
javadocNode(query.javaLabel(pkg), query.javaFqcn(pkg), jAnchor, node).accept(visitor)
236-
} else
235+
else
237236
scaladocNode("java", query.javaLabel(pkg), query.scalaFqcn(pkg) + scalaClassSuffix, jAnchor, node)
238237
.accept(visitor)
239238
case 2 if matches.forall(_.contains("adsl")) =>
@@ -243,13 +242,12 @@ class ApidocDirective(scanner: ScanResult, allClassesAndObjects: IndexedSeq[Stri
243242
scaladocNode("scala", query.scalaLabel(pkg), query.scalaFqcn(pkg) + scalaClassSuffix, sAnchor, node)
244243
.accept(visitor)
245244
}
246-
if (!pkg.contains("scaladsl")) {
245+
if (!pkg.contains("scaladsl"))
247246
if (hasJavadocUrl(pkg))
248247
javadocNode(query.javaLabel(pkg), query.javaFqcn(pkg), jAnchor, node).accept(visitor)
249248
else
250249
scaladocNode("java", query.javaLabel(pkg), query.scalaFqcn(pkg) + scalaClassSuffix, jAnchor, node)
251250
.accept(visitor)
252-
}
253251
}
254252
case n =>
255253
ctx.error(

src/main/scala/com/lightbend/paradox/apidoc/ApidocPlugin.scala

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -34,28 +34,29 @@ object ApidocPlugin extends AutoPlugin {
3434

3535
override def projectSettings: Seq[Setting[_]] = apidocParadoxZeroSettings
3636

37-
def apidocParadoxZeroSettings: Seq[Setting[_]] = Seq(
38-
apidocRootPackage := "scala",
39-
apidocClasses := Def.taskDyn {
40-
val classpathProjects = apidocProjects.?.value
41-
.map(inProjects)
42-
.getOrElse {
43-
inAggregates(LocalRootProject, includeRoot = true)
37+
def apidocParadoxZeroSettings: Seq[Setting[_]] =
38+
Seq(
39+
apidocRootPackage := "scala",
40+
apidocClasses := Def.taskDyn {
41+
val classpathProjects = apidocProjects.?.value
42+
.map(inProjects)
43+
.getOrElse {
44+
inAggregates(LocalRootProject, includeRoot = true)
45+
}
46+
val filter = ScopeFilter(classpathProjects, inConfigurations(Compile))
47+
fullClasspath.all(filter).map(_.flatMap(_.files).map(_.toURI.toURL))
48+
}.value,
49+
paradoxDirectives ++= Def.taskDyn {
50+
val classLoader = new java.net.URLClassLoader(apidocClasses.value.toArray, this.getClass.getClassLoader)
51+
val scanner = new ClassGraph()
52+
.whitelistPackages(apidocRootPackage.value)
53+
.addClassLoader(classLoader)
54+
.enableMethodInfo()
55+
.scan()
56+
val allClasses = scanner.getAllClasses.getNames.asScala.toVector
57+
Def.task {
58+
Seq((ctx: Writer.Context) => new ApidocDirective(scanner, allClasses, ctx))
4459
}
45-
val filter = ScopeFilter(classpathProjects, inConfigurations(Compile))
46-
fullClasspath.all(filter).map(_.flatMap(_.files).map(_.toURI.toURL))
47-
}.value,
48-
paradoxDirectives ++= Def.taskDyn {
49-
val classLoader = new java.net.URLClassLoader(apidocClasses.value.toArray, this.getClass.getClassLoader)
50-
val scanner = new ClassGraph()
51-
.whitelistPackages(apidocRootPackage.value)
52-
.addClassLoader(classLoader)
53-
.enableMethodInfo()
54-
.scan()
55-
val allClasses = scanner.getAllClasses.getNames.asScala.toVector
56-
Def.task {
57-
Seq((ctx: Writer.Context) => new ApidocDirective(scanner, allClasses, ctx))
58-
}
59-
}.value
60-
)
60+
}.value
61+
)
6162
}

src/test/scala/com/lightbend/paradox/apidoc/ApidocDirectiveSpec.scala

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ class ApidocDirectiveSpec extends MarkdownTestkit with Matchers with AnyFlatSpec
6767
)
6868

6969
override val markdownWriter = new Writer(
70-
linkRenderer = Writer.defaultLinks,
70+
linkRenderer = Writer.defaultLinks,
7171
verbatimSerializers = Writer.defaultVerbatims,
7272
serializerPlugins = Writer.defaultPlugins(
7373
Writer.defaultDirectives ++ Seq((ctx: Writer.Context) =>
@@ -311,7 +311,9 @@ class ApidocDirectiveSpec extends MarkdownTestkit with Matchers with AnyFlatSpec
311311
}
312312

313313
it should "use anchors" in {
314-
markdown("""The @apidoc[TheClass[File].method[String]](Flow) { scala="#method():Unit" java="#method()" } thingie""") shouldEqual
314+
markdown(
315+
"""The @apidoc[TheClass[File].method[String]](Flow) { scala="#method():Unit" java="#method()" } thingie"""
316+
) shouldEqual
315317
html(
316318
"""<p>The <span class="group-java">
317319
|<a href="https://doc.akka.io/japi/akka/2.5/?akka/stream/javadsl/Flow.html#method()" title="akka.stream.javadsl.Flow"><code>TheClass&lt;File&gt;.method&lt;String&gt;</code></a></span><span class="group-scala">
@@ -333,16 +335,13 @@ class ApidocDirectiveSpec extends MarkdownTestkit with Matchers with AnyFlatSpec
333335
}
334336

335337
it should "catch exception on malformed URIs and make suggestions" in {
336-
try {
337-
338-
markdown(
339-
"""The @apidoc[label](Flow) { scala="#method[ T <: Q[T] ](Flow => Unit):Unit" java="#method()" } thingie"""
340-
)
341-
} catch {
342-
case t @ ParadoxException(error) => {
338+
try markdown(
339+
"""The @apidoc[label](Flow) { scala="#method[ T <: Q[T] ](Flow => Unit):Unit" java="#method()" } thingie"""
340+
)
341+
catch {
342+
case t @ ParadoxException(error) =>
343343
error.msg should include("template resulted in an invalid URL")
344344
error.msg should include("method%5B T %3C: Q%5BT] ](Flow =%3E Unit):Unit")
345-
}
346345
}
347346
}
348347

0 commit comments

Comments
 (0)