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

Posted 韩曙亮

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Android Gradle 插件LintOptions 配置 ⑦ ( explainIssues 属性配置 | htmlOutput 属性配置 | htmlReport 属性配置 )相关的知识，希望对你有一定的参考价值。

文章目录

Android Plugin DSL Reference 参考文档 :





一、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
创作打卡挑战赛 赢取流量/现金/CSDN周边激励大奖

以上是关于Android Gradle 插件LintOptions 配置 ⑦ ( explainIssues 属性配置 | htmlOutput 属性配置 | htmlReport 属性配置 )的主要内容，如果未能解决你的问题，请参考以下文章

Android Gradle 插件Gradle 自定义 Plugin 插件 ③ ( 自定义插件作用 | Android Gradle 插件的扩展 | 自定义 Extension 扩展 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑥ ( 在 buildSrc 模块中依赖 Android Gradle 插件 | 完整代码示例 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑥ ( 在 buildSrc 模块中依赖 Android Gradle 插件 | 完整代码示例 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ② ( buildSrc 目录中实现 Gradle 插件 | 实现 Gradle 插件代码 | 模块引入插件并编译 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )

Android Gradle 插件Android Module 模块 build.gradle 构建脚本 Groovy 语法分析 ① ( Gradle 二进制插件引入 | Gradle依赖配置 )