ci(swiftlint): 启用 --strict 并清理规则豁免

Author: i-stack

.github/workflows/swift.yml

@@ -30,28 +30,30 @@ jobs:
             brew install swiftlint
           fi
           swiftlint version
-          # 不加 --strict：warning 不阻断 CI，仅 .swiftlint.yml 中明确为 error 级别的规则会失败构建。
-          # 待存量 warning 清零后可改为 --strict 提升门槛。
-          swiftlint --reporter github-actions-logging
+          # --strict：所有 warning 提升为 error。已清零规则（force_unwrapping、modifier_order、
+          # convenience_type、computed_accessors_order 等）一旦回归即阻断构建。
+          # missing_docs 存量未清零，已从 opt_in_rules 移入 disabled_rules（见 .swiftlint.yml），
+          # 补齐文档后恢复并继续由 --strict 守护。
+          swiftlint --strict --reporter github-actions-logging
 
       - name: Resolve SPM dependencies
-        run: xcodebuild -resolvePackageDependencies -scheme STBaseProject-Package
+        run: xcodebuild -resolvePackageDependencies -scheme STBaseProject
 
       - name: Build (iOS Simulator) with compile log
         run: |
           # 完整编译日志供 swiftlint analyze 使用（analyzer_rules 依赖 type-checked AST）。
           # 不使用增量构建缓存，确保日志完整。
           rm -rf ~/Library/Developer/Xcode/DerivedData
           xcodebuild \
-            -scheme STBaseProject-Package \
+            -scheme STBaseProject \
             -destination 'generic/platform=iOS Simulator' \
             clean build | tee xcodebuild.log
 
       - name: SwiftLint Analyze (unused_import / unused_declaration)
         run: |
           # analyzer_rules 仅在 `swiftlint analyze` 下执行；普通 `swiftlint lint` 不会跑。
           # 需完整编译日志（上方 Build 步骤产出 xcodebuild.log）。
-          swiftlint analyze \
+          swiftlint analyze --strict \
             --compiler-log-path xcodebuild.log \
             --reporter github-actions-logging
 

.swiftlint.yml

@@ -25,8 +25,7 @@ disabled_rules:
   # 注意：line_length 是默认开启规则，不在 disabled_rules 中关闭，
   # 直接在下方 line_length: 配置块生效（置于 disabled_rules 会导致同名配置块被忽略）
   - force_try                     # 由 st_no_force_try_outside_markdown 精准限制，允许 STMarkdown 静态正则
-  - blanket_disable_command        # 基础库大量历史 disable 注释，不卡"禁用过多/需 re-enable"风格
-  - superfluous_disable_command    # 同上：保留历史 disable 豁免，不因区域内未触发而告警
+  - missing_docs                   # 存量 882 个公开 API 缺文档，暂不纳入 --strict 门槛；文档补齐专项后再恢复 opt_in_rules
 
 opt_in_rules:
   - empty_count
@@ -59,7 +58,7 @@ opt_in_rules:
   - redundant_string_enum_value
   - sorted_imports
   - toggle_bool
-  - missing_docs                   # ★ 公开 API 缺文档报警（先 warning 观察存量，后续可收紧）
+  - computed_accessors_order
   # === 公共基础库 Bug Prevention（第一批，低风险高价值）===
   - weak_delegate                    # ★ delegate 必须为 weak，否则循环引用
   - discarded_notification_center_observer  # ★ block observer token 应被持有，便于按生命周期移除
@@ -74,11 +73,11 @@ analyzer_rules:
   - unused_import
   - unused_declaration
 
-# 公开 API 文档缺失检查：先 warning 观察存量，待清零后可改为 error 收紧。
-# 仅检查 public 级别（open/internal/private 豁免），避免内部实现噪音。
-# CI 不使用 --strict，因此当前 warning 不阻断；使用 --strict 时会提升为 error。
-missing_docs:
-  warning: public
+# 公开 API 文档缺失检查：存量 882 个未清零，暂移出 opt_in_rules（见 disabled_rules），
+# 待文档补齐专项后再恢复并重新纳入 --strict 门槛。仅检查 public 级别。
+# 恢复方式：从 disabled_rules 移回 opt_in_rules，并重新启用下方配置块：
+# missing_docs:
+#   warning: public
 
 # === 规则参数化 ===
 line_length:
