Harmonize：现代Swift代码架构和谐工具-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00065/article/details/147659763

Harmonize：现代Swift代码架构和谐工具

Harmonize Harmonize is a modern linter for Swift that allows you to write architectural lint rules as unit tests, helping your team to keep your codebase clean, maintainable, and consistent as it grows, without relying on manual code reviews. 项目地址: https://gitcode.com/gh_mirrors/har/Harmonize

项目介绍

Harmonize 是一款现代化的 Swift 代码静态分析工具，它允许开发者通过编写类似单元测试的规则来对代码结构和架构进行断言、验证和优化。Harmonize 利用 Quick、XCTest 或 Swift Testing 框架，使得团队能够在代码库增长过程中保持代码的清洁、可维护性和一致性，而无需依赖人工代码审查。

项目技术分析

Harmonize 的核心在于将代码规范和架构约束作为单元测试来执行，这种方式突破了传统基于正则表达式（如 SwiftLint）的代码风格检查工具的限制。Harmonize 受到了 Kotlin 的 Konsist 和 Java 的 ArchUnit 的启发，提供了一种更丰富、语义化的方法来强制执行项目的架构和结构指南。

使用方式

Harmonize 的使用方式非常直观，开发者可以像编写单元测试一样编写 lint 规则。例如，创建一个规则来确保所有 ViewModel 类继承自 BaseViewModel：

import Harmonize
import Quick

final class ViewModelsInheritBaseViewModelSpec: QuickSpec {
    override func spec() {
        describe("ViewModels") {
            let viewModels = Harmonize.productionCode().classes()
                .withNameEndingWith("ViewModel")

            it("should inherit from BaseViewModel") {
                viewModels.assertTrue(message: "All ViewModels must inherit from BaseViewModel") {
                    $0.inherits(from: "BaseViewModel")
                }
            }
        }
    }
}

这样的规则会在检测到违反时导致单元测试失败，从而提示开发者进行修正。