scalariformかけるとDSL形式のインデントが崩れる

scalikejdbcやWSClientなんかでDSLっぽく書いたプログラムがscalariformかけるとインデント崩れする問題を解決するために調べたメモとなります。

scalariformとは

コンパイルと同時にコード整形してくれる便利なツールです。コードの書き方が統一されるので大規模であればあるほど保守性が高くなるはず。

GitHub - sbt/sbt-scalariform: sbt plugin adding support for source code formatting using Scalariform

sbt plugin adding support for source code formatting using Scalariform - sbt/sbt-scalariform

github.com

コード整形の細かい調整はこちら

GitHub - scala-ide/scalariform: Scala source code formatter

Scala source code formatter. Contribute to scala-ide/scalariform development by creating an account on GitHub.

github.com

自分が使っている設定抜粋

参考までに自分が使っているbuild.sbtの設定の抜粋です。

Seq(
  scalariformPreferences := scalariformPreferences.value
    .setPreference(AlignParameters, true)
    .setPreference(AlignArguments, true)
    .setPreference(AlignSingleLineCaseStatements, true)
    .setPreference(DoubleIndentConstructorArguments, true)
    .setPreference(DoubleIndentMethodDeclaration, true)
    .setPreference(IndentWithTabs, false)
    .setPreference(IndentSpaces, 2)
    .setPreference(PlaceScaladocAsterisksBeneathSecondAsterisk, true)
    .setPreference(DanglingCloseParenthesis,  scalariform.formatter.preferences.Force)
)

そのままコード整形すると

クラス定義は省略しますがDSLっぽく書くと各ステップごとにインデントが深くなってしまいます。(インデント2スペースなので少しわかりづらいかもしれませんが・・・)

  def test(): Unit = {
    Await.result(
      ws.url(
        "https://shimer-system.com"
      ).withHttpHeaders(
          ("Content-Type", "application/json")
        ).post(
            Json.obj(
              "submittedAt" -> System.currentTimeMillis(),
              "fields" -> Json.arr(
                Json.obj(
                  "name" -> "email",
                  "value" -> "test@shimer-system.com"
                )
              )
            ).toString()
          ).map { res =>
              println("======================")
              println(res.status + ":" + res.statusText)
              println(res.body)
              println("======================")
            },
      Duration.Inf
    )
  }

formatのON/OFFを切り替える方法

scalariformの丁度いい設定が見つからなかったので少し強引ですが、コメントで
// format: OFF
または
// format: ON
をいれることでフォーマット対象のコードを細かく指定できます。

  def test(): Unit = {
    // format: OFF
    Await.result(
      ws.url(
        "https://shimer-system.com"
      ).withHttpHeaders(
        ("Content-Type", "application/json")
      ).post(
        Json.obj(
          "submittedAt" -> System.currentTimeMillis(),
          "fields" -> Json.arr(
            Json.obj(
              "name" -> "email",
              "value" -> "test@shimer-system.com"
            )
          )
        ).toString()
      ).map { res =>
        println("======================")
        println(res.status + ":" + res.statusText)
        println(res.body)
        println("======================")
      },
      Duration.Inf
    )
    // format: ON
  }