Help us understand the problem. What is going on with this article?

Xcodeで使えるSwiftコードフォーマッター「Swimat」をつかってみた

More than 1 year has passed since last update.

Swimatとは

会社の人にXcodeでつかえるSwiftコードフォーマッター Swimat を教えてもらったのでつかってみました。

Swimatがどういうものかは、GitHub - Jintin/Swimat: An Xcode formatter plug-in to format your swift code. のGIFアニメがわかりやすいです。

01-01.png

01-02.png

このように、一定のルールに従って空白やインデントを入れたり消したりして、コードを読みやすくしてくれます。

インストールしてみよう

Swimatは、homebrew-caskでインストールします。
もし、homebrewがインストールされていない場合は、事前にHomebrew-Caskからインストールしてください。

まず、ターミナルを開いて、つぎのコマンドを実行します。

brew cask install swimat

つぎに、Swimatのアプリをダウンロードします。

02.png

ダウンロードしたSwimatのアプリを起動します。

03.png

Swimatの画面が表示されるので、内容をよく読んだら閉じます。

04.png

システム環境設定を開いて、機能拡張をクリックします。

05.png

画面左のXcode Source Editorをクリックして、右側のSwimatをチェックします。

Xcodeを起動している場合は、再起動してください。

つかってみよう

06.png

Xcodeでフォーマットしたいファイルを選択して、メニューのEditor > Swimat > Fromatをクリックします。青色の選択部分のコードにご注目。

07.png

あっというまに、きれいなコードのできあがりです。

おまけ(ショートカットで楽々フォーマット)

毎回メニューから実行するのは大変なのでショートカットを設定します。

08.png

XcodeのメニューのXcode > Preferencesを開いて、Key Bindingsをクリックします。

09.png

検索欄に Swi と入力すると、Swimatが表示されます。

10.png

Key欄をダブルクリックしてから、割り当てたいショートカットキーをキーボードで押します(すでに割り当て済みの場合は、右側に黄色い三角や赤い丸のエラーマークが表示されるので、別のキーを割り当てましょう)。
保存するついでにフォーマットするのが良さそうなので、 option + S にしてみました。

11.png

メニューで確認すると、バッチリショートカットキーが割り当てられています。

おまけ(SwiftFormat)

SwiftFormat というコードフォーマッターもあるので、興味があるかたはご覧ください。

GitHub - nicklockwood/SwiftFormat: A code library and command-line formatting tool for reformatting Swift code

12.png

こちらのスクリーンショットのように、Githubにフォーマットのルールがたくさん掲載されています。不要な空白はなくしましょう、というようなものから

13.png

数値の3桁区切りに _ を入れましょう、みたいなものまでいろいろとあります(3桁区切りの _ 知りませんでした)。

ざっと眺めるだけでもコードの書き方の勉強になりますね。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
Comments
No comments
Sign up for free and join this conversation.
If you already have a Qiita account
Why do not you register as a user and use Qiita more conveniently?
You need to log in to use this function. Qiita can be used more conveniently after logging in.
You seem to be reading articles frequently this month. Qiita can be used more conveniently after logging in.
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
ユーザーは見つかりませんでした