@@ -113,6 +112,14 @@ nesting:
 
 # === 自定义规则 ===
 custom_rules:
+  st_no_swiftlint_disable:
+    name: "SwiftLint disable comments are forbidden"
+    regex: 'swiftlint\s*:\s*disable(?:\s|:|$)'
+    match_kinds:
+      - comment
+    message: "禁止使用 swiftlint:disable 规避规则；请修复真实问题或调整项目级规则配置。"
+    severity: error
+
   st_no_force_try_outside_markdown:
     name: "try! outside STMarkdown is forbidden"
     regex: '\\btry!'

Sources/STBaseModel/STBaseModel.swift

@@ -707,11 +707,9 @@ private struct STPropertyType {
         // attributes 形如：T@"NSString",&,N,V_name
         // 第一段以 'T' 开头，描述类型编码。
         var typeEncoding = ""
-        for component in attributes.split(separator: ",") {
-            if component.first == "T" {
-                typeEncoding = String(component.dropFirst())
-                break
-            }
+        for component in attributes.split(separator: ",") where component.first == "T" {
+            typeEncoding = String(component.dropFirst())
+            break
         }
         self.kind = STPropertyType.parseKind(typeEncoding)
         switch self.kind {
@@ -766,7 +764,7 @@ private struct STPropertyType {
         }
     }
 
-    /// 把传入值尝试转换为属性接受的形式；不兼容时返回 nil。
+    // 把传入值尝试转换为属性接受的形式；不兼容时返回 nil。
     func coerce(_ value: Any) -> Any? {
         switch kind {
         case .object(let className):
@@ -799,7 +797,7 @@ private struct STPropertyType {
             return value
         }
     }
-
+    
     private static func coerceObject(_ value: Any, expectedClassName: String?) -> Any? {
         guard let className = expectedClassName else { return value }
         let resolvedClass: AnyClass? = NSClassFromString(className)

Sources/STBaseView/STBaseView.swift

@@ -572,7 +572,10 @@ extension STBaseView {
         self.tableViewStyle = style
         if self._tableView != nil, self._isInternallyCreatedTableView {
             #if DEBUG
-            assertionFailure("STBaseView.st_tableViewStyle(_:) called after the internal tableView was created. All table configuration (delegate/dataSource/cell registration/pull-to-refresh/load-more) will be lost and must be re-applied.")
+            assertionFailure(
+                "STBaseView.st_tableViewStyle(_:) called after the internal tableView was created. "
+                    + "All table configuration (delegate/dataSource/cell registration/pull-to-refresh/load-more) will be lost and must be re-applied."
+            )
             #endif
             self.st_removePullToRefresh()
             self.st_removeLoadMore()

Sources/STHUD/STAlertController.swift

@@ -184,7 +184,6 @@ open class STAlertController: UIViewController {
 
     /// 是否在点击动作后自动关闭，默认 true
     @available(*, deprecated, renamed: "setAutoDismiss(_:)")
-    // swiftlint:disable:next st_avoid_bool_flag_param
     public func setAutoDismissOnAction(_ enabled: Bool) {
         self.autoDismissOnAction = enabled
     }
@@ -250,7 +249,7 @@ open class STAlertController: UIViewController {
             ].compactMap { $0 })
         }
 
-        if self.alertInfo.title.text != "" && self.alertInfo.message.text != "" {
+        if !self.alertInfo.title.text.isEmpty && !self.alertInfo.message.text.isEmpty {
             self.titleLabel.text = self.alertInfo.title.text
             self.messageLabel.text = self.alertInfo.message.text
             self.alertView.addSubview(self.titleLabel)
@@ -265,15 +264,15 @@ open class STAlertController: UIViewController {
                 NSLayoutConstraint(item: self.messageLabel, attribute: .left, relatedBy: .equal, toItem: self.titleLabel, attribute: .left, multiplier: 1, constant: STAlertLayoutConstant.contentHorizontal),
                 NSLayoutConstraint(item: self.messageLabel, attribute: .right, relatedBy: .equal, toItem: self.titleLabel, attribute: .right, multiplier: 1, constant: -STAlertLayoutConstant.contentHorizontal)
             ])
-        } else if self.alertInfo.title.text != "" && self.alertInfo.message.text == "" {
+        } else if !self.alertInfo.title.text.isEmpty && self.alertInfo.message.text.isEmpty {
             self.titleLabel.text = self.alertInfo.title.text
             self.alertView.addSubview(self.titleLabel)
             self.view.addConstraints([
                 NSLayoutConstraint(item: self.titleLabel, attribute: .top, relatedBy: .equal, toItem: self.alertView, attribute: .top, multiplier: 1, constant: STAlertLayoutConstant.contentTop),
                 NSLayoutConstraint(item: self.titleLabel, attribute: .left, relatedBy: .equal, toItem: self.alertView, attribute: .left, multiplier: 1, constant: STAlertLayoutConstant.contentHorizontal),
                 NSLayoutConstraint(item: self.titleLabel, attribute: .right, relatedBy: .equal, toItem: self.alertView, attribute: .right, multiplier: 1, constant: -STAlertLayoutConstant.contentHorizontal)
             ])
-        } else if self.alertInfo.title.text == "" && self.alertInfo.message.text != "" {
+        } else if self.alertInfo.title.text.isEmpty && !self.alertInfo.message.text.isEmpty {
             self.messageLabel.text = self.alertInfo.message.text
             self.alertView.addSubview(self.messageLabel)
             self.view.addConstraints([
@@ -420,9 +419,9 @@ open class STAlertController: UIViewController {
             ])
         }
         self.view.layoutIfNeeded()
-        if self.alertInfo.message.text != "" {
+        if !self.alertInfo.message.text.isEmpty {
             self.newConstraint?.constant = self.messageLabel.frame.maxY + 54
-        } else if self.alertInfo.title.text != "" {
+        } else if !self.alertInfo.title.text.isEmpty {
             self.newConstraint?.constant = self.titleLabel.frame.maxY + 54
         }
         UIView.animate(withDuration: 0.3) {

Sources/STHUD/STProgressHUD.swift

@@ -172,7 +172,6 @@ public class STProgressHUD: UIView {
 
     @available(*, deprecated, renamed: "show(addedToView:animation:)")
     @discardableResult
-    // swiftlint:disable:next st_avoid_bool_flag_param
     public class func show(addedToView view: UIView, animated: Bool) -> STProgressHUD {
         return show(addedToView: view, animation: animated ? .fade : .none)
     }
@@ -187,7 +186,6 @@ public class STProgressHUD: UIView {
 
     @available(*, deprecated, renamed: "hide(addedToView:animation:)")
     @discardableResult
-    // swiftlint:disable:next st_avoid_bool_flag_param
     public class func hide(addedToView view: UIView, animated: Bool) -> Bool {
         guard let hud = hudForView(view) else { return false }
         hud.removeFromSuperViewOnHide = true
@@ -205,7 +203,6 @@ public class STProgressHUD: UIView {
     }
 
     @available(*, deprecated, renamed: "show(animation:)")
-    // swiftlint:disable:next st_avoid_bool_flag_param
     public func show(animated: Bool) {
         self.showCore(animated: animated)
     }
@@ -216,7 +213,6 @@ public class STProgressHUD: UIView {
     }
 
     @available(*, deprecated, renamed: "hide(animation:)")
-    // swiftlint:disable:next st_avoid_bool_flag_param
     public func hide(animated: Bool) {
         self.hideCore(animated: animated)
     }
@@ -226,7 +222,6 @@ public class STProgressHUD: UIView {
     }
 
     @available(*, deprecated, renamed: "hide(animation:afterDelay:)")
-    // swiftlint:disable:next st_avoid_bool_flag_param
     public func hide(animated: Bool, afterDelay delay: TimeInterval) {
         self.hideCore(animation: animated ? self.animationType.stHUDAnimation : .none, afterDelay: delay)
     }
@@ -615,6 +610,7 @@ private extension STProgressHUD {
 
     func unregisterFromNotifications() {
         #if !os(tvOS)
+        // 与 registerForNotifications() 配对的注销方法，观察者生命周期由注册/注销配对管理。
         NotificationCenter.default.removeObserver(self)
         #endif
     }

Sources/STMedia/STScanView.swift

@@ -275,20 +275,20 @@ public class STScanView: UIView {
                 var newFrame = scanLineView.frame
                 newFrame.origin.y = endY
                 scanLineView.frame = newFrame
-            }
-        ) { [weak self] _ in
-            guard let self, !self.isAnimationStopped else { return }
-            UIView.animate(withDuration: 0.2, animations: {
-                scanLineView.alpha = 0
-            }) { _ in
-                guard !self.isAnimationStopped else { return }
-                let item = DispatchWorkItem { [weak self] in
-                    self?.startAnimation()
-                }
-                self.animationStartWorkItem = item
-                DispatchQueue.main.asyncAfter(deadline: .now() + self.configuration.animationInterval, execute: item)
-            }
-        }
+            },
+            completion: { [weak self] _ in
+                guard let self, !self.isAnimationStopped else { return }
+                UIView.animate(withDuration: 0.2, animations: {
+                    scanLineView.alpha = 0
+                }, completion: { _ in
+                    guard !self.isAnimationStopped else { return }
+                    let item = DispatchWorkItem { [weak self] in
+                        self?.startAnimation()
+                    }
+                    self.animationStartWorkItem = item
+                    DispatchQueue.main.asyncAfter(deadline: .now() + self.configuration.animationInterval, execute: item)
+                })
+            })
     }
 
     private func stopAnimation() {

Sources/STMedia/STScreenshot.swift

@@ -10,7 +10,7 @@ import UIKit
 public final class STScreenshot: NSObject {
 
     @MainActor
-    private class func captureData() -> Data {
+    private static func captureData() -> Data {
         guard let windowScene = UIApplication.shared.connectedScenes.first as? UIWindowScene else {
             return Data()
         }

Sources/STNetwork/STHTTPSession.swift

@@ -679,7 +679,6 @@ open class STHTTPSession: NSObject {
     }
 
     // MARK: - 任务注册
-
     private func register(
         _ request: STRequest,
         task: URLSessionTask,
@@ -842,11 +841,9 @@ extension STHTTPSession: URLSessionDelegate, URLSessionDataDelegate, URLSessionT
 
         let serverCertificates = self.serverCertificates(from: serverTrust)
         if hasCertificatePins {
-            for serverCertificate in serverCertificates {
-                if self.sslPinningConfig.certificates.contains(serverCertificate) {
-                    completionHandler(.useCredential, URLCredential(trust: serverTrust))
-                    return
-                }
+            for serverCertificate in serverCertificates where self.sslPinningConfig.certificates.contains(serverCertificate) {
+                completionHandler(.useCredential, URLCredential(trust: serverTrust))
+                return
             }
         }
 

Sources/STSecurity/STEncrypt.swift

@@ -85,11 +85,11 @@ public extension String {
         return st_hmac(key: key, algorithm: .sha512)
     }
 
-    /// AES-256-GCM 加密
-    /// - Parameters:
-    ///   - key: 密钥字符串
-    ///   - nonce: 随机数（可选，自动生成）
-    /// - Returns: 加密结果，包含密文、随机数和认证标签
+    // AES-256-GCM 加密
+    // - Parameters:
+    //   - key: 密钥字符串
+    //   - nonce: 随机数（可选，自动生成）
+    // - Returns: 加密结果，包含密文、随机数和认证标签
     func st_encryptAES256GCM(key: String, nonce: AES.GCM.Nonce? = nil) throws -> (ciphertext: Data, nonce: AES.GCM.Nonce, tag: Data) {
         let keyData = Data(key.utf8)
         guard keyData.count == 32 else {
@@ -201,11 +201,11 @@ public extension Data {
         }
     }
 
-    /// AES-256-GCM 加密
-    /// - Parameters:
-    ///   - key: 密钥数据
-    ///   - nonce: 随机数（可选，自动生成）
-    /// - Returns: 加密结果，包含密文、随机数和认证标签
+    // AES-256-GCM 加密
+    // - Parameters:
+    //   - key: 密钥数据
+    //   - nonce: 随机数（可选，自动生成）
+    // - Returns: 加密结果，包含密文、随机数和认证标签
     func st_encryptAES256GCM(key: Data, nonce: AES.GCM.Nonce? = nil) throws -> (ciphertext: Data, nonce: AES.GCM.Nonce, tag: Data) {
         guard key.count == 32 else {
             throw STCryptoError.invalidKey