[#541] Integrate the Twitter Jetpack Compose Rules Detekt plugin #556

ryan-conway · 2023-11-03T08:01:18Z

closes #541

What happened 👀

Added the compose-rules detekt plugin
Updated detekt-config.yml
Added kotlinx.collections.immutable dependency and updated UI lists to use ImmutableList
Brought detekt rules changes to sample-compose

Insight 📝

As the Twitter compose-rules detekt plugin seems abandoned, we should instead use a forked version from one of the original maintainers which is being actively worked on 🙏🏻
Because compose treats all instances of Collection (i.e., List, Set, etc.) as unstable, we should update all UI usages of collections to use their ImmutableX counterpart to reduce unnecessary recomposition.
- Reference: https://medium.com/androiddevelopers/jetpack-compose-stability-explained-79c10db270c8
We have added ignoreAnnotated: [ 'Preview' ] to the MagicNumber rule as preview composables typically contain hard-coded values and we don't want these to be flagged 👀

Proof Of Work 📹

With incorrect composable name (homeScreenContent), public @Preview and unstable lists:

ryanconway@Ryans-MacBook-Pro-13-2020-Nimble template-compose % detekt

> Task :detekt
.....................................................

53 kotlin files were analyzed.
/Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:41:13: Composable functions that return Unit should start with an uppercase letter.
They are considered declarative entities that can be either present or absent in a composition and therefore follow the naming rules for classes.

See https://mrmans0n.github.io/compose-rules/rules/#naming-composable-functions-properly for more information. [ComposableNaming]
/Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:62:5: Composables annotated with @Preview that are used only for previewing the UI should not be public.

See https://mrmans0n.github.io/compose-rules/rules/#preview-composables-should-not-be-public for more information. [PreviewPublic]
/Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:43:15: The Compose Compiler cannot infer the stability of a parameter if a List<UiModel> is used in it, even if the item type is stable.
You should use Kotlinx Immutable Collections instead: `uiModels: ImmutableList<UiModel>` or create an `@Immutable` wrapper for this class: `@Immutable data class UiModelsList(val items: List<UiModel>)`

See https://mrmans0n.github.io/compose-rules/rules/#avoid-using-unstable-collections for more information. [UnstableCollections]

/Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt - 35min debt
        ComposableNaming - [Composable functions that return Unit should start with an uppercase letter. The(...)] at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:41:13
        PreviewPublic - [Composables annotated with @Preview that are used only for previewing the UI sho(...)] at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:62:5
        UnstableCollections - [The Compose Compiler cannot infer the stability of a parameter if a List<UiModel(...)] at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:43:15

Overall debt: 35min

Compose - 35min debt
        ComposableNaming - [Composable functions that return Unit should start with an uppercase letter. The(...)] at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:41:13
        PreviewPublic - [Composables annotated with @Preview that are used only for previewing the UI sho(...)] at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:62:5
        UnstableCollections - [The Compose Compiler cannot infer the stability of a parameter if a List<UiModel(...)] at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/app/src/main/java/co/nimblehq/template/compose/ui/screens/home/HomeScreen.kt:43:15

Overall debt: 35min

Complexity Report:
        - 1,201 lines of code (loc)
        - 915 source lines of code (sloc)
        - 544 logical lines of code (lloc)
        - 22 comment lines of code (cloc)
        - 86 cyclomatic complexity (mcc)
        - 19 cognitive complexity
        - 3 number of total code smells
        - 2% comment source ratio
        - 158 mcc per 1,000 lloc
        - 5 code smells per 1,000 lloc

Project Statistics:
        - number of properties: 145
        - number of functions: 53
        - number of classes: 32
        - number of packages: 23
        - number of kt files: 53

Successfully generated Checkstyle XML report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.xml
Successfully generated plain text report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.txt
Successfully generated HTML report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.html
Successfully generated SARIF: a standard format for the output of static analysis tools at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.sarif
Successfully generated Markdown report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.md

BUILD SUCCESSFUL in 15s
5 actionable tasks: 1 executed, 4 up-to-date

With fixes applied:

ryanconway@Ryans-MacBook-Pro-13-2020-Nimble template-compose % detekt

> Task :detekt
.....................................................

53 kotlin files were analyzed.
Complexity Report:
        - 1,203 lines of code (loc)
        - 917 source lines of code (sloc)
        - 544 logical lines of code (lloc)
        - 22 comment lines of code (cloc)
        - 86 cyclomatic complexity (mcc)
        - 19 cognitive complexity
        - 0 number of total code smells
        - 2% comment source ratio
        - 158 mcc per 1,000 lloc
        - 0 code smells per 1,000 lloc

Project Statistics:
        - number of properties: 145
        - number of functions: 53
        - number of classes: 32
        - number of packages: 23
        - number of kt files: 53

Successfully generated Checkstyle XML report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.xml
Successfully generated plain text report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.txt
Successfully generated HTML report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.html
Successfully generated SARIF: a standard format for the output of static analysis tools at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.sarif
Successfully generated Markdown report at /Users/ryanconway/Projects/Nimble/android-templates/template-compose/build/reports/detekt/detekt.md

BUILD SUCCESSFUL in 2s
5 actionable tasks: 1 executed, 4 up-to-date

github-actions · 2023-11-03T08:07:28Z

	2 Warnings
⚠️	Uh oh! HomeScreen.kt is under 95% coverage!
⚠️	Uh oh! Your project is under 80% coverage!

Kover report for template-compose:

🧛 Template - Compose Unit Tests Code Coverage: `61.24%`

Coverage of Modified Files:

File	Coverage
`HomeScreen.kt`	`61.42%`
`HomeViewModel.kt`	`100.00%`

Modified Files Not Found In Coverage Report:

Dependencies.kt
ItemList.kt
Plugins.kt
SecondScreen.kt
ThirdScreen.kt
Versions.kt
Versions.kt
build.gradle.kts
build.gradle.kts
build.gradle.kts
build.gradle.kts
detekt-config.yml
detekt-config.yml

Codebase cunningly covered by count Shroud 🧛

Generated by 🚫 Danger

kaungkhantsoe · 2023-11-24T09:00:31Z

Don't we need to apply these changes to sample @ryan-conway ?

lydiasama · 2023-12-07T03:19:57Z

@ryan-conway Conflict 😶‍🌫️

lydiasama · 2023-12-07T03:22:12Z

IMO, the unstable list should be handled in another PR instead. This PR is about to update the Jetpack Compose Rule. 🤔 Please correct me if I'm wrong. 🙇🏻

ryan-conway · 2023-12-15T05:40:59Z

Don't we need to apply these changes to sample @ryan-conway ?

@kaungkhantsoe Updated in bfda1aa

IMO, the unstable list should be handled in another PR instead. This PR is about to update the Jetpack Compose Rule. 🤔 Please correct me if I'm wrong. 🙇🏻

@lydiasama That's a fair point, but since these are new rules introduced in this task it made sense to me to handle them here as well instead of opening another task, what do you think? 🤔

luongvo · 2024-05-28T02:58:27Z

...-compose/app/src/main/java/co/nimblehq/sample/compose/ui/screens/main/second/SecondScreen.kt

    viewModel: SecondViewModel = hiltViewModel(),
    navigator: (destination: BaseDestination) -> Unit,


Should the viewModel param with the default value be located at the end as well?

Suggested change

viewModel: SecondViewModel = hiltViewModel(),

navigator: (destination: BaseDestination) -> Unit,

navigator: (destination: BaseDestination) -> Unit,

viewModel: SecondViewModel = hiltViewModel(),

luongvo · 2024-05-28T03:03:45Z

...-compose/app/src/main/java/co/nimblehq/sample/compose/ui/screens/main/second/SecondScreen.kt

    id: String,
+    modifier: Modifier = Modifier,
    onUpdateClick: () -> Unit,


Please cross-check with some config from https://github.com/appKODE/detekt-rules-compose, which forces us to order the Modifier with the default value at the end. I think that's a good convention to apply as well 🤔

luongvo · 2024-05-28T03:04:21Z

...le-compose/app/src/main/java/co/nimblehq/sample/compose/ui/screens/main/third/ThirdScreen.kt

+    model: UiModel?,
    viewModel: ThirdViewModel = hiltViewModel(),
    navigator: (destination: BaseDestination) -> Unit,


same, params with default values to the bottom.

luongvo · 2024-05-28T03:04:43Z

...le-compose/app/src/main/java/co/nimblehq/sample/compose/ui/screens/main/third/ThirdScreen.kt

 ) {
    ThirdScreenContent(data = model)
 }

 @Composable
