Stay organized with collections Save and categorize content based on your preferences.

LintOptions

@Incubating interface LintOptions


DSL object for configuring lint options.

This block is replaced by the new Lint block. Unlike most other renamed blocks the new type is unrelated, to allow for some extra changes, such as removing the 'is' prefix from boolean properties.

Example:

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
// 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
// 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
// whether lint should include full issue explanations in the text error output
explainIssues false
// 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' or 'stderr'
//textOutput 'stdout'
textOutput file("$reportsDir/lint-results.txt")
// if true, generate an XML report for use by for example Jenkins
xmlReport true
// file to write report to (if not specified, defaults to lint-results.xml)
xmlOutput file("$reportsDir/lint-report.xml")
// if true, generate an HTML report (with issue explanations, sourcecode, etc)
htmlReport true
// optional path to HTML report (default will be lint-results.html in the builddir)
htmlOutput file("$reportsDir/lint-report.html")
// if true, generate a SARIF report (OASIS Static Analysis Results Interchange Format)
sarifReport true
// optional path to SARIF report (default will be lint-results.sarif in the builddir)
sarifOutput file("$reportsDir/lint-report.html")
// 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'
// Set the severity of the given issues to informational
informational 'StopShip'
// Use (or create) a baseline file for issues that should not be reported
baseline file("lint-baseline.xml")
// Normally most lint checks are not run on test sources (except the checks
// dedicated to looking for mistakes in unit or instrumentation tests, unless
// ignoreTestSources is true). You can turn on normal lint checking in all
// sources with the following flag, false by default:
checkTestSources true
// Like checkTestSources, but always skips analyzing tests -- meaning that it
// also ignores checks that have explicitly asked to look at test sources, such
// as the unused resource check.
ignoreTestSources true
// Normally lint will skip generated sources, but you can turn it on with this flag
checkGeneratedSources true
// Normally lint will analyze all dependencies along with each module; this ensures
// that lint can correctly (for example) determine if a resource declared in a library
// is unused; checking only the library in isolation would not be able to identify this
// problem. However, this leads to quite a bit of extra computation; a library is
// analyzed repeatedly, for each module that it is used in.
checkDependencies false
}
}

Summary

Public functions

@Incubating Unit
baseline(baseline: String)

This function is deprecated. Replaced by lint.baseline

@Incubating Unit
baseline(baselineFile: File)

This function is deprecated. Replaced by lint.baseline

@Incubating Unit

This function is deprecated. Use checkOnly instead; check will turn off all other checks so the method has been renamed to be more explicit about this

@Incubating Unit
check(vararg ids: String)

This function is deprecated. Use checkOnly instead; check will turn off all other checks so the method has been renamed to be more explicit about this

@Incubating Unit

This function is deprecated. Replaced by lint.checkOnly += id

@Incubating Unit
checkOnly(vararg ids: String)

This function is deprecated. Replaced by lint.checkOnly += ids

@Incubating Unit

This function is deprecated. Replaced by lint.disable += ids

@Incubating Unit
disable(vararg ids: String)

This function is deprecated. Replaced by lint.disable += ids

@Incubating Unit

This function is deprecated. Replaced by lint.enable += id

@Incubating Unit
enable(vararg ids: String)

This function is deprecated. Replaced by lint.enable += ids

@Incubating Unit

This function is deprecated. Replaced by lint.error += id

@Incubating Unit
error(vararg ids: String)

This function is deprecated. Replaced by lint.error += ids

@Incubating Unit

This function is deprecated. Replaced by lint.fatal += id

@Incubating Unit
fatal(vararg ids: String)

This function is deprecated. Replaced by lint.fatal += ids

@Incubating Unit

This function is deprecated. Replaced by lint.ignore += id

@Incubating Unit
ignore(vararg ids: String)

This function is deprecated. Replaced by lint.ignore += ids

@Incubating Unit

This function is deprecated. Replaced by lint.informational += id

@Incubating Unit
informational(vararg ids: String)

This function is deprecated. Replaced by lint.informational += ids

@Incubating Unit
textOutput(textOutput: String)

This function is deprecated. Replaced by lint.textOutput

@Incubating Unit
textOutput(textOutput: File)

This function is deprecated. Replaced by lint.textOutput

@Incubating Unit

This function is deprecated. Replaced by lint.warning += id

@Incubating Unit
warning(vararg ids: String)

This function is deprecated. Replaced by lint.warning += ids

