<p data-line="0" class="code-line">iOSアプリ/Swift開発において、コードの品質と可読性を保つための Lint と Formatter についてまとめました。</p>
<h2 id="%E7%9B%AE%E7%9A%84%E3%81%A8%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88" data-line="2" class="code-line">
<a class="header-anchor-link" href="#%E7%9B%AE%E7%9A%84%E3%81%A8%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88" aria-hidden="true"></a> 目的とメリット</h2>
<h3 id="lint%EF%BC%88%E9%9D%99%E7%9A%84%E8%A7%A3%E6%9E%90%E3%83%84%E3%83%BC%E3%83%AB%EF%BC%89" data-line="4" class="code-line">
<a class="header-anchor-link" href="#lint%EF%BC%88%E9%9D%99%E7%9A%84%E8%A7%A3%E6%9E%90%E3%83%84%E3%83%BC%E3%83%AB%EF%BC%89" aria-hidden="true"></a> Lint（静的解析ツール）</h3>
<ul data-line="5" class="code-line">
<li data-line="5" class="code-line">目的
<ul data-line="6" class="code-line">
<li data-line="6" class="code-line">潜在的なバグやアンチパターン、非推奨な書き方を検出</li>
<li data-line="7" class="code-line">クラスやメソッドの行数、複雑度を監視し、巨大化を防ぐことにより保守性を担保</li>
</ul>
</li>
</ul>
<h3 id="formatter%EF%BC%88%E3%82%B3%E3%83%BC%E3%83%89%E6%95%B4%E5%BD%A2%E3%83%84%E3%83%BC%E3%83%AB%EF%BC%89" data-line="9" class="code-line">
<a class="header-anchor-link" href="#formatter%EF%BC%88%E3%82%B3%E3%83%BC%E3%83%89%E6%95%B4%E5%BD%A2%E3%83%84%E3%83%BC%E3%83%AB%EF%BC%89" aria-hidden="true"></a> Formatter（コード整形ツール）</h3>
<ul data-line="10" class="code-line">
<li data-line="10" class="code-line">目的
<ul data-line="11" class="code-line">
<li data-line="11" class="code-line">コードの整形ルールを強制し、スタイルを統一</li>
<li data-line="12" class="code-line">インデントや改行、スペースなどの表記揺れを自動で修正し、可読性を向上</li>
</ul>
</li>
</ul>
<h3 id="%E5%85%B1%E9%80%9A%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88%3A" data-line="14" class="code-line">
<a class="header-anchor-link" href="#%E5%85%B1%E9%80%9A%E3%81%AE%E3%83%A1%E3%83%AA%E3%83%83%E3%83%88%3A" aria-hidden="true"></a> 共通のメリット:</h3>
<ul data-line="15" class="code-line">
<li data-line="15" class="code-line">開発チーム全体のコード品質・一貫性が向上</li>
<li data-line="16" class="code-line">読みやすく保守しやすいコード</li>
<li data-line="17" class="code-line">レビューでスタイル指摘（「ここはスペース空けて」等）に時間を使わず、本質的なレビューに集中が可能</li>
</ul>
<h2 id="%E4%BB%A3%E8%A1%A8%E7%9A%84%E3%81%AA%E3%83%84%E3%83%BC%E3%83%AB" data-line="19" class="code-line">
<a class="header-anchor-link" href="#%E4%BB%A3%E8%A1%A8%E7%9A%84%E3%81%AA%E3%83%84%E3%83%BC%E3%83%AB" aria-hidden="true"></a> 代表的なツール</h2>
<ul data-line="21" class="code-line">
<li data-line="21" class="code-line">
<a href="https://github.com/realm/SwiftLint" target="_blank" rel="nofollow noopener noreferrer">SwiftLint</a> (Lint)</li>
<li data-line="22" class="code-line">
<a href="https://github.com/nicklockwood/SwiftFormat" target="_blank" rel="nofollow noopener noreferrer">SwiftFormat</a> (Formatter)</li>
<li data-line="23" class="code-line">
<a href="https://github.com/swiftlang/swift-format" target="_blank" rel="nofollow noopener noreferrer">swift-format</a> (Lint + Formatter)</li>
</ul>
<p data-line="26" class="code-line">現段階では、 SwiftLint + SwiftFormat の併用が主流で、柔軟なルール設定が可能です。<br>
ただ、 swiftlang/swift-format は Apple 公式のため、長期的には主流になっていく可能性があります。</p>
<h2 id="%E5%AE%9F%E6%A1%88%E4%BB%B6%E3%81%A7%E3%81%AE%E9%81%8B%E7%94%A8%E4%BE%8B" data-line="29" class="code-line">
<a class="header-anchor-link" href="#%E5%AE%9F%E6%A1%88%E4%BB%B6%E3%81%A7%E3%81%AE%E9%81%8B%E7%94%A8%E4%BE%8B" aria-hidden="true"></a> 実案件での運用例</h2>
<p data-line="30" class="code-line">SwiftFormat の GitHub のページでは下記のような使用例が挙げられています。</p>
<ul data-line="32" class="code-line">
<li data-line="32" class="code-line">手動で、あるいは他のツールチェーンの一部として実行するコマンドラインツール</li>
<li data-line="33" class="code-line">Xcode 内の [Editor] &gt; [SwiftFormat] メニューから呼び出せる Source Editor Extension</li>
<li data-line="34" class="code-line">Cmd-R や Cmd-B を押すたびに実行される、Xcode プロジェクトの Build Phase</li>
<li data-line="35" class="code-line">ファイルをチェックインする前に変更箇所に対して実行される Git pre-commit フック</li>
</ul>
<p data-line="37" class="code-line">上記の内容を踏まえて開発現場での、運用例の一例を紹介します。<br>
実際のスクリプトや導入方法については、それぞれの GitHub レポジトリにも記載があるため、こちらの記事では割愛します。</p>
<h3 id="%E3%83%AD%E3%83%BC%E3%82%AB%E3%83%AB%E7%92%B0%E5%A2%83" data-line="40" class="code-line">
<a class="header-anchor-link" href="#%E3%83%AD%E3%83%BC%E3%82%AB%E3%83%AB%E7%92%B0%E5%A2%83" aria-hidden="true"></a> ローカル環境</h3>
<h4 id="formatter" data-line="41" class="code-line">
<a class="header-anchor-link" href="#formatter" aria-hidden="true"></a> Formatter</h4>
<ul data-line="42" class="code-line">
<li data-line="42" class="code-line">ビルド時に実行する Script を追加し自動実行
<ul data-line="43" class="code-line">
<li data-line="43" class="code-line">常に整形された状態でコミットすることで、差分をきれいに保つ</li>
</ul>
</li>
</ul>
<h4 id="lint" data-line="45" class="code-line">
<a class="header-anchor-link" href="#lint" aria-hidden="true"></a> Lint</h4>
<ul data-line="46" class="code-line">
<li data-line="46" class="code-line">ビルド時に実行する Script を追加し Xcode 上に Warning/Error を表示
<ul data-line="47" class="code-line">
<li data-line="47" class="code-line">開発者は Warning/Error を確認し、手動で修正</li>
</ul>
</li>
</ul>
<h3 id="ci%E7%92%B0%E5%A2%83" data-line="49" class="code-line">
<a class="header-anchor-link" href="#ci%E7%92%B0%E5%A2%83" aria-hidden="true"></a> CI環境</h3>
<ul data-line="50" class="code-line">
<li data-line="50" class="code-line">PR作成時などにチェックを実行</li>
<li data-line="51" class="code-line">ルール違反（Lintエラーやフォーマット未適用）があればCI失敗</li>
</ul>
<h2 id="%E8%A3%9C%E8%B6%B3%E8%AA%AC%E6%98%8E%E3%81%A8%E6%B3%A8%E6%84%8F%E7%82%B9" data-line="53" class="code-line">
<a class="header-anchor-link" href="#%E8%A3%9C%E8%B6%B3%E8%AA%AC%E6%98%8E%E3%81%A8%E6%B3%A8%E6%84%8F%E7%82%B9" aria-hidden="true"></a> 補足説明と注意点</h2>
<h3 id="swiftlint%E3%81%AE%E8%87%AA%E5%8B%95%E4%BF%AE%E6%AD%A3" data-line="54" class="code-line">
<a class="header-anchor-link" href="#swiftlint%E3%81%AE%E8%87%AA%E5%8B%95%E4%BF%AE%E6%AD%A3" aria-hidden="true"></a> SwiftLintの自動修正</h3>
<p data-line="55" class="code-line">SwiftLintには --fix (autocorrect) 機能がありますが、フォーマッターとしては不十分です。<br>
「空白を削除する」などはできますが、「改行を入れて読みやすくする」といった構造的な整形はしません。<br>
そのため、可読性を高めるための構造的な整形や、厳密なスタイル統一を行いたい場合には、SwiftFormat との併用がおすすめです。</p>
<h3 id="%E3%83%84%E3%83%BC%E3%83%AB%E9%96%93%E3%81%AE%E3%83%AB%E3%83%BC%E3%83%AB%E3%81%AE%E7%AB%B6%E5%90%88" data-line="59" class="code-line">
<a class="header-anchor-link" href="#%E3%83%84%E3%83%BC%E3%83%AB%E9%96%93%E3%81%AE%E3%83%AB%E3%83%BC%E3%83%AB%E3%81%AE%E7%AB%B6%E5%90%88" aria-hidden="true"></a> ツール間のルールの競合</h3>
<p data-line="60" class="code-line">SwiftLint と SwiftFormat を併用する場合、ルールが競合することがあります。<br>
下記の例は両ツールでデフォルトルールのままですが、コンフリクトが発生します。</p>
<ul data-line="63" class="code-line">
<li data-line="63" class="code-line">例：末尾のカンマ (Trailing Comma)
<ul data-line="64" class="code-line">
<li data-line="64" class="code-line">SwiftFormat: 配列の最後の要素にもカンマをつけようとする（diffが見やすいため）</li>
<li data-line="65" class="code-line">SwiftLint: 「余計なカンマがある」とWarningを出す</li>
</ul>
</li>
</ul>
<div class="code-block-container"><pre><code class="code-line" data-line="67">let array = [
    "A",
    "B",
]
</code></pre></div><p data-line="74" class="code-line">基本的に Formatter（SwiftFormat）を優先し、SwiftLint側の競合するルールを無効化（disabled_rules）するのが良いかと思います。</p>


Swift での Lint と Formatter の整理

Discussion