Adds Detekt rules for Compose. Updates detekt to 1.23.6. #1822
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JayShortway
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1822 +/- ##
=======================================
Coverage 82.78% 82.78%
=======================================
Files 222 222
Lines 7680 7680
Branches 1081 1081
=======================================
Hits 6358 6358
Misses 899 899
Partials 423 423 ☔ View full report in Codecov by Sentry. |
tonidero
approved these changes
Aug 22, 2024
|
@tonidero I was debating that in my mind as well. In the end I figured that if we want to fix the smells before adding these rules, it'd be a while before we reap the benefits. Maybe we add tickets or something, to tackle 1 offended rule at a time from the baseline? |
|
I think that makes sense yeah. I wouldn't consider it a priority, but we can dedicate some time if we have some downtime |
tonidero
pushed a commit
that referenced
this pull request
Aug 29, 2024
**This is an automatic release.** ### New Features * Paywalls can use custom in-app purchase/restore code (#1777) via James Borthwick (@jamesrb1) ### Bugfixes * [Paywalls] Add spacing between paragraphs and make text go full width so text align applies (#1824) via Josh Holtz (@joshdholtz) ### Dependency Updates * Bump rexml from 3.3.4 to 3.3.6 (#1823) via dependabot[bot] (@dependabot[bot]) * Bump fastlane-plugin-revenuecat_internal from `4c4b8ce` to `85e1c83` (#1812) via dependabot[bot] (@dependabot[bot]) * Adds Detekt rules for Compose. Updates detekt to 1.23.6. (#1822) via JayShortway (@JayShortway) ### Other Changes * Converts MagicWeather's Gradle files to Kotlin (#1821) via JayShortway (@JayShortway) Co-authored-by: revenuecat-ops <ops@revenuecat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Compose has many footguns that are easy to forget. (Think state restoration, remembering, modifier parameters, viewmodel forwarding.) It's unrealistic to expect everyone to always remember all of these. These Detekt rules help to avoid these issues a lot, in my experience. Static checks also ease the pressure on code reviews to spot these issues.
You can find a description of the rules here. They were originally developed at Twitter (1.0), and are currently maintained by the engineer who started the project. Slack is maintaining the Lint version of these same rules.
Note: the Detekt IntelliJ plugin doesn't show violations of these rules (running via Gradle / CI does). For that we'd need to point it to a 66 Mb plugin jar file, which is probably a bad idea to add to the repo. We can do something fancy with Gradle to download it automatically, but that's less of a quick win than just adding the rules. So I figured we can do that later.