Public properties

File?

This property is deprecated. Moved to lint.baseline

MutableSet<String>

This property is deprecated. Moved to lint.checkOnly

MutableSet<String>

This property is deprecated. Moved to lint.disable

MutableSet<String>

This property is deprecated. Moved to lint.enable

File?

This property is deprecated. Moved to lint.htmlOutput

Boolean

This property is deprecated. Moved to lint.htmlReport

Boolean

This property is deprecated. Moved to lint.abortOnError

Boolean

This property is deprecated. Moved to lint.absolutePaths

Boolean

This property is deprecated. Moved to lint.checkAllWarnings

Boolean

This property is deprecated. Moved to lint.checkDependencies

Boolean

This property is deprecated. Moved to lint.checkGeneratedSources

Boolean

This property is deprecated. Moved to lint.checkReleaseBuilds

Boolean

This property is deprecated. Moved to lint.checkTestSources

Boolean

This property is deprecated. Moved to lint.explainIssues

Boolean

This property is deprecated. Moved to lint.ignoreTestSources

Boolean

This property is deprecated. Moved to lint.ignoreWarnings

Boolean

This property is deprecated. Moved to lint.noLines

Boolean

This property is deprecated. Moved to lint.quiet

Boolean

This property is deprecated. Moved to lint.showAll

Boolean

This property is deprecated. Moved to lint.warningsAsErrors

File?

This property is deprecated. Moved to lint.lintConfig

File?

This property is deprecated. Moved to lint.sarifOutput

Boolean

This property is deprecated. Moved to lint.sarifReport

File?

This property is deprecated. Moved to lint.textOutput

Boolean

This property is deprecated. Moved to lint.textReport

File?

This property is deprecated. Moved to lint.xmlOutput

Boolean

This property is deprecated. Moved to lint.xmlReport

Public functions

baseline

@Incubating
fun baseline(baseline: String): Unit

Sets the baseline file to use, if any. The baseline file is an XML report previously created by lint, and any warnings and errors listed in that report will be ignored from analysis.

If you have a project with a large number of existing warnings, this lets you set a baseline and only see newly introduced warnings until you get a chance to go back and address the "technical debt" of the earlier warnings.

baseline

@Incubating
fun baseline(baselineFile: File): Unit

Sets the baseline file to use, if any. The baseline file is an XML report previously created by lint, and any warnings and errors listed in that report will be ignored from analysis.

If you have a project with a large number of existing warnings, this lets you set a baseline and only see newly introduced warnings until you get a chance to go back and address the "technical debt" of the earlier warnings.

check

@Incubating
fun check(id: String): Unit

Adds the id to the set of unique issues to check.

check

@Incubating
fun check(vararg ids: String): Unit

Adds the ids to the set of unique issues to check.

checkOnly

@Incubating
fun checkOnly(id: String): Unit

Adds the id to the set of issues to check. Note that when using this, all other checks are turned off.

checkOnly

@Incubating
fun checkOnly(vararg ids: String): Unit

Adds the id to the set of issues to check. Note that when using this, all other checks are turned off.

disable

@Incubating
fun disable(id: String): Unit

Adds the id to the set of issues to suppress.

disable

@Incubating
fun disable(vararg ids: String): Unit

Adds the ids to the set of issues to suppress.

enable

@Incubating
fun enable(id: String): Unit

Adds the id to the set of issues to enable.

enable

@Incubating
fun enable(vararg ids: String): Unit

Adds the ids to the set of issues to enable.

error

@Incubating
fun error(id: String): Unit

Adds a severity override for the given issue.

error

@Incubating
fun error(vararg ids: String): Unit

Adds a severity override for the given issues.

fatal

@Incubating
fun fatal(id: String): Unit

Adds a severity override for the given issue.

fatal

@Incubating
fun fatal(vararg ids: String): Unit

Adds a severity override for the given issues.

ignore

@Incubating
fun ignore(id: String): Unit

Adds a severity override for the given issue.

ignore

@Incubating
fun ignore(vararg ids: String): Unit

Adds a severity override for the given issues.

informational

@Incubating
fun informational(id: String): Unit

Adds a severity override for the given issue.

informational

@Incubating
fun informational(vararg ids: String): Unit

Adds a severity override for the given issues.

textOutput

@Incubating
fun textOutput(textOutput: String): Unit

Sets the optional path to where a text report should be written

textOutput

@Incubating
fun textOutput(textOutput: File): Unit

