ScalafixやWartremoverの独自ルールを仕事で活用する

class: center, middle

# ScalafixやWartremoverの独自ルールを仕事で活用する

ScalaMatsuri 2020
アンカンファレンス

---
class: middle

- twitter [@xuwei_k](https://twitter.com/xuwei_k)
- github [@xuwei-k](https://github.com/xuwei-k)
- blog <https://xuwei-k.hatenablog.com>

---
class: middle

---
class: middle

- 毎回強制にしてもいいが、厳しすぎてダルい、他のpull reqとコンフリクトしたら辛いので、現在は週一回全自動削除pull reqが来る運用にしている

<https://scalacenter.github.io/scalafix/docs/rules/RemoveUnused.html>

---
class: middle

---
class: middle

2番目の要素だけ使うならevalでいいのに、なぜかapplyが大量に使われていたので

- <https://github.com/scalaz/scalaz/blob/v7.2.30/core/src/main/scala/scalaz/StateT.scala#L8-L21>

---
class: middle

<pre>
<code class="scala hljs remark-code" style="font-size: 60%;">
import scalafix.v1.{Patch, SemanticDocument, SemanticRule}
import scala.meta._
import scalafix.v1._

class ReplaceScalazState extends SemanticRule("ReplaceScalazState") {

override def fix(implicit doc: SemanticDocument): Patch = {
    doc.tree.collect {
      case t: Term.Apply
          if t.fun.symbol.displayName == "apply" && t.symbol.owner.value == "scalaz/IndexedStateT#" && t.args.size == 1 =>
        val Term.Select(_, method) = t.fun
        Patch.replaceTree(method, "eval")
      case t: Defn.Val if t.pats.size == 1 && t.rhs.symbol.owner.value == "scalaz/IndexedStateT#" =>
        t.pats match {
          case List(x @ Pat.Tuple(List(Pat.Wildcard(), p))) =>
            Patch.replaceTree(x, p.toString)
          case _ =>
            Patch.empty
        }
    }.asPatch
  }
}
</code>
</pre>

---
class: middle

どちらでもいいけど、混在してるの微妙なので揃えたかった

---
class: middle

<pre>
<code class="scala hljs remark-code" style="font-size: 60%;">
import scala.meta._
import scalafix.v1._

class ScalazEitherInfix extends SemanticRule("ScalazEitherInfix") {
  override def fix(implicit doc: SemanticDocument): Patch = {
    doc.tree.collect {
      case x: Type.Apply if """scalaz/`\/`#""" == x.tpe.symbol.value && x.args.size == 2 =>
        Patch.replaceTree(x, s"""${x.args(0)} \\/ ${x.args(1)}""")
    }.asPatch
  }
}
</code>
</pre>

---
class: middle

---
class: middle

<pre>
<code class="scala hljs remark-code" style="font-size: 60%;">
import scalafix.v1._
import scala.meta.Pat.{ Extract, Wildcard }
import scala.meta.Term.Select
import scala.meta._

class NonFatalLog extends SemanticRule("NonFatalLog") {
  override def fix(implicit doc: SemanticDocument): Patch = {
    doc.tree.collect {
      case c @ Case(Extract(x, List(Wildcard())), None, _) =>
        // ↑ try catchのcase部分かつWildcardで潰してるやつ取り出し
        val patch1 = x match {
          case Select(_, Term.Name("NonFatal")) =>
            // 歴史的都合で `case scala.util.control.NonFatal(_)` となってる部分あったからついでに書き換え
            Option(Patch.addGlobalImport(importer"scala.util.control.NonFatal"))
          case Term.Name("NonFatal") =>
            Option(Patch.empty)
          case _ =>
            None
        }
        patch1.map { p =>
          List(
            p,
            Patch.addGlobalImport(importer"独自のLoggerのimport追加"),
            Patch.replaceTree(
              c.pat,
              s"NonFatal(e)" // 変数bindするように変更
            ),
            Patch.replaceTree(
              c.body,
              s"""変数 `e` と、独自のLogger使ってログ出す処理。 ${c.body} はそのまま後ろに残す """
            )
          ).asPatch
        }.asPatch
    }.asPatch
  }
}
</code>
</pre>

---
class: middle

---
class: middle

使い捨てなので完全に波動拳な雑コードで草

---
class: middle

---
class: middle

---
class: middle

---
class: middle

- <https://github.com/liancheng/scalafix-organize-imports>
- それぞれがIDEの設定バラバラだと、特に変える必要ないのに毎回import部分が変更されてしまう
- 差分が意味なく増えるだけならまだしも、意味のないコンフリクトにつながる
- このorganize-importとscalafmt組み合わせることにより、import文をほぼ強制的に一意にする
- 導入後、コンフリクトする確率が実際にたぶん減った、はず

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

これもある意味仕事でやる必要があったから

- [play-wsのstandalone版に自動書き換えするscalafixのruleを書いた](https://xuwei-k.hatenablog.com/entry/2020/03/25/112953)
- https://github.com/xuwei-k/play-ws-scalafix

---
class: middle

scalafix本体への貢献

[improve RemoveUnused rule](https://github.com/scalacenter/scalafix/pull/1114)

---
class: middle

`Throwable` から `NonFatal` に書き換え

https://gist.github.com/xuwei-k/3fa03b1c9f1f55bbd830c35f04e5e19a

作れたから作ったが、これは単にgrepやsedでいけるような・・・

---
class: middle

# ここから独自Wartremoverの話

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

---
class: middle

- https://stackoverflow.com/a/26585903
- https://github.com/slick/slick/blob/eecc74fa1ba8e477e6fbd991b5b9bbb87b8f3918/slick/src/main/scala/slick/ast/Node.scala#L170-L173

---
class: middle

---
class: middle

---
class: middle

---
class: middle