Swiftpack.co - cpisciotta/xcbeautify as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
See all packages published by cpisciotta.
cpisciotta/xcbeautify 2.0.0-beta.1
A little beautifier tool for xcodebuild
⭐️ 853
🕓 4 days ago
.package(url: "https://github.com/cpisciotta/xcbeautify.git", from: "2.0.0-beta.1")

xcbeautify

All Contributors

CI Latest Release License

Example Screenshot

xcbeautify is a little beautifier tool for xcodebuild.

Similar to xcpretty, but faster.

Features

  • ☑ 2x faster than xcpretty.
  • ☑ 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.

Fun fact

xcbeautify uses itself to format its CI build logs.

Installation

Homebrew

brew install xcbeautify

Mint

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: "0.13.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

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!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Nikolay Kasyanov
Nikolay Kasyanov

💻
Charles Pisciotta
Charles Pisciotta

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

GitHub

link
Stars: 854
Last commit: 3 days ago
Advertisement: IndiePitcher.com - Cold Email Software for Startups

Related Packages

Release Notes

2.0.0 (Beta 1)
4 days ago

What's Changed

Full Changelog: https://github.com/cpisciotta/xcbeautify/compare/1.4.0...2.0.0-beta.1

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics