Xcodeでコードを整形して読みやすくしたい。
やること
- XcodeにAlcatrazをいれる
- AlcatrazからClangFormatをいれる
- 整形する
- 設定ファイルを書いてカスタマイズする
- おまけ
XcodeにAlcatrazをいれる
まずはXcode用のパッケージマネージャーであるAlcatrazをいれる。
Xcode7以上じゃないとダメなので注意。
公式にあるコマンドを叩けばおｋ。
curl -fsSL https://raw.githubusercontent.com/supermarin/Alcatraz/deploy/Scripts/install.sh | sh
Xcodeを再起動して、メニューバーのWindowにPackage Managerが追加されていればおｋ。
AlcatrazからClangFormatをいれる
次に、AlcatrazからClangFormatをいれる。
オプションでフォーマット時のルールを設定することができる。
日本語のサイトもあるので助かる。
XcodeのメニューバーのWindow -> Package Managerを押してAlcatrazを起動させる。
上部の検索ボックスに「clang」とかいれるとひっかかるので、INSTALLを押す。
再度Xcodeを再起動して、メニューバーのEditにClang Formatが追加されていればおｋ。
整形する
適当なプロジェクトを用意して、
適当にコードを書き、
メニューバーのEdit -> Clang Format -> Format Selected Filesを押すと、
整形される。
整形？？？？？？？？？？？？？？？？？？
設定ファイルを書く
デフォルトで整形のフォーマットがいくつか用意されているが、どれもしっくりこないので自分で設定を書く。
プロジェクトファイルの親以上のディレクトリに.clang-formatという設定ファイルを置き、どういうふうに整形するかを記述していく。
今回はとりあえずシンプルに、変数宣言のインデントを揃える設定を書く。
# 連続する行の代入演算子を揃える
AlignConsecutiveAssignments: true
# 連続する行の宣言を揃える
AlignConsecutiveDeclarations: true
# * や & の位置
PointerAlignment: Left
設定の詳細はClang-Format Style Options — Clang 4.0 documentationか、日本語でみたい場合はこちらで確認できる。
次に、整形時に.clang-formatの設定を使用するようにする。
ニューバーのEdit -> Clang Format -> Fileを押すだけ。
するとFileにチェックがはいるので、この状態でもう一度整形をしてみる。
すると、
ちょっとよさげになった。（気がする）
この辺りは個人の好みだったりするので、追求しないことにする。
とりあえずカスタマイズできるようになったのでおｋ。
おまけ
毎回メニューバーから操作するのはめんどうなので、ショートカットを登録する。
システム環境設定 -> キーボード -> ショートカット -> アプリケーションを選択した状態で、+ボタンを押す。
アプリケーションはXcode.appを選択。
メニュータイトルはFormat Selected Filesを入力。
キーボードショートカットにフォーカスした状態で、割り当てたいショートカットキーを押す。
（今回はshift + command + eに割り当てた）
最後に追加ボタンを押すと↓に追加される。
これで、Xcodeでshift + command + eを押すだけでファイルを整形できるようになる。
というね。