LintOptions

@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.

@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.

@Incubating
fun check(id: String): Unit

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

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

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

@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.

@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.

@Incubating
fun disable(id: String): Unit

Adds the id to the set of issues to suppress.

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

Adds the ids to the set of issues to suppress.

@Incubating
fun enable(id: String): Unit

Adds the id to the set of issues to enable.

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

Adds the ids to the set of issues to enable.

@Incubating
fun error(id: String): Unit

Adds a severity override for the given issue.

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

Adds a severity override for the given issues.

@Incubating
fun fatal(id: String): Unit

Adds a severity override for the given issue.

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

Adds a severity override for the given issues.

@Incubating
fun ignore(id: String): Unit

Adds a severity override for the given issue.

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

Adds a severity override for the given issues.

@Incubating
fun informational(id: String): Unit

Adds a severity override for the given issue.

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

Adds a severity override for the given issues.

@Incubating
fun textOutput(textOutput: File): Unit

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

@Incubating
fun textOutput(textOutput: String): Unit

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

@Incubating
fun warning(id: String): Unit

Adds a severity override for the given issue.

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

Adds a severity override for the given issues.

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.

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.

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.

val enable: MutableSet<String>

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

var htmlOutput: File?

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

var htmlReport: Boolean

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

var isAbortOnError: Boolean

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

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.

var isCheckAllWarnings: Boolean

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

var isCheckDependencies: Boolean

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

var isCheckGeneratedSources: Boolean

Returns whether lint should run checks on generated sources.

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.

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)

var isExplainIssues: Boolean

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

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.

var isIgnoreWarnings: Boolean

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

var isNoLines: Boolean

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

var isQuiet: Boolean

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

var isShowAll: Boolean

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

var isWarningsAsErrors: Boolean

Whether lint should treat all warnings as errors

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.

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.

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.

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.

var textReport: Boolean

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

var xmlOutput: File?

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

var xmlReport: Boolean

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