codacy/codacy-swiftlint

镜像概述

codacy-swiftlint是Codacy平台提供的Docker镜像，集成了SwiftLint工具，专为Swift项目的代码质量检查设计。该镜像可无缝集成到持续集成/持续部署(CI/CD)流程中，通过静态分析识别Swift代码中的风格问题、潜在错误和不符合规范的内容，帮助开发团队维护一致的代码质量标准。

核心功能与特性

• 内置SwiftLint：预安装最新版SwiftLint，支持Swift代码的风格检查、语法验证和潜在问题识别
• CI/CD友好：轻量级设计，启动快速，适合集成到GitHub Actions、GitLab CI、Jenkins等CI/CD工具中
• Codacy兼容：输出结果符合Codacy平台规范，可直接同步至Codacy dashboard查看详细代码质量报告
• 灵活配置：支持通过.swiftlint.yml自定义检查规则，适配不同团队的代码规范

使用场景

• Swift项目CI流程：在代码提交、PR创建或合并前自动执行代码质量检查，阻止不合规代码进入主分支
• 团队协作规范：统一团队Swift代码风格，减少代码审查中的风格争议
• 遗留代码优化：对现有Swift项目进行批量代码质量扫描，识别需要重构的部分

使用方法与配置说明

拉取镜像

bash
docker pull codacy/swiftlint

基本使用（本地检查）

在Swift项目根目录执行以下命令，检查当前项目代码：

bash
docker run --rm -v $(pwd):/code codacy/swiftlint swiftlint lint --path /code

• --rm：检查完成后自动删除容器
• -v $(pwd):/code：将本地项目目录挂载到容器内/code路径
• swiftlint lint --path /code：执行SwiftLint检查，指定检查路径为挂载的项目目录

CI/CD集成示例（GitHub Actions）

在项目根目录创建.github/workflows/swiftlint.yml文件：

yaml
name: SwiftLint Check
on: [pull_request, push]

jobs:
  swiftlint:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      
      - name: Run codacy-swiftlint
        run: |
          docker run --rm -v $(pwd):/code codacy/swiftlint swiftlint lint --path /code --reporter json

自定义检查规则

在项目根目录创建.swiftlint.yml文件定义规则（示例）：

yaml
excluded: # 排除检查的目录/文件
  - Carthage
  - Pods
  - Example/Generated

disabled_rules: # 禁用的规则
  - trailing_whitespace
  
opt_in_rules: # 启用的可选规则
  - empty_count
  - explicit_init
  
line_length: # 每行最大长度
  warning: 120
  error: 150

输出格式配置

通过--reporter参数指定输出格式：

bash
# 输出JSON格式（适合CI工具解析）
docker run --rm -v $(pwd):/code codacy/swiftlint swiftlint lint --path /code --reporter json

# 输出简洁格式（适合终端查看）
docker run --rm -v $(pwd):/code codacy/swiftlint swiftlint lint --path /code --reporter compact