ComposeGuard：项目的核心功能/场景

ComposeGuard：项目的核心功能/场景

ComposeGuard A Gradle plugin for detecting regressions in Jetpack Compose / Compose Multiplatform 项目地址: https://gitcode.com/gh_mirrors/co/ComposeGuard

自动检测 Jetpack Compose 和 Compose Multiplatform 中的回归问题。

项目介绍

ComposeGuard 是一个针对 Android 项目和跨平台项目的 Gradle 插件，旨在帮助开发者检测在 Jetpack Compose 开发过程中可能引入的回归问题。这些问题可能包括新增的不可跳过的可重启 @Composable 函数、不稳定的类、@dynamic 属性以及不稳定参数等。通过在编译阶段自动生成和比较 golden metrics（黄金指标），ComposeGuard 可以在项目构建过程中及时发现这些问题，从而确保应用的稳定性和性能。

项目技术分析

ComposeGuard 插件通过以下技术手段实现自动检测功能：

1. 编译时检测：插件在编译时生成 golden metrics，并与之前的 golden metrics 进行对比，以检测是否有不稳定因素引入。
2. Gradle 任务集成：插件为 Android 和 Multiplatform 项目添加了特定的 Gradle 任务，如 <variant>ComposeCompilerGenerate 和 <variant>ComposeCompilerCheck，以方便在构建过程中执行检测。
3. 配置灵活性：开发者可以根据项目需求，自定义哪些检查项应该启用或禁用，以及 golden metrics 的输出目录。

项目及技术应用场景

ComposeGuard 适用于以下场景：

• Android 应用开发：确保在添加新功能或修改现有代码时，不会引入破坏稳定性的变更。
• 跨平台项目开发：在支持多种平台（如 Android、iOS、Web）的 Compose Multiplatform 项目中，统一检测和确保稳定性。
• 持续集成/持续部署（CI/CD）：集成到 CI/CD 流程中，自动检测每次代码提交可能引入的稳定性问题。

项目特点

1. 自动生成和比较 golden metrics：自动生成 golden metrics 并与基准值进行比较，以便快速发现潜在的稳定性问题。
2. 高度可配置：开发者可以根据项目需求，开启或关闭特定的检查项，以及自定义 golden metrics 的输出目录。
3. 多平台支持：无论是在 Android、iOS 还是 Web 平台上，ComposeGuard 都能提供稳定性检测。
4. 集成方便：通过简单的 Gradle 插件配置，即可将 ComposeGuard 集成到项目中。
5. 性能优化：提供了禁用 Kotlin 编译任务配置的选项，以便在性能敏感的项目中减少编译时间。

以下是一个简单的示例，展示了如何在项目中添加和配置 ComposeGuard：

// 在根 build.gradle 文件中
plugins {
    id("com.joetr.compose.guard") version "<latest version>" apply false
}

// 在需要应用检查的模块中
plugins {
    id("com.joetr.compose.guard")
}

// 配置 ComposeGuard
composeGuardCheck {
    errorOnNewDynamicProperties = false
    errorOnNewRestartableButNotSkippableComposables = false
    errorOnNewUnstableClasses = false
    errorOnNewUnstableParams = false
    ignoreUnstableParamsOnSkippableComposables = true
    reportAllOnMissingBaseline = true
    assumeRuntimeStabilityAsUnstable = true
}

通过上述配置，开发者可以自定义哪些类型的稳定性问题需要被检测，以及如何处理这些问题的检测报告。

总之，ComposeGuard 是一个强大的工具，可以帮助开发者在项目开发过程中及时发现并解决稳定性问题，确保应用在迭代过程中的稳定性和性能。通过自动化的检测流程，它不仅减少了手动检查的工作量，还提高了代码质量，是 Android 和跨平台项目开发中不可或缺的助手。

ComposeGuard A Gradle plugin for detecting regressions in Jetpack Compose / Compose Multiplatform 项目地址: https://gitcode.com/gh_mirrors/co/ComposeGuard