introduce scalafixOnCompile

Users can control whether scalafix (running the default rules declared
in .scalafix.conf) should be run as part of `compile` at the project &
configuration level.

The value of scalafixOnCompile is ignored when invoking directly
scalafix or scalafixAll, as the CLI arguments (if there are any)
take precedence over the default rules. That means for example that
`scalafix --check` is safe to run even though scalafixOnCompile := true,
as there will not be any rewrite triggered by the implicit compilation.

src/main/scala/scalafix/sbt/ScalafixPlugin.scala

@@ -33,13 +33,22 @@ object ScalafixPlugin extends AutoPlugin {
  inputKey[Unit](
  "Run scalafix rule(s) in this project and configuration. " +
  "For example: scalafix RemoveUnusedImports. " +
- "To run on test sources use test:scalafix or scalafixAll."
+ "To run on test sources use test:scalafix or scalafixAll. " +
+ "When invoked directly, prior compilation will be triggered for semantic rules."
  )
  val scalafixAll: InputKey[Unit] =
  inputKey[Unit](
  "Run scalafix rule(s) in this project, for all configurations where scalafix is enabled. " +
- "Compile and Test are enabled by default, other configurations can be enabled via scalafixConfigSettings."
+ "Compile and Test are enabled by default, other configurations can be enabled via scalafixConfigSettings. " +
+ "When invoked directly, prior compilation will be triggered for semantic rules."
  )
+
+ val scalafixOnCompile: SettingKey[Boolean] =
+ settingKey[Boolean](
+ "Run Scalafix rule(s) declared in .scalafix.conf on compilation and fail on lint errors. " +
+ "Off by default."
+ )
+
  val scalafixCaching: SettingKey[Boolean] =
  settingKey[Boolean](
  "Cache scalafix invocations (off by default, still experimental)."
@@ -87,6 +96,17 @@ object ScalafixPlugin extends AutoPlugin {
  def scalafixConfigSettings(config: Configuration): Seq[Def.Setting[_]] =
  Seq(
  scalafix := scalafixInputTask(config).evaluated,
+ compile := Def.taskDyn {
+ val oldCompile =
+ compile.value // evaluated first, before the potential scalafix evaluation
+ val runScalafixAfterCompile =
+ scalafixOnCompile.value && !scalafixRunExplicitly.value
+ if (runScalafixAfterCompile)
+ scalafix
+ .toTask("")
+ .map(_ => oldCompile)
+ else Def.task(oldCompile)
+ }.value,
  // In some cases (I haven't been able to understand when/why, but this also happens for bgRunMain while
  // fgRunMain is fine), there is no specific streams attached to InputTasks, so we they end up sharing the
  // global streams, causing issues for cache storage. This does not happen for Tasks, so we define a dummy one
@@ -160,6 +180,7 @@ object ScalafixPlugin extends AutoPlugin {
  override lazy val globalSettings: Seq[Def.Setting[_]] = Seq(
  scalafixConfig := None, // let scalafix-cli try to infer $CWD/.scalafix.conf
  scalafixCaching := false,
+ scalafixOnCompile := false,
  scalafixResolvers := Seq(
  Repository.ivy2Local(),
  Repository.central(),
@@ -394,16 +415,22 @@ object ScalafixPlugin extends AutoPlugin {
  new SemanticdbNotFound(ruleNames, scalaVersion.value, sbtVersion.value)
  ).findErrors(files, dependencies, withScalaInterface)
  if (errors.isEmpty) {
- Def.task {
+ val task = Def.task {
+ // passively consume compilation output without triggering compile as it can result in a cyclic dependency
+ val classpath =
+ dependencyClasspath.in(config).value.map(_.data.toPath) :+
+ classDirectory.in(config).value.toPath
  val semanticInterface = withScalaInterface.withArgs(
  Arg.Paths(files),
- Arg.Classpath(fullClasspath.in(config).value.map(_.data.toPath))
+ Arg.Classpath(classpath)
  )
  runArgs(
  semanticInterface,
  streams.in(config, scalafix).value
  )
  }
+ if (scalafixRunExplicitly.value) task.dependsOn(compile.in(config))
+ else task
  } else {
  Def.task {
  if (errors.length == 1) {
@@ -537,6 +564,16 @@ object ScalafixPlugin extends AutoPlugin {
  }
  }
 
+ // Controls whether scalafix should depend on compile (true) & whether compile may depend on
+ // scalafix (false), to avoid cyclic dependencies causing deadlocks during executions (as
+ // dependencies come from dynamic tasks).
+ private val scalafixRunExplicitly: Def.Initialize[Task[Boolean]] =
+ Def.task {
+ executionRoots.value.exists { root =>
+ Seq(scalafix.key, scalafixAll.key).contains(root.key)
+ }
+ }
+
  private def isScalaFile(file: File): Boolean = {
  val path = file.getPath
  path.endsWith(".scala") ||

src/sbt-test/sbt-scalafix/scalafixOnCompile/.scalafix.conf

@@ -0,0 +1,2 @@
+rules = [DisableSyntax, RemoveUnused]
+DisableSyntax.noNulls = true

src/sbt-test/sbt-scalafix/scalafixOnCompile/build.sbt

@@ -0,0 +1,23 @@
+import _root_.scalafix.sbt.{BuildInfo => Versions}
+
+inThisBuild(
+ Seq(
+ scalaVersion := Versions.scala212,
+ scalacOptions ++= List(
+ "-Yrangepos",
+ "-Ywarn-unused-import"
+ )
+ )
+)
+lazy val lint = project
+ .settings(
+ addCompilerPlugin(scalafixSemanticdb)
+ )
+
+lazy val rewrite = project
+ .configs(IntegrationTest)
+ .settings(
+ Defaults.itSettings,
+ inConfig(IntegrationTest)(scalafixConfigSettings(IntegrationTest)),
+ addCompilerPlugin(scalafixSemanticdb)
+ )

src/sbt-test/sbt-scalafix/scalafixOnCompile/lint/src/test/scala/Null.scala

@@ -0,0 +1,3 @@
+object Null {
+ println(null)
+}

src/sbt-test/sbt-scalafix/scalafixOnCompile/project/plugins.sbt

@@ -0,0 +1,2 @@
+resolvers += Resolver.sonatypeRepo("public")
+addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % sys.props("plugin.version"))

src/sbt-test/sbt-scalafix/scalafixOnCompile/rewrite/src/it/scala/UnusedImports.scala

@@ -0,0 +1,3 @@
+import java.time.Instant
+
+object UnusedImports

src/sbt-test/sbt-scalafix/scalafixOnCompile/rewrite/src/main/scala/UnusedImports.scala

@@ -0,0 +1,3 @@
+import java.time.Instant
+
+object UnusedImports

src/sbt-test/sbt-scalafix/scalafixOnCompile/test

@@ -0,0 +1,26 @@
+# check implicit rewrite of rewrite/src/main/scala/UnusedImports.scala via `compile`
+> compile
+-> scalafix --check
+> set scalafixOnCompile.in(ThisBuild) := true
+-> scalafix --check
+> compile
+> scalafix --check
+
+# check explicit rewrite of rewrite/src/it/scala/UnusedImports.scala via `scalafix`
+-> it:scalafix --check
+> it:scalafix
+> it:scalafix --check
+
+# check lint for lint/src/test/scala/Null.scala
+-> lint/test:scalafix --check
+-> lint/test:scalafix
+-> lint/test:compile
+
+# check that default rules are ignored when rules are passed explicitly
+-> lint/test:scalafix --check
+> lint/test:scalafix --check RemoveUnused
+> lint/test:scalafix RemoveUnused
+
+# check configuration granularity for scalafixOnCompile
+> set scalafixOnCompile.in(lint, Test) := false
+> lint/test:compile