Sonar-Swift 项目安装与使用教程

1. 项目目录结构及介绍

Sonar-Swift 项目的目录结构如下：

sonar-swift/
├── commons/
├── docs/
├── javalang/
├── objclang/
├── sonar-swift-plugin/
├── swiftlang/
├── tools/
├── .gitignore
├── .travis.yml
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── README_OLD.md
├── README_en.md
├── SwitchProfiles.png
├── build-and-deploy.sh
├── pom.xml
├── screenshot.png
└── sonar-project.properties

目录介绍：

• commons/: 包含项目通用工具和库。
• docs/: 包含项目的文档文件。
• javalang/: 包含与 Java 语言相关的代码和配置。
• objclang/: 包含与 Objective-C 语言相关的代码和配置。
• sonar-swift-plugin/: 包含 SonarQube 插件的核心代码。
• swiftlang/: 包含与 Swift 语言相关的代码和配置。
• tools/: 包含项目使用的各种工具和脚本。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.md: 项目许可证。
• README.md: 项目主文档。
• README_OLD.md: 旧版项目文档。
• README_en.md: 英文版项目文档。
• SwitchProfiles.png: 项目相关图片。
• build-and-deploy.sh: 构建和部署脚本。
• pom.xml: Maven 项目配置文件。
• screenshot.png: 项目截图。
• sonar-project.properties: SonarQube 项目配置文件。

2. 项目启动文件介绍

项目的启动文件主要是 build-and-deploy.sh 脚本。该脚本用于构建和部署 Sonar-Swift 插件。

build-and-deploy.sh 脚本介绍：

• 功能: 该脚本用于自动化构建和部署 Sonar-Swift 插件。
• 使用方法: 在终端中运行 ./build-and-deploy.sh 即可执行构建和部署操作。

3. 项目配置文件介绍

pom.xml

• 功能: Maven 项目配置文件，定义了项目的依赖、构建配置等。
• 重要配置项:
  • dependencies: 定义了项目所需的依赖库。
  • build: 定义了项目的构建配置，包括插件的打包方式等。

sonar-project.properties

• 功能: SonarQube 项目配置文件，定义了项目的扫描配置。
• 重要配置项:
  • sonar.host.url: SonarQube 服务器的 URL。
  • sonar.projectKey: 项目的唯一标识符。
  • sonar.sources: 项目源代码的路径。
  • sonar.swift.swiftlint.report: SwiftLint 报告文件路径。
  • sonar.swift.infer.report: Infer 报告文件路径。

通过以上配置文件和启动脚本，可以方便地构建、部署和配置 Sonar-Swift 插件，实现对 Objective-C 和 Swift 代码的静态代码扫描。