Scalafmt bump: scripts, commit hook, 🔥 old config

Anna Zubenko · Anna Zubenko · commit 231bf566201b · 2017-06-07T17:48:51.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -22,3 +22,7 @@ goldrush.cfg
 goldrush.state
 
 *.sublime*
+
+# Installed via script
+utils/scalafmt/coursier
+
diff --git a/documents/buildkite/pipelines/green-river.yml b/documents/buildkite/pipelines/green-river.yml
@@ -1,5 +1,5 @@
 steps:
-  - command: "sbt '; clean; scalafmtTest; assembly'\n\n"
+  - command: "../utils/scalafmt/scalafmt.sh --test && sbt '; clean; assembly'\n\n"
     label: build and package
     agents:
       - queue=core
@@ -37,4 +37,4 @@ steps:
       TOKEN: c5e4764e4d0116e34e17c2d4e0b1e7df45aaa468
       PROJECT: stage-provisioning
       MESSAGE: Green River Updated
-    branches: master
+    branches: master
diff --git a/documents/buildkite/pipelines/phoenix-scala.yml b/documents/buildkite/pipelines/phoenix-scala.yml
@@ -2,15 +2,15 @@ env:
   ARTIFACT: gatling/target/scala-2.11/phoenix-scala-assembly-1.0.jar
 
 steps:
-  - command: sbt '; clean ; gatling/clean ; scalafmtTest ; gatling/scalafmtTest'
+  - command: ../utils/scalafmt/scalafmt.sh --test && sbt clean
     label: scalafmt
     agents:
       - queue=core
 
   - wait
 
   - command: 'bash -c "make -C docs/api all && sbt all && tar -zcvf gatling-classes.tar.gz gatling-classes"
-  
+
   '
     label: build, test, package
     agents:
@@ -22,13 +22,13 @@ steps:
 
   - command: |
       rm -rf gatling && mkdir gatling && cd gatling
-  
+
       buildkite-agent artifact download "$ARTIFACT" .
-  
+
       cd ../
-  
+
       buildkite-agent artifact download "gatling-classes.tar.gz" ./
-  
+
       rm -rf gatling-classes && tar -zxvf gatling-classes.tar.gz
     label: dump to stage master
     agents:
@@ -54,4 +54,4 @@ steps:
     env:
       TOKEN: c5e4764e4d0116e34e17c2d4e0b1e7df45aaa468
       PROJECT: stage-provisioning
-    branches: master
+    branches: master
diff --git a/green-river/.scalafmt b/green-river/.scalafmt
diff --git a/green-river/.scalafmt.conf b/green-river/.scalafmt.conf
@@ -0,0 +1 @@
+../utils/scalafmt/scalafmt.conf
diff --git a/green-river/Makefile b/green-river/Makefile
@@ -14,8 +14,7 @@ clean:
 
 test:
 	$(call header, Testing)
-	sbt scalafmtTest
-	sbt test
+	../utils/scalafmt/scalafmt.sh --test &&	sbt test
 
 docker:
 	$(call header, Dockerizing)
diff --git a/green-river/build.sbt b/green-river/build.sbt
@@ -91,9 +91,7 @@ lazy val greenRiver = (project in file(".")).
             val old = (assemblyMergeStrategy in assembly).value
             old(x)
         }
-    },
-    scalafmtConfig := Some(file(".scalafmt")),
-    reformatOnCompileSettings // scalafmt
+    }
     //test in assembly := {}
 )
 
diff --git a/green-river/project/plugins.sbt b/green-river/project/plugins.sbt
@@ -5,5 +5,3 @@ addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.13.0")
 addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.0.0-M4")
 
 addSbtPlugin("org.brianmckenna" % "sbt-wartremover" % "0.14")
-
-addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "0.2.5")
diff --git a/phoenix-scala/.scalafmt b/phoenix-scala/.scalafmt
diff --git a/phoenix-scala/.scalafmt.conf b/phoenix-scala/.scalafmt.conf
@@ -0,0 +1 @@
+../utils/scalafmt/scalafmt.conf
diff --git a/phoenix-scala/Makefile b/phoenix-scala/Makefile
@@ -21,7 +21,7 @@ clean:
 
 test:
 	$(call header, Testing)
