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

SwiftLintコマンドとそのコマンドオプションの一覧まとめ

はじめに

SwiftでデファクトスタンダードなLintツールであるSwiftLintのコマンド一覧とそのコマンドオプション一覧をまとめました。
もちろん以下のヘルプの出し方さえ知っていれば確認できるのですが、さらっと日本語でどんなことができるのか確認したい方向けに整理しました。

# コマンド一覧の表示
$ swiftlint help

# コマンドオプションの表示
$ swiftlint help <command_name>

また、具体的な運用方法については以下の記事にまとめています。
Qiita / SwiftLintの運用ノウハウ

※執筆時のswiftLintバージョン: 0.30.0(最新)

コマンド一覧

# 分析ルールを実行
swiftlint analyze

# 警告とエラーを自動的に修正
swiftlint autocorrect

# 全ルールのドキュメントをmarkdown形式で出力
swiftlint generate-docs

# ヘルプの表示
swiftlint help

# lintの警告とエラーを表示
swiftlint lint

# ルールのリストとその識別子を表示
swiftlint rules

# バージョンを表示
swiftlint version

コマンドオプション一覧

analyzeコマンドオプション

# 分析対象のパス
swiftlint analyze --path <path>

# SwiftLintの設定ファイルへのパス
swiftlint analyze --config <config_path>

# warningをerrorとする
swiftlint analyze --strict

# errorをwarningとし、warning閾値を無効にする
swiftlint analyze --lenient

# パスオプションよりも設定ファイルのexcludedを優先する
swiftlint analyze --force-exclude

# SCRIPT_INPUT_FILE 環境変数をファイルとして読み込む
swiftlint analyze --use-script-input-files

# benchmark_files.txtとbenchmark_rules.txtにベンチマーク結果(実行速度)を保存する
swiftlint analyze --benchmark

# エラーと警告を記録するために使用するレポート用パス
swiftlint analyze --reporter <path>

# ログを出力しないようにする
swiftlint analyze --quiet

# whitelist_rules、opt-in、disabledを無視し、全てのルールを適用する
swiftlint analyze [--enable-all-rules]

# 可能な限り違反を修正する
swiftlint analyze --autocorrect

# AnalyzerRulesをLintするときに使用するxcodebuildログのフルパス
swiftlint analyze --compiler-log-path <compiler_log_path>

autocorrectコマンドオプション

# 修正するファイルまたはディレクトリへのパス
swiftlint autocorrect --path <path>

# SwiftLintの設定ファイルへのパス
swiftlint autocorrect --config <config_file>

# SCRIPT_INPUT_FILE 環境変数をファイルとして読み込む
swiftlint autocorrect --use-script-input-file

# ログを出力しないようにする
swiftlint autocorrect --quiet

# パスオプションよりも設定ファイルのexcludedを優先する
swiftlint autocorrect --force-exclude

# Swiftファイルを再フォーマット(インデント整形)
swiftlint autocorrect --format

# キャッシュディレクトリのパス
swiftlint autocorrect --cache-path <cache_path>

# キャッシュを利用しない
swiftlint autocorrect --no-cache

# 整形にスペースでなくタブを使う(非推奨)
swiftlint autocorrect --use-tab

generate-docsコマンドオプション

# ドキュメントを保存する場所のパス。存在しない場合は、出力に表示されます。
swift generate-docs --path <path>

helpコマンドオプション

なし

lintコマンドオプション

# Lint対象のパス
swiftlint lint --path <path>

# 標準入力に対してLintをかける
swiftlint lint --use-stdin

# SwiftLintの設定ファイルへのパス
swiftlint lint --config <config_path>

# warningをerrorとする
swiftlint lint --strict

# errorをwarningとし、warning閾値を無効にする
swiftlint lint --lenient

# パスオプションよりも設定ファイルのexcludedを優先する
swiftlint lint --force-exclude

# SCRIPT_INPUT_FILE 環境変数をファイルとして読み込む
swiftlint lint --use-script-input-files

# benchmark_files.txtとbenchmark_rules.txtにベンチマーク結果(実行速度)を保存する
swiftlint lint --benchmark

# エラーと警告を記録するために使用するレポート用パス
swiftlint lint --reporter <path>

# ログを出力しないようにする
swiftlint lint --quiet

# キャッシュディレクトリのパス
swiftlint lint --cache-path <cache_path>

# キャッシュを利用しない
swiftlint lint --no-cache

# whitelist_rules、opt-in、disabledを無視し、全てのルールを適用する
swiftlint lint [--enable-all-rules]

rulesコマンドオプション

# SwiftLintの設定ファイルへのパス
swiftlint rules --config <config_path>

# 指定した識別子のルールの説明を表示
swiftlint rules <rule_identifier>

# 有効化されたルールのみ表示
swiftlint rules --enabled
swiftlint rules -e

# 無効化されたルールのみ表示
swiftlint rules --disabled
swiftlint rules -d

versionコマンドオプション

なし

以上となります。もし間違いなどあれば編集リクエストをお願いいたします。

Why do not you register as a user and use Qiita more conveniently?
  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
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