(#) `createRefsFor(vararg ids: Any)` should have at least one argument and match assigned variables !!! ERROR: `createRefsFor(vararg ids: Any)` should have at least one argument and match assigned variables This is an error. Id : `IncorrectReferencesDeclaration` Summary : `createRefsFor(vararg ids: Any)` should have at least one argument and match assigned variables Severity : Error Category : Correctness Platform : Any Vendor : Android Open Source Project Identifier : androidx.constraintlayout.compose Feedback : https://issuetracker.google.com/issues/new?component=323867&template=1023345 Min : Lint 8.7+ Compiled : Lint 8.7+ Artifact : [androidx.constraintlayout:constraintlayout-compose](androidx_constraintlayout_constraintlayout-compose.md.html) Since : 1.1.0 Affects : Kotlin and Java files Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/constraintlayout/constraintlayout-compose-lint/src/main/java/androidx/constraintlayout/compose/lint/ConstraintLayoutDslDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/constraintlayout/constraintlayout-compose-lint/src/test/java/androidx/constraintlayout/compose/lint/ConstraintLayoutDslDetectorTest.kt) Copyright Year : 2022 `createRefsFor(vararg ids: Any)` conveniently allows creating multiple references using destructuring. However, providing an un-equal amount of arguments to the assigned variables will result in unexpected behavior since the variables may reference a ConstrainedLayoutReference with unknown ID. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text src/example/test.kt:8:Error: Arguments of createRefsFor (2) do not match assigned variables (3) [IncorrectReferencesDeclaration] val (box1, text1, image1) = createRefsFor("box", "text") ------------- src/example/test.kt:9:Error: Arguments of createRefsFor (3) do not match assigned variables (2) [IncorrectReferencesDeclaration] val (box2, text2) = createRefsFor("box", "text", "image") ------------- src/example/test.kt:19:Error: Arguments of createRefsFor (2) do not match assigned variables (3) [IncorrectReferencesDeclaration] val (box1, text1, image1) = createRefsFor("box", "text") ------------- src/example/test.kt:20:Error: Arguments of createRefsFor (3) do not match assigned variables (2) [IncorrectReferencesDeclaration] val (box2, text2) = createRefsFor("box", "text", "image") ------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `src/example/test.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package example import androidx.constraintlayout.compose.* fun Test() { val scopeApplier: ConstraintSetScope.() -> Unit = { val (box, text) = createRefsFor("box", "text") val (box1, text1, image1) = createRefsFor("box", "text") val (box2, text2) = createRefsFor("box", "text", "image") val ids = arrayOf("box", "text") val (box3, text3, image3) = createRefsFor(*ids) } } fun Test2() { val scopeApplier: MotionSceneScope.() -> Unit = { val (box, text) = createRefsFor("box", "text") val (box1, text1, image1) = createRefsFor("box", "text") val (box2, text2) = createRefsFor("box", "text", "image") val ids = arrayOf("box", "text") val (box3, text3, image3) = createRefsFor(*ids) } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/constraintlayout/constraintlayout-compose-lint/src/test/java/androidx/constraintlayout/compose/lint/ConstraintLayoutDslDetectorTest.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, `ConstraintLayoutDslDetector.createRefsForArgumentTest`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=323867&template=1023345. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. ``` // build.gradle.kts implementation("androidx.constraintlayout:constraintlayout-compose:1.1.0") // build.gradle implementation 'androidx.constraintlayout:constraintlayout-compose:1.1.0' // build.gradle.kts with version catalogs: implementation(libs.constraintlayout.compose) # libs.versions.toml [versions] constraintlayout-compose = "1.1.0" [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: constraintlayout-compose = { module = "androidx.constraintlayout:constraintlayout-compose", version.ref = "constraintlayout-compose" } ``` 1.1.0 is the version this documentation was generated from; there may be newer versions available. [Additional details about androidx.constraintlayout:constraintlayout-compose](androidx_constraintlayout_constraintlayout-compose.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("IncorrectReferencesDeclaration") fun method() { problematicStatement() } ``` or ```java // Java @SuppressWarnings("IncorrectReferencesDeclaration") void method() { problematicStatement(); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection IncorrectReferencesDeclaration 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="IncorrectReferencesDeclaration" 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 'IncorrectReferencesDeclaration' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore IncorrectReferencesDeclaration ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).