ArgInFormattedQuantityStringRes.md.html

<meta charset="utf-8">
(#) Count value in formatted string resource

!!! WARNING: Count value in formatted string resource
   This is a warning.

Id
:   `ArgInFormattedQuantityStringRes`
Summary
:   Count value in formatted string resource
Severity
:   Warning
Category
:   Internationalization
Platform
:   Any
Vendor
:   slack
Identifier
:   slack-lint
Contact
:   https://github.com/slackhq/slack-lints
Feedback
:   https://github.com/slackhq/slack-lints
Min
:   Lint 8.0 and 8.1
Compiled
:   Lint 8.0 and 8.1
Artifact
:   [com.slack.lint:slack-lint-checks](com_slack_lint_slack-lint-checks.md.html)

Affects
:   Kotlin and Java files
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/ArgInFormattedQuantityStringResDetector.kt)
Tests
:   [Source Code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/ArgInFormattedQuantityStringResDetectorTest.kt)
Copyright Year
:   2021

Some languages require modifiers to counted values in written text.
Consider consulting #plz-localization if you are unsure if this
formatted string requires a special modifier. If one is required,
consider using `LocalizationUtils.getFormattedCount()`. If not, suppress
this warning.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/com/slack/lint/Foo.java:7:Warning: This may require a localized
count modifier. If so, use LocalizationUtils.getFormattedCount().
Consult #plz-localization if you are unsure.
[ArgInFormattedQuantityStringRes]
    String s = res.getQuantityString(0, 3, 3, "asdf");
                                              ------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/com/slack/lint/Foo.java`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~java linenumbers
package com.slack.lint;

import android.content.res.Resources;

public class Foo {
  public void bar(Resources res) {
    String s = res.getQuantityString(0, 3, 3, "asdf");
  }
}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://github.com/slackhq/slack-lints/tree/main/slack-lint-checks/src/test/java/slack/lint/ArgInFormattedQuantityStringResDetectorTest.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, `ArgInFormattedQuantityStringResDetector.getQuantityStringWithNoLocalizedFormatTest`.
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.7.4")

// build.gradle
lintChecks 'com.slack.lint:slack-lint-checks:0.7.4'

// build.gradle.kts with version catalogs:
lintChecks(libs.slack.lint.checks)

# libs.versions.toml
[versions]
slack-lint-checks = "0.7.4"
[libraries]
slack-lint-checks = {
    module = "com.slack.lint:slack-lint-checks",
    version.ref = "slack-lint-checks"
}
```

0.7.4 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("ArgInFormattedQuantityStringRes")
  fun method() {
     getQuantityString(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("ArgInFormattedQuantityStringRes")
  void method() {
     getQuantityString(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection ArgInFormattedQuantityStringRes
  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
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="ArgInFormattedQuantityStringRes" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  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 'ArgInFormattedQuantityStringRes'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore ArgInFormattedQuantityStringRes ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>