Sets the optional path to where a text report should be written

warning

@Incubating
fun warning(id: String): Unit

Adds a severity override for the given issue.

warning

@Incubating
fun warning(vararg ids: String): Unit

Adds a severity override for the given issues.

Public properties

baselineFile

var baselineFileFile?

The baseline file to use, if any. The baseline file is an XML report previously created by lint, and any warnings and errors listed in that report will be ignored from analysis.

If you have a project with a large number of existing warnings, this lets you set a baseline and only see newly introduced warnings until you get a chance to go back and address the "technical debt" of the earlier warnings.

checkOnly

val checkOnlyMutableSet<String>

The exact set of issues to check set by checkOnly. s If empty, lint will detect the issues that are enabled by default plus any issues enabled via enable and without issues disabled via disable.

disable

val disableMutableSet<String>

The set of issue IDs to suppress.

Issues passed to disable to this list, call Callers are allowed to modify this collection.

enable

val enableMutableSet<String>

The set of issue IDs to enable. Callers are allowed to modify this collection.

htmlOutput

var htmlOutputFile?

The optional path to where an HTML report should be written. Setting this property will also turn on htmlReport.

htmlReport

var htmlReportBoolean

Whether we should write an HTML report. Default is true. The location can be controlled by htmlOutput.

isAbortOnError

var isAbortOnErrorBoolean

Whether lint should set the exit code of the process if errors are found

isAbsolutePaths

var isAbsolutePathsBoolean

Whether lint should display full paths in the error output. By default the paths are relative to the path lint was invoked from.

isCheckAllWarnings

var isCheckAllWarningsBoolean

Whether lint should check all warnings, including those off by default

isCheckDependencies

var isCheckDependenciesBoolean

Whether lint should check all dependencies too as part of its analysis. Default is false.

isCheckGeneratedSources

var isCheckGeneratedSourcesBoolean

Returns whether lint should run checks on generated sources.

isCheckReleaseBuilds

var isCheckReleaseBuildsBoolean

Whether lint should check for fatal errors during release builds. Default is true. If issues with severity "fatal" are found, the release build is aborted.

isCheckTestSources

var isCheckTestSourcesBoolean

Whether lint should run all checks on test sources, instead of just the lint checks that have been specifically written to include tests (e.g. checks looking for specific test errors, or checks that need to consider testing code such as the unused resource detector)

isExplainIssues

var isExplainIssuesBoolean

Whether lint should include explanations for issue errors. (Note that HTML and XML reports intentionally do this unconditionally, ignoring this setting.)

isIgnoreTestSources

var isIgnoreTestSourcesBoolean

Whether lint should ignore all test sources. This is like isCheckTestSources, but always skips analyzing tests -- meaning that it also ignores checks that have explicitly asked to look at test sources, such as the unused resource check.

isIgnoreWarnings

var isIgnoreWarningsBoolean

Returns whether lint will only check for errors (ignoring warnings)

isNoLines

var isNoLinesBoolean

Whether lint should include the source lines in the output where errors occurred (true by default)

isQuiet

var isQuietBoolean

Whether lint should be quiet (for example, not write informational messages such as paths to report files written)

isShowAll

var isShowAllBoolean

Whether lint should include all output (e.g. include all alternate locations, not truncating long messages, etc.)

isWarningsAsErrors

var isWarningsAsErrorsBoolean

Whether lint should treat all warnings as errors

lintConfig

var lintConfigFile?

The default config file to use as a fallback. This corresponds to a lint.xml file with severities etc to use when a project does not have more specific information.

sarifOutput

var sarifOutputFile?

The optional path to where a SARIF report (OASIS Static Analysis Results Interchange Format) should be written. Setting this property will also turn on sarifReport.

sarifReport

var sarifReportBoolean

Whether we should write a SARIF (OASIS Static Analysis Results Interchange Format) report. Default is false. The location can be controlled by sarifOutput.

textOutput

var textOutputFile?

The optional path to where a text report should be written. The special value "stdout" can be used to point to standard output. Setting this property will also turn on textReport.

textReport

var textReportBoolean

Whether we should write a text report. Default is false. The location can be controlled by textOutput.

xmlOutput

var xmlOutputFile?

The optional path to where an XML report should be written. Setting this property will also turn on xmlReport.

xmlReport

var xmlReportBoolean

Whether we should write an XML report. Default is true. The location can be controlled by xmlOutput.