cpisciotta/xcbeautify

An xcodebuild formatter

Features

[x] Human-friendly and colored output.
[x] Supports the new build system's output.
[x] Supports Xcode's parallel testing output.
[x] Supports formatting Swift Package Manager output.
[x] Supports generating JUnit reports.
[x] Supports macOS & Linux.
[x] Written in Swift: xcbeautify compiles to a static binary which you can

bring anywhere. This also means less Ruby-dependant in your development environment and CI.

Installation

Homebrew

brew install xcbeautify

Mint

mint install cpisciotta/xcbeautify

Build from source

git clone https://github.com/cpisciotta/xcbeautify.git
cd xcbeautify
make install

Usage

xcodebuild [flags] | xcbeautify

If you want xcbeautify to exit with the same status code as xcodebuild (e.g. on a CI):

set -o pipefail && xcodebuild [flags] | xcbeautify

For parallel and concurrent destination testing, it helps to use unbuffered I/O for stdout and to redirect stderr to stdout.

NSUnbufferedIO=YES xcodebuild [flags] 2>&1 | xcbeautify

swift test [flags] 2>&1 | xcbeautify

GitHub Actions

xcbeautify features an integrated GitHub Actions renderer that harnesses workflow commands to highlight warnings, errors, and results directly within the GitHub user interface. To utilize this function, simply run xcbeautify and add the --renderer github-actions flag during execution:

set -o pipefail && xcodebuild [flags] | xcbeautify --renderer github-actions

TeamCity

xcbeautify features an integrated TeamCity renderer that harnesses service messages to highlight warnings, errors, and results directly within the TeamCity user interface. To utilize this function, simply run xcbeautify and add the --renderer teamcity flag during execution:

set -o pipefail && xcodebuild [flags] | xcbeautify --renderer teamcity

Azure DevOps Pipeline

xcbeautify features an integrated Azure DevOps Pipeline renderer that harnesses logging commands to highlight warnings, errors and results directly within the Azure DevOps Pipeline user interface. To utilize this function, simply run xcbeautify and add the --renderer azure-devops-pipelines flag during execution:

set -o pipefail && xcodebuild [flags] | xcbeautify --renderer azure-devops-pipelines

Development

Generate Xcode project:

make xcode

Release a new version, e.g. x.y.z:

make release version=x.y.z

Contributing

Please send a PR!

Package Metadata

Repository: cpisciotta/xcbeautify

Stars: 1468

Forks: 104

Open issues: 62

Default branch: main

Primary language: swift

License: MIT

Topics: formatter, github-actions, ios, swift, swift-argument-parser, swift-package-manager, xcode, xcodebuild, xcpretty

README: README.md