【Android Gradle 插件】LintOptions 配置 ⑤ ( absolutePaths 属性配置 | check 属性配置 | checkAllWarnings 属性配置 )

文章目录

• 一、LintOptions#absolutePaths 属性配置
• • 1、配置简介
  • 2、配置原型
  • 3、使用示例
• 二、LintOptions#check 属性配置
• • 1、配置简介
  • 2、配置原型
  • 3、使用示例
• 三、LintOptions#checkAllWarnings 属性配置
• • 1、配置简介
  • 2、配置原型
  • 3、使用示例

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#absolutePaths 属性配置

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

1、配置简介

LintOptions#absolutePaths 属性配置 用于配置 在 Lint 检查后输出的错误提示中 , 是否显示 " 完整的路径 " , 默认情况下 , 显示的路径是基于当前调用 Lint 工具 的相对路径 ;

2、配置原型

LintOptions#absolutePaths 属性配置原型 : 该属性是 boolean 类型的 , 设置 true 或 false ;

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

3、使用示例

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

    lintOptions {
        // 编译时遇到错误, 停止编译
        abortOnError false
        fatal ('ContentDescription')
        // 显示完整路径
        absolutePaths true
    }

二、LintOptions#check 属性配置

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

1、配置简介

LintOptions#check 属性配置 用于配置 Lint 检查的 问题 ID 集合 , 当启动 Lint 检查时 , 就会检查上述配置的 Lint 问题集合 ;

配置的 多个 Lint 问题 ID 之间 , 使用逗号隔开 ;

如果配置了该选项 , 则只检查配置的 Lint 问题集合 , 其它问题不再进行检查 ;

Lint 问题 ID 参考 【Android Gradle 插件】LintOptions 配置 ③ ( LintOptions#error 方法配置 | Lint 问题 ID | 查询 Lint 问题 ID 列表 ) 博客 , 执行

lint --list

命令 , 可以查询所有的 Lint 问题 ID ;

2、配置原型

LintOptions#check 属性配置原型 : 该属性是 Set<String> 类型的 , 设置 String 集合类型属性值 ; 多个 Lint 问题 ID 之间 , 使用逗号隔开 ;

Set<String> check
The exact set of issues to check, or null to run the issues that are enabled by default plus any issues enabled via LintOptions.getEnable() and without issues disabled via LintOptions.getDisable(). If non-null, callers are allowed to modify this collection.

要检查的问题的确切集合，或null以运行默认启用的问题以及通过选项启用的任何问题。
getEnable（）并通过LintOptions禁用无问题。getDisable（）。
如果非null，则允许调用方修改此集合。

3、使用示例

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

    lintOptions {
        // 编译时遇到错误, 停止编译
        abortOnError false
        fatal ('ContentDescription')
        // 显示完整路径
        absolutePaths true
        check 'ContentDescription'
    }

三、LintOptions#checkAllWarnings 属性配置

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

1、配置简介

LintOptions#checkAllWarnings 属性配置 用于配置 Lint 检查时 是否检查所有的 " 警告 " , 如果配置 true , 则默认情况下关闭的警告也会进行检查 ;

2、配置原型

LintOptions#checkAllWarnings 属性配置原型 : 该属性是 boolean 类型的 , 设置 true 或 false ;

boolean checkAllWarnings
Returns whether lint should check all warnings, including those off by default

返回lint是否应检查所有警告，包括默认情况下关闭的警告

3、使用示例

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

    lintOptions {
        // 编译时遇到错误, 停止编译
        abortOnError false
        // 将指定的 Lint 问题 ID 设置为 fatal 级别
        fatal ('ContentDescription')
        // 显示完整路径
        absolutePaths true
        // 设定要检查的 Lint 问题 ID 集合 , 使用逗号隔开
        check 'ContentDescription'
        // 是否检查所有警告
        checkAllWarnings true
    }