(#) This is replaced by the caller !!! ERROR: This is replaced by the caller This is an error. Id : `RetrofitUsage` Summary : This is replaced by the caller Severity : Error Category : Correctness Platform : Any Vendor : slack Identifier : slack-lint Contact : https://github.com/slackhq/slack-lints Feedback : https://github.com/slackhq/slack-lints Min : Lint 8.7+ Compiled : Lint 8.7+ Artifact : [com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html) Since : 0.1.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/slack-lints/tree/main/slack-lint-checks/src/main/java/slack/lint/retrofit/RetrofitUsageDetector.kt) Tests : [Source Code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/retrofit/RetrofitUsageDetectorTest.kt) Copyright Year : 2021 This linter reports various common configuration issues with Retrofit. !!! 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/test/Example.kt:11:Error: @FormUrlEncoded requires @PUT, @POST, or @PATCH. [RetrofitUsage] fun wrongMethod(): String ----------- src/test/Example.kt:14:Error: @FormUrlEncoded but has no @Field(Map) parameters. [RetrofitUsage] @FormUrlEncoded --------------- src/test/Example.kt:18:Error: @Field(Map) param requires @FormUrlEncoded. [RetrofitUsage] fun missingAnnotation(@Field("hi") input: String): String ----------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `src/test/Example.kt`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~kotlin linenumbers package test import retrofit2.http.Field import retrofit2.http.FormUrlEncoded import retrofit2.http.GET import retrofit2.http.POST interface Example { @GET("/") @FormUrlEncoded fun wrongMethod(): String @POST("/") @FormUrlEncoded fun missingFieldParams(): String @POST("/") fun missingAnnotation(@Field("hi") input: String): String @FormUrlEncoded @POST("/") fun correct(@Field("hi") input: String): String } ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/retrofit/RetrofitUsageDetectorTest.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, `RetrofitUsageDetector.formEncoding`. To report a problem with this extracted sample, visit https://github.com/slackhq/slack-lints. (##) 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:slack-lint-checks:0.8.2") // build.gradle lintChecks 'com.slack.lint:slack-lint-checks:0.8.2' // build.gradle.kts with version catalogs: lintChecks(libs.slack.lint.checks) # libs.versions.toml [versions] slack-lint-checks = "0.8.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: slack-lint-checks = { module = "com.slack.lint:slack-lint-checks", version.ref = "slack-lint-checks" } ``` 0.8.2 is the version this documentation was generated from; there may be newer versions available. [Additional details about com.slack.lint:slack-lint-checks](com_slack_lint_slack-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("RetrofitUsage") fun method() { problematicStatement() } ``` or ```java // Java @SuppressWarnings("RetrofitUsage") void method() { problematicStatement(); } ``` * Using a suppression comment like this on the line above: ```kt //noinspection RetrofitUsage 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="RetrofitUsage" 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 'RetrofitUsage' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore RetrofitUsage ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).