【Swift】SwiftLint(静的解析ツール)の導入と使い方!アプリの中身をチェック

【Swift】SwiftLint(静的解析ツール)の導入と使い方!アプリの中身をチェック

この記事からわかること

  • Swiftで使える静的解析ツールとは?
  • SwiftLint使い方
  • アプリ中身自動チェックする方法
  • .swiftlint.yml書き方
  • Command PhaseScriptExecution failed with a nonzero exit codeの解決法

\ アプリをリリースしました /

みんなの誕生日

友達や家族の誕生日をメモ!通知も届く-みんなの誕生日-

posted withアプリーチ

環境

静的解析ツールとは?

静的解析ツールとはプログラムが記法や規約に対して則っているかを自動で解析するためのツールです。

これを使用することで準じていない部分が分かりやすく表示されるようになるので、普段の開発業務やレビュー業務を効率化することができます。

SwiftLintとは?

公式リファレンス:SwiftLint

SwiftLintはSwiftで使用できる静的解析ツールです。チェックできる項目は多く、インデントやスペース、変数の命名などなかなか人では気づきにくい部分もツールを使用することで簡単に識別することが可能です。

またSwiftLintではチェックするファイル自体や細かいルールもカスタマイズすることができるようになっています。

導入方法

SwiftLintHomebrewCocoa Podsを使用して導入することが可能です。

Homebrewでインストール

おすすめ記事:【Mac】Homebrewインストール方法!

HomebrewはMacOS(及びLinux)のパッケージ管理システムです。ターミナルからSwiftLintを使用するためにコマンドラインでXcodeが使用できるかを確認しておきます。以下コマンドでバージョンが返ってくるか試しておきます。

$ xcode-select --version
xcode-select version 2396.

問題なければSwiftLintをインストールします。

$ brew install swiftlint

Cocoa Podsでインストール

おすすめ記事:【Swift UI】CocoaPodsのインストール方法と使い方

Cocoa PodsはObjective-CまたはSwiftのライブラリ管理ツールです。インストール方法は他のライブラリと変わらず以下の文を「PodFile」に書き込んでpod installを実行するだけです。

pod 'SwiftLint'
$ pod install

静的解析の使い方と実行方法

SwiftLintを実行する方法はいくつかありますが、今回はXcode内からRun Scriptに組み込む形で実行させるようにしていきます。これでアプリをビルドした際に自動で実行されます。

おすすめ記事:【Swift/Xcode】Run Scriptの設定方法!ビルド時に処理を実行する

まずはXcodeから「TARGET」>「Build Phases」>「Run Script」をクリックします。もしなければ上部の「+」をクリックし「New Run Script Phase」で追加してください。

【Swift】SwiftLint(静的解析ツール)の導入と使い方!アプリの中身をチェック

追加できたらコードブロックの中に以下を書き込みます。

【Swift】SwiftLint(静的解析ツール)の導入と使い方!アプリの中身をチェック

Homebrew

if which swiftlint >/dev/null; then
  swiftlint
else
  echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi

Cocoa Pods

if which "${PODS_ROOT}/SwiftLint/swiftlint" >/dev/null; then
    ${PODS_ROOT}/SwiftLint/swiftlint
else
    echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi

Based on dependency analysis」のチェックは外しておいてください。

あとはプロジェクトをビルド(Cmd + B)すれば自動でSwiftLintが働きコードをチェックしてくれます。すると以下のようにエラーや警告がたくさん表示されます。デフォルトのルールは結構厳しめなので良きルールに改変して使用してください。

【Swift】SwiftLint(静的解析ツール)の導入と使い方!アプリの中身をチェック

エラーや警告を一発で解決しよう

SwiftLintを使用して出たエラーや警告はSwiftFormatを使用することでほぼ解消することができる場合があります。導入は簡単なのでぜひ使用してみてください。

おすすめ記事:【Swift】SwiftFormatの導入と使い方!コードを自動で修正する

