Develop Reference

Android - set all lint warnings as errors except for certain ones

I am trying to make my continuous integration fail the build when new lint warnings that aren't in the lint-baseline.xml file are introduced. I want to have all lint warnings treated as errors (so the build is aborted), but I'd like a way to specify certain lint checks to be treated as informational or warning level so that they still appear in the lint results, but don't cause the build to be aborted.
Here is an example of basically what I'd like to do (except this doesn't work, the build fails if any non-ignored warnings exist):
lintOptions {
lintConfig file("lint.xml")
baseline file("lint-baseline.xml")
checkAllWarnings true
warningsAsErrors true
abortOnError true
informational 'MissingTranslation, ...' // don't fail the build for these
}
Is there an easy way to treat all lint checks as errors, excluding certain ones? I thought about manually setting all 200+ lint checks to the error level, but that wouldn't be very future proof, since I'd have to update the list every time new lint checks were added.

You should be able to achieve what you want if you do not use the Gradle lintOptions (checkAllWarnings, warningsAsErrors, etc.) to configure which warnings should be treated as errors. Use lint.xml instead. There you can do the following:
<?xml version="1.0" encoding="UTF-8"?>
<lint>
<issue id="MissingTranslation" severity="warning" />
<!-- The following must be at the bottom of your file!
All lint issues (not listed above) will be treated as errors. -->
<issue id="all" severity="error" />
</lint>
In my tests this seemed to work fine and all warnings were treated as errors except for those listed at the top of the lint.xml.
However, I've not tested it in combination with a lint-baseline.xml but I see no reason why it shouldn't work there as well.

For me, this configuration worked:
android {
lintOptions {
warningsAsErrors true
warning 'MissingTranslation', ...
}
}
It seems the options are evaluated in the "correct order" (aka "as I need it"), i.e. first all warnings are elevated to errors, then this settings is overriden again for a single issue id. Using warning instead of disable or ignore ensures the issues are still visible in the report or the IDE.

It doesnt seem informational is a real option from this doc, I suggest:
android {
lintOptions {
checkAllWarnings true
warningsAsErrors true
// use this line to check all rules except those listed
disable 'MissingTranslation', ...
//OR this line to check but not worry about result (i think this is what you want)
ignore 'MissingTranslation', ...
}
}

Mark part of code as "it can not be in release"

Is there any method to mark some place it code, which has to be improved? I seen it before somewhere but can not remember now. It blocks release build, and it is not TODO comment. What is it?

I've found. It is StopShip lint check.
Enable it in build.gradle:
android {
...
lintOptions {
abortOnError true
fatal 'StopShip'
}
}
If you have a //STOPSHIP comment in your code, this will cause an error to be thrown when a release apk is generated.
You can turn on //STOPSHIP highlighting in Android Studio (wasn't enabled by default for me) in Preferences > Editor > Code Style > Inspections. Search for STOPSHIP to find the correct setting.
Source: https://www.reddit.com/r/androiddev/comments/5c8b0a/i_know_android_studio_allows_you_to_make_custom/d9uhdzt/

I don't think there is a native way provided to do so.
You may however do something like this, by control a single boolean:
static boolean isDebug = false;
assert isDebug = true;
if (isDebug)
{
/* Do stuff only for debug builds */
}

We need to use BuildConfig.DEBUG
if (BuildConfig.DEBUG)
{
/* Do stuff only for debug builds */
}
Its the proper way for writing some code only for Debug and no need to use any variables to check for debug as BuildConfig.DEBUG its taken care by Android run system depending on your Build Config.

How to schedule a `lint` error (update: use papercut)

I'm looking for a way to temporarily suppress a lint error or to schedule an error after a particular date or condition.
Here's some context:
I have an android app that is translated to multiple languages and I have set it up so that lint fails with an error if there are missing translations. Evidently this is done so that untranslated strings don't escape into the wild.
Whenever there's a new string resource, it takes a while until it gets translated, during which lint fails.
This can be suppressed or the strings can be marked as untranslatable but that beats the purpose of having the check in the first place.
Aside from that context, there are plenty more instances when a particular setting is "temporary". I don't like having to remember to flip back every switch.
The builds are on a CI server, releases are often and this happens in a team where anyone is able to "temporarily" ignore warnings.
Is there an automagical way to make sure things don't get ignored upon release?
Update:
Since asking this question, someone has developed a library that does just what I asked and more: https://github.com/Stuie/papercut

