(#) Implicit dependencies of composables should be made explicit !!! ERROR: Implicit dependencies of composables should be made explicit This is an error. Id : `ComposeViewModelInjection` Summary : Implicit dependencies of composables should be made explicit Severity : Error Category : Correctness Platform : Any Vendor : slack Identifier : com.slack.lint.compose:compose-lints Feedback : https://github.com/slackhq/compose-lints/issues Min : Lint 8.7+ Compiled : Lint 8.7+ Artifact : [com.slack.lint.compose:compose-lint-checks](com_slack_lint_compose_compose-lint-checks.md.html) Since : 1.0.0 Affects : Kotlin and Java files and test sources Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://github.com/slackhq/compose-lints/tree/main/compose-lint-checks/src/main/java/slack/lint/compose/ViewModelInjectionDetector.kt) Tests : [Source Code](https://github.com/slackhq/compose-lints/tree/main/compose-lint-checks/src/test/java/slack/lint/compose/ViewModelInjectionDetectorTest.kt) Copyright Year : 2023 Replaced when reporting. (##) Options You can configure this lint checks using the following options: (###) viewmodel-factories A comma-separated list of viewModel factories.. This property should define comma-separated list of allowed viewModel factory function names. Example `lint.xml`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers <lint> <issue id="ComposeViewModelInjection"> <option name="viewmodel-factories" value="some string" /> </issue> </lint> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text src/test.kt:6:Error: Implicit dependencies of composables should be made explicit. Usages of to acquire a ViewModel should be done in composable default parameters, so that it is more testable and flexible. See https://slackhq.github.io/compose-lints/rules/#viewmodels for more information. [ComposeViewModelInjection] val viewModel = <MyVM>() ------------------------ src/test.kt:11:Error: Implicit dependencies of composables should be made explicit. Usages of to acquire a ViewModel should be done in composable default parameters, so that it is more testable and flexible. See https://slackhq.github.io/compose-lints/rules/#viewmodels for more information. [ComposeViewModelInjection] val viewModel: MyVM = () ------------------------ src/test.kt:16:Error: Implicit dependencies of composables should be made explicit. Usages of to acquire a ViewModel should be done in composable default parameters, so that it is more testable and flexible. See https://slackhq.github.io/compose-lints/rules/#viewmodels for more information. [ComposeViewModelInjection] val viewModel: MyVM = () ------------------------ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `src/test.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers import androidx.compose.runtime.Composable import androidx.compose.ui.Modifier @Composable fun MyComposable(modifier: Modifier) { val viewModel = () } @Composable fun MyComposableNoParams() { val viewModel: MyVM = () } @Composable fun MyComposableTrailingLambda(block: () -> Unit) { val viewModel: MyVM = () } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://github.com/slackhq/compose-lints/tree/main/compose-lint-checks/src/test/java/slack/lint/compose/ViewModelInjectionDetectorTest.kt) for the unit tests for this check to see additional scenarios. The above example was automatically extracted from the first unit test found for this lint check, `ViewModelInjectionDetector.errors when a weaverViewModel is used at the beginning of a Composable`. To report a problem with this extracted sample, visit https://github.com/slackhq/compose-lints/issues. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. This lint check is included in the lint documentation, but the Android team may or may not agree with its recommendations. ``` // build.gradle.kts lintChecks("com.slack.lint.compose:compose-lint-checks:1.4.2") // build.gradle lintChecks 'com.slack.lint.compose:compose-lint-checks:1.4.2' // build.gradle.kts with version catalogs: lintChecks(libs.compose.lint.checks) # libs.versions.toml [versions] compose-lint-checks = "1.4.2" [libraries] # For clarity and text wrapping purposes the following declaration is # shown split up across lines, but in TOML it needs to be on a single # line (see https://github.com/toml-lang/toml/issues/516) so adjust # when pasting into libs.versions.toml: compose-lint-checks = { module = "com.slack.lint.compose:compose-lint-checks", version.ref = "compose-lint-checks" } ``` 1.4.2 is the version this documentation was generated from; there may be newer versions available. [Additional details about com.slack.lint.compose:compose-lint-checks](com_slack_lint_compose_compose-lint-checks.md.html). (##) Suppressing You can suppress false positives using one of the following mechanisms: * Using a suppression annotation like this on the enclosing element: ```kt // Kotlin @Suppress("ComposeViewModelInjection") fun method() { problematicStatement() } ``` or ```java // Java @SuppressWarnings("ComposeViewModelInjection") void method() { problematicStatement(); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection ComposeViewModelInjection problematicStatement() ``` * Using a special `lint.xml` file in the source tree which turns off the check in that folder and any sub folder. A simple file might look like this: ```xml <?xml version="1.0" encoding="UTF-8"?> <lint> <issue id="ComposeViewModelInjection" severity="ignore" /> </lint> ``` Instead of `ignore` you can also change the severity here, for example from `error` to `warning`. You can find additional documentation on how to filter issues by path, regular expression and so on [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html). * In Gradle projects, using the DSL syntax to configure lint. For example, you can use something like ```gradle lintOptions { disable 'ComposeViewModelInjection' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore ComposeViewModelInjection ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).