.swiftlint.yml:規約を変更する

SwiftLintのルールを変更するにはプロジェクトの直下に.swiftlint.ymlを作成し中に適切なルールを記述します。細かいルールの構築方法は以下の公式サイトを確認してください。

公式リファレンス:SwiftLintCore Reference Rule Directory Reference

以下は公式に記載されていたサンプルをそのまま組み込んだところCommand PhaseScriptExecution failed with a nonzero exit codeというエラーが出たので少し修正し、コメント日本語にしたものです。


# デフォルトでは、SwiftLint は適切なデフォルトルールセットを使用します。以下で調整可能です。
disabled_rules: # デフォルトで有効になっているルールのうち、除外したいルールを指定
  - colon              # コロンのスタイルチェックを無効化
  - comma              # カンマのスタイルチェックを無効化
  - control_statement  # if などの制御文の書き方チェックを無効化

opt_in_rules: # デフォルトでは無効になっているルール。使用するには明示的に opt-in が必要
  - empty_count        # `.count == 0` の代わりに `.isEmpty` を使うことを推奨するルール
  # 利用可能なすべてのルールは `swiftlint rules` コマンドで確認できます

# 代わりに、使用するすべてのルールを明示的に指定する方法もあります(以下のオプションのコメントを外す)
# only_rules: # `disabled_rules` と `opt_in_rules` はこの設定を使う場合は削除してください
#   - empty_parameters
#   - vertical_whitespace

analyzer_rules: # `swiftlint analyze` 実行時に適用されるルール
  - explicit_self      # 明示的な self の使用を推奨

## 以下をコメントアウトしました
#included: # lint 対象とするパス(大文字小文字を区別)。これを指定すると `--path` は無視される
#  - Source

excluded: # lint の対象外とするパス(大文字小文字を区別)。`included` より優先されます
  - Carthage
  - Pods
  - Source/ExcludedFolder
  - Source/ExcludedFile.swift
  - Source/*/ExcludedFile.swift # ワイルドカードでファイルを除外

# true の場合、lint 対象ファイルが見つからなくても SwiftLint は失敗しません
allow_zero_lintable_files: false

# 設定可能なルールのカスタマイズ
# バイナリルールは severity(警告レベル)を設定できます
force_cast: warning # `as!` の強制キャストに対して警告

force_try:
  severity: warning # `try!` の強制使用に対して警告

# 警告とエラーのレベルを持つルールは、警告レベルのみを設定することも可能
line_length: 110 # 1行の最大文字数。これを超えると警告

# 警告とエラーの両方を設定する場合(配列で設定)
type_body_length:
  - 300 # 警告レベル
  - 400 # エラーレベル

# 警告とエラーを明示的に設定する場合
file_length:
  warning: 500  # ファイル行数が 500 行で警告
  error: 1200   # ファイル行数が 1200 行でエラー

# 命名規則ルールの設定:min/max 長さの警告・エラー閾値、除外対象など
type_name:
  min_length: 4 # 最小長さに対する警告
  max_length:
    warning: 40
    error: 50
  excluded: iPhone # 除外する型名
  allowed_symbols: ["_"] # 型名に許可される記号

identifier_name:
  min_length:
    error: 4 # 最小長さに満たない識別子に対してエラー
  excluded:
    - id
    - URL
    - GlobalAPIKey # 特定の識別子を除外

# エラー・警告の出力形式を指定(例: xcode, json, markdown など)
reporter: "xcode"

まだまだ勉強中ですので間違っている点や至らぬ点がありましたら教えていただけると助かります。

ご覧いただきありがとうございました。

searchbox

スポンサー

ProFile

ame

趣味:読書,プログラミング学習,サイト制作,ブログ

IT嫌いを克服するためにITパスを取得しようと勉強してからサイト制作が趣味に変わりました笑
今はCMSを使わずこのサイトを完全自作でサイト運営中〜

New Article