(#) Using a BOM without platform call !!! WARNING: Using a BOM without platform call This is a warning. Id : `BomWithoutPlatform` Summary : Using a BOM without platform call Severity : Warning Category : Correctness Platform : Android Vendor : Android Open Source Project Feedback : https://issuetracker.google.com/issues/new?component=192708 Since : 8.1.0 (July 2023) Affects : Gradle build files and TOML files Editing : This check runs on the fly in the IDE editor See : https://developer.android.com/r/tools/gradle-bom-docs Implementation : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/GradleDetector.kt) Tests : [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/GradleDetectorTest.kt) When including a BOM, the dependency's coordinates must be wrapped in a call to `platform()` for Gradle to interpret it correctly. !!! Tip This lint check has an associated quickfix available in the IDE. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text build.gradle:6:Warning: BOM should be added with a call to platform() [BomWithoutPlatform] implementation(libs.compose.bom) ---------------- build.gradle:7:Warning: BOM should be added with a call to platform() [BomWithoutPlatform] testImplementation(libs.compose.bom) ---------------- build.gradle:8:Warning: BOM should be added with a call to platform() [BomWithoutPlatform] testImplementation "androidx.compose:compose-bom:2023.01.00" ----------------------------------------- build.gradle:9:Warning: BOM should be added with a call to platform() [BomWithoutPlatform] api("androidx.compose:compose-bom:2023.01.00") ----------------------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here are the relevant source files: `src/libs.versions.toml`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~toml linenumbers [versions] composeBom = "2023.01.00" [libraries] compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `build.gradle`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~groovy linenumbers plugins { id 'com.android.application' id 'kotlin-android' } dependencies { implementation(libs.compose.bom) testImplementation(libs.compose.bom) testImplementation "androidx.compose:compose-bom:2023.01.00" api("androidx.compose:compose-bom:2023.01.00") // Make sure we don't complain about existing platforms implementation platform("androidx.compose:compose-bom:2023.01.00") } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/GradleDetectorTest.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, `GradleDetector.testBomWithoutPlatform`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=192708. (##) Suppressing You can suppress false positives using one of the following mechanisms: * Using a suppression comment like this on the line above: ```kt //noinspection BomWithoutPlatform 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="BomWithoutPlatform" 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 'BomWithoutPlatform' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore BomWithoutPlatform ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).