Merge pull request #10 from 2m/wip-classgraph-2m

Migrate to the classgraph lib

Author: 2m

.scalafmt.conf

@@ -0,0 +1,11 @@
+maxColumn = 120
+docstrings = JavaDoc
+assumeStandardLibraryStripMargin = true
+rewrite.rules = [RedundantBraces, RedundantParens, SortImports, SortModifiers]
+unindentTopLevelOperators = true
+align.tokens = [
+  {code = "%", owner = "Term.ApplyInfix"},
+  {code = "%%", owner = "Term.ApplyInfix"},
+  {code = ":=", owner = "Term.ApplyInfix"},
+  "="
+]

.travis.yml

@@ -5,7 +5,10 @@ scala: 2.12.4
 jobs:
   include:
     - stage: test
-      script: sbt test
+      script: sbt scalafmtCheck scalafmtSbtCheck
+      name: "Formatting check"
+    - script: sbt test
+      name: "Tests run"
     - stage: publish
       script: sbt ^publish
 

RELEASING.md

@@ -0,0 +1,10 @@
+# Releasing
+
+1. Check [closed issues without a milestone](https://github.com/lightbend/sbt-paradox-apidoc/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20no%3Amilestone) and either assign them the upcoming release milestone or 'invalid'
+1. Create a [new release](https://github.com/lightbend/sbt-paradox-apidoc/releases/new) with:
+    * the next tag version (e.g. `v0.2`)
+    * title and release description including notable changes
+    * link to the [milestone](https://github.com/lightbend/sbt-paradox-apidoc/milestones) showing an overview of closed issues for this release
+    * overview of contributors generated by [`sbt-authors`](https://github.com/2m/authors) (eg. `sbt authors v0.1 v0.2`)
+1. Travis CI will start a [CI build](https://travis-ci.org/lightbend/sbt-paradox-apidoc/builds) for the new tag and publish artifacts to Bintray.
+1. Close the milestone for this release and start a new one.

build.sbt

@@ -1,28 +1,30 @@
 scalaVersion := "2.12.7"
 
-sbtPlugin := true
+sbtPlugin        := true
 crossSbtVersions := List("1.0.0")
-organization := "com.lightbend.paradox"
-name := "sbt-paradox-apidoc"
+organization     := "com.lightbend.paradox"
+name             := "sbt-paradox-apidoc"
 
 addSbtPlugin(Library.sbtParadox)
 libraryDependencies ++= Seq(
-  Library.fastClassPathScanner,
-  Library.jtidy % Test,
+  Library.classgraph,
+  Library.jtidy     % Test,
   Library.scalatest % Test
 )
 
 licenses += ("Apache-2.0", url("http://www.apache.org/licenses/LICENSE-2.0"))
 homepage := Some(url("https://github.com/lightbend/sbt-paradox-apidoc"))
-scmInfo := Some(ScmInfo(url("https://github.com/lightbend/sbt-paradox-apidoc"), "[email protected]:lightbend/sbt-paradox-apidoc.git"))
+scmInfo := Some(
+  ScmInfo(url("https://github.com/lightbend/sbt-paradox-apidoc"), "[email protected]:lightbend/sbt-paradox-apidoc.git"))
 developers += Developer("contributors",
-  "Contributors",
-  "https://gitter.im/lightbend/paradox",
-  url("https://github.com/lightbend/sbt-paradox-apidoc/graphs/contributors"))
+                        "Contributors",
+                        "https://gitter.im/lightbend/paradox",
+                        url("https://github.com/lightbend/sbt-paradox-apidoc/graphs/contributors"))
 organizationName := "Lightbend Inc."
-startYear := Some(2018)
+startYear        := Some(2018)
 
 bintrayOrganization := Some("sbt")
-bintrayRepository := "sbt-plugin-releases"
+bintrayRepository   := "sbt-plugin-releases"
 
 enablePlugins(AutomateHeaderPlugin)
+scalafmtOnCompile := true

project/Dependencies.scala

@@ -1,15 +1,15 @@
 import sbt._
 
 object Version {
-  val fastClassPathScanner = "2.21"
-  val jtidy                = "r938"
-  val sbtParadox           = "0.4.3"
-  val scalatest            = "3.0.3"
+  val classgraph = "4.4.2"
+  val jtidy      = "r938"
+  val sbtParadox = "0.4.3"
+  val scalatest  = "3.0.5"
 }
 
 object Library {
-  val fastClassPathScanner = "io.github.lukehutch"   %  "fast-classpath-scanner" % Version.fastClassPathScanner
-  val jtidy                = "net.sf.jtidy"          %  "jtidy"                  % Version.jtidy
-  val sbtParadox           = "com.lightbend.paradox" %  "sbt-paradox"            % Version.sbtParadox
-  val scalatest            = "org.scalatest"         %% "scalatest"              % Version.scalatest
+  val classgraph = "io.github.classgraph"  % "classgraph"  % Version.classgraph
+  val jtidy      = "net.sf.jtidy"          % "jtidy"       % Version.jtidy
+  val sbtParadox = "com.lightbend.paradox" % "sbt-paradox" % Version.sbtParadox
+  val scalatest  = "org.scalatest"         %% "scalatest"  % Version.scalatest
 }

project/build.properties

@@ -1 +1 @@
-sbt.version=1.2.4
+sbt.version=1.2.6

project/plugins.sbt

@@ -1,3 +1,4 @@
-addSbtPlugin("com.dwijnand" % "sbt-dynver" % "3.1.0")
-addSbtPlugin("org.foundweekends" % "sbt-bintray" % "0.5.4")
-addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.0.0")
+addSbtPlugin("com.dwijnand"      % "sbt-dynver"   % "3.1.0")
+addSbtPlugin("org.foundweekends" % "sbt-bintray"  % "0.5.4")
+addSbtPlugin("de.heikoseeberger" % "sbt-header"   % "5.0.0")
+addSbtPlugin("com.geirsson"      % "sbt-scalafmt" % "1.5.1")

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

@@ -21,7 +21,7 @@ import org.pegdown.Printer
 import org.pegdown.ast.{DirectiveNode, TextNode, Visitor}
 
 class ApidocDirective(allClasses: IndexedSeq[String]) extends InlineDirective("apidoc") {
-  def render(node: DirectiveNode, visitor: Visitor, printer: Printer): Unit = {
+  def render(node: DirectiveNode, visitor: Visitor, printer: Printer): Unit =
     if (node.label.split('[')(0).contains('.')) {
       val fqcn = node.label
       if (allClasses.contains(fqcn)) {
@@ -31,11 +31,9 @@ class ApidocDirective(allClasses: IndexedSeq[String]) extends InlineDirective("a
       } else {
         throw new java.lang.IllegalStateException(s"fqcn not found by @apidoc[$fqcn]")
       }
-    }
-    else {
+    } else {
       renderByClassName(node.label, node, visitor, printer)
     }
-  }
 
   private def baseClassName(label: String) = {
     val labelWithoutGenerics = label.split("\\[")(0)
@@ -52,16 +50,27 @@ class ApidocDirective(allClasses: IndexedSeq[String]) extends InlineDirective("a
 
   def syntheticNode(group: String, label: String, fqcn: String, node: DirectiveNode): DirectiveNode = {
     val syntheticSource = new DirectiveNode.Source.Direct(fqcn)
-    val attributes = new org.pegdown.ast.DirectiveAttributes.AttributeMap()
-    new DirectiveNode(DirectiveNode.Format.Inline, group, null, null, attributes, null,
-      new DirectiveNode(DirectiveNode.Format.Inline, group + "doc", label, syntheticSource, node.attributes, fqcn,
-        new TextNode(label)
-      ))
+    val attributes      = new org.pegdown.ast.DirectiveAttributes.AttributeMap()
+    new DirectiveNode(
+      DirectiveNode.Format.Inline,
+      group,
+      null,
+      null,
+      attributes,
+      null,
+      new DirectiveNode(DirectiveNode.Format.Inline,
+                        group + "doc",
+                        label,
+                        syntheticSource,
+                        node.attributes,
+                        fqcn,
+                        new TextNode(label))
+    )
   }
 
   def renderByClassName(label: String, node: DirectiveNode, visitor: Visitor, printer: Printer): Unit = {
-    val query = node.label.replaceAll("\\\\_", "_")
-    val className = baseClassName(query)
+    val query       = node.label.replaceAll("\\\\_", "_")
+    val className   = baseClassName(query)
     val classSuffix = if (query.endsWith("$")) "$" else ""
 
     val matches = allClasses.filter(_.endsWith('.' + className))

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

@@ -16,7 +16,7 @@
 
 package com.lightbend.paradox.apidoc
 
-import _root_.io.github.lukehutch.fastclasspathscanner.FastClasspathScanner
+import io.github.classgraph.ClassGraph
 import com.lightbend.paradox.markdown.Writer
 import com.lightbend.paradox.sbt.ParadoxPlugin
 import com.lightbend.paradox.sbt.ParadoxPlugin.autoImport.paradoxDirectives
@@ -40,17 +40,26 @@ object ApidocPlugin extends AutoPlugin {
   def apidocParadoxGlobalSettings: Seq[Setting[_]] = Seq(
     apidocRootPackage := "scala",
     paradoxDirectives ++= Def.taskDyn {
-      val classpath = (fullClasspath in Compile).value.files.map(_.toURI.toURL).toArray
+      val classpath   = (fullClasspath in Compile).value.files.map(_.toURI.toURL).toArray
       val classLoader = new java.net.URLClassLoader(classpath, this.getClass.getClassLoader)
-      val scanner = new FastClasspathScanner(apidocRootPackage.value).addClassLoader(classLoader).scan()
-      val allClasses = scanner.getNamesOfAllClasses.asScala.toVector
-      Def.task { Seq(
-        { _: Writer.Context ⇒ new ApidocDirective(allClasses) }
-      )}
+      val scanner = new ClassGraph()
+        .whitelistPackages(apidocRootPackage.value)
+        .addClassLoader(classLoader)
+        .scan()
+      val allClasses = scanner.getAllClasses.getNames.asScala.toVector
+      Def.task {
+        Seq(
+          { _: Writer.Context ⇒
+            new ApidocDirective(allClasses)
+          }
+        )
+      }
     }.value
   )
 
-  def apidocSettings(config: Configuration): Seq[Setting[_]] = apidocParadoxGlobalSettings ++ inConfig(config)(Seq(
-    // scoped settings here
-  ))
+  def apidocSettings(config: Configuration): Seq[Setting[_]] =
+    apidocParadoxGlobalSettings ++ inConfig(config)(
+      Seq(
+        // scoped settings here
+      ))
 }