Jetpack Compose 规则 - 用于 ktlint 和 detekt 的 @Composable 函数静态分析

注意 这个仓库是由原维护者从 Twitter Jetpack Compose 规则 分叉而来。由于所有管理员/维护者都不再在该公司工作，从现在开始项目的开发将在这里继续。如果你来自那个项目，请查看迁移指南。

概述

对于大型团队来说，开始采用 Compose 可能具有挑战性，特别是因为并非每个人都会同时开始或使用相同的模式。我们试图通过创建一系列 Compose 静态检查来缓解这种痛苦。

Compose 拥有很多超能力，但也有一些需要注意的潜在问题正如这个 Twitter 帖子所示。

这就是我们的静态检查发挥作用的地方。我们希望尽可能快地检测到尽可能多的潜在问题。在这种情况下，我们希望在工程师需要审查代码之前就显示错误。与其他静态检查库类似，我们希望这能导致一种"不要责怪信使"的理念，从而促进 Compose 的健康采用。

查看项目网站以获取更多信息：https://mrmans0n.github.io/compose-rules

这个仓库中包含哪些自定义规则？

你可以在规则文档中找到完整的规则列表。它包含了每条规则的内容和原因，我们建议你在采用我们的规则之前阅读它。

有两种方法可以将这些静态检查添加到你的构建中 - 使用 ktlint 或使用 detekt。

与 ktlint 一起使用

你可以参考与 ktlint 一起使用文档。

与 detekt 一起使用

你可以参考与 detekt 一起使用文档。

贡献

我们喜欢与他人分享和学习；欢迎贡献新规则或修复。有关更多信息，请参阅贡献说明。

许可证

    Copyright 2022 Twitter, Inc.
    Copyright 2024 Nacho Lopez.

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.