Set javafmtOnCompile := false by default (#151)

README.md

@@ -18,12 +18,12 @@ addSbtPlugin("com.lightbend.sbt" % "sbt-java-formatter" % --latest version---)
 
 For available versions see [releases](https://github.com/sbt/sbt-java-formatter/releases).
 
-* `javafmt` formats Java files (done automatically on `compile` for `Compile` and `Test` configurations, unless `javafmtOnCompile := false` is set)
+* `javafmt` formats Java files
 * `javafmtAll` formats Java files for all configurations (`Compile` and `Test` by default)
 * `javafmtCheck` fails if files need reformatting
 * `javafmtCheckAll` fails if files need reformatting in any configuration (`Compile` and `Test` by default)
 
-* The `javafmtOnCompile` setting controls whether the formatter kicks in on compile (`true` by default as the `AutomateJavaFormatterPlugin` is triggered if not disabled explicitly).
+* The `javafmtOnCompile` setting controls whether the formatter kicks in on compile (`false` by default).
 * The `javafmtStyle` setting defines the formatting style: Google Java Style (by default) or AOSP style.
 
 This plugin requires sbt 1.3.0+.

plugin/src/main/scala/com/lightbend/sbt/JavaFormatterPlugin.scala

@@ -27,7 +27,7 @@ object AutomateJavaFormatterPlugin extends AutoPlugin {
 
   override def `requires` = plugins.JvmPlugin && JavaFormatterPlugin
 
-  override def globalSettings: Seq[Def.Setting[_]] = Seq(JavaFormatterPlugin.autoImport.javafmtOnCompile := true)
+  override def globalSettings: Seq[Def.Setting[_]] = Seq(JavaFormatterPlugin.autoImport.javafmtOnCompile := false)
 }
 
 object JavaFormatterPlugin extends AutoPlugin {
@@ -41,7 +41,7 @@ object JavaFormatterPlugin extends AutoPlugin {
     val javafmtCheckAll: TaskKey[Unit] = taskKey(
       "Execute the javafmtCheck task for all configurations in which it is enabled. " +
       "(By default this means the Compile and Test configurations.)")
-    val javafmtOnCompile = settingKey[Boolean]("Format Java source files on compile, on by default.")
+    val javafmtOnCompile = settingKey[Boolean]("Format Java source files on compile, off by default.")
     val javafmtStyle =
       settingKey[JavaFormatterOptions.Style]("Define formatting style, Google Java Style (default) or AOSP")
     val javafmtOptions = settingKey[JavaFormatterOptions](
@@ -91,12 +91,12 @@ object JavaFormatterPlugin extends AutoPlugin {
         JavaFormatter.check(baseDir, sD, iF, eF, streamz, cache, options)
       },
       javafmtDoFormatOnCompile := Def.settingDyn {
-          if (javafmtOnCompile.value) {
-            javafmt in resolvedScoped.value.scope
-          } else {
-            Def.task(())
-          }
-        }.value,
+        if (javafmtOnCompile.value) {
+          javafmt in resolvedScoped.value.scope
+        } else {
+          Def.task(())
+        }
+      }.value,
       compile / compileInputs := (compile / compileInputs).dependsOn(javafmtDoFormatOnCompile).value)
 
   def notToBeScopedSettings: Seq[Setting[_]] =

plugin/src/main/scala/com/lightbend/sbt/javaformatter/JavaFormatter.scala

@@ -65,9 +65,11 @@ object JavaFormatter {
 
     import sjsonnew.{ :*:, LList, LNil }
 
-    implicit val analysisIso = LList.iso({ a: Analysis => ("failedCheck", a.failedCheck) :*: LNil }, {
-      in: (Set[File] :*: LNil) => Analysis(in.head)
-    })
+    implicit val analysisIso = LList.iso(
+      { a: Analysis => ("failedCheck", a.failedCheck) :*: LNil },
+      { in: (Set[File] :*: LNil) =>
+        Analysis(in.head)
+      })
   }
 
   private def cachedCheckSources(cacheStoreFactory: CacheStoreFactory, baseDir: File, sources: Seq[File], log: Logger)(
@@ -101,8 +103,8 @@ object JavaFormatter {
     Analysis(failedCheck = unformatted)
   }
 
-  private def cachedFormatSources(cacheStoreFactory: CacheStoreFactory, sources: Seq[File], log: Logger)(
-      implicit formatter: Formatter): Unit = {
+  private def cachedFormatSources(cacheStoreFactory: CacheStoreFactory, sources: Seq[File], log: Logger)(implicit
+      formatter: Formatter): Unit = {
     trackSourcesViaCache(cacheStoreFactory, sources) { (outDiff, prev) =>
       log.debug(outDiff.toString)
       val updatedOrAdded = outDiff.modified & outDiff.checked
@@ -139,8 +141,8 @@ object JavaFormatter {
     prevTracker(())
   }
 
-  private def withFormattedSources[T](sources: Seq[File], log: Logger)(onFormat: (File, String, String) => T)(
-      implicit formatter: Formatter): Seq[Option[T]] = {
+  private def withFormattedSources[T](sources: Seq[File], log: Logger)(onFormat: (File, String, String) => T)(implicit
+      formatter: Formatter): Seq[Option[T]] = {
     sources.map { file =>
       val input = IO.read(file)
       try {

plugin/src/sbt-test/sbt-java-formatter/aosp-style/build.sbt

@@ -2,3 +2,4 @@ import com.google.googlejavaformat.java.JavaFormatterOptions
 // no settings needed
 
 ThisBuild / javafmtStyle := JavaFormatterOptions.Style.AOSP
+ThisBuild / javafmtOnCompile := true

plugin/src/sbt-test/sbt-java-formatter/default/test

@@ -1,5 +1,4 @@
-# compile should trigger formatting
-> test:compile
+> javafmtAll
 
 #$ exec echo "====== FORMATTED ======"
 #$ exec cat src/main/java/com/lightbend/BadFormatting.java

plugin/src/sbt-test/sbt-java-formatter/on-compile-false/build.sbt

@@ -0,0 +1 @@
+// no settings needed

plugin/src/sbt-test/sbt-java-formatter/on-compile/test → plugin/src/sbt-test/sbt-java-formatter/on-compile-false/test

@@ -1,4 +1,4 @@
-# compile should trigger formatting
+# compile should not trigger formatting
 > compile
 
 #$ exec echo "====== FORMATTED ======"

plugin/src/sbt-test/sbt-java-formatter/on-compile-true/build.sbt

@@ -0,0 +1 @@
+ThisBuild / javafmtOnCompile := true

plugin/src/sbt-test/sbt-java-formatter/on-compile-true/project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.3.0

plugin/src/sbt-test/sbt-java-formatter/on-compile-true/project/plugins.sbt

@@ -0,0 +1 @@
+addSbtPlugin("com.lightbend.sbt"  % "sbt-java-formatter" % System.getProperty("plugin.version"))

plugin/src/sbt-test/sbt-java-formatter/on-compile-true/src/main/java-expected/com/lightbend/BadFormatting.java

@@ -0,0 +1,9 @@
+package com.lightbend;
+
+public class BadFormatting {
+  BadFormatting() {
+    example();
+  }
+
+  public void example() {}
+}

plugin/src/sbt-test/sbt-java-formatter/on-compile-true/src/main/java/com/lightbend/BadFormatting.java

@@ -0,0 +1,6 @@
+package com.lightbend;
+
+public     class BadFormatting {
+  BadFormatting    () {example();}
+  public    void example     () {}
+}

plugin/src/sbt-test/sbt-java-formatter/on-compile-true/test

@@ -0,0 +1,10 @@
+# compile should not trigger formatting
+> compile
+
+#$ exec echo "====== FORMATTED ======"
+#$ exec cat src/main/java/com/lightbend/BadFormatting.java
+#$ exec echo "====== EXPECTED ======"
+#$ exec cat src/main/java-expected/com/lightbend/BadFormatting.java
+
+#$ exec echo "====== DIFF ======"
+$ exec diff src/main/java/com/lightbend/BadFormatting.java src/main/java-expected/com/lightbend/BadFormatting.java