scalafix で利用できる汎用的なリファクタリングルール
If you would like the README written in English, please click here.
ThisBuild / scalafixDependencies += "net.pixiv" %% "scalafix-pixiv-rule" % "<VERSIONS>"不要な行末セミコロンを削除します。セミコロン後に行が接続されている場合には削除しません。
/* rule = UnnecessarySemicolon */
val x = 3; // rewrite to: `val x = 3`
val a = 1; val b = 2非推奨の矢印 (→, ⇒) 文字を ->, => に置換します。
/* rule = UnifiedArrow */
List(1 → "a", 2 → "b", 3 → "c").map { // rewrite to: List(1 -> "a", 2 -> "b", 3 -> "c").map {
case (_, s) ⇒ s // rewrite to: case (_, s) => s
}Seq のインデックスによる最初の要素へのアクセスを head 呼び出しに置換します。
/* rule = ZeroIndexToHead */
Seq(1, 2, 3)(0) // rewrite to: `Seq(1, 2, 3).head`Option や Seq の空チェックに isEmpty, nonEmpty, isDefined を利用するように置き換えます。
/* rule = CheckIsEmpty */
Some(1) == None // rewrite to: Some(1).isEmpty
Some(1).nonEmpty // if `CheckIsEmpty.alignIsDefined = true` then rewrite to Some(1).isDefinedException を継承した case class の定義に警告を発生させます。
これは、 case class として実装することにより、例外の階層化や一意性による恩恵が損なわれるためです。
/* rule = NonCaseException */
case class NonCaseException(msg: String) extends RuntimeException(msg)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
case class として Exception を継承することは推奨されません: NonCaseException型変数指定のない List() や List.empty を Nil に置き換えます。
これは、 Nil が List[Nothing] として定義されているためです。
また、型変数指定のある List[Any]() は List.empty[Any] へと置換されます。
/* rule = EmptyListToNil */
val empty = List.empty // rewrite to: val empty = Nil
val list = List[String]() // rewrite to: val list = List.empty[String]単一の case しか持たないパターンマッチを分解します。
また、 Some.unapply のみが利用されているパターンを foreach 呼び出しに置換します。
※このルールではインデントが破壊されることがあります。必ずフォーマッターと併用してください
/* rule = SingleConditionMatch */
Some(1) match {
case result => println(result)
}
/* rewrite to:
* println(Some(1))
*/技術的な問題により、ネストされたパターンでは、最深のものだけが置換されます。
/* rule = SingleConditionMatch */
Some(1) match {
case result =>
result match {
case result => println(result)
}
}
/* rewrite to:
* Some(1) match {
* case result =>
* println(result)
* }
*/Mockito を Scala で使う場合の記法を統一します。
when/then 構文は戻り値型のチェックを受けられる反面で、 void (Unit) を返却したい場合は使えないなどのデメリットがあります。 このルールでは、 when/then 構文で書かれたテストコードを do/when 構文に置き換えます。
/* rule = MockitoThenToDo */
Mockito.when(a.hoge()).thenReturn("mock1").thenReturn("mock2")
when(a.fuga).thenReturn("mock")
/* rewrite to:
* Mockito.doReturn("mock1").doReturn("mock2").when(a).hoge()
* Mockito.doReturn("mock").when(a).fuga
*/ScalatestのExceptionのassertionを統一します。
using_assertionsのドキュメントで、Exceptionsのassertionの場合にはassertThrowsとinterceptがありますが、 二つの違いはinterceptはExceptionsを値として返し、assertThrowsは返さないという振る舞いをします。
このルールではassertThrowsをinterceptに変更するものです。
/* rule = ScalatestAssertThrowsToIntercept */
assertThrows[RuntimeException]{
a.hoge()
}
/* rewrite to:
* intercept[RuntimeException]{
* a.hoge()
* }
*/RuntimeException を継承した class の定義にメッセージが付与されていない場合は警告を発生させます。
これは、エラー通知時の識別を可能にするためです。
/* rule = NeedMessageExtendsRuntimeException */
class RedException extends RuntimeException {}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
RuntimeException を継承したクラスを作る際にはメッセージを付与してください: RedException
*/ある命名規則に倣ったクラスが適切でないパッケージにある場合に警告を発生させます。
例えば、 Play Framework を利用している場合に、
Controller と命名されたクラスが filters ディレクトリをないことを要求します。
/*
rule = NamingConventionPackage
NamingConventionPackage.convention = [
{ package = "^filters$", class = "^.+Controller$" }
]
*/
package filters
// class HomeController は filters パッケージに実装すべきではありません
class HomeController {}Jakarta EE 9 から変更された名前空間に対応した書き換えルール。
javax.* 名前空間を jakarta.* に変更します。
変更されるパッケージの完全なリストはこちら。
/* rule = PackageJavaxToJakarta */
package fix.pixiv
import javax.inject.Inject // rewrite to: import jakarta.inject.Inject
class PackageJavaxToJakarta @Inject()() {
}