-fun ThirdScreenContent(data: UiModel?) {
+fun ThirdScreenContent(


must be private

luongvo · 2024-05-28T03:05:06Z

sample-compose/app/src/main/java/co/nimblehq/sample/compose/ui/screens/main/home/HomeScreen.kt

+    isResultOk: Boolean = false,
    viewModel: HomeViewModel = hiltViewModel(),
    navigator: (destination: BaseDestination) -> Unit,


ryan-conway added the type : chore label Nov 3, 2023

ryan-conway self-assigned this Nov 3, 2023

ryan-conway temporarily deployed to template-compose November 3, 2023 08:01 — with GitHub Actions Inactive

ryan-conway marked this pull request as ready for review November 3, 2023 08:10

ryan-conway requested review from AVI5HEK, chornerman, doannimble, hoangnguyen92dn, kaungkhantsoe, luongvo, lydiasama, manh-t, minhnimble, sleepylee, thiennguyen0196, toby-thanathip and Wadeewee as code owners November 3, 2023 08:10

ryan-conway added this to the 3.27.0 milestone Dec 1, 2023

ryan-conway added 2 commits December 15, 2023 11:58

[#541] Update detekt rules for Jetpack Compose

be92fe1

[#541] Handle unstable collections detekt warning

391946a

ryan-conway force-pushed the feature/541-integrate-the-twitter-jetpack-compose-rules-detekt-plugin branch from 5662c4f to 391946a Compare December 15, 2023 04:59

ryan-conway temporarily deployed to template-compose December 15, 2023 04:59 — with GitHub Actions Inactive

ryan-conway added 2 commits December 15, 2023 12:36

[#538] Move detekt plugin declaration to Plugins file

815f42a

[#538] Apply new detekt rules to sample-compose

bfda1aa

ryan-conway had a problem deploying to template-compose December 15, 2023 05:37 — with GitHub Actions Error

ryan-conway temporarily deployed to template-compose December 15, 2023 05:40 — with GitHub Actions Inactive

chornerman approved these changes Jan 8, 2024

View reviewed changes

manh-t approved these changes Jan 26, 2024

View reviewed changes

ryan-conway modified the milestones: 3.27.0, 3.29.0 Apr 1, 2024

luongvo reviewed May 28, 2024

View reviewed changes

ryan-conway modified the milestones: 3.29.0, 3.30.0 Aug 1, 2024

ryan-conway modified the milestones: 3.30.0, 3.31.0 Nov 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#541] Integrate the Twitter Jetpack Compose Rules Detekt plugin #556

[#541] Integrate the Twitter Jetpack Compose Rules Detekt plugin #556

ryan-conway commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

kaungkhantsoe commented Nov 24, 2023

lydiasama commented Dec 7, 2023

lydiasama commented Dec 7, 2023

ryan-conway commented Dec 15, 2023

luongvo May 28, 2024

luongvo May 28, 2024

luongvo May 28, 2024

luongvo May 28, 2024

luongvo May 28, 2024

		viewModel: SecondViewModel = hiltViewModel(),
		navigator: (destination: BaseDestination) -> Unit,

[#541] Integrate the Twitter Jetpack Compose Rules Detekt plugin #556

Are you sure you want to change the base?

[#541] Integrate the Twitter Jetpack Compose Rules Detekt plugin #556

Conversation

ryan-conway commented Nov 3, 2023 • edited Loading

What happened 👀

Insight 📝

Proof Of Work 📹

github-actions bot commented Nov 3, 2023 • edited Loading

Kover report for template-compose:

🧛 Template - Compose Unit Tests Code Coverage: 61.24%

Coverage of Modified Files:

Modified Files Not Found In Coverage Report:

kaungkhantsoe commented Nov 24, 2023

lydiasama commented Dec 7, 2023

lydiasama commented Dec 7, 2023

ryan-conway commented Dec 15, 2023

luongvo May 28, 2024

Choose a reason for hiding this comment

luongvo May 28, 2024

Choose a reason for hiding this comment

luongvo May 28, 2024

Choose a reason for hiding this comment

luongvo May 28, 2024

Choose a reason for hiding this comment

luongvo May 28, 2024

Choose a reason for hiding this comment

ryan-conway commented Nov 3, 2023 •

edited

Loading

github-actions bot commented Nov 3, 2023 •

edited

Loading

🧛 Template - Compose Unit Tests Code Coverage: `61.24%`