Twitter の Jetpack Compose ルール

大規模なチームが Compose の採用を開始するのは難しい場合があります。特に、全員が同時に、または同じパターンで開始するわけではないためです。Twitter は、一連の Compose 静的チェックを作成することで、この問題を緩和しようとしました。

Compose には多くのスーパーパワーがありますが、この Twitter スレッド に見られるように、注意すべきフットガンもたくさんあります。

ここで、静的チェックの出番です。できるだけ多くの潜在的な問題をできるだけ早く検出したいと考えています。この場合、エンジニアがコードをレビューする前にエラーを表示する必要があります。他の静的チェック ライブラリと同様に、これが Compose の健全な採用を促進する「メッセンジャーを撃つな」という哲学につながることを願っています。

詳細については、プロジェクトの Web サイトをご覧ください: https://twitter.github.io/compose-rules

このリポジトリにバンドルされている Compose の静的チェック

ルールのドキュメントで、ルールの包括的なリストを見つけることができます。これには、各ルールの内容と理由の両方が含まれています。ルールを採用する前に読むことをお勧めします。

これらの静的チェックをビルドに追加するには、ktlint または Detekt を使用する 2 つの方法があります。

ktlint での使用

dependencies {
    ktlintRuleset "com.twitter.compose.rules:ktlint:<VERSION>"
}

詳細については、ktlint の使用に関するドキュメントを参照してください。

Detekt との併用

dependencies {
    detektPlugins "com.twitter.compose.rules:detekt:<VERSION>"
}

詳細については、Detekt の使用に関するドキュメントを参照してください。

貢献する

私たちは他の人から分かち合い、学ぶことが大好きです。新しいルールや修正への貢献は大歓迎です。詳細については、寄稿の手順を参照してください。

ライセンス

    Copyright 2022 Twitter, Inc.

    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.