Merge branch 'main' into update/scopt-4.0.1

Author: scala-steward

.github/workflows/ci.yml

@@ -52,27 +52,15 @@ jobs:
       - name: Check that workflows are up to date
         run: sbt ++${{ matrix.scala }} githubWorkflowCheck
 
-      - name: Check formatting and style
-        run: sbt ++${{ matrix.scala }} scalafmtCheckAll scalastyle
-
-      - name: Check version adheres to the policy
-        run: sbt ++${{ matrix.scala }} versionPolicyCheck
-
-      - name: Check documentation has been generated
-        run: sbt ++${{ matrix.scala }} mdocCheck
-
-      - name: Check dependencies
-        run: sbt ++${{ matrix.scala }} evicted undeclaredCompileDependenciesTest unusedCompileDependenciesTest dependencyCheckAggregate
-
-      - name: Build and test
-        run: sbt ++${{ matrix.scala }} test
+      - name: Build, test and check libraries
+        run: sbt ++${{ matrix.scala }} check
 
       - name: Build and test sbt plugin
         if: matrix.scala == '2.12.13'
         run: sbt ++${{ matrix.scala }} scripted
 
       - name: Compress target directories
-        run: tar cf targets.tar sbt/target target doc-templates/target cli/target core/target project/target
+        run: tar cf targets.tar sbt/target target doc-templates/target cli/target core/target example/target project/target
 
       - name: Upload target directories
         uses: actions/upload-artifact@v2

README.md

@@ -1,7 +1,8 @@
 # Scala2PlantUML
 
