Merge pull request #230 from shiguredo/feature/switch-to-swift-format

フォーマッターを swift-format に移行する

Author: zztkm

.github/workflows/build.yml

@@ -52,7 +52,7 @@ jobs:
             CODE_SIGNING_REQUIRED=NO \
             CODE_SIGN_IDENTITY= \
             PROVISIONING_PROFILE=
-    - name: Check uncommitted unformatted code
+    - name: Lint
       run: |
         ./lint-format.sh
   slack_notify_succeeded:

.swift-format

@@ -0,0 +1,71 @@
+{
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "spacesBeforeEndOfLineComments": 1,
+  "indentConditionalCompilationBlocks" : true,
+  "indentSwitchCaseLabels" : false,
+  "indentation" : {
+    "spaces" : 4
+  },
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : false,
+  "lineBreakBeforeEachGenericRequirement" : false,
+  "lineLength" : 100,
+  "maximumBlankLines" : 1,
+  "multiElementCollectionTrailingCommas" : true,
+  "noAssignmentInExpressions" : {
+    "allowedFunctions" : [
+      "XCTAssertNoThrow"
+    ]
+  },
+  "prioritizeKeepingFunctionOutputTogether" : false,
+  "respectsExistingLineBreaks" : true,
+  "rules" : {
+    "AllPublicDeclarationsHaveDocumentation" : false,
+    "AlwaysUseLiteralForEmptyCollectionInit" : false,
+    "AlwaysUseLowerCamelCase" : true,
+    "AmbiguousTrailingClosureOverload" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
+    "DoNotUseSemicolons" : true,
+    "DontRepeatTypeInStaticProperties" : true,
+    "FileScopedDeclarationPrivacy" : true,
+    "FullyIndirectEnum" : true,
+    "GroupNumericLiterals" : true,
+    "IdentifiersMustBeASCII" : true,
+    "NeverForceUnwrap" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoPlaygroundLiterals" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : false,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "TypeNamesShouldBeCapitalized" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : true,
+    "UseLetInEveryBoundCaseVariable" : true,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : true,
+    "UseSynthesizedInitializer" : true,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "tabWidth" : 8,
+  "version" : 1
+}

CHANGES.md

@@ -17,13 +17,20 @@
   - Configration.role に .sendrecv を指定している場合に multistream を true に更新する処理を削除
   - Configration.spotlightEnabled に .enabled を指定している場合に multistream を true に更新する処理を削除
   - 結果、connect メッセージには Configration.multistreamEnabled に指定した値が送信される
-  - 今後は Configration.role に .sendrecv を指定している場合または Configration.spotlightEnabled に .enabled を指定している場合に Confgration.multistreamEnabled に false を指定すると接続エラーになる 
+  - 今後は Configration.role に .sendrecv を指定している場合または Configration.spotlightEnabled に .enabled を指定している場合に Confgration.multistreamEnabled に false を指定すると接続エラーになる
   - @zztkm
 - [UPDATE] multistreamEnabled を非推奨扱いにする
   - multistreamEnabled の設定が不要なイニシャライザを `Configuration` に追加する
   - ドキュメントコメントに非推奨扱いの旨を追加する
   - @zztkm
 
+### misc
+
+- [CHANGE] フォーマッターを swift-format に移行する
+  - @zztkm
+- [UPDATE] GitHub Actions で format check をするのをやめる
+  - @zztkm
+
 ## 2025.1.1
 
 **リリース日**: 2025-01-23

Podfile.dev

@@ -7,5 +7,4 @@ target 'Sora' do
   use_frameworks!
   pod 'WebRTC', '132.6834.5.3'
   pod 'SwiftLint', '0.51.0'
-  pod 'SwiftFormat/CLI', '0.53.2'
 end

Sora/AspectRatio.swift

@@ -2,8 +2,8 @@ import UIKit
 
 /// :nodoc:
 public enum AspectRatio {
-    case standard // 4:3
-    case wide // 16:9
+    case standard  // 4:3
+    case wide  // 16:9
 
     public func height(forWidth width: CGFloat) -> CGFloat {
         switch self {
@@ -24,9 +24,12 @@ public enum AspectRatio {
 }
 
 private var aspectRatioTable: PairTable<String, AspectRatio> =
-    PairTable(name: "AspectRatio",
-              pairs: [("standard", .standard),
-                      ("wide", .wide)])
+    PairTable(
+        name: "AspectRatio",
+        pairs: [
+            ("standard", .standard),
+            ("wide", .wide),
+        ])
 
 /// :nodoc:
 extension AspectRatio: Codable {

Sora/AudioCodec.swift

@@ -1,14 +1,15 @@
 import Foundation
 
 private let descriptionTable: PairTable<String, AudioCodec> =
-    PairTable(name: "AudioCodec",
-              pairs: [("default", .default),
-                      ("OPUS", .opus),
-                      ("PCMU", .pcmu)])
+    PairTable(
+        name: "AudioCodec",
+        pairs: [
+            ("default", .default),
+            ("OPUS", .opus),
+            ("PCMU", .pcmu),
+        ])
 
-/**
- 音声コーデックを表します。
- */
+/// 音声コーデックを表します。
 public enum AudioCodec {
     /**
      サーバーが指定するデフォルトのコーデック。

Sora/AudioMode.swift

@@ -1,18 +1,15 @@
 import AVFoundation
 import Foundation
 
-/**
- * 音声モード。
- *  ``AVAudioSession`` の音声モードと音声カテゴリを変更します。
- *  詳細な設定を行いたい場合は ``AVAudioSession`` を使用して下さい。
- *
- *  音声カテゴリのオプションは次の値が指定されます:
- *
- *  - ``allowBluetooth``
- *  - ``allowBluetoothA2DP``
- *  - ``allowAirPlay``
- *
- */
+/// 音声モード。
+///  ``AVAudioSession`` の音声モードと音声カテゴリを変更します。
+///  詳細な設定を行いたい場合は ``AVAudioSession`` を使用して下さい。
+///
+///  音声カテゴリのオプションは次の値が指定されます:
+///
+///  - ``allowBluetooth``
+///  - ``allowBluetoothA2DP``
+///  - ``allowAirPlay``
 public enum AudioMode {
     /**
      * デフォルト。
@@ -44,9 +41,7 @@ public enum AudioMode {
     case voiceChat(output: AudioOutput)
 }
 
-/**
- * 音声出力先
- */
+/// 音声出力先
 public enum AudioOutput {
     /// デフォルト。端末の状態に依存します。
     case `default`