(#) Remove androidx.work.WorkManagerInitializer from your AndroidManifest.xml when using on-demand initialization !!! ERROR: Remove androidx.work.WorkManagerInitializer from your AndroidManifest.xml when using on-demand initialization This is an error, and is also enforced at build time when supported by the build system. For Android this means it will run during release builds. Id : `RemoveWorkManagerInitializer` Summary : Remove androidx.work.WorkManagerInitializer from your AndroidManifest.xml when using on-demand initialization Severity : Fatal Category : Correctness Platform : Android Vendor : Android Open Source Project Identifier : androidx.work Feedback : https://issuetracker.google.com/issues/new?component=409906 Min : Lint 8.0 and 8.1 Compiled : Lint 8.7+ Artifact : [androidx.work:work-runtime](androidx_work_work-runtime.md.html) Since : 2.3.0 Affects : Kotlin and Java files and manifest files Editing : This check can *not* run live in the IDE editor Implementation : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/main/java/androidx/work/lint/RemoveWorkManagerInitializerDetector.kt) Tests : [Source Code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/RemoveWorkManagerInitializerDetectorTest.kt) Copyright Year : 2019 If an `android.app.Application` implements `androidx.work.Configuration.Provider`, the default `androidx.startup.InitializationProvider` needs to be removed from the AndroidManifest.xml file. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text AndroidManifest.xml:4:Error: Remove androidx.work.WorkManagerInitializer from your AndroidManifest.xml when using on-demand initialization. [RemoveWorkManagerInitializer] <application /> --------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here are the relevant source files: `AndroidManifest.xml`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers <manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools" package="com.example"> <application /> </manifest> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `com/example/App.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package com.example import android.app.Application import androidx.work.Configuration class App: Application(), Configuration.Provider { override fun onCreate() { } override fun getWorkManagerConfiguration(): Configuration = TODO() } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://cs.android.com/androidx/platform/frameworks/support/+/androidx-main:/work/work-lint/src/test/java/androidx/work/lint/RemoveWorkManagerInitializerDetectorTest.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, `RemoveWorkManagerInitializerDetector.failWhenUsingDefaultManifestMergeStrategy`. To report a problem with this extracted sample, visit https://issuetracker.google.com/issues/new?component=409906. (##) Including !!! This is not a built-in check. To include it, add the below dependency to your project. ``` // build.gradle.kts implementation("androidx.work:work-runtime:2.10.1") // build.gradle implementation 'androidx.work:work-runtime:2.10.1' // build.gradle.kts with version catalogs: implementation(libs.work.runtime) # libs.versions.toml [versions] work-runtime = "2.10.1" [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: work-runtime = { module = "androidx.work:work-runtime", version.ref = "work-runtime" } ``` 2.10.1 is the version this documentation was generated from; there may be newer versions available. [Additional details about androidx.work:work-runtime](androidx_work_work-runtime.md.html). (##) Suppressing You can suppress false positives using one of the following mechanisms: * Adding the suppression attribute `tools:ignore="RemoveWorkManagerInitializer"` on the problematic XML element (or one of its enclosing elements). You may also need to add the following namespace declaration on the root element in the XML file if it's not already there: `xmlns:tools="http://schemas.android.com/tools"`. ```xml <?xml version="1.0" encoding="UTF-8"?> <manifest xmlns:tools="http://schemas.android.com/tools"> ... <application tools:ignore="RemoveWorkManagerInitializer" .../> ... </manifest> ``` * Using a suppression annotation like this on the enclosing element: ```kt // Kotlin @Suppress("RemoveWorkManagerInitializer") fun method() { problematicStatement() } ``` or ```java // Java @SuppressWarnings("RemoveWorkManagerInitializer") void method() { problematicStatement(); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection RemoveWorkManagerInitializer 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="RemoveWorkManagerInitializer" 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 'RemoveWorkManagerInitializer' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore RemoveWorkManagerInitializer ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).