play-migrations-scalafix-rules

While these rules won't cover the entire migration process, they should at least help automate the most tedious tasks.

Some rules are complex (e.g. MigrateControllers) and will likely not cover all use cases or generate code that may not compile. If that's the case you will need to finish the migration manually.

Usage

Start by installing the sbt plugin in project/plugins.sbt

// project/plugins.sbt (for sbt 0.13.x)
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.29") // final sbt 0.13.x version
dependencyOverrides += "ch.epfl.scala" % "scalafix-interfaces" % "0.10.3"

// project/plugins.sbt (for sbt 1.x)
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.10.3")

... then add custom rules

// build.sbt
scalafixDependencies in ThisBuild ++= List(
  "com.typesafe.play.contrib" %% "play-migrations-v25-to-v26-scalafix-rules" % "0.1.0-SNAPSHOT",
  "com.typesafe.play.contrib" %% "play-migrations-v26-to-v27-scalafix-rules" % "0.1.0-SNAPSHOT"
)

$ sbt
> scalafixEnable
> scalafix MigrateControllers

... then remove the plugin and all rules once you're done.

Advanced Usage

When you have multiple projects that need migration, it is easier to enable the plugin globally in ~/.sbt/0.13/ instead of editing each project.

// ~/.sbt/0.13/plugins/plugins.sbt
addSbtPlugin("ch.epfl.scala" % "sbt-scalafix" % "0.9.29")

// ~/.sbt/0.13/plugins/PlayFixPlugin.scala

import sbt._
import Keys._
import scalafix.sbt.ScalafixPlugin
import scalafix.sbt.ScalafixPlugin.autoImport._

object PlayFixPlugin extends AutoPlugin {
  override def trigger: PluginTrigger = allRequirements
  override def requires: Plugins = ScalafixPlugin

  override def buildSettings: Seq[Setting[_]] =
    List(
      scalafixDependencies ++= List(
        "com.typesafe.play.contrib" %% "play-migrations-v23-to-v24-scalafix-rules" % "0.1.0-SNAPSHOT",
        "com.typesafe.play.contrib" %% "play-migrations-v24-to-v25-scalafix-rules" % "0.1.0-SNAPSHOT",
        "com.typesafe.play.contrib" %% "play-migrations-v25-to-v26-scalafix-rules" % "0.1.0-SNAPSHOT",
        "com.typesafe.play.contrib" %% "play-migrations-v26-to-v27-scalafix-rules" % "0.1.0-SNAPSHOT"
      ),
      scalafixConfig := Some(file("~/shared/scalafix.conf")) // see examples
    )

  override def projectSettings: Seq[Setting[_]] =
    List(
      libraryDependencies ++= List(
        "com.typesafe.play.contrib" %% "play-migrations-v23-to-v24-adapters" % "0.1.0-SNAPSHOT"
      )
    )
}

... then run the rules in any sbt 0.13.x project

$ sbt
> scalafixEnable
> scalafix

... it will use the global plugin and run all migrations you specified in the config file.

For developers:

Run only a single test :

$ sbt
> tests26/testOnly -- -z WS