【Android Gradle 插件】LintOptions 配置 ⑪ ( textReport 属性配置 | textOutput 属性配置 )

2023-03-30 15:38:21 浏览数 (2)

文章目录

  • 一、LintOptions#xmlReport 属性配置
    • 1、配置简介
    • 2、配置原型
    • 3、使用示例
  • 二、LintOptions#xmlOutput 属性配置
    • 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#xmlReport 属性配置

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

1、配置简介

LintOptions#xmlReport 属性配置 用于配置 是否开启 xml 报告输出 ;

默认输出 xml 报告 ;

2、配置原型

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

代码语言：javascript复制
boolean xmlReport
Whether we should write an XML report. Default true. The location can be controlled by LintOptions.getXmlOutput().

我们是否应该编写XML报告。默认为true。该位置可由 LintOptions.getXmlOutput() 控制。

3、使用示例

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

代码语言：javascript复制
    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
        // 是否忽略警告 , 只报告错误
        ignoreWarnings true
        // 指定用于备份的配置文件
        lintConfig File('config.xml')
        // 如果检查出的错误 , 是否输出出错位置代码行
        noLines true
        // 终端是否输出分析消息 
        quiet true
        // 是否输出所有的 Lint 检查信息
        showAll true
        // 开启文本报告
        textReport true
        // 文本报告输出文件
        textOutput File('text.txt')
        // 是否将警告当做错误进行处理
        warningsAsErrors true
        // 开启 xml 报告
        xmlReport true
    }

二、LintOptions#xmlOutput 属性配置

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

1、配置简介

LintOptions#xmlOutput 属性配置 用于配置 xml 报告的输出文件 ;

2、配置原型

LintOptions#xmlOutput 属性配置原型 : 该属性设置类型是 java.io.File 类型的 , 直接创建 Java 类即可 ;

代码语言：javascript复制
File xmlOutput
The optional path to where an XML report should be written

编写XML报告的可选路径

3、使用示例

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

代码语言：javascript复制
    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
        // 是否忽略警告 , 只报告错误
        ignoreWarnings true
        // 指定用于备份的配置文件
        lintConfig File('config.xml')
        // 如果检查出的错误 , 是否输出出错位置代码行
        noLines true
        // 终端是否输出分析消息 
        quiet true
        // 是否输出所有的 Lint 检查信息
        showAll true
        // 开启文本报告
        textReport true
        // 文本报告输出文件
        textOutput File('report.txt')
        // 是否将警告当做错误进行处理
        warningsAsErrors true
        // 开启 xml 报告
        xmlReport true
        // xml 报告路径
        xmlOutput File('report.xml')
    }
android gradle 插件 配置 原型

0 人点赞