{"componentChunkName":"component---src-templates-post-template-js","path":"/posts/how-to-code-swiftlint-run-script","result":{"data":{"markdownRemark":{"id":"90fd8cd1-81ec-5cb6-9bd6-6825b0c3f44a","html":"

SwiftLint をビルド時に Run Script で実行する設定は、様々な記事で紹介されています。

\n

しかし、微妙に間違っていたり、シェルスクリプトをよく書く自分からすると、もっとこう書いた方がいいと思ったりする点があったりします。

\n

この記事では、あまりシェルスクリプトに慣れていない iOS エンジニアの方に向けて、SwiftLint の Run Script を通してシェルスクリプトのコツを解説します。

\n

結論

\n

最初に SwiftLint の Run Script の書き方の結論を載せます。

\n

SwiftLint を CocoaPods でインストールしている場合

\n
SWIFT_LINT="${PODS_ROOT}/SwiftLint/swiftlint"\n\nif which "${SWIFT_LINT}" >/dev/null; then\n  "${SWIFT_LINT}" autocorrect --format\n  "${SWIFT_LINT}"\nelse\n  echo "warning: SwiftLint not installed."\nfi
\n

SwiftLint を Homebrew などで Mac にインストールしている場合 (非推奨)

\n
SWIFT_LINT="swiftlint"\n\nif which "${SWIFT_LINT}" >/dev/null; then\n  "${SWIFT_LINT}" autocorrect --format\n  "${SWIFT_LINT}"\nelse\n  echo "warning: SwiftLint not installed."\nfi
\n

解説

\n

シェルスクリプトはなかなか癖のある文法をしているので、このコードの意味・意図を解説していきます。

\n
SWIFT_LINT="${PODS_ROOT}/SwiftLint/swiftlint"\n\nif which "${SWIFT_LINT}" >/dev/null; then\n  "${SWIFT_LINT}" autocorrect --format\n  "${SWIFT_LINT}"\nelse\n  echo "warning: SwiftLint not installed."\nfi
\n

SwiftLint の有無による分岐

\n

if which "${SWIFT_LINT}" >/dev/null; then

\n

シェルスクリプトに慣れていない方にとって、一番分かりにくいのはこの部分だと思います。\n雰囲気的に SwiftLint があるかどうかで分岐していることは分かると思いますが、ここをちゃんと解説してみます。

\n

まず、この部分は if と which "${SWIFT_LINT}" >/dev/null と ;then に分けて読む必要があります。\n単純な話ですが、 which "${SWIFT_LINT}" >/dev/null の部分が if で条件分岐するための判定です。

\n

which "${SWIFT_LINT}" >/dev/null は何をしているかと言うと、which "${SWIFT_LINT}" コマンドを実行し、その際に画面 (標準出力) に表示される内容を捨てています。\nwhich "${SWIFT_LINT}" コマンドは、SwiftLint の有無を調べるコマンドですが、なぜその結果を捨てているのでしょうか ?

\n

その理由は、シェルスクリプトの if が表示内容ではなく、終了コードを見ていることにあります。

\n

which コマンドは指定したコマンドが見つかったか場合は終了コード 0 を、見つからなかった場合は終了コード 1 を返します。\nif はその値を見て分岐しているのです。

\n

SWIFT_LINT 変数の定義

\n

ざっと調べたところ全く見かけなかったのですが、${PODS_ROOT}/SwiftLint/swiftlint という部分は上記のように変数に SWIFT_LINT のような変数にまとめた方が良いです。\n理由はもちろん、使用する swiftlint コマンドのパスが変わった際に、1 箇所の修正で済むようにするためです。

\n

これはシェルスクリプトではよく見かけるテクニックです。

\n

"" の挙動

\n

SWIFT_LINT という変数を使用する際、それを "" で括っています。\n"" で括った部分は、シェルスクリプトでは 1 つの文字列として扱われます。

\n

なので、もし "${SWIFT_LINT}" autocorrect --format の部分を "${SWIFT_LINT} autocorrect --format" のように書いてしまうと、${SWIFT_LINT} autocorrect --format という空白を含んだコマンドを実行しようとしてしまい、正しい結果が得られません。\n"" でどこまで括るべきかは注意しましょう。

\n

ちなみに ${} で変数を呼び出す箇所を "" で括ることは、Google の Shell Style Guide で推奨されています。

\n

SwiftLint を Homebrew でインストールすべきでない理由

\n

最後に、SwiftLint を Homebrew でインストールするケースを非推奨としている理由ですが、これは SwiftLint のバージョンが開発者間で統一されなくなってしまうためです。

\n

インフラ系の仕事をする機会が多い自分にとって環境間のバージョン違いをなくすことは自然なことなのですが、こちらも実施していない記事が多いです。

\n

このことについては「iOSアプリを開発する人はもっとRubyとgemの管理に慎重になって、かつ有効に使って欲しいという気持ちの記事を書いた。」というブログ記事とそのリンク先で、なぜそうすべきか、具体的にどう設定すればいいのか、が解説されています。

\n

おわりに

\n

先日参加した Swift の勉強会で色々初心者的な質問をさせていただいたので、この記事の内容のように、自分が比較的得意な分野 (シェルスクリプト) で Swift のコミュニティに貢献できればと思います。

\n

シェルスクリプトのすすめ

\n

シェルスクリプトは非常に便利ですし、学ぶ価値は非常に高いです。\n興味を持った方が勉強する最初の一冊にはこちらの本がオススメです。

\n\n

\"\"

","fields":{"slug":"/posts/how-to-code-swiftlint-run-script","tagSlugs":["/tag/ios/","/tag/swift/","/tag/bash/"],"autoRecommendPosts":["udemy-crafting-shell","what-is-executing-a-command-on-bash","udemy-linux-reintroduction","macos-virtualization"]},"frontmatter":{"date":"2020-02-02T14:13:00.000Z","description":"SwiftLint をビルド時に Run Script で実行する設定は、様々な記事で紹介されています。\nしかし、微妙に間違っていたり、シェルスクリプトをよく書く自分からすると、もっとこう書いた方がいいと思ったりする点があったりします。\nこの記事では、あまりシェルスクリプトに慣れていない iOS エンジニアの方に向けて、SwiftLint の Run Script を通してシェルスクリプトのコツを解説します。","tags":["ios","swift","bash"],"title":"SwiftLint の Run Script は結局どう書くのが適切なのか","socialImage":null,"recommendPosts":["https://www.kanzennirikaisita.com/posts/software-developer-books-index"]}}},"pageContext":{"slug":"/posts/how-to-code-swiftlint-run-script"}},"staticQueryHashes":["251939775","3942705351","401334301"]}