swift-format 全設定の解説:どの項目が何を変えるのか
自分のiOSプロジェクトAtofolioに.swift-formatを書いていて、公式ドキュメントが各項目に一文しか説明を付けていないことに気づいた。prioritizeKeepingFunctionOutputTogetherのような名前は、その一文を読んでもコードがどう変わるのか分からない。
そこで全部試した。デフォルト値で一度フォーマットし、変更後の値でもう一度フォーマットして、その差分を見る。この記事はその実験の記録である。
以下の出力はすべてXcode 27に同梱のswift-format(xcrun --find swift-format、--versionはmainと表示される)、macOS 27、Swift 6.4で得たもの。swift-formatの挙動はバージョンと強く結びついているので、Swift Package Managerで個別に入れたものを使っている場合、一部のルールの出力は違うかもしれない。
まず結果から
同じコードを2つの設定でフォーマットした結果。前半がデフォルト(2スペース、returnを省略しない、引数をなるべく詰める)、後半が自分の設定である。
// デフォルト設定private struct LibraryRow: View { var title: String { return item.displayName }
var body: some View { return HStack(spacing: 12) { Text(title) Spacer() } }
func rebuild(from items: [LibraryItem], selection: Set<LibraryItem.ID>, sorted: Bool) -> [LibraryRow] { var rows = [LibraryRow]() for item in items { if selection.contains(item.id) { rows.append(LibraryRow(item: item, isSelected: true, onSelect: onSelect)) } } return rows }}// 自分の設定private struct LibraryRow: View { var title: String { item.displayName }
var body: some View { HStack(spacing: 12) { Text(title) Spacer() } }
func rebuild( from items: [LibraryItem], selection: Set<LibraryItem.ID>, sorted: Bool ) -> [LibraryRow] { var rows: [LibraryRow] = [] for item in items where selection.contains(item.id) { rows.append(LibraryRow(item: item, isSelected: true, onSelect: onSelect)) } return rows }}2つのコードは意味的に完全に同じで、違いはすべて設定から来ている。以下、一つずつ見ていく。
確認の方法
自分で試したい場合、手順は簡単である。まずデフォルト設定を基準として書き出す。
xcrun swift-format dump-configuration > default.jsonjqでキーを一つ変え、2つの出力を比較する。
jq '.indentation.spaces = 4' default.json > patched.jsondiff <(xcrun swift-format format --configuration default.json a.swift) \ <(xcrun swift-format format --configuration patched.json a.swift)ここで一つ引っかかりやすい点がある。swift-formatのルールは2種類に分かれる。 コードを書き換えるもの(format rule)と、問題を報告するだけのもの(lint-only rule)である。formatだけを実行すると、NeverForceUnwrapのようなルールは「何もしない」ように見えて、効いていないと誤解してしまう。これらはswift-format lintでしか現れない。
xcrun swift-format lint --configuration patched.json a.swift以下、各ルールがどちらに属するかを明記している。
一、レイアウト系の設定
lineLength
1行の最大文字数。これを超えると改行の処理が入る。
// lineLength: 80let view = makeRow(title: "Title", subtitle: "Subtitle", icon: iconName, action: handler)let view = makeRow( title: "Title", subtitle: "Subtitle", icon: iconName, action: handler)選んだ値:100(デフォルト)。 Swiftは型名も引数ラベルも元々長く、80だとSwiftUIのview部分が細切れになる。100はGoogle Swift Style Guideの値であり、swift-format自身のデフォルトでもある。
indentation
1段のインデントを何で作るか。{"spaces": N}か{"tabs": N}を書く。
struct Point { var x: Int func move() { x += 1 } var x: Int func move() { x += 1 }}選んだ値:{"spaces": 4}。 swift-formatのデフォルトは2スペースだが、Xcodeのエディタ既定値は4スペースで、Appleのサンプルコードも4である。Xcodeで手で打ったインデントとフォーマット後のインデントが食い違うのは避けたい。
tabWidth
この名前は誤解を招く。「インデント幅」ではなく、行の長さを測るときにタブ1文字を何桁として数えるかである。
indentationがスペースなら、この値は出力にまったく影響しない。タブでインデントしている場合にだけ差が出る。以下は同じコード、同じlineLength: 60、同じタブインデントで、tabWidthだけが違う。
// tabWidth: 8 —— タブ2段が16桁と数えられ、残りが足りず改行されるfunc outer() { func inner() { let r = compute( alpha: 1, beta: 2, gamma: 3, delta: 44) }}
// tabWidth: 4 —— タブ2段は8桁なので1行に収まるfunc outer() { func inner() { let r = compute(alpha: 1, beta: 2, gamma: 3, delta: 44) }}選んだ値:4。ただし正直なところ、自分の設定では効いていない。 スペースでインデントしているので、swift-formatが幅を換算すべきタブに出会うことがない。エディタの設定と揃えるために残しているだけで、消しても結果は変わらない。
indentBlankLines
空行に現在の段のインデントを入れるか(つまり行末に空白を残すか)。
func f() { let a = 1
⎵⎵⎵⎵ let b = 2}(上の⎵は実際に生成される空白である。)
選んだ値:false(デフォルト)。 有効にすると行末空白ができ、多くのエディタの「保存時に行末空白を削除」やgit diffの読み方と衝突する。
maximumBlankLines
連続する空行を何行まで許すか。それ以上は畳まれる。
let a = 1
let b = 2(上は2からデフォルトの1に戻したときの効果。)
選んだ値:1(デフォルト)。 空行で論理的な塊を分けはするが、「より大きな区切り」を表すために2行以上を使う必要はない。それは見出しコメントの仕事である。
spacesBeforeEndOfLineComments
行末の//コメントの前に空白をいくつ置くか。
let a = 1 // onelet bb = 22 // twolet a = 1 // onelet bb = 22 // two(上は1にしたときの効果。)揃えはしない。固定個数の空白を保証するだけである。
選んだ値:2(デフォルト)。 1個だとコメントがコードに近すぎる。2個あれば視覚的に離れる。
spacesAroundRangeFormationOperators
...と..<の前後に空白を入れるか。
let r = 0..<10let c = 1...5let r = 0 ..< 10let c = 1 ... 5選んだ値:false(デフォルト)。 0..<10は一つのまとまりとして読んでいる。空白を入れると3つの独立した語のように見える。
indentConditionalCompilationBlocks
#if / #endifの中身をもう1段インデントするか。
func f() { #if DEBUG let a = 1 print(a) let a = 1 print(a) #endif}(デフォルトのtrueが右側。)
選んだ値:true(デフォルト)。 #ifは開きと閉じを持つ構造なので、中身を1段下げるのは直感に合う。
indentSwitchCaseLabels
caseをswitchに対してインデントするか。
switch v {case 1: print(1)default: break case 1: print(1) default: break}選んだ値:false(デフォルト)。 Swiftコミュニティの主流であり、Appleのドキュメントもこの形である。有効にするとswitch全体が2段右に寄り、すでにネストしたコードでは場所を取りすぎる。
二、改行の方針
このグループは「1行に収まらないとき、どこで折るか」を決める。
respectsExistingLineBreaks
手で書いた改行を尊重するかどうか。
let a = compute( x: 1, y: 2)let a = compute(x: 1, y: 2)let b = 1 + 2(上はfalseにしたときの効果。結合できるものはすべて結合される。)
選んだ値:true(デフォルト)。 ファイル中で最も重要な項目だと思っている。これを切るとswift-formatは「行の密度を最大化する機械」になり、グループを表現するために手で分けた引数リストが容赦なく1行にまとめられる。有効なら、ルールに違反しない限り手書きの改行は残る。フォーマッタは下限を担保し、表現は人が持つ。
lineBreakBeforeEachArgument
引数リストが1行に収まらないとき、各行をできるだけ詰めるか、1引数につき1行にするか。
let view = makeRow( title: "Title", subtitle: "Subtitle", icon: iconName, action: handler, isEnabled: true) title: "Title", subtitle: "Subtitle", icon: iconName, action: handler, isEnabled: true)関数宣言も同じである。
func makeRow( title: String, subtitle: String, iconName: String, action: @escaping () -> Void, isEnabled: Bool, title: String, subtitle: String, iconName: String, action: @escaping () -> Void, isEnabled: Bool, badgeCount: Int) -> Row {選んだ値:true。 デフォルトの詰め込み方式には実用上の問題がある。引数を1つ足すと後ろの引数がすべて並び替わり、実際は1つ追加しただけなのにdiffでは5行変わったように見える。1引数1行なら、引数の追加は行の追加で済む。SwiftUIのイニシャライザは引数が多く長いので、この差はコードレビューではっきり出る。
代償は縦に長くなること。それは受け入れる。
lineBreakBeforeEachGenericRequirement
同じ考え方をwhere句に適用したもの。
func merge<A, B>(_ a: A, _ b: B) -> [A.Element]where A: Sequence, B: Sequence, A.Element == B.Element, A.Element: Hashable, B.Element: Comparable, A: Codable, B: Codable, A: Sendable A: Sequence, B: Sequence, A.Element == B.Element, A.Element: Hashable, B.Element: Comparable, A: Codable, B: Codable, A: Sendable{where句が折り返しを要する長さになったときだけ働く。短いものは影響を受けない。
選んだ値:true。 前の項目と同じ理由で揃えた。実際には自分のプロジェクトにはまだ折り返すほど長いwhere句がないので、今のところ将来のために書いてある。
lineBreakBeforeControlFlowKeywords
elseやcatchのようなキーワードを行頭に置くか。
if condition { print(a) } else { } else { print(0) }}選んだ値:false(デフォルト)。 } else {はSwiftで広く使われる書き方であり、Allmanスタイルに変えるとどのSwiftプロジェクトでも浮く。
lineBreakBetweenDeclarationAttributes
複数の属性をそれぞれ1行にするか。
@MainActor @preconcurrency final class Store {@MainActor@preconcurrencyfinal class Store { var value = 0}選んだ値:false(デフォルト)。 SwiftUIでは@State private varのような組み合わせが多く、強制的に分けるとプロパティ宣言の領域が縦一列になる。しかもこの項目は全体に効くので、「長い属性のときだけ」という指定はできない。
lineBreakAroundMultilineExpressionChainComponents
メソッドチェーンが収まらないとき、メソッド名の間で折るか、引数の括弧の中で折るか。
let names = people.filter { $0.age > 18 }.map { $0.name.uppercased() }.sorted().joined( separator: ", ")let names = people.filter { $0.age > 18 }.map { $0.name.uppercased() }.sorted() .joined(separator: ", ")選んだ値:false(デフォルト)。 これは迷った。有効にすると折る位置が意味的に自然になる(.で折れる)が、実際の挙動は「複数行のチェーンの各要素の前後で強制的に改行する」なので、あるチェーンが複数行と判定された時点で全体がばらける。デフォルトの出力で自分のコードには足りているので、今は触らない。
prioritizeKeepingFunctionOutputTogether
関数シグネチャが収まらないとき、どの部分を守るか。この記事で一番気に入っている項目である。
func loadConfiguration(from url: URL, using decoder: JSONDecoder, strict: Bool) throws -> Configuration{func loadConfiguration( from url: URL, using decoder: JSONDecoder, strict: Bool) throws -> Configuration { try decoder.decode(Configuration.self, from: Data(contentsOf: url))}デフォルト(false)は戻り値の型を次の行へ送り、シグネチャが複数行になった結果、開き波括弧まで単独行に追いやられる。シグネチャ3行と孤立した{ができあがる。有効にすると引数リストのほうが分割され、) throws -> Configuration {はまとまったまま残る。
選んだ値:true。 戻り値の型は関数シグネチャの中でも情報量の多い部分で、引数リストから切り離す理由がない。孤立した{も、4スペースでインデントされたコードの中ではやけに目立つ。
三、末尾のカンマ
2つの項目があり、後者が前者を上書きする。
multiElementCollectionTrailingCommas
要素が複数ある配列・辞書リテラルで、最後の要素の後ろにカンマを置くか。
let colors = [ "red", "green", "blue" "blue",]単一要素のコレクションは影響を受けない。["only"]を複数行に開いてもカンマは付かない。
選んだ値:true(デフォルト)。ただし自分の設定ではすでに効いていない。 理由は次の項目にある。
multilineTrailingCommaBehavior
適用範囲がより広い。引数リスト、タプルなど「対称に区切られたカンマ区切りのリスト」すべてで、コレクションリテラルも含む。値は3つ。
keptAsWritten(デフォルト):書いてあれば残し、なければ足さない。コレクションリテラルは前の項目に任せるalwaysUsed:複数行のリストには必ず付けるneverUsed:すべて削除する
let view = makeRow( title: "Title", subtitle: "Subtitle", icon: iconName, icon: iconName)選んだ値:neverUsed。
最初はalwaysUsedにしていた。末尾カンマがあれば最後の要素も他の要素と同じように追加・削除・並び替えができ、引数を1つ足してもdiffは1行で済む、という理由である。この理由自体は間違っていないが、カバーできない範囲がある。名前のとおりmultilineTrailingCommaBehaviorは複数行のリストしか扱わない。1行のmakeRow(title: "a", subtitle: "b")にカンマが付くことは決してない。
つまりalwaysUsedで実際に得られるのは「複数行にはある、1行にはない」という分裂したルールである。同じ呼び出しが、100桁を超えたかどうかで書き方を変える。neverUsedなら一つのルールですべてを覆える。どこにも末尾カンマは付かない。それで後者に変えた。
代償はdiff上の利点を手放すこと。得られるのは「このリストは今1行なのか複数行なのか」を考えなくて済むことである。
2つの波及。
一つ目は、neverUsedがmultiElementCollectionTrailingCommasを上書きすること。後者がtrueのままでも、コレクションリテラルの末尾カンマは削除される。
// multiElementCollectionTrailingCommas: true + multilineTrailingCommaBehavior: neverUsedlet colors = [ "red", "green", "blue"]つまりmultiElementCollectionTrailingCommasの行は、自分の設定では今は空回りしている。将来keptAsWrittenに戻すときに考え直さなくて済むよう残しているが、出力には一切影響しない。
二つ目は、コンパイラのバージョン要件が消えること。引数リストの末尾カンマはSE-0439で導入された構文で、Swift 6.1以降のコンパイラが必要である(実際に確かめたが、言語モードによる制限ではない。コンパイラさえ新しければ-swift-version 5でも通る)。alwaysUsedを選ぶと古いツールチェーンでビルドできないコードが生成される。neverUsedならこの問題は起きない。
ついでに一つバグ。 手書きの1行末尾カンマは構文上は正しい(makeRow(title: "a", subtitle: "b",)も[1, 2, 3,]もコンパイルできる)が、swift-formatの処理は綺麗ではない。neverUsedはカンマを削除した後に空白を残し、収束するには2回目の実行が必要になる。
// 入力let v = makeRow(title: "a", subtitle: "b",)
// 1回目let v = makeRow(title: "a", subtitle: "b" )
// 2回目let v = makeRow(title: "a", subtitle: "b")デフォルトのkeptAsWrittenはさらに悪く、("b", )をそのまま残し、何度実行しても変わらない。コレクションリテラルにこの問題はない。自分で1行の末尾カンマを打つことはあまりないだろうが、他のプロジェクトからコードを移してきた場合は、コミット前に2回フォーマットしておく価値がある。
reflowMultilineStringLiterals
複数行文字列リテラルの中で、長すぎる行を\の継続で折り返すかどうか。
// never(デフォルト)let message = """ This line is short. This particular line is quite long and definitely goes past the configured maximum line length limit of one hundred columns. """
// onlyLinesOverLengthlet message = """ This line is short. This particular line is quite long and definitely goes past the configured maximum line length \ limit of one hundred columns. """3つ目の値alwaysの説明は「既存のエスケープ改行を無視して常に再整形する」である。試したいくつかの例ではonlyLinesOverLengthと同じ出力になった。短い行を結合することはない。違いが出るのは、すでに\の継続を含むリテラルだけだと思われる。
選んだ値:onlyLinesOverLength。 文字列リテラルだけが100桁を超えられる場所になるのは避けたい(それではlineLengthが形骸化する)が、行ごとに整えた短いテキストをフォーマッタに触られるのも困る。この中間の値がちょうどよい。
四、引数を取る3つの項目
fileScopedDeclarationPrivacy
ファイルスコープの非公開宣言をprivateとfileprivateのどちらに揃えるか。FileScopedDeclarationPrivacyルールに対応する。
fileprivate let cache = 1fileprivate func helper() {}private let cache = 1private func helper() {}ファイルスコープではこの2つのキーワードの意味は完全に同じなので、純粋に書き方を揃えるだけの設定である。
選んだ値:private(デフォルト)。 短く、型の内部で使うprivateと見た目が揃う。
noAssignmentInExpressions
NoAssignmentInExpressionsルールの許可リスト。どの関数なら引数の中に代入を書いてよいか。
デフォルトは["XCTAssertNoThrow"]で、XCTAssertNoThrow(x = try compute())がテストでよくある書き方だからである。許可リストを空にすると、この行が報告される。
warning: [NoAssignmentInExpressions] move this assignment expression into its own statement選んだ値:デフォルトの["XCTAssertNoThrow"]のまま。 自分のプロジェクトはXCTestではなくSwift Testingを使っているので、この許可リストは今のところ空回りしている。デフォルトを残しておくコストはない。
orderedImports
OrderedImportsルールの2つのスイッチ。
shouldGroupImports(デフォルトtrue):種類の違うimportをグループに分け、間に空行を入れる。
import Foundationimport UIKit
import enum Swift.Optional
@testable import MyAppimport UIKit順序は、通常のimport → 単一シンボルのimport(import enum Swift.Optional)→ @testable importで、グループ内はアルファベット順。無効にするとすべて混ざり、アルファベット順のみになる。
includeConditionalImports(デフォルトfalse):#ifブロック内のimportも並べ替えるか。
#if canImport(Combine) import Combine import Accelerate import Combine#endif選んだ値:どちらもデフォルトのまま(グループ化 = true、条件付き = false)。 グループ化されていれば@testableが一目で分かる。条件付きコンパイルブロック内のimportの順序には意味がある場合(依存関係など)があるので、ツールに触らせたくない。
五、追加で有効にした10のルール
以下はデフォルトで無効なルールで、自分で有効にしたものである。
AlwaysUseLiteralForEmptyCollectionInit(書き換える)
var names = [String]()var lookup = [String: Int]()var names: [String] = []var lookup: [String: Int] = [:]有効にした理由: どちらの書き方も等価だが、後者は型を型の位置に書いている。宣言の左に型注釈、右に値という形はvar x: Int = 0と同じである。
BeginDocumentationCommentWithOneLineSummary(報告のみ)
ドキュメントコメントの最初の文を、独立した1行の要約にすることを求める。
/// Returns the sum of two integers. This function is very simple. It adds them.func add(_ a: Int, _ b: Int) -> Int { a + b }warning: [BeginDocumentationCommentWithOneLineSummary]add a blank comment line after this sentence: "Returns the sum of two integers."有効にした理由: XcodeのQuick HelpもDocCも、最初の段落だけを要約として取る。3文の要約を書くと、Quick Helpに塊のまま表示される。
NeverForceUnwrap / NeverUseForceTry / NeverUseImplicitlyUnwrappedOptionals(いずれも報告のみ)
warning: [NeverForceUnwrap] do not force unwrap 'Int(s!)'warning: [NeverUseForceTry] do not use force trywarning: [NeverUseImplicitlyUnwrappedOptionals] use 'String' or 'String?' instead of 'String!'有効にした理由: Atofolioは外部データを取り込むアーカイブアプリで、Bangumi、Steam、Apple Musicのフィールドはいつ欠けても形が変わってもおかしくない。プロジェクトの第一原則は「欠けている情報を捏造しない、不明は不明のまま残す」である。!はこの原則と最も直接的に衝突する構文で、「ここには値がないかもしれない」を「ここに値がなければクラッシュする」に変えてしまう。
この3つはlintでしか報告されず、コードを書き換えない。書き換えるべきでもない。正しい直し方(guard let、do/catch、型の変更)は文脈によって変わるからである。
代償として、避けられない報告がいくらか出る。UIKitの@IBOutletは設計上、暗黙的アンラップである。Bundle.main.url(forResource:)のような「リソースは必ずappバンドルに入っている」呼び出しも!なしで書くのは難しい。その場合は一行のコメントで個別に免除する。
// swift-format-ignore: NeverUseImplicitlyUnwrappedOptionalsvar label: String!この指示は直後の宣言にだけ効き、それ以降の宣言は通常どおり検査される。ファイル全体を免除するには// swift-format-ignore-fileを使う。
NoEmptyLinesOpeningClosingBraces(書き換える)
struct S {
var x = 1
}有効にした理由: 波括弧に接した空行は何のグループも表さない。改行キーを押した痕跡でしかない。
OmitExplicitReturns(書き換える)
func double(_ x: Int) -> Int { return x * 2 x * 2}var squared: Int { return 4 4}有効にした理由: SwiftUIのbodyも多くの計算プロパティも単一の式である。言語が省略を許している以上、各自の習慣に任せるのではなくツールに統一して省かせる。後述のデフォルトルールUseSingleLinePropertyGetter(余分なget { }を取り除く)と組み合わせると、計算プロパティは式そのものだけまで簡略化される。
これについては少し疑いを残している。returnを省くと、単一式の関数とクロージャが視覚的に区別しにくくなる。ただしSwiftUIのコードでは利点のほうが大きい。
UseEarlyExits(書き換える)
func f(_ x: Int?) { if let x = x { print(x) } else { guard let x = x else { return } print(x) print("done")}有効にした理由: guardは「条件を満たさなければ抜ける」という意図を先頭に置き、主な処理を最も外側のインデントに残す。Swiftでは珍しい、ツールが確実に実行できる意味レベルの書き換えである。
else節が単一の脱出文だけの場合しか扱わないので、複雑な分岐が勝手に変えられることはない。
UseWhereClausesInForLoops(書き換える)
func f(_ xs: [Int]) { for x in xs { if x > 0 { print(x) } for x in xs where x > 0 { print(x) }}有効にした理由: インデントが1段減り、whereが「絞り込み」と「処理」を構文レベルで分けてくれる。
ValidateDocumentationComments(報告のみ)
ドキュメントコメントの引数リストが実際のシグネチャと一致しているか検査する。
/// Returns the sum.////// - Parameters:/// - a: first/// - c: wrong name/// - Returns: the sumfunc add(a: Int, b: Int) -> Int { a + b }warning: [ValidateDocumentationComments]change the parameters of the documentation of 'add' to match its parameters有効にした理由: ドキュメントコメントとシグネチャのずれは、最も気づきにくい種類の誤りである。コンパイルにも実行にも影響せず、次にコードを読む人(たいてい自分)を誤解させるだけだからである。
六、デフォルトで有効なルール
swift-formatがデフォルトで有効にしていて、自分もすべてそのまま残しているものである。働きごとに分け、最小の例を一つずつ挙げる。
書き換える側
DoNotUseSemicolons —— セミコロンを改行にする。
let a = 1; let b = 2;let a = 1let b = 2FullyIndirectEnum —— すべてのcaseがindirectならenum側に引き上げる。
enum Tree { indirect case node(Tree, Tree) indirect case leaf(Tree)indirect enum Tree { case node(Tree, Tree) case leaf(Tree)}GroupNumericLiterals —— 長い数値リテラルにアンダースコアの区切りを入れる。
let big = 1000000let hex = 0xFFFFFFFFlet big = 1_000_000let hex = 0xFFFF_FFFFlet bin = 0b11110000最後の行が変わっていないことに注意。8桁の2進数リテラルは閾値の内側である。
NoAccessLevelOnExtensionDeclaration —— アクセスレベルをextensionからメンバーへ移す。
public extension String { func shout() -> String { uppercased() }extension String { public func shout() -> String { uppercased() }}NoAssignmentInExpressions —— 式の中の代入を独立した文に分ける。
func f() -> Int { var x = 0 return x = 5 x = 5 return}(この例は元のコードからして怪しく、書き換えた結果もコンパイルできるとは限らない。このルールの価値は、その行を見直させることにある。)
NoCasesWithOnlyFallthrough —— fallthroughだけのcaseを統合する。
case 1: fallthroughcase 2:case 1, 2: print("small")NoEmptyTrailingClosureParentheses —— トレイリングクロージャの前の空の括弧。
UIView.animate() {UIView.animate {NoLabelsInCasePatterns —— caseパターン内の余分なラベル。
case .a(x: let x, y: let y):case .a(let x, let y):NoParensAroundConditions —— 条件式を囲む括弧。
if (x > 0) {if x > 0 {while (x < 10) { break }while x < 10 { break }NoVoidReturnOnFunctionSignature —— 関数シグネチャ上の明示的な-> Void。
func f() -> Void {}func g() -> () {}func f() {}func g() {}ReturnVoidInsteadOfEmptyTuple —— クロージャ型の()をVoidにする。
let handler: (Int) -> () = { _ in }let handler: (Int) -> Void = { _ in }前のルールと向きが逆だが矛盾はしていない。関数シグネチャ上の戻り値の型は削除し、型注釈の中ではVoidと書く。
OneCasePerLine —— 関連値や生の値を持つcaseを独立した行にする。
enum E { case a, b, c(Int) case d = 1, e = 2 case a, b case c(Int) case d = 1 case e = 2}値を持たないcase a, bは1行のまま残ることに注意。
OneVariableDeclarationPerLine —— 1行に1つの変数。
let a = 1, b = 2, c = 3let a = 1let b = 2let c = 3UseExplicitNilCheckInConditions —— 束縛を捨てるif let _をnil比較にする。
if let _ = x {if x != nil {UseLetInEveryBoundCaseVariable —— case let .a(x, y)を各束縛にletを書く形にする。
case let .a(x, y):case .a(let x, let y):UseShorthandTypeNames —— ジェネリクス表記を短縮形にする。
var a: Array<Int> = []var b: Optional<String> = nilvar c: Dictionary<String, Int> = [:]var a: [Int] = []var b: String? = nilvar c: [String: Int] = [:]UseSingleLinePropertyGetter —— 読み取り専用プロパティの余分なget { }。
var x: Int { get { return 1 } return 1}UseTripleSlashForDocumentationComments —— ブロックコメントのドキュメントを///にする。
/** * A documented function. *//// A documented function.func f() {}FileScopedDeclarationPrivacyとOrderedImportsは、それぞれ設定項目を持つため前述した。
報告のみ
コードを変更せず、lintで報告するだけのルールである。
| ルール | 引っかかる例 | 報告内容 |
|---|---|---|
| AlwaysUseLowerCamelCase | let Max_Count = 10 | rename the constant ‘Max_Count’ using lowerCamelCase |
| TypeNamesShouldBeCapitalized | struct myStruct {} | rename the struct ‘myStruct’ using UpperCamelCase |
| DontRepeatTypeInStaticProperties | static let redColor = Color() | remove the suffix ‘Color’ from the name of the variable ‘redColor’ |
| IdentifiersMustBeASCII | let café = 1 | remove non-ASCII characters from ‘café’: é |
| AmbiguousTrailingClosureOverload | ラベルだけが違うクロージャ引数のオーバーロード | rename ‘f(a:)’ so it is no longer ambiguous when called with a trailing closure |
| AvoidRetroactiveConformances | extension URL: @retroactive Identifiable | do not declare retroactive conformances |
| NoBlockComments | /* comment */ | replace this block comment with line comments |
| NoPlaygroundLiterals | #colorLiteral(...) | replace ‘#colorLiteral’ with a call to an initializer on ‘NSColor’ or ‘UIColor’ |
| OnlyOneTrailingClosureArgument | クロージャ引数とトレイリングクロージャの併用 | revise this function call to avoid using both closure arguments and a trailing closure |
| ReplaceForEachWithForLoop | xs.forEach { ... } | replace use of ‘.forEach { … }’ with for-in loop |
| UseSynthesizedInitializer | 合成されるものと同一のinit | remove this explicit initializer |
このグループには特に意見はない。報告される内容はどれも実際の問題である。一つだけ触れておくとReplaceForEachWithForLoopで、forEachの中ではbreakもcontinueも使えず、returnの意味も直感と違う(そのクロージャ呼び出しを抜けるだけである)ので、for-inのほうが確かに安全である。
七、無効のままにした2つ
この2つはswift-formatがデフォルトで無効にしていて、自分も有効にしていない。
AllPublicDeclarationsHaveDocumentation —— すべてのpublic宣言にドキュメントコメントを求める。
warning: [AllPublicDeclarationsHaveDocumentation] add a documentation comment for 'S'無効にした理由: Atofolioはアプリであって、ライブラリではない。アプリターゲット内のpublicの多くはモジュールをまたぐための技術的な都合で、外部の利用者向けのAPIではない。強制すると/// The title.のような、名前を言い換えただけのコメントが増える。いつかデータ層を独立したパッケージに切り出すなら、そのパッケージの中で有効にする。
NoLeadingUnderscores —— アンダースコアで始まる識別子を禁止する。
warning: [NoLeadingUnderscores] remove the leading '_' from the name '_internalValue'無効にした理由: 先頭のアンダースコアはSwiftでは構文上の意味を持つ。@State var xは_xという名前のproperty wrapperのインスタンスを生成するし、自分でproperty wrapperを実装するときも内部の格納に_始まりの名前をよく使う。有効にすると言語機能と喧嘩する。
八、実際に使う上での落とし穴
設定ファイルの探し方。 --configurationを付けずに実行すると、swift-formatはフォーマット対象のファイルがあるディレクトリから上へ遡って.swift-formatを探し、最初に見つかったものを使う。深い階層のファイルでもリポジトリ直下の設定を見つけることは実際に確認した。したがってルートに1つ置けば足りる。(Xcode内蔵のフォーマット機能がまったく同じ探索をするかどうかは、スクリプトで検証する手段がないので断定していない。)
未知のキーはエラーにならない。 トップレベルのキー名を打ち間違えると(たとえばlineLenght)、swift-formatは黙って無視する。設定が効いていると思い込んだまま、実際には効いていない状態になる。ただしルール名を間違えた場合は警告が出る。
warning: Configuration contains an unrecognized rule: BogusRuleしたがって設定ファイルは手で書くのではなく、dump-configurationで生成してから値を変えるのがよい。
ルール一覧はツールチェーンに紐づく。 自分の設定のルール一覧は、Xcode 27同梱のswift-formatと完全に一致している。ただしswift-formatのmainブランチにはすでに新しいルール(SwiftTestingNamingConventionsなど)があり、この設定には含まれていない。欠けているルールはデフォルト値が使われる。ツールチェーンを変えたら、あらためてdump-configurationして新しい項目がないか比べる価値がある。
formatとlintは別のコマンドである。 繰り返しになるが、書き換えるルールはformatで働き、報告するだけのルールはlintでなければ見えない。CIでは両方を走らせる必要がある。そうしないとNeverForceUnwrapのようなルールは無効も同然である。
xcrun swift-format lint --strict --recursive --parallel Sourcesxcrun swift-format format --in-place --recursive --parallel Sources設定ファイル全体
{ "version": 1, "lineLength": 100, "indentation": { "spaces": 4 }, "tabWidth": 4, "maximumBlankLines": 1, "indentBlankLines": false, "spacesBeforeEndOfLineComments": 2, "spacesAroundRangeFormationOperators": false, "indentConditionalCompilationBlocks": true, "indentSwitchCaseLabels": false,
"respectsExistingLineBreaks": true, "lineBreakBeforeEachArgument": true, "lineBreakBeforeEachGenericRequirement": true, "lineBreakBeforeControlFlowKeywords": false, "lineBreakBetweenDeclarationAttributes": false, "lineBreakAroundMultilineExpressionChainComponents": false, "prioritizeKeepingFunctionOutputTogether": true,
"multiElementCollectionTrailingCommas": true, "multilineTrailingCommaBehavior": "neverUsed", "reflowMultilineStringLiterals": "onlyLinesOverLength",
"fileScopedDeclarationPrivacy": { "accessLevel": "private" }, "noAssignmentInExpressions": { "allowedFunctions": ["XCTAssertNoThrow"] }, "orderedImports": { "includeConditionalImports": false, "shouldGroupImports": true },
"rules": { "AlwaysUseLiteralForEmptyCollectionInit": true, "BeginDocumentationCommentWithOneLineSummary": true, "NeverForceUnwrap": true, "NeverUseForceTry": true, "NeverUseImplicitlyUnwrappedOptionals": true, "NoEmptyLinesOpeningClosingBraces": true, "OmitExplicitReturns": true, "UseEarlyExits": true, "UseWhereClausesInForLoops": true, "ValidateDocumentationComments": true,
"AllPublicDeclarationsHaveDocumentation": false, "NoLeadingUnderscores": false }}これは変更した部分だけである。実際のファイルにはデフォルトで有効な残り31のルールも入っていて、値はすべてtrueになる。xcrun swift-format dump-configurationで生成して統合すればよい。
判断の基準をまとめると、結局3つしかない。
一つ目はdiffを安定させること。1引数1行、1行1変数はどちらも「一つ変えたら一行だけ動く」ためのものである。末尾カンマも元はこの分類にいたが、最後は残らなかった。すべての場合で一貫させられなかったからである。
二つ目は下限はツールに、表現は人に任せること。respectsExistingLineBreaks: trueがその中心で、手書きの改行をすべて均してしまうフォーマッタは望んでいない。
三つ目はプロジェクトの原則を設定に書き込むこと。Atofolioの原則が「欠けている情報を捏造しない」である以上、NeverForceUnwrapのグループは有効であるべきだ。設定ファイルは実行できるプロジェクトの約束であって、体裁の好みだけではない。
この3つはときどき衝突する。末尾カンマがまさにその例で、diffの安定とルールの一貫性がぶつかり、後者を選んだ。