(#) Logging call to Log instead of Timber !!! WARNING: Logging call to Log instead of Timber This is a warning. Id : `LogNotTimber` Summary : Logging call to Log instead of Timber Severity : Warning Category : Correctness: Messages Platform : Any Vendor : JakeWharton/timber Identifier : com.jakewharton.timber:timber:{version} Feedback : https://github.com/JakeWharton/timber/issues Min : Lint 4.0 Compiled : Lint 7.0 Artifact : [com.jakewharton.timber:timber](com_jakewharton_timber_timber.md.html) Since : 4.6.0 Affects : Kotlin and Java files Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://github.com/JakeWharton/timber/tree/trunk/timber-lint/src/main/java/timber/lint/WrongTimberUsageDetector.kt) Tests : [Source Code](https://github.com/JakeWharton/timber/tree/trunk/timber-lint/src/test/java/timber/lint/WrongTimberUsageDetectorTest.kt) Since Timber is included in the project, it is likely that calls to Log should instead be going to Timber. !!! 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 src/foo/Example.java:5:Warning: Using 'Log' instead of 'Timber' [LogNotTimber] Log.d("TAG", "msg"); ------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here are the relevant source files: `src/foo/Example.java`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~java linenumbers package foo; import android.util.Log; public class Example { public void log() { Log.d("TAG", "msg"); } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `src/foo/Example.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package foo import android.util.Log class Example { fun log() { Log.d("TAG", "msg") } } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://github.com/JakeWharton/timber/tree/trunk/timber-lint/src/test/java/timber/lint/WrongTimberUsageDetectorTest.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, `WrongTimberUsageDetector.usingAndroidLogWithTwoArguments`. To report a problem with this extracted sample, visit https://github.com/JakeWharton/timber/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 implementation("com.jakewharton.timber:timber:5.0.1") // build.gradle implementation 'com.jakewharton.timber:timber:5.0.1' // build.gradle.kts with version catalogs: implementation(libs.timber) # libs.versions.toml [versions] timber = "5.0.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: timber = { module = "com.jakewharton.timber:timber", version.ref = "timber" } ``` 5.0.1 is the version this documentation was generated from; there may be newer versions available. [Additional details about com.jakewharton.timber:timber](com_jakewharton_timber_timber.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("LogNotTimber") fun method() { tag(...) } ``` or ```java // Java @SuppressWarnings("LogNotTimber") void method() { tag(...); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection LogNotTimber 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="LogNotTimber" 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 'LogNotTimber' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore LogNotTimber ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).