如何在Gradle的build.gradle文件中禁用Checkstyle的LineLength规则？

问题背景 #

你当前通过Gradle集成Checkstyle，使用内置的google_checks.xml做代码检查，想在build.gradle里直接禁用LineLength规则，但尝试的configProperties方式没起作用。

你的现有Checkstyle配置：

/// Checkstyle linter
// Run by `gradle check`, which is run by `gradle build`
apply plugin: 'checkstyle'
ext.checkstyleVersion = '10.5.0'
configurations {
  checkstyleConfig
}
dependencies {
  checkstyleConfig("com.puppycrawl.tools:checkstyle:${checkstyleVersion}") { transitive = false }
}
checkstyle {
  toolVersion "${checkstyleVersion}"
  ignoreFailures = false
  config = resources.text.fromArchiveEntry(configurations.checkstyleConfig, 'google_checks.xml')
}

之前尝试的无效配置：

checkstyle {
  ...
  configProperties += ['LineLength.max': 140]
  configProperties += ['LineLength.enabled': false]
  configProperties += ['suppressions.suppress': 'LineLength']
}

正确解决方案 #

直接用configProperties没法禁用规则，因为内置的google_checks.xml没给这些规则暴露可外部覆盖的属性。正确做法是动态修改加载的配置内容，在读取内置配置后添加抑制规则或修改对应规则的启用状态。

方法1：添加抑制规则（推荐） #

通过修改配置文本，注入SuppressionFilter来禁用LineLength：

checkstyle {
  toolVersion "${checkstyleVersion}"
  ignoreFailures = false
  // 加载内置配置并添加抑制规则
  config = resources.text.fromArchiveEntry(configurations.checkstyleConfig, 'google_checks.xml').map { configText ->
    // 在配置末尾插入SuppressionFilter，禁用LineLength规则
    configText.replace('</module>', '''
        <module name="SuppressionFilter">
            <property name="checks" value="LineLength"/>
        </module>
    </module>''')
  }
}

方法2：直接禁用LineLength模块 #

如果要完全关掉该规则，可以找到配置里的LineLength模块，修改它的enabled属性：

checkstyle {
  toolVersion "${checkstyleVersion}"
  ignoreFailures = false
  config = resources.text.fromArchiveEntry(configurations.checkstyleConfig, 'google_checks.xml').map { configText ->
    // 针对google_checks.xml里的LineLength配置（带参数的情况）修改enabled属性
    configText.replace('<module name="LineLength">', '<module name="LineLength" enabled="false">')
  }
}

补充说明 #

• configProperties只对配置中明确用${propertyName}引用的属性生效，而内置的google_checks.xml没有为每个规则设置这类可配置属性，所以你之前的尝试无效。
• 动态修改配置文本的方式可以直接调整内置规则，不用单独维护自定义的XML配置文件。

内容的提问来源于stack exchange，提问作者mernst