jkmathew/Swift Format Action
Runs Apple's swift-format in lint mode and reports violations as inline pull request review comments.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| token | GitHub token used to post review comments. Defaults to the workflow token. | no | ${{ github.token }} |
| swift-format-command | The swift-format executable to invoke. Use 'swift-format' for the standalone binary or 'swift format' for the toolchain subcommand. | no | swift format |
| paths | Newline- or space-separated list of files/directories to lint. Defaults to the current directory. | no | . |
| configuration | Path to a .swift-format configuration file. If omitted, swift-format searches upward from each linted file. | no | "" |
| recursive | Recurse into directories listed in `paths`. | no | true |
| strict | Treat all lint findings as errors inside swift-format (passes --strict). | no | false |
| fail-on-violations | Fail the action (non-zero exit) when any violation is found. | no | true |
Outputs
| name | description |
|---|---|
| violation-count | Total number of violations reported by swift-format. |