I don't know how you determin when it is time to de/activate lint. But maybe this helps:
You can switch Lint on/off with a boolean in the gradle script:
android {
lintOptions {
if (lintOn){
checkReleaseBuilds true
abortOnError true
} else {
checkReleaseBuilds false
abortOnError false
}
}
}
Add lintOn=false to your gradle.properties, otherwise gradle won't recognize it as variable.
Now you cann add a task and make it run before the build task:
task preBuild << {
// do stuff to determin if lint should run
lintOn = true
}
build.dependsOn preBuild
In this preBuild task you can now implement some code to check if you should run lint or not.
Here are some good examples of what a task can do.

How to find gradle lintOptions document for android?

I got "...is not translated in ... [MissingTranslation]"error in my android project. I searched by google find something works as abortOnError false and a document about lintOptions.
But I do not want to ignore all lint errors, so I copied xml created by Eclipse as lintConfig file("default-lint.xml"), and it works.
I want to know where can I find the full document about all lint options that can set in the lint.xml?
thanks for any help

Here are all the available options (original source here)
android {
lintOptions {
// set to true to turn off analysis progress reporting by lint
quiet true
// if true, stop the gradle build if errors are found
abortOnError false
// if true, only report errors
ignoreWarnings true
// if true, emit full/absolute paths to files with errors (true by default)
absolutePaths true
// if true, check all issues, including those that are off by default
checkAllWarnings true
// if true, treat all warnings as errors
warningsAsErrors true
// turn off checking the given issue id's
disable 'TypographyFractions','TypographyQuotes'
// turn on the given issue id's
enable 'RtlHardcoded','RtlCompat', 'RtlEnabled'
// check *only* the given issue id's
check 'NewApi', 'InlinedApi'
// if true, don't include source code lines in the error output
noLines true
// if true, show all locations for an error, do not truncate lists, etc.
showAll true
// Fallback lint configuration (default severities, etc.)
lintConfig file("default-lint.xml")
// if true, generate a text report of issues (false by default)
textReport true
// location to write the output; can be a file or 'stdout'
textOutput 'stdout'
// if true, generate an XML report for use by for example Jenkins
xmlReport false
// file to write report to (if not specified, defaults to lint-results.xml)
xmlOutput file("lint-report.xml")
// if true, generate an HTML report (with issue explanations, sourcecode, etc)
htmlReport true
// optional path to report (default will be lint-results.html in the builddir)
htmlOutput file("lint-report.html")
// set to true to have all release builds run lint on issues with severity=fatal
// and abort the build (controlled by abortOnError above) if fatal issues are found
checkReleaseBuilds true
// Set the severity of the given issues to fatal (which means they will be
// checked during release builds (even if the lint target is not included)
fatal 'NewApi', 'InlineApi'
// Set the severity of the given issues to error
error 'Wakelock', 'TextViewEdits'
// Set the severity of the given issues to warning
warning 'ResourceAsColor'
// Set the severity of the given issues to ignore (same as disabling the check)
ignore 'TypographyQuotes'
}
}

Here you can find all the Lint issues you can suppress via the lint.xml like this:
`
<!-- Ignore the ObsoleteLayoutParam issue in the given files -->
<issue id="ObsoleteLayoutParam">
<ignore path="res/layout/activation.xml" />
<ignore path="res/layout-xlarge/activation.xml" />
</issue>
<!-- Ignore the UselessLeaf issue in the given file -->
<issue id="UselessLeaf">
<ignore path="res/layout/main.xml" />
</issue>
<!-- Change the severity of hardcoded strings to "error" -->
<issue id="HardcodedText" severity="error" />
`

You can find the official documentation in android gradle dsl site:
http://google.github.io/android-gradle-dsl/current/com.android.build.gradle.internal.dsl.LintOptions.html#com.android.build.gradle.internal.dsl.LintOptions

How to sign APK on Android Studio even with non-translated strings?

