咨询：能否用Sonar自定义规则检查移动项目文件路径结构

完全可以通过Sonar的自定义规则机制实现这类文件路径/目录结构合规性检查，尤其是你提到的「Xib文件与ViewController文件同目录」这种场景——甚至不需要深入分析代码语法树，只需要基于文件的元数据（路径、文件名）就能完成检查。

接下来给你梳理具体的实现思路和关键点：

1. 选对对应的Sonar插件基础 #

针对移动项目，你需要基于对应平台的Sonar插件来扩展规则：

• iOS项目：基于SonarSwift插件（如果是Objective-C则用SonarObjC）
• Android项目：基于SonarKotlin或SonarJava插件

这些官方插件都提供了文件级别的检查扩展点，专门用来处理这类不需要分析代码内容的规则。

2. 编写核心检查逻辑 #

以iOS的Xib/ViewController检查为例，核心逻辑非常清晰：

• 拦截目标文件（比如所有.xib或.swift文件）
• 提取对应关联文件的预期路径
• 验证该路径下是否存在目标文件

举个简化的Swift规则实现示例（基于SonarSwift的API）：

import SonarSwift

class XibViewControllerDirectoryCheck: SwiftFileCheck {
    // 规则的元信息，会在Sonar界面显示
    static let rule = Rule(
        key: "xib-vc-same-directory",
        name: "Xib files must reside in the same directory as their corresponding ViewController",
        description: "Ensure Xib files are placed alongside their matching ViewController classes to maintain directory structure consistency",
        severity: .minor,
        tags: ["convention", "mobile"]
    )

    override func visitFile(_ file: SwiftFile) {
        // 只处理Xib文件
        guard file.pathExtension.lowercased() == "xib" else { return }
        
        // 生成对应的ViewController文件名（比如MyVC.xib → MyVC.swift）
        let expectedVcFileName = file.baseName + ".swift"
        // 获取当前Xib所在目录，拼接ViewController的路径
        guard let parentDir = file.parent() else { return }
        let expectedVcPath = parentDir.path + "/" + expectedVcFileName
        
        // 检查文件是否存在
        if !FileManager.default.fileExists(atPath: expectedVcPath) {
            // 上报违规问题
            reportIssue(
                message: "Xib file should be in the same directory as its corresponding ViewController (\(expectedVcFileName))",
                location: file.location
            )
        }
    }
}

3. 注册并部署规则 #

• 把自定义规则类注册到你的Sonar插件扩展中，打包成jar（Java/Kotlin）或框架（Swift/ObjC）
• 将插件部署到你的SonarQube服务器，然后在项目的Sonar配置中启用这条规则

额外注意事项 #

• 大小写兼容性：如果你的项目运行在区分大小写的文件系统（比如Linux CI环境），要确保文件名的大小写匹配检查
• 可配置性：可以给规则添加参数（比如允许用户自定义关联文件的扩展名、是否双向检查ViewController对应的Xib）
• 测试覆盖：编写单元测试，模拟不同的目录结构场景（合规/不合规）来验证规则的正确性

内容的提问来源于stack exchange，提问作者Caio Sanchez Christino