mtgto/swift-format-action

swift-format-action

镜像概述和主要用途

swift-format-action 是一个 GitHub Action，用于运行 https://github.com/apple/swift-format 工具。它旨在将 Swift 代码格式化和风格检查集成到 GitHub 工作流中，帮助开发团队自动确保代码风格的一致性。

核心功能和特性

• 支持通过配置文件（.swift-format）自定义格式化规则
• 可选择检查所有文件或仅检查变更文件
• 提供自动格式化功能，可自动修复代码风格问题
• 支持设置最大警告数量阈值，超过阈值时工作流失败

使用场景和适用范围

• 代码提交（push）到主分支时自动进行代码风格检查
• 拉取请求（pull_request）创建或更新时验证代码格式
• 在 CI/CD 流程中集成，作为代码合并前的质量门禁
• 自动修复代码格式问题，减少人工调整成本

使用方法和配置说明

工作流示例

仅检查模式

此模式仅对代码进行风格检查，不修改文件内容。

yaml
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2
        with:
          # 需要完整的 git 历史以获取正确的变更文件列表
          fetch-depth: 0
      - name: Lint
        uses: mtgto/swift-format-action@main
        with:
          # 如需指定配置文件，请保留此行；否则注释掉
          configuration_file: .swift-format
          # 是否检查所有文件，默认值为 false
          all_files: false
          # 最大警告数量，默认值为 -1（无限制）
          max_warnings: -1

自动格式化模式

此模式会自动修复代码风格问题，并可配合其他 Action 将修改提交到 PR。

yaml
on:
  pull_request:
    branches: [main]

jobs:
  lint:
    name: Auto Correct
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2
        with:
          # 需要完整的 git 历史以获取正确的变更文件列表
          fetch-depth: 0
      - name: Lint
        uses: mtgto/swift-format-action@main
        with:
          # 如需指定配置文件，请保留此行；否则注释掉
          configuration_file: .swift-format
          # 是否检查所有文件，默认值为 false
          all_files: false
          # 是否自动修复格式问题，默认值为 false
          auto_correct: true
          # 最大警告数量，默认值为 -1（无限制）
          max_warnings: -1

参数说明

许可证

MIT 许可证