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

$ xcode-select --version
xcode-select version 2409.

$ brew install swiftlint

PodFile
pod 'SwiftLint'

$ pod install

if [ -f /opt/homebrew/bin/swiftlint ]; then
  /opt/homebrew/bin/swiftlint
else
  echo "⚠️⚠️⚠️ Warning: SwiftLintが未インストール⚠️⚠️⚠️"
fi

if which "${PODS_ROOT}/SwiftLint/swiftlint" >/dev/null; then
    ${PODS_ROOT}/SwiftLint/swiftlint
else
    echo "⚠️⚠️⚠️ Warning: SwiftLintが未インストール⚠️⚠️⚠️"
fi

$ swiftlint --fix --format

$ swiftlint --fix --format {ファイルパス}

.swiftlint.yml
# デフォルトでは、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"

// swiftlint:disable <rule1> [<rule2> <rule3> ...]
// ... 無効にしたいコード ...
// swiftlint:enable <rule1> [<rule2> <rule3> ...]

// swiftlint:disable line_length identifier_name
let A = "短すぎる変数名かつ長すぎる文字列"
// swiftlint:enable line_length identifier_name

let value = value as! String // swiftlint:disable:this force_cast
// swiftlint:disable:next force_cast
let key = key as! String

swiftlint(
    mode: :lint,                            # SwiftLint の実行モード（:lint = 通常の検査, :autocorrect = 自動修正）
    # Homebrewでインストール済みならパス指定は不要
    executable: "Pods/SwiftLint/swiftlint", # SwiftLint 実行ファイルのパス（CocoaPods で導入した場合は必須）
    path: "/path/to/lint",                  # 検査対象のディレクトリパス（省略可能）
    output_file: "swiftlint.result.json",   # 出力結果を保存するファイルパス（省略可能）
    reporter: "json",                       # 出力形式（json, xcode, html, github-actions など）
    config_file: ".swiftlint-ci.yml",       # 使用する設定ファイルのパス（省略可能。デフォルトは .swiftlint.yml）
    files: [                                # 特定のファイルのみを検査したい場合に指定（省略可能）
        "AppDelegate.swift",
        "path/to/project/Model.swift"
    ],
    ignore_exit_status: true,               # SwiftLint がエラー終了しても fastlane を停止させない（デフォルト: false）
    quiet: true,                            # 'Linting 開始' や '完了' などのログ出力を抑制する（デフォルト: false）
    strict: true                            # 警告もエラーとして扱い、処理を失敗と見なす（デフォルト: false）
)