(#) Marks strings which contain formal German words !!! WARNING: Marks strings which contain formal German words This is a warning. Id : `FormalGerman` Summary : Marks strings which contain formal German words Severity : Warning Category : Correctness Platform : Android Vendor : vanniktech/lint-rules/ Feedback : https://github.com/vanniktech/lint-rules/issues Min : Lint 8.0 and 8.1 Compiled : Lint 8.0 and 8.1 Artifact : [com.vanniktech:lint-rules-android](com_vanniktech_lint-rules-android.md.html) Since : 0.24.0 Affects : Resource files Editing : This check runs on the fly in the IDE editor Implementation : [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/main/kotlin/com/vanniktech/lintrules/android/FormalGermanDetector.kt) Tests : [Source Code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/test/kotlin/com/vanniktech/lintrules/android/FormalGermanDetectorTest.kt) Informal language should be used at all times. (##) Example Here is an example of lint warnings produced by this check: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text res/values/config.xml:2:Warning: Formal language "Ihr" detected [FormalGerman] <string name="my_string_1">Wie lautet Ihr Name?</string> ^ res/values/config.xml:3:Warning: Formal language "Sie?" detected [FormalGerman] <string name="my_string_2">Wie heissen Sie?</string> ^ res/values/config.xml:4:Warning: Formal language "Ihrem" detected [FormalGerman] <string name="my_string_3">Frag nach Ihrem Namen.</string> ^ res/values/config.xml:5:Warning: Formal language "Sie" detected [FormalGerman] <string name="my_string_4">Wie Sie möchten</string> ^ res/values/config.xml:6:Warning: Formal language "Ihre" detected [FormalGerman] <string name="my_string_5">Ihre Historie</string> ^ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Here is the source file referenced above: `res/values/config.xml`: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers <resources> <string name="my_string_1">Wie lautet Ihr Name?</string> <string name="my_string_2">Wie heissen Sie?</string> <string name="my_string_3">Frag nach Ihrem Namen.</string> <string name="my_string_4">Wie Sie möchten</string> <string name="my_string_5">Ihre Historie</string> </resources> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can also visit the [source code](https://github.com/vanniktech/lint-rules/tree/master/lint-rules-android-lint/src/test/kotlin/com/vanniktech/lintrules/android/FormalGermanDetectorTest.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, `FormalGermanDetector.formal`. To report a problem with this extracted sample, visit https://github.com/vanniktech/lint-rules/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 lintChecks("com.vanniktech:lint-rules-android:0.25.0") // build.gradle lintChecks 'com.vanniktech:lint-rules-android:0.25.0' // build.gradle.kts with version catalogs: lintChecks(libs.lint.rules.android) # libs.versions.toml [versions] lint-rules-android = "0.25.0" [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: lint-rules-android = { module = "com.vanniktech:lint-rules-android", version.ref = "lint-rules-android" } ``` 0.25.0 is the version this documentation was generated from; there may be newer versions available. [Additional details about com.vanniktech:lint-rules-android](com_vanniktech_lint-rules-android.md.html). (##) Suppressing You can suppress false positives using one of the following mechanisms: * Adding the suppression attribute `tools:ignore="FormalGerman"` 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"?> <resources xmlns:tools="http://schemas.android.com/tools"> ... <string tools:ignore="FormalGerman" .../> ... </resources> ``` * 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="FormalGerman" 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 'FormalGerman' } ``` In Android projects this should be nested inside an `android { }` block. * For manual invocations of `lint`, using the `--ignore` flag: ``` $ lint --ignore FormalGerman ...` ``` * Last, but not least, using baselines, as discussed [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).