-[![Continuous Integration](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml/badge.svg)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
-![Scala2PlantUML Version](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13?label=Scala2PlantUML)
+[![Build badge](https://img.shields.io/github/workflow/status/BotTech/scala2plantuml/Continuous%20Integration/main)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
+[![Maven-Central badge](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13)](https://search.maven.org/search?q=g:nz.co.bottech%20a:*scala2plantuml*)
+[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
 
 Scala2PlantUML generates [PlantUML] diagrams from Scala code.
 
@@ -52,6 +53,7 @@ cs install --channel https://git.io/Jqv1i scala2plantuml
 ### Usage
 
 ```text
+> scala2plantuml --help
 Scala2PlantUML version 0.1.12
 Usage: scala2plantuml [options] symbol
 

build.sbt

@@ -4,37 +4,31 @@ val supportedScalaVersions = List(scala212, scala213)
 
 val logbackVersion                      = "1.2.3"
 val scalaCollectionCompatibilityVersion = "2.3.2"
-val scoptVersion                        = "4.0.1"
+val scoptVersion                        = "4.0.0"
+val sdbVersion                          = "4.4.10"
 val slf4jVersion                        = "1.7.30"
 val utestVersion                        = "0.7.7"
 
-val checkTasks = List(
-  "scalafmtCheckAll",
-  "scalastyle",
-  "versionPolicyCheck",
-  "githubWorkflowCheck",
-  "mdocCheck",
-  "evicted",
-  "undeclaredCompileDependenciesTest",
-  "unusedCompileDependenciesTest",
-  "dependencyCheckAggregate",
-  "test",
-  "scripted"
-)
-
 addCommandAlias(
-  "check",
+  "devCheck",
   supportedScalaVersions.flatMap { version =>
-    s"++$version" :: checkTasks.filterNot(_ == "scripted" && version == scala213)
-  }.mkString("; ")
+    s"++$version" :: "githubWorkflowCheck" :: "check" :: (if (version == scala213) Nil else List("scripted"))
+  }.mkString(";")
 )
 
 addCommandAlias(
-  "mdocCheck",
+  "check",
   List(
-    """set docs / mdocExtraArguments += "--check"""",
-    "docs / mdoc"
-  ).mkString("; ")
+    "scalafmtCheckAll",
+    "scalastyle",
+    "versionPolicyCheck",
+    "docs/mdoc --check",
+    "evicted",
+    "undeclaredCompileDependenciesTest",
+    "unusedCompileDependenciesTest",
+    "dependencyCheckAggregate",
+    "test"
+  ).mkString(";")
 )
 
 val isScala213 = settingKey[Boolean]("Checks if the current Scala version is 2.13")
@@ -58,19 +52,7 @@ inThisBuild(
     organization := "nz.co.bottech",
     organizationName := "BotTech",
     githubWorkflowBuild := List(
-      WorkflowStep.Sbt(List("scalafmtCheckAll", "scalastyle"), name = Some("Check formatting and style")),
-      WorkflowStep.Sbt(List("versionPolicyCheck"), name = Some("Check version adheres to the policy")),
-      WorkflowStep.Sbt(List("mdocCheck"), name = Some("Check documentation has been generated")),
-      WorkflowStep.Sbt(
-        List(
-          "evicted",
-          "undeclaredCompileDependenciesTest",
-          "unusedCompileDependenciesTest",
-          "dependencyCheckAggregate"
-        ),
-        name = Some("Check dependencies")
-      ),
-      WorkflowStep.Sbt(List("test"), name = Some("Build and test")),
+      WorkflowStep.Sbt(List("check"), name = Some("Build, test and check libraries")),
       WorkflowStep.Sbt(
         List("scripted"),
         name = Some("Build and test sbt plugin"),
@@ -126,10 +108,8 @@ val metaProjectSettings = List(
   publish / skip := true
 )
 
-val libraryProjectSettings = commonProjectSettings
-
 lazy val root = (project in file("."))
-  .aggregate(cli, core, docs, sbtProject)
+  .aggregate(cli, core, docs, example, sbtProject)
   .settings(metaProjectSettings)
   .settings(
     crossScalaVersions := supportedScalaVersions,
@@ -141,7 +121,7 @@ lazy val root = (project in file("."))
   )
 
 lazy val core = project
-  .settings(libraryProjectSettings)
+  .settings(commonProjectSettings)
   .settings(
     libraryDependencies ++= collectionsCompatibilityDependency.value,
     libraryDependencies ++= List(
@@ -154,7 +134,7 @@ lazy val core = project
     ),
     name := s"${(LocalRootProject / name).value}",
     semanticdbEnabled := true,
-    semanticdbVersion := "4.4.10",
+    semanticdbVersion := sdbVersion,
     testFrameworks += new TestFramework("utest.runner.Framework"),
     Test / managedSourceDirectories += (Test / semanticdbTargetRoot).value,
     Test / fullClasspath += (Test / semanticdbTargetRoot).value
@@ -163,7 +143,7 @@ lazy val core = project
 lazy val cli = project
   .dependsOn(core)
   .enablePlugins(BuildInfoPlugin)
-  .settings(libraryProjectSettings)
+  .settings(commonProjectSettings)
   .settings(
     buildInfoKeys := Seq[BuildInfoKey](version),
     buildInfoPackage := s"${organization.value}.${(LocalRootProject / name).value}",
@@ -183,10 +163,9 @@ lazy val sbtProject = (project in file("sbt"))
   .settings(commonProjectSettings)
   .settings(
     libraryDependencies ++= {
-      // Don't add dependencies when the rest of the build is cross building with Scala 2.13
-      // otherwise it will cause a whole lot of resolution failures.
-      if ((core / isScala213).value) Nil
-      else
+      // Only add dependencies when the build is building with a Scala version that is
+      // sbt compatible otherwise it will cause a whole lot of resolution failures.
+      if (spspCanBuild.value)
         collectionsCompatibilityDependency.value ++ List(
           "org.scala-sbt" %% "collections"            % sbtVersion.value,
           "org.scala-sbt" %% "command"                % sbtVersion.value,
@@ -202,6 +181,7 @@ lazy val sbtProject = (project in file("sbt"))
           "org.scala-sbt" %% "util-logging"           % sbtVersion.value,
           "org.scala-sbt" %% "util-position"          % sbtVersion.value
         )
+      else Nil
     },
     name := s"sbt-${(LocalRootProject / name).value}",
     scriptedBufferLog := false,
@@ -230,6 +210,15 @@ lazy val docs = (project in file("doc-templates"))
     unusedCompileDependenciesFilter -= moduleFilter("org.scalameta", "mdoc*")
   )
 
+lazy val example = project
+  .settings(commonProjectSettings)
+  .settings(
+    semanticdbEnabled := true,
+    semanticdbIncludeInJar := true,
+    semanticdbVersion := sdbVersion,
+    versionPolicyFirstVersion := Some("0.1.13"),
+  )
+
 def isScala213Setting: Def.Initialize[Boolean] = Def.setting {
   CrossVersion.partialVersion(scalaVersion.value) match {
     case Some((2, n)) if n == 13 => true

docs/README.md

@@ -1,7 +1,8 @@
 # Scala2PlantUML
 
-[![Continuous Integration](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml/badge.svg)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
-![Scala2PlantUML Version](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13?label=Scala2PlantUML)
+[![Build badge](https://img.shields.io/github/workflow/status/BotTech/scala2plantuml/Continuous%20Integration/main)](https://github.com/BotTech/scala2plantuml/actions/workflows/ci.yml)
+[![Maven-Central badge](https://img.shields.io/maven-central/v/nz.co.bottech/scala2plantuml_2.13)](https://search.maven.org/search?q=g:nz.co.bottech%20a:*scala2plantuml*)
+[![Scala Steward badge](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://scala-steward.org)
 
 Scala2PlantUML generates [PlantUML] diagrams from Scala code.
 
@@ -52,6 +53,7 @@ cs install --channel https://git.io/Jqv1i scala2plantuml
 ### Usage
 
 ```text
+> scala2plantuml --help
 Scala2PlantUML version @VERSION@
 Usage: scala2plantuml [options] symbol
 

example/src/main/scala/nz/co/bottech/scala2plantuml/example/A.scala

@@ -0,0 +1,5 @@
+package nz.co.bottech.scala2plantuml.example
+
+class A extends B {
+  override def b: C = C(this)
+}

example/src/main/scala/nz/co/bottech/scala2plantuml/example/B.scala

@@ -0,0 +1,11 @@
+package nz.co.bottech.scala2plantuml.example
+
+trait B {
+
+  def b: C
+}
+
+object B {
+
+  val Const: String = "X"
+}

example/src/main/scala/nz/co/bottech/scala2plantuml/example/C.scala

@@ -0,0 +1,3 @@
+package nz.co.bottech.scala2plantuml.example
+
+final case class C(value: A)

example/src/main/scala/nz/co/bottech/scala2plantuml/example/Main.scala

@@ -0,0 +1,8 @@
+package nz.co.bottech.scala2plantuml.example
+
+object Main extends App {
+
+  {
+    val _ = new A
+  }
+}

project/ConditionalKeys.scala

@@ -0,0 +1,70 @@
+import sbt.Keys.skip
+import sbt.{Def, InputKey, InputTask, Task, TaskKey}
+
+object ConditionalKeys {
+
+  def settingDefaultIfSetting[A, B](
+      setting: Def.Initialize[A],
+      condition: Def.Initialize[B],
+      default: => A
+    )(
+      p: B => Boolean
+    ): Def.Initialize[A] = Def.setting {
+    if (p(condition.value)) {
+      default
+    } else {
+      setting.value
+    }
+  }
+
+  def taskDefaultIfSkipped[A](task: TaskKey[A], default: => A): Def.Initialize[Task[A]] =
+    taskDefaultIfTask(task, task / skip, default)(identity)
+
+  def taskDefaultIfSetting[A, B](
+      task: Def.Initialize[Task[A]],
+      condition: Def.Initialize[B],
+      default: => A
+    )(
+      p: B => Boolean
+    ): Def.Initialize[Task[A]] = Def.taskIf {
+    if (p(condition.value)) {
+      default
+    } else {
+      task.value
+    }
+  }
+
+  def taskDefaultIfTask[A, B](
+      task: Def.Initialize[Task[A]],
+      condition: Def.Initialize[Task[B]],
+      default: => A
+    )(
+      p: B => Boolean
+    ): Def.Initialize[Task[A]] = Def.taskIf {
+    if (p(condition.value)) {
+      default
+    } else {
+      task.value
+    }
+  }
+
+  def inputDefaultIfSkipped[A](input: InputKey[A], default: => A): Def.Initialize[InputTask[A]] =
+    inputDefaultIfTask(input, input / skip, default)(identity)
+
+  def inputDefaultIfTask[A, B](
+      input: InputKey[A],
+      condition: Def.Initialize[Task[B]],
+      default: => A
+    )(
+      p: B => Boolean
+    ): Def.Initialize[InputTask[A]] = Def.inputTaskDyn {
+    val task = input.parsed
+    Def.taskIf {
+      if (p(condition.value)) {
+        default
+      } else {
+        task.value
+      }
+    }
+  }
+}

project/SbtPluginSubProjectPlugin.scala

@@ -0,0 +1,56 @@
+import ConditionalKeys._
+import com.typesafe.tools.mima.plugin.MimaKeys.mimaPreviousArtifacts
+import explicitdeps.ExplicitDepsPlugin
+import explicitdeps.ExplicitDepsPlugin.autoImport._
+import sbt.Keys._
+import sbt.ScriptedPlugin.autoImport.scripted
+import sbt._
+import sbt.plugins.SbtPlugin
+import sbtversionpolicy.SbtVersionPolicyMima
+
+// This is all the crazy hacks to get cross compiling working with an sub-project that is an sbt plugin.
+object SbtPluginSubProjectPlugin extends AutoPlugin {
+
+  override def trigger: PluginTrigger = allRequirements
+  override def requires: Plugins      = SbtPlugin && SbtVersionPolicyMima && ExplicitDepsPlugin
+
+  object autoImport {
+    val spspCanBuild = settingKey[Boolean]("Checks if the project dependencies are using a compatible Scala version.")
+  }
+
+  import autoImport._
+
+  override def projectSettings: Seq[Def.Setting[_]] =
+    List(
+      crossScalaVersions := Nil,
+      // Remove all project dependencies for Scala 2.13 as they will not resolve when cross building.
+      projectDependencies := taskDefaultIfSkipped(projectDependencies, Nil).value,
+      scripted := inputDefaultIfSkipped(scripted, ()).evaluated,
+      spspCanBuild := canBuildSetting.value,
+      // We can't skip this as it has to run at least once or sbt complains.
+      update / skip := false,
+      // Skip everything else otherwise it will just fail.
+      skip := !spspCanBuild.value,
+      undeclaredCompileDependenciesFilter -= moduleFilter(),
+      mimaPreviousArtifacts := defaultIfCannotBuild(mimaPreviousArtifacts, Set.empty[ModuleID]).value
+    )
+
+  def defaultIfCannotBuild[A](setting: Def.Initialize[A], default: => A): Def.Initialize[A] =
+    settingDefaultIfSetting(setting, spspCanBuild, default)(!_)
+
+  private def canBuildSetting = Def.setting {
+    if (!isScala212(scalaVersion.value))
+      throw new IllegalStateException(
+        "sbt project must use Scala 2.12. Check that you have not forced the version with '+'."
+      )
+    val versions =
+      scalaVersion.all(ScopeFilter(inDependencies(ThisProject, transitive = true, includeRoot = false))).value
+    versions.forall(isScala212)
+  }
+
+  private def isScala212(version: String) =
+    CrossVersion.partialVersion(version) match {
+      case Some((2, n)) if n == 12 => true
+      case _                       => false
+    }
+}