第21回 yidev での発表内容です。この勉強会では参加者の意見を集めてSwift-Clean用のフォーマットを作成しました。 このとき作成したフォーマットは https://github.com/mnat44/yidev-21-swift-style-settings-for-swift-clean にアップロードされています。

2. Swift-Clean

3. http://swiftcleanapp.com/
Swift-Clean

4. Swift-Cleanとは？
• Swiftのコードフォーマッター
• フォーマットルールを設定することができる
• フォーマットはビルド時に適用される

5. 有料です
Free Trialあり

6. きっかけ
• 最近、Swiftのソースレビューをしている
• Swiftのフォーマットのレビューの方針がない
• 個人的にはどこにスペースを入れるとか、どこで
改行するとか割とどうでも良い
• でも、やっぱり統一されていた方が気持ち良い

7. Swift-Cleanの良いところ
• アンケートに答えていくとSwiftStyleSettings.plist
が生成される
• これをもとにSwift-Clean.appが警告を出してくれ
たりする

8. あなたのフォーマットルールは？

9. yidev-swiftフォーマットを作ろう

10. 1/39 (AutoFix)
クラス宣言などの : の前後のス
ペーシング
What should the spacing around the colon look like in a class
declaration?

11. 2/39 (AutoFix)
メソッドのreturn オペレータの
スペーシングは
What should the spacing around the return operator look like
in a method signature?

