Run lint when building android studio projects
I would like to be able to run the lint task when I'm building projects with the android studio to ensure the lint rules are being followed.
I have tried using task dependencies but with no luck. My TeamCity build server uses the build task which runs the lint task so that works great. However, the android studio appears to use generateDebugSources
and compileDebugJava
tasks interchangeably when I have selected the debug build variant.
Here is what I have tried in my build.gradle:
assemble.dependsOn lint
If you just want to configure your Android Studio project to run the lint check before the default run configuration without affecting how your gradle tasks are configured, you can follow these steps.
- Open the run configurations drop down and choose edit
- Select your app run configuration
- Press the '+' to add a new step
- Choose "Gradle-aware Make"
- Type 'check' and choose the option with your app module name and check. (Mine is
:app:check
)
- Press the up arrow to move the new
check
step before the existingGradle-aware make
step
Now, Android Studio will run the lint check and fail the build if any lint errors occur.
To runt lint and analyze your project, simply select Analyze > Inspect Code
.
You should get a nice window with all issues.
Also check Run lint in Android Studio for more information.
I did a little more research, try adding this to your build.gradle
.
lintOptions {
abortOnError true
}
There are many options that you can apply to the build.gradle
To do this in build.gradle, add the following lines to your build.gradle:
android {
applicationVariants.all { variant ->
variant.outputs.each { output ->
def lintTask = tasks["lint${variant.name.capitalize()}"]
output.assemble.dependsOn lintTask
}
}
...
}
This makes all of your assemble tasks depend on the lint task effectively running them before every assemble call that is executed by Android Studio.
Edit
With Android Gradle Plugin 3.3 and Gradle 5.x this is a revised version using Kotlin script:
applicationVariants.all {
val lintTask = tasks["lint${name.capitalize()}"]
assembleProvider.get().dependsOn.add(lintTask)
}