【Android Gradle 插件】LintOptions 配置 ⑦ ( explainIssues 属性配置 | htmlOutput 属性配置 | htmlReport 属性配置 )

Android Plugin DSL Reference 参考文档 :

• 文档主页 : https://google.github.io/android-gradle-dsl/2.3/

• BaseExtension 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.BaseExtension.html

• AppExtension ( build.gradle#android 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.AppExtension.html

• build.gradle#android 模块配置文档 : android-gradle-dsl/2.3/com.android.build.gradle.AppExtension.html

• ProductFlavor ( build.gradle#android#defaultConfig 配置 ) 文档 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.ProductFlavor.html

• ProductFlavor#externalNativeBuild 配置 ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) : com.android.build.gradle.internal.dsl.ProductFlavor:externalNativeBuild

• ExternalNativeBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.ExternalNativeBuildOptions.html

• NdkBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild#ndkBuild 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.NdkBuildOptions.html

• CmakeOptions ( build.gradle#android#defaultConfig#externalNativeBuild#cmake 配置 ) 文档位置 : android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.CmakeOptions.html

• JackOptions ( build.gradle#android#defaultConfig#jackOptions 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.JackOptions.html

• AnnotationProcessorOptions ( 注解处理器配置 ) ( build.gradle#android#defaultConfig#javaCompileOptions配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AnnotationProcessorOptions.html

• NdkOptions ( build.gradle#android#defaultConfig#ndk 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.NdkOptions.html

• VectorDrawablesOptions ( build.gradle#android#defaultConfig#vectorDrawables 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.VectorDrawablesOptions.html

• BuildType ( build.gradle#android#buildTypes 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.BuildType.html

• SigningConfig ( build.gradle#android#signingConfigs 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.SigningConfig.html

• AaptOptions ( build.gradle#android#aaptOptions 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AaptOptions.html

• AndroidSourceSets ( build.gradle#android#sourceSets 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceSet.html

• AndroidSourceDirectorySet ( build.gradle#android#sourceSets#aidl/assets/java/jni/jniLibs 配置 ) 文档位置 :android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceDirectorySet.html

• AndroidSourceFile ( build.gradle#android#sourceSets#manifest 配置 ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceFile.html

• DataBindingOptions ( build.gradle#android#dataBinding ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DataBindingOptions.html

• DexOptions ( build.gradle#android#dexOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DexOptions.html

• LintOptions ( build.gradle#android#lintOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html

• NDK 参考文档 : Add C and C++ Code to Your Project.

一、LintOptions#explainIssues 属性配置

LintOptions ( build.gradle#android#lintOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html

1、配置简介

LintOptions#explainIssues 属性配置 用于配置 是否返回 Lint 检查中 , 检查出的问题的详解 ;

2、配置原型

LintOptions#explainIssues 属性配置原型 : boolean 类型 , 设置 true 或 false ;

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

返回lint是否应包含问题错误的解释。
（请注意，HTML和XML报告有意无条件地执行此操作，忽略此设置。）

3、使用示例

LintOptions#explainIssues 属性配置使用示例 :

    lintOptions {
        // 编译时遇到错误, 停止编译
        abortOnError false
        // 将指定的 Lint 问题 ID 设置为 fatal 级别
        fatal ('ContentDescription')
        // 显示完整路径
        absolutePaths true
        // 设定要检查的 Lint 问题 ID 集合 , 使用逗号隔开
        check 'ContentDescription'
        // 是否检查所有警告
        checkAllWarnings true
        // 发布版本是否检查 fatal 级别的错误
        checkReleaseBuilds true
        // 设定要 关闭 检查的 Lint 问题 ID 集合 , 字符串之间使用逗号隔开
        disable 'UnusedResources'
        // 设定要 开启 检查的 Lint 问题 ID 集合 , 字符串之间使用逗号隔开
        enable 'ContentDescription'
        // 检查结果是否带详解
        explainIssues true
    }

二、LintOptions#htmlOutput 属性配置

LintOptions ( build.gradle#android#lintOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html

1、配置简介

LintOptions#htmlOutput 属性配置 用于配置 html 输出文件 ;

需要配置 File 对象 ;

2、配置原型

LintOptions#htmlOutput 属性配置原型 : File 类型对象 , 需要配置一个 Java 的 File 实例对象 , 使用 File(path) , 传入 文件路径 参数即可 ;

File htmlOutput
The optional path to where an HTML report should be written

编写HTML报告的可选路径

3、使用示例

LintOptions#htmlOutput 属性配置使用示例 :

    lintOptions {
        // 编译时遇到错误, 停止编译
        abortOnError false
        // 将指定的 Lint 问题 ID 设置为 fatal 级别
        fatal ('ContentDescription')
        // 显示完整路径
        absolutePaths true
        // 设定要检查的 Lint 问题 ID 集合 , 使用逗号隔开
        check 'ContentDescription'
        // 是否检查所有警告
        checkAllWarnings true
        // 发布版本是否检查 fatal 级别的错误
        checkReleaseBuilds true
        // 设定要 关闭 检查的 Lint 问题 ID 集合 , 字符串之间使用逗号隔开
        disable 'UnusedResources'
        // 设定要 开启 检查的 Lint 问题 ID 集合 , 字符串之间使用逗号隔开
        enable 'ContentDescription'
        // 检查结果是否带详解
        explainIssues true
        // html 输出文件
        htmlOutput File('lint.html')
    }

三、LintOptions#htmlReport 属性配置

LintOptions ( build.gradle#android#lintOptions ) 文档位置 : android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html

1、配置简介

LintOptions#htmlReport 属性配置 用于配置 是否生成 html 输出文件 ;

默认配置为 true ;

2、配置原型

LintOptions#htmlReport 属性配置原型 : boolean 类型对象 , 设置 true 或 false ;

boolean htmlReport
Whether we should write an HTML report. Default true. 
The location can be controlled by LintOptions.getHtmlOutput().

我们是否应该写一份HTML报告。默认为true。
该位置可由选项控制。getHtmlOutput（）。

3、使用示例

LintOptions#htmlReport 属性配置使用示例 :

    lintOptions {
        // 编译时遇到错误, 停止编译
        abortOnError false
        // 将指定的 Lint 问题 ID 设置为 fatal 级别
        fatal ('ContentDescription')
        // 显示完整路径
        absolutePaths true
        // 设定要检查的 Lint 问题 ID 集合 , 使用逗号隔开
        check 'ContentDescription'
        // 是否检查所有警告
        checkAllWarnings true
        // 发布版本是否检查 fatal 级别的错误
        checkReleaseBuilds true
        // 设定要 关闭 检查的 Lint 问题 ID 集合 , 字符串之间使用逗号隔开
        disable 'UnusedResources'
        // 设定要 开启 检查的 Lint 问题 ID 集合 , 字符串之间使用逗号隔开
        enable 'ContentDescription'
        // 检查结果是否带详解
        explainIssues true
        // html 输出文件
        htmlOutput File('lint.html')
        // 是否生成 html 输出文件
        htmlReport true
    }