-	sbt '; scalafmtTestAll ; test; seedDemo'
+	../utils/scalafmt/scalafmt.sh --test && sbt '; test; seedDemo'
 
 docker:
 	$(call header, Dockerizing)
diff --git a/phoenix-scala/build.sbt b/phoenix-scala/build.sbt
@@ -14,7 +14,6 @@ lazy val phoenix = (project in file("phoenix"))
   .configs(IT, ET)
   .settings(itSettings, etSettings)
   .settings(commonSettings)
-  .settings(reformatOnCompileWithItSettings)
   .settings(
     libraryDependencies ++= {
       import Dependencies._
@@ -96,20 +95,3 @@ seedDemo := (runMain in Compile in seeder).partialInput(s"$seedCommand --seedDem
 // Gatling seeds
 seedOneshot    := (runMain in Compile in seeder).partialInput(" gatling.seeds.OneshotSeeds").evaluated
 seedContinuous := (runMain in Compile in seeder).partialInput(" gatling.seeds.ContinuousSeeds").evaluated
-
-// Scalafmt
-scalafmtAll := Def.task().dependsOn(scalafmt in Compile in phoenix,
-                                    scalafmt in Test    in phoenix,
-                                    scalafmt in IT      in phoenix,
-                                    scalafmt in ET      in phoenix,
-                                    scalafmt in Compile in objectframework,
-                                    scalafmt in Compile in core,
-                                    scalafmt in Compile in seeder).value
-
-scalafmtTestAll := Def.task().dependsOn(scalafmtTest in Compile in phoenix,
-                                        scalafmtTest in Test    in phoenix,
-                                        scalafmtTest in IT      in phoenix,
-                                        scalafmtTest in ET      in phoenix,
-                                        scalafmtTest in Compile in objectframework,
-                                        scalafmtTest in Compile in core,
-                                        scalafmtTest in Compile in seeder).value
diff --git a/phoenix-scala/project/Settings.scala b/phoenix-scala/project/Settings.scala
@@ -1,6 +1,4 @@
 import Configurations._
-import org.scalafmt.sbt.ScalaFmtPlugin
-import org.scalafmt.sbt.ScalaFmtPlugin.autoImport._
 import sbt.Keys._
 import sbt._
 import sbtassembly.AssemblyKeys._
@@ -62,10 +60,7 @@ object Settings {
       "confluent"          at "http://packages.confluent.io/maven/",
       Resolver.bintrayRepo("kwark", "maven") // Slick with deadlock patch
     )
-  ) ++ scalafmtSettings ++ sourceLocationSettings ++ Revolver.settings
-
-  lazy val scalafmtSettings: Seq[Setting[_]] =
-    reformatOnCompileSettings :+ (scalafmtConfig := Some(file(".scalafmt")))
+  ) ++ sourceLocationSettings ++ Revolver.settings
 
   // Let's keep project sources in `app` directory instead of `src/scala/main`
   // I also prefer `app` over `src` because sources end up on top of list in the project tree view! -- Anna
@@ -75,7 +70,7 @@ object Settings {
   )
 
   lazy val sharedItSettings: Seq[Setting[_]] =
-    Defaults.testTasks ++ Defaults.itSettings ++ ScalaFmtPlugin.configScalafmtSettings
+    Defaults.testTasks ++ Defaults.itSettings
 
   lazy val itSettings: Seq[Setting[_]] = inConfig(IT)(sharedItSettings) ++ Seq(
       testOptions in IT := (testOptions in Test).value :+ Tests.Argument("-l", "tags.External")
diff --git a/phoenix-scala/project/Tasks.scala b/phoenix-scala/project/Tasks.scala
@@ -2,9 +2,6 @@ import sbt._
 
 object Tasks {
 
-  lazy val scalafmtAll     = taskKey[Unit]("scalafmt all the things")
-  lazy val scalafmtTestAll = taskKey[Unit]("scalafmtTest all the things")
-
   lazy val fullAssembly = taskKey[Unit]("Assembly all the things")
 
   lazy val writeVersion = taskKey[Seq[String]]("Write project version data to version file")
diff --git a/phoenix-scala/project/plugins.sbt b/phoenix-scala/project/plugins.sbt
@@ -4,6 +4,4 @@ addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.3")
 
 addSbtPlugin("com.typesafe.sbt" % "sbt-native-packager" % "1.0.0-M4")
 
-addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "0.2.10")
-
 addSbtPlugin("com.eed3si9n" % "sbt-sh" % "0.1.0")
diff --git a/utils/git-hooks/post-commit b/utils/git-hooks/post-commit
@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+set -e
+
+ROOT_DIR="$(git rev-parse --show-toplevel)"
+SCALAFMT_DIR="${ROOT_DIR}/utils/scalafmt"
+source "${SCALAFMT_DIR}"/shared-functions.sh
+
+SCALA_FILES_IN_LAST_COMMIT=$(scala_files_in_last_commit)
+
+if [ "${SCALA_FILES_IN_LAST_COMMIT}" ]; then
+  if [ ! "$(eval ${SCALAFMT_DIR}/scalafmt.sh --test ${SCALA_FILES_IN_LAST_COMMIT} &> /dev/null)" ]; then
+    echo "******************************************************************"
+    echo "     Some Scala files are not formatted properly! Please run"
+    echo "          utils/scalafmt/scalafmt-last-commit.sh"
+    echo "     to format sources changed in last commit!"
+    echo "******************************************************************"
+  else true; fi
+else true; fi
diff --git a/utils/scalafmt/coursier b/utils/scalafmt/coursier
diff --git a/utils/scalafmt/coursier.sh b/utils/scalafmt/coursier.sh
@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+set -e
+
+# Once coursier is installed, you can use binary directly if you need it.
+# If calling from other scripts, call this one to ensure binary is installed.
+
+COURSIER="$(dirname $0)/coursier"
+URL="https://github.com/coursier/coursier/raw/v1.0.0-RC3/coursier"
+
+# if binary already exists,
+if [ -a "${COURSIER}" ]; then
+  # skip download and pass all arguments from script to binary
+  "${COURSIER}" "$@"
+else
+  # download binary, make it executable and launch it with script arguments
+  echo "No coursier binary found in ${COURSIER}, installing..."
+  curl --location --output "${COURSIER}" --silent --show-error "${URL}"
+  chmod +x "${COURSIER}"
+  echo "Checking installation..."
+  echo "----------------------------------------------------------------------"
+  "${COURSIER}" --help
+  echo "----------------------------------------------------------------------"
+  echo "Looks good!"
+  echo
+  echo
+  echo
+  "${COURSIER}" "$@"
+fi
diff --git a/utils/scalafmt/scalafmt-last-commit.sh b/utils/scalafmt/scalafmt-last-commit.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -e
+
+SCALAFMT_DIR=$(dirname $0)
+
+source "${SCALAFMT_DIR}"/shared-functions.sh
+
+cd "${ROOT_DIR}"
+
+eval "${SCALAFMT_DIR}/scalafmt.sh $(scala_files_in_last_commit)"
+
+echo "     To update latest commit, run"
+echo "           git commit --all --amend --no-edit"
+echo
diff --git a/utils/scalafmt/scalafmt-version b/utils/scalafmt/scalafmt-version
@@ -0,0 +1 @@
+1.0.0-RC1
diff --git a/utils/scalafmt/scalafmt.conf b/utils/scalafmt/scalafmt.conf
@@ -0,0 +1,21 @@
+style = defaultWithAlign
+maxColumn = 111
+
+rewrite.rules = [
+    SortImports
+    RedundantBraces
+    RedundantParens
+    PreferCurlyFors
+]
+rewrite.redundantBraces.stringInterpolation = true
+
+# See https://github.com/scalameta/scalafmt/issues/960
+project.git = false
+project.excludeFilters = [
+    target
+    .ensime_cache
+]
+
+align.arrowEnumeratorGenerator = true
+spaces.afterTripleEquals = true
+importSelectors = singleLine
diff --git a/utils/scalafmt/scalafmt.sh b/utils/scalafmt/scalafmt.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -e
+
+# Not bootstrapping/installing the binary to simplify version updates.
+# Once cached, works offline well.
+
+SCALAFMT_DIR="$(dirname $0)"
+SCALAFMT_VERSION="$(cat ${SCALAFMT_DIR}/scalafmt-version)"
+
+"${SCALAFMT_DIR}/coursier.sh" launch com.geirsson:scalafmt-cli_2.11:"${SCALAFMT_VERSION}" --main org.scalafmt.cli.Cli -- --config "${SCALAFMT_DIR}/scalafmt.conf" "$@"
diff --git a/utils/scalafmt/shared-functions.sh b/utils/scalafmt/shared-functions.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+ROOT_DIR="$(git rev-parse --show-toplevel)"
+
+# Returns modified Scala/SBT files in last commit as one line
+# When calling with scalafmt, this needs an eval, e.g.
+# eval "scalafmt.sh $(scala_files_in_last_commit)"
+function scala_files_in_last_commit {
+  git diff-tree --no-commit-id --name-only -r HEAD | grep -E '\.scala$|\.sbt$'
+}
diff --git a/utils/scalafmt/update-scalafmt.sh b/utils/scalafmt/update-scalafmt.sh
@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+set -e
+
+ROOT_DIR="$(git rev-parse --show-toplevel)"
+SCALAFMT="${ROOT_DIR}/$(dirname $0)/scalafmt.sh"
+
+echo "Hey there! We're moving to a new approach with scalafmt!"
+echo "From now on, it won't ship as SBT plugin, but as a standalone executable."
+echo "You can find it in ${SCALAFMT}"
+echo "To support different workflows, you are now responsible for formatting sources."
+echo "Post-commit git hook will check if all changed Scala files are formatted."
+echo "Don't worry, you can still commit :)"
+echo "Post-commit hook provides instructions how to format and amend your commit with proper formatting."
+echo
+echo "Editor integrations are described in http://scalameta.org/scalafmt/#IntelliJ and http://scalameta.org/scalafmt/#Vim"
+echo
+echo "This script installs scalafmt with dependencies, configures git hooks and triggers initial formatting."
+echo "Running scalafmt before you pull master is important to ensure you have no formatting-only merge conflicts between scalafmt updates and configuration changes."
+echo
+read -p "Press enter to continue!"
+echo
+echo
+
+"${SCALAFMT}" --version
+echo "This is your current scalafmt version. Expected version: $(cat ${ROOT_DIR}/$(dirname $0)/scalafmt-version)"
+echo "Please report if versions don't match!"
+echo
+
+echo "Running scalafmt on all sources... (only needs to be done once!)"
+eval "${SCALAFMT} ${ROOT_DIR}"
+echo
+
+echo "Checking that sources are formatted correctly..."
+eval "${SCALAFMT} ${ROOT_DIR} --test"
+echo
+
+echo "Setting utils/git-hooks dir as a default hooks dir..."
+git config core.hooksPath "${ROOT_DIR}/utils/git-hooks"
+echo
+echo
+echo "All done! Happy hacking!"

Original file line number	Diff line number	Diff line change
`@@ -91,9 +91,7 @@ lazy val greenRiver = (project in file(".")).`
`91`	`91`	`val old = (assemblyMergeStrategy in assembly).value`
`92`	`92`	`old(x)`
`93`	`93`	`}`
`94`		`- },`
`95`		`- scalafmtConfig := Some(file(".scalafmt")),`
`96`		`- reformatOnCompileSettings // scalafmt`
	`94`	`+ }`
`97`	`95`	`//test in assembly := {}`
`98`	`96`	`)`
`99`	`97`