如何让Checkstyle仅检查Gradle多模块项目中的暂存文件？

方案一：无需自定义SourceSet（推荐） #

直接通过Git命令获取暂存文件，修改Checkstyle任务的扫描范围，无需额外定义SourceSet。

步骤1：添加获取暂存文件的任务 #

在根项目的build.gradle中定义任务，从Git拉取暂存的Java文件路径：

task getStagedFiles(type: Exec) {
    commandLine 'git', 'diff', '--cached', '--name-only', '--', '*.java'
    standardOutput = new ByteArrayOutputStream()
    ext.stagedFilePaths = {
        return standardOutput.toString().trim().split('\n')
    }
}

步骤2：配置子项目的Checkstyle任务 #

遍历所有子项目，将Checkstyle扫描源限制为当前子项目下的暂存文件：

subprojects {
    apply plugin: 'checkstyle'

    checkstyle {
        toolVersion = '8.39'
        ignoreFailures = false
        // 可添加其他Checkstyle配置，如configFile等
    }

    tasks.withType(Checkstyle).configureEach {
        dependsOn rootProject.getStagedFiles
        doFirst {
            def allStagedPaths = rootProject.getStagedFiles.stagedFilePaths()
            // 过滤出当前子项目的文件
            def projectStagedFiles = allStagedPaths.findAll { 
                it.startsWith(project.path.substring(1))
            }.collect { file(it) }
            
            // 覆盖Checkstyle的扫描源
            source = projectStagedFiles
        }
    }
}

方案二：自定义SourceSet实现 #

如果坚持使用SourceSet，可创建自定义SourceSet包含暂存文件，再针对该SourceSet创建Checkstyle任务。

subprojects {
    apply plugin: 'java'
    apply plugin: 'checkstyle'

    checkstyle {
        toolVersion = '8.39'
        ignoreFailures = false
    }

    // 创建名为staged的自定义SourceSet
    sourceSets {
        staged {
            java {
                srcDirs = [] // 初始为空，后续动态填充
            }
        }
    }

    // 获取暂存文件的任务，同方案一
    task getStagedFiles(type: Exec) {
        commandLine 'git', 'diff', '--cached', '--name-only', '--', '*.java'
        standardOutput = new ByteArrayOutputStream()
        ext.stagedFilePaths = {
            return standardOutput.toString().trim().split('\n')
        }
    }

    // 为staged SourceSet添加暂存文件
    sourceSets.staged.java.srcDirs = files {
        getStagedFiles.stagedFilePaths().collect { file(it) }
    }

    // 创建针对staged SourceSet的Checkstyle任务
    task checkstyleStaged(type: Checkstyle) {
        dependsOn getStagedFiles
        source = sourceSets.staged.java
        classpath = sourceSets.staged.compileClasspath
        configFile = file("${rootProject.rootDir}/config/checkstyle/checkstyle.xml") // 替换为你的配置文件路径
    }

    // 可选：让默认check任务依赖自定义检查任务
    check.dependsOn checkstyleStaged
}

注意事项 #

• 确保执行环境（包括CI/CD）有Git可用；若需检查其他类型文件，修改Git命令中的后缀（如*.java改为*.groovy）
• 多模块项目中注意路径匹配逻辑，避免扫描到其他子项目的文件
• Checkstyle配置文件路径需根据项目实际结构调整

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