Format code with scalafmt + test format via travis

Author: MasseGuillaume

.gitignore

@@ -13,3 +13,5 @@ target/
 /bin/
 /.cache-main
 /.cache-tests
+admin/.coursier
+admin/.scalafmt*

.scalafmt.conf

@@ -0,0 +1,15 @@
+align = more
+docstrings = JavaDoc
+assumeStandardLibraryStripMargin = true
+project.git = true
+maxColumn = 100
+project.excludeFilters = [
+  "scalafix/input/"
+  "scalafix/output/"
+  "scalafix/output212/"
+  "scalafix/output212\\+/"
+  "scalafix/output213/"
+  "scalafix/output213-failure/"
+]
+
+

.travis.yml

@@ -59,6 +59,11 @@ matrix:
       scala: 2.12.6
       env: TEST_BINARY_COMPAT=true
 
+    # # run scalafmt
+    # - jdk: oraclejdk8
+    #   scala: 2.12.6
+    #   env: TEST_SCALAFMT=true
+
 # | jdk         |   scala   | scala target | scala target version | scalafix test |
 # | ----------- | --------- | ------------ | -------------------- |---------------|
 # |    openjdk6 | 2.11.12   | jvm          |                      |               |

CONTRIBUTING.md

@@ -53,7 +53,9 @@ class ToIteratorVsIteratorSrc(xs: Iterable[Int]) {
     - run sbt
       and then run the following task `compile`;
 
-5. Commit your changes, push your branch to your fork and create a pull request.
+5. Format your code with the `scalafmt` sbt task.
+
+6. Commit your changes, push your branch to your fork and create a pull request.
 
 Then maybe someone will take over and implement your use case… or maybe you will
 (see next section)!

admin/install-scalafmt-githook.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+# set -x
+
+HERE="`dirname $0`"
+DST="$HERE/../.git/hooks/pre-commit"
+
+if [ ! -f $DST ]; then
+  cp "$HERE/pre-commit" $DST
+fi

admin/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+$GIT_DIR/../admin/scalafmt.sh --test $GIT_DIR/..

admin/scalafmt.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# set -x
+
+HERE="`dirname $0`"
+VERSION="1.5.1"
+COURSIER="$HERE/.coursier"
+SCALAFMT="$HERE/.scalafmt-$VERSION"
+
+if [ ! -f $COURSIER ]; then
+  curl -L -o $COURSIER https://git.io/vgvpD
+  chmod +x $COURSIER
+fi
+
+if [ ! -f $SCALAFMT ]; then
+  $COURSIER bootstrap com.geirsson:scalafmt-cli_2.11:$VERSION --main org.scalafmt.cli.Cli -o $SCALAFMT
+  chmod +x $SCALAFMT
+fi
+
+$SCALAFMT "$@"

build.sbt

@@ -254,6 +254,7 @@ val travisScalaVersion = sys.env.get("TRAVIS_SCALA_VERSION").flatMap(Version.par
 val releaseVersion     = sys.env.get("TRAVIS_TAG").flatMap(Version.parse)
 val isScalaJs          = sys.env.get("SCALAJS_VERSION").nonEmpty
 val isScalafix         = sys.env.get("TEST_SCALAFIX").nonEmpty
+val isScalafmt         = sys.env.get("TEST_SCALAFMT").nonEmpty
 val isBinaryCompat     = sys.env.get("TEST_BINARY_COMPAT").nonEmpty
 val isRelease          = releaseVersion.nonEmpty
 
@@ -292,56 +293,69 @@ inThisBuild(Seq(
 
     state
   },
+  commands += Command.command("scalafmt-test") { state =>
+    Seq("admin/scalafmt.sh", "--test") ! state.globalLogging.full
+    state
+  },
+  commands += Command.command("scalafmt") { state =>
+    Seq("admin/scalafmt.sh") ! state.globalLogging.full
+    state
+  },
   commands += Command.command("ci") { state =>
-    val platformSuffix = if (isScalaJs) "JS" else ""
-
-    val compatProject       = "compat" + travisScalaVersion.get.binary + platformSuffix
-    val binaryCompatProject = "binary-compat"
-
-    val testProjectPrefix =
-      if (isScalafix) {
-        "scalafix-tests"
-      } else if (isBinaryCompat) {
-        binaryCompatProject
+    val toRun =
+      if (isScalafmt) {
+        Seq("scalafmt-test")
       } else {
-        compatProject
-      }
+        val platformSuffix = if (isScalaJs) "JS" else ""
+
+        val compatProject       = "compat" + travisScalaVersion.get.binary + platformSuffix
+        val binaryCompatProject = "binary-compat"
+
+        val testProjectPrefix =
+          if (isScalafix) {
+            "scalafix-tests"
+          } else if (isBinaryCompat) {
+            binaryCompatProject
+          } else {
+            compatProject
+          }
 
-    val projectPrefix =
-      if (isScalafix) {
-        "scalafix-rules"
-      } else if (isBinaryCompat) {
-        binaryCompatProject
-      } else {
-        compatProject
-      }
+        val projectPrefix =
+          if (isScalafix) {
+            "scalafix-rules"
+          } else if (isBinaryCompat) {
+            binaryCompatProject
+          } else {
+            compatProject
+          }
 
-    val setPublishVersion = releaseVersion.map("set every version := " + _).toList
+        val setPublishVersion =
+          releaseVersion.map("set every version := " + _).toList
+
+        val publishTask =
+          if (releaseVersion.nonEmpty) {
+            List(
+              preRelease,
+              s"$projectPrefix/publish-signed"
+            )
+          } else {
+            Nil
+          }
 
-    val publishTask =
-      if (releaseVersion.nonEmpty) {
-        List(
-          preRelease,
-          s"$projectPrefix/publish-signed"
-        )
-      } else {
-        Nil
+        Seq(
+          setPublishVersion,
+          List(s"$projectPrefix/clean"),
+          List(s"$testProjectPrefix/test"),
+          List(s"$projectPrefix/publishLocal"),
+          publishTask
+        ).flatten
       }
 
-    val toRun = Seq(
-      setPublishVersion,
-      List(s"$projectPrefix/clean"),
-      List(s"$testProjectPrefix/test"),
-      List(s"$projectPrefix/publishLocal"),
-      publishTask
-    ).flatten
-
     println("---------")
     println("Running CI: ")
     toRun.foreach(println)
     println("---------")
 
-
     toRun ::: state
   }
 ))