Background
I've recently migrated my app to Android-Studio. I had some issues doing so, but I got over them eventually.
The problem
For some reason, on Android Studio, when I try to sign an APK, I get a lot of errors that look like this:
Error:(16) Error: "..." is not translated in "de" (German), "el" (Greek), "iw" (Hebrew) [MissingTranslation]
(where "..." is a string)
At the bottom, after a lot of errors of this kind, I see this:
Error:Execution failed for task ':app:lintVitalRelease'.
> Lint found fatal errors while assembling a release target.
To proceed, either fix the issues identified by lint, or modify your build script as follows:
...
android {
lintOptions {
checkReleaseBuilds false
// Or, if you prefer, you can continue to check for errors in release builds,
// but continue the build even when errors are found:
abortOnError false
}
}
...
The question
I'm not sure what's wrong and how I can fix it. On Eclipse I did it very easily. Missing translations shouldn't stop me from signing an APK...
To me it seems as if Lint is preventing the exporting of the APK, and that the reason is that I didn't translate all of the strings. Is that true?
Can anyone please help me? How can I fix this, so that Lint will show me just warnings instead? or a confirmation dialog if I'm sure I want to do it?

The cleanest way to solve the problem is to disable Lint checks of missing translations for release builds only.
To do so add "disable 'MissingTranslation'" to your build.gradle file as shown below:
android {
buildTypes {
release {
lintOptions {
disable 'MissingTranslation'
}
}
}
}

To me it seems as if Lint is preventing the exporting of the APK, and
that the reason is that I didn't translate all of the strings. Is that
true?
Yes. Default option is lintOptions.abortOnError = true
Can anyone please help me?
You should open the build.gradle file located at the main project module, or the generic folder if you do not have a module. Then add the suggested lines:
android {
lintOptions {
checkReleaseBuilds false
// Or, if you prefer, you can continue to check for errors in release builds,
// but continue the build even when errors are found:
abortOnError false
}
}
Some Lint warnings are by default turned to studio as errors, I don't actually know why, but in terms of translations I guess that is a way to "stop" you publishing an app that the translation is incomplete due to a last minute additions of some texts.
With the lintOptions checkReleaseBuilds abortOnError you set the checking of Lint not to run for release versions and also not stopping if an "error" is found. Below I explain where the Lint errors settings can be found, so if you want to go further you can go one step forward and read them one by one. Some of them provide helpful instructions for code optimizations.
How can I fix this, so that Lint will show me just warnings instead?
or a confirmation dialog if I'm sure I want to do it?
There is also an option at the Android Studio settings to change any Lint error to Lint warning, but I never test that. I usually turn to the gradle solution.
The option is located at Settings > Inspections > Android Lint. For easy find open Settings and at the search (located at the top) type Lint translation there you can change the translation options appear at the left from errors to warnings.
An other option if your error strings never going to be translated is to add at your XML string files tools:ignore="MissingTranslation" either at the root item or at each non-translatable string.

Simple way to solve this Error
Just add following Code To do add "disable 'MissingTranslation'" to your build.gradle file as shown below:
...
android {
lintOptions {
checkReleaseBuilds false
// Or, if you prefer, you can continue to check for errors in release builds,
// but continue the build even when errors are found:
abortOnError false
}
}
...
OR You can also Add this:
android {
buildTypes {
release {
lintOptions {
disable 'MissingTranslation'
}
}
}
}

You could try to open "Translations Editor" and set the string "..." as "Unstranlatable".
You also must remove all translations of this string.

FWIW: If you don't plan on supporting other languages, then you don't need to disable the lint checks at all. Sometimes your project setup (or a library you're importing) may have accidentally - or intentionally - included a config to support additional languages by declaring a values- folder for that language like this for instance:
<your project source folder>/main/res/values-ar
This was the case for me so I simply removed the folder. But if you have no control over the offending library then one choice is to disable lint abortOnError as indicated in the accepted answer, or find a way to exclude 'library-imported' folders somehow. For the latter option you can start here

there is many solution but i tried
<string name="hello" translatable="false">hello</string>
It's the ignore attribute of the tools namespace in your strings file, as follows:
<?xml version="1.0" encoding="utf-8"?>
<resources
xmlns:tools="http://schemas.android.com/tools"
tools:ignore="MissingTranslation" >
<!-- your strings here; no need now for the translatable attribute -->
</resources>
and from the Gradle
release {
lintOptions {
disable 'MissingTranslation'
}
}
and
android {
lintOptions {
disable 'MissingTranslation'
}
}

Working
buildTypes {
release {
lintOptions {
checkReleaseBuilds false
abortOnError false
}
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}