12. 3/39
クラス宣言の { を始める位置
は？
Where should the open curly brace be in relation to a class
declaration?

13. 4/39
メソッド宣言の { を始める位置
は？
Where should the open curly brace be in relation to a method
declaration?

14. 5/39 (AutoFix)
メソッドの ( はスペースを空け
るべきか？
Should there be a space before the opening parentheses in a
method signature?

15. 6/39 (AutoFix)
オペレータ宣言の ( の前にはス
ペースを入れるべきか？
Should there be a space before the opening parentheses in a
operator function signature?

16. 7/39 (AutoFix)
メソッド呼び出しの ( の前には
スペースを入れるべきか？
Should there be a space before the opening parentheses in a
method call?

17. 8/39 (AutoFix)
メソッドの引数の : の周りには
スペースをどう入れるか？
What should the spacing around the colon look like in a
method signature?

18. 9/39 (AutoFix)
変数宣言の : の周りにはスペー
スをどう入れるか？
What should the spacing around the colon look like in a
variable declaration?

19. 10/39
for文の { はどこに置くべきか？
Where should the open curly brace be in relation to a loop
declaration?

20. 11/39
if文の { はどこに置くべきか？
Where should the open curly brace be in relation to an if-
statement declaration?

21. 12/39
switch文の { はどこに置くべき
か？
Where should the open curly brace be in relation to a switch
statement declaration?

22. 13/39
return文の上に空の行を入れる
べきか？
Should there be an empty line above return statements?

23. 14/39 (AutoFix)
四則演算の周りにスペースを入
れるべきか？
What should the spacing around math operators look like?

24. 15/39 (AutoFix)
{ の前にはスペースを入れるべ
きか？
Should there be a space before opening braces?

25. 16/39 (AutoFix)
, のあとにスペースを入れるべ
きか？
Should there be a space after commas?

26. 17/39
メソッド間にどれくらい空行を
入れるべきか？
How many empty lines should there be between (main, non-nested) method bodies?

27. 18/39 (AutoFix)
メソッドのジェネリクス宣言の
周りにスペースを入れるか？
What should the spacing around generic declarations look like
in a method signature?

28. 19/39 (AutoFix)
カスタムプロパティのセッター
の ( の前にスペースを入れる
か？
Should there be a space before the opening parentheses of a
custom property setter?

29. 20/39 (AutoFix)
型指定の前にスペースを入れる
か？
Should there be a space before the type specifier?

30. 21/39 (AutoFix)
論理演算子の周りのスペースは
どうする？
What should the spacing around logical operators look like?

31. 22/39 (AutoFix)
代入時のスペースはどうする？
What should the spacing around the assignment operator look
like?

32. 23/39
// MARK: コメントの上には空
行をどれくらい入れるべきか？
How many empty lines should there be above a // MARK:
declaration?

33. 24/39
// MARK: コメントの下には空
行をどれくらい入れるべきか？
How many empty lines should there be below a // MARK:
declaration?

34. 25/39
モジュールインポートの最後の
行の下にどれくらい空行を入れ
るか？
How many empty lines should there be below the last module
import?

35. 26/39
モジュールインポートの最初の
行の上にどれくらい空行を入れ
るか？
How many empty lines should there be above the first module
import?

36. 27/39 (AutoFix)
Dictionaryの : の周りにどうやっ
てスペースを入れるか？
What should the spacing around the colon look like in a
dictionary?

37. 28/39 (AutoFix)
メソッド呼び出しの際の : の周
りはどうスペーシングするか？
What should the spacing around the colon look like in a
function call?

38. 29/39
Swiftファイルの最後の行にはど
れくらい空行を入れるべきか
How many empty lines should there be at the end of every
Swift file?

39. 30/39
クラス名は1文字目を大文字に
すべきか？
Should class names be capitalized?

40. 31/39
メソッド名は1文字目を大文字
にすべきか？
Should function names be capitalized?

41. 32/39
変数名は1文字目を大文字にす
べきか？
Should variable names be capitalized?

42. 33/39
enum名は1文字目を大文字にす
べきか？
Should enum names be capitalized?

43. 34/39
struct名は1文字目を大文字にす
べきか？
Should struct names be capitalized?

44. 35/39
typealias時の名前は1文字目を
大文字にすべきか？
Should typealias names be capitalized?

45. 36/39
定数名は1文字目を大文字にす
べきか？
Should static variable names be capitalized?

46. 37/39
struct宣言時の { はどうすべき
か？
Where should the open curly brace be in relation to a struct
declaration?

47. 38/39
enum宣言時の { はどうすべき
か？
Where should the open curly brace be in relation to an enum
declaration?

48. 39/39
コーディングルール違反時はビ
ルドエラーにするか？ワーニン
グにするか？
Do you want Swift-Clean to show code violations as build
errors or warnings in Xcode?

49. 設定方法

50. 設定方法
Swift-Cleanアプリを立ち上げる

51. 設定方法
Customでさっきのアンケート画面に

52. 設定方法
StackoverflowアカウントSign-inしたユーザーのアンケート結果

53. 設定方法
アンケートに回答したすべてのユーザーの平均

54. 設定方法
除外ファイルなどの設定

55. 設定方法
プロジェクトファイルを追加

56. 設定方法
AutoFixでさきほどのアンケートでAutoFixと
記載されていた項目を自動で修正してくれる

57. 設定方法
Install Run Scriptをクリック

58. 設定方法
Build PhasesにSwift-Clean Run Scriptが追加される
不要だったら削除すればOK

59. 設定方法
• 先ほど生成したSwiftStyleSettings.plist
を.xcodeprojと同じ階層に保存して、あとはBuildす
ればOK

60. こんな感じ
• モジュールインポートの最後の行の下は空行1つにしましょう
• メソッド名はキャメルケースにしましょう などなど

61. 注意

62. ビルドするごとに…
Free Trial版だとビルドするごとに出てくる

63. うざかったら
Build PhasesにSwift-Clean Run Scriptが追加される
不要だったら削除すればOK

64. コードフォーマットとか好みでしかないし、
どうでもいい、でも整ってる方が気持ち良い
→ チーム開発時はツールで自動化したい
→ Swift-Cleanは一つの手段
まとめ

65. • アンケート形式で答えられるので、チーム開発で多
数決とって決めたい場合にちょうど良いかも
• 150ドルのSingle Site Licenseが用意されている
まとめ

66. • 第21回 yidevで作成したSwiftStyleSettings.plistは
https://github.com/mnat44/yidev-21-swift-style-
settings-for-swift-clean
にアップロードしています
補足

67. おわり