如何解决ktlint-gradle与Ktlint-IntelliJ插件的基线路径兼容问题

这里有几种实用的方法让两者的基线文件路径兼容：

方法1：自定义Gradle任务自动修正路径 #

在app模块的build.gradle.kts中添加一个自定义任务，依赖ktlintGenerateBaseline并自动修改生成的基线文件路径：

tasks.register("generateRootRelativeBaseline") {
    dependsOn(tasks.ktlintGenerateBaseline)
    doLast {
        val moduleBaseline = file("build/ktlint/baseline.xml")
        if (moduleBaseline.exists()) {
            // 读取原基线内容，给所有file路径添加app/前缀
            val updatedContent = moduleBaseline.readText()
                .replace("<file name=\"src/", "<file name=\"app/src/")
            
            // 输出到项目根目录，方便IDE插件读取
            val rootBaseline = project.rootProject.file("ktlint-baseline.xml")
            rootBaseline.writeText(updatedContent)
            
            println("已生成项目根目录相对路径的基线文件：${rootBaseline.path}")
        }
    }
}

执行任务：./gradlew :app:generateRootRelativeBaseline，之后在IntelliJ插件配置中选择项目根目录下的ktlint-baseline.xml即可。

方法2：手动批量替换基线文件路径 #

如果不想修改Gradle配置，可以在生成基线后，用命令行工具批量替换路径：

Linux/macOS终端 #

sed -i '' 's/<file name="src\//<file name="app\//g' app/build/ktlint/baseline.xml

Windows PowerShell #

(Get-Content app/build/ktlint/baseline.xml) -replace '<file name="src/', '<file name="app/src/' | Set-Content app/build/ktlint/baseline.xml

修改完成后，在IntelliJ插件中指定读取app/build/ktlint/baseline.xml即可。

方法3：多模块项目的通用处理（可选） #

如果是多模块项目，可以编写根项目的Gradle任务，遍历所有模块的基线文件，合并并添加模块前缀到路径中，生成统一的项目根目录基线文件：

tasks.register("generateMultiModuleRootBaseline") {
    // 依赖所有模块的ktlintGenerateBaseline任务
    dependsOn(subprojects.map { it.tasks.findByName("ktlintGenerateBaseline") })
    
    doLast {
        val mergedContent = StringBuilder("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<baseline>\n")
        
        subprojects.forEach { module ->
            val moduleName = module.name
            val moduleBaseline = module.file("build/ktlint/baseline.xml")
            if (moduleBaseline.exists()) {
                val moduleContent = moduleBaseline.readText()
                    // 去掉xml头和根标签，只保留内部的file条目
                    .replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<baseline>\n", "")
                    .replace("</baseline>", "")
                    // 添加模块前缀
                    .replace("<file name=\"src/", "<file name=\"$moduleName/src/")
                
                mergedContent.append(moduleContent)
            }
        }
        
        mergedContent.append("</baseline>")
        val rootBaseline = rootProject.file("ktlint-baseline.xml")
        rootBaseline.writeText(mergedContent.toString())
        println("已生成多模块统一基线文件：${rootBaseline.path}")
    }
}

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