コードフォーマッターのススメ

コードフォーマッター使ってますか?

チームで開発する際、各々が好きなルールでコーディングしてしまうと、思わぬバグを生んでしまったり、コードレビューも大変です。

コーディングルールを決めて、守ってもらうことが大事ですが、やはりツールで自動化できるところは、自動化したいですね。

今回はSwiftコードフォーマッターのSwimatの紹介です。

Swimat

Swimatは非常にシンプルなコードフォーマット機能を提供するXcodeプラグインです。(現行ver1.6.2時点では)フォーマット設定のオプションは2つのみです。

もっと複雑なルールを設定できるコードフォーマッターもありますが、私の経験上、開発の現場でそれらの設定を思い通りに統一することはなかなか困難です。割り切って、フォーマッター標準の設定で統一してしまったほうが良いとも考えます。

そういう意味でもSwimatの手軽さは魅力のひとつです。

導入

環境

  • macOS 10.15.4
  • Xcode 11.4.1

インストール

  1. 最新のバイナリをダウンロードし、適当な場所に解凍します。
  2. Swimat.appを一度立ち上げて、機能を動作させます。
  3. Macの[システム環境設定] > [拡張機能] > [Xcode Source Editor] > [Swimat] にチェックをいれます。

ホットキー設定

[Xcode] > [Preferences ..] > [Key Bindings]でホットキーを作成することもできます。

動作確認

良い感じ。