xcbeautify

2.3.1

A little beautifier tool for xcodebuild
cpisciotta/xcbeautify

What's New

2.3.1

2024-05-13T19:16:37Z

xcbeautify

CI Latest Release License

Example Screenshot

xcbeautify is a little beautifier tool for xcodebuild.

A faster alternative to xcpretty written in Swift.

Features

  • Human-friendly and colored output.
  • Supports the new build system's output.
  • Supports Xcode's parallel testing output.
  • Supports formatting Swift Package Manager output.
  • Supports generating JUnit reports.
  • Supports macOS & Linux.
  • 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 install cpisciotta/xcbeautify

Swift Package Manager

Create a directory in the same location as the xcodeproj file, for example BuildTools.
In that directory, create a Package.swift file with the following contents.
In addition, add an empty file named Empty.swift to the same location.

// swift-tools-version: 5.9
import PackageDescription

let package = Package(
    name: "BuildTools",
    platforms: [.macOS(.v10_11)],
    dependencies: [
      .package(url: "https://github.com/cpisciotta/xcbeautify", from: "1.7.0"),
    ],
    targets: [
      .target(name: "BuildTools", path: "")
    ]
)

Enter this command to execute.

swift run -c release --package-path ./BuildTools 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

GitHub Actions Summary
GitHub Actions Summary
GitHub Actions Comment
GitHub Actions Comment

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

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!

Description

  • Swift Tools 5.9.0
View More Packages from this Author

Dependencies

Last updated: Wed May 29 2024 12:13:15 GMT-0900 (Hawaii-Aleutian Daylight Time)