Swift スタイルガイド

なぜ Swift スタイルガイドが必要なのか

Swift はまだ新しい言語です。当社が 2014 年に Swift を使い始めたときには、標準化された Swift スタイルガイドがありませんでした。15 人のエンジニアがコードベース内で自由に記述し、各自が独自のパーソナル Swift スタイルで記述していました。標準化されたスタイルで合意が得られない場合、プルリクエスト内でスタイルに関して時間を費やすか、コードベースが Jackson Pollock の絵画 のようになってしまうことはすぐに明らかになりました。

Apple TV アプリを開発しているとき、非公式のスタイルガイドを作成しました。そのスタイルガイドは 2016 年 1 月 に他のアドホックな試みと組み合わせて公式の Airbnb Swift スタイルガイド になりました。そこで、Airbnb で Swift を記述する推奨の方法を定義するための共同作業を開始しました。

Apple と Swift コミュニティは、Swift の記述方法に関する貴重なガイダンスを提供してきました。それらのガイダンスは Airbnb で Swift を記述する方法に多大な影響を与えているものの、私たちにふさわしいと思われるものを反復的に取り入れ、同時にコミュニティに沿ったスタイルガイドを独自に維持することは価値があると考えています。そのため、Apple の推奨事項を当社の 指針 に追加しました。

スタイルガイドの違反を手動で特定して修正したくはないため、Swift コミュニティで最も人気のあるリンターとフォーマッターである SwiftLint と SwiftFormat を採用しています。当社の スタイルガイド には、SwiftLint と SwiftFormat の設定 が記載されています。当社と同じルールを使用したい場合は、それらを取得してプロジェクトで使用を開始するだけです。