Lint

interface Lint

com.android.build.api.dsl.Lint

Known Direct Subclasses LintOptions LintOptions DSL object for configuring lint options.

DSL object for configuring lint options. Example:

android {
   lint {
         // 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 methods
abstract Unit	baseline(baseline: String) Sets the baseline file to use, if any.
abstract Unit	baseline(baselineFile: File) Sets the baseline file to use, if any.
abstract Unit	check(id: String) Adds the id to the set of unique issues to check.
abstract Unit	check(vararg ids: String) Adds the ids to the set of unique issues to check.
abstract Unit	checkOnly(id: String) Adds the id to the set of issues to check.
abstract Unit	checkOnly(vararg ids: String) Adds the id to the set of issues to check.
abstract Unit	disable(id: String) Adds the id to the set of issues to suppress.
abstract Unit	disable(vararg ids: String) Adds the ids to the set of issues to suppress.
abstract Unit	enable(id: String) Adds the id to the set of issues to enable.
abstract Unit	enable(vararg ids: String) Adds the ids to the set of issues to enable.
abstract Unit	error(id: String) Adds a severity override for the given issue.
abstract Unit	error(vararg ids: String) Adds a severity override for the given issues.
abstract Unit	fatal(id: String) Adds a severity override for the given issue.
abstract Unit	fatal(vararg ids: String) Adds a severity override for the given issues.
abstract Unit	ignore(id: String) Adds a severity override for the given issue.
abstract Unit	ignore(vararg ids: String) Adds a severity override for the given issues.
abstract Unit	informational(id: String) Adds a severity override for the given issue.
abstract Unit	informational(vararg ids: String) Adds a severity override for the given issues.
abstract Unit	textOutput(textOutput: String) Sets the optional path to where a text report should be written
abstract Unit	textOutput(textOutput: File) Sets the optional path to where a text report should be written
abstract Unit	warning(id: String) Adds a severity override for the given issue.
abstract Unit	warning(vararg ids: String) Adds a severity override for the given issues.

Properties
abstract File?	baselineFile The baseline file to use, if any.
abstract MutableSet<String>	checkOnly The exact set of issues to check set by checkOnly.
abstract MutableSet<String>	disable The set of issue IDs to suppress.
abstract MutableSet<String>	enable The set of issue IDs to enable.
abstract File?	htmlOutput The optional path to where an HTML report should be written.
abstract Boolean	htmlReport Whether we should write an HTML report.
abstract Boolean	isAbortOnError Whether lint should set the exit code of the process if errors are found
abstract Boolean	isAbsolutePaths Whether lint should display full paths in the error output.
abstract Boolean	isCheckAllWarnings Whether lint should check all warnings, including those off by default
abstract Boolean	isCheckDependencies Whether lint should check all dependencies too as part of its analysis.
abstract Boolean	isCheckGeneratedSources Returns whether lint should run checks on generated sources.
abstract Boolean	isCheckReleaseBuilds Whether lint should check for fatal errors during release builds.
abstract Boolean	isCheckTestSources Whether lint should run all checks on test sources, instead of just the lint checks that have been specifically written to include tests (e.
abstract Boolean	isExplainIssues Whether lint should include explanations for issue errors.
abstract Boolean	isIgnoreTestSources Whether lint should ignore all test sources.
abstract Boolean	isIgnoreWarnings Returns whether lint will only check for errors (ignoring warnings)
abstract Boolean	isNoLines Whether lint should include the source lines in the output where errors occurred (true by default)
abstract Boolean	isQuiet Whether lint should be quiet (for example, not write informational messages such as paths to report files written)
abstract Boolean	isShowAll Whether lint should include all output (e.
abstract Boolean	isWarningsAsErrors Whether lint should treat all warnings as errors
abstract File?	lintConfig The default config file to use as a fallback.
abstract File?	sarifOutput The optional path to where a SARIF report (OASIS Static Analysis Results Interchange Format) should be written.
abstract Boolean	sarifReport Whether we should write a SARIF (OASIS Static Analysis Results Interchange Format) report.
abstract File?	textOutput The optional path to where a text report should be written.
abstract Boolean	textReport Whether we should write a text report.
abstract File?	xmlOutput The optional path to where an XML report should be written.
abstract Boolean	xmlReport Whether we should write an XML report.

Public methods

baseline

@Incubating abstract 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 abstract 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 abstract fun check(id: String): Unit

Deprecated.

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

check

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

Deprecated.

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

checkOnly

@Incubating abstract 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 abstract 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 abstract fun disable(id: String): Unit

Adds the id to the set of issues to suppress.

disable

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

Adds the ids to the set of issues to suppress.

enable

@Incubating abstract fun enable(id: String): Unit

Adds the id to the set of issues to enable.

enable

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

Adds the ids to the set of issues to enable.

error

@Incubating abstract fun error(id: String): Unit

Adds a severity override for the given issue.

error

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

Adds a severity override for the given issues.

fatal

@Incubating abstract fun fatal(id: String): Unit

Adds a severity override for the given issue.

fatal

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

Adds a severity override for the given issues.

ignore

@Incubating abstract fun ignore(id: String): Unit

Adds a severity override for the given issue.

ignore

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

Adds a severity override for the given issues.

informational

@Incubating abstract fun informational(id: String): Unit

Adds a severity override for the given issue.

informational

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

Adds a severity override for the given issues.

textOutput

@Incubating abstract fun textOutput(textOutput: String): Unit

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

textOutput

@Incubating abstract fun textOutput(textOutput: File): Unit

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

warning

@Incubating abstract fun warning(id: String): Unit

Adds a severity override for the given issue.

warning

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

Adds a severity override for the given issues.

Properties

baselineFile

abstract var baselineFile: File?

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

abstract val checkOnly: MutableSet<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

abstract val disable: MutableSet<String>

The set of issue IDs to suppress.

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

enable

abstract val enable: MutableSet<String>

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

htmlOutput

abstract var htmlOutput: File?

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

htmlReport

abstract var htmlReport: Boolean

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

isAbortOnError

abstract var isAbortOnError: Boolean

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

isAbsolutePaths

abstract var isAbsolutePaths: Boolean

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

isCheckAllWarnings

abstract var isCheckAllWarnings: Boolean

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

isCheckDependencies

abstract var isCheckDependencies: Boolean

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

isCheckGeneratedSources

abstract var isCheckGeneratedSources: Boolean

Returns whether lint should run checks on generated sources.

isCheckReleaseBuilds

abstract var isCheckReleaseBuilds: Boolean

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

abstract var isCheckTestSources: Boolean

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

abstract var isExplainIssues: Boolean

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

isIgnoreTestSources

abstract var isIgnoreTestSources: Boolean

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

abstract var isIgnoreWarnings: Boolean

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

isNoLines

abstract var isNoLines: Boolean

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

isQuiet

abstract var isQuiet: Boolean

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

isShowAll

abstract var isShowAll: Boolean

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

isWarningsAsErrors

abstract var isWarningsAsErrors: Boolean

Whether lint should treat all warnings as errors

lintConfig

abstract var lintConfig: File?

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

abstract var sarifOutput: File?

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

abstract var sarifReport: Boolean

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

textOutput

abstract var textOutput: File?

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

abstract var textReport: Boolean

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

xmlOutput

abstract var xmlOutput: File?

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

xmlReport

abstract var xmlReport: Boolean

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