diff --git a/docs/best-practices/xcodebuild-formatters.md b/docs/best-practices/xcodebuild-formatters.md index 1c87d9377..580373f2f 100644 --- a/docs/best-practices/xcodebuild-formatters.md +++ b/docs/best-practices/xcodebuild-formatters.md @@ -26,12 +26,12 @@ scan( xcodebuild_formatter: "xcpretty" ) -# Specificy a local install of xcbeautify +# Specify a local install of xcbeautify scan( xcodebuild_formatter: "/custom/path/to/xcbeautify" ) -# Specifify your own custom formatter +# Specify your own custom formatter scan( xcodebuild_formatter: "/custom/path/to/my_formatter" ) @@ -55,16 +55,16 @@ $ xcodebuild [flags] | $ brew install xcbeautify ``` -`xcbeautify` is the recommended because: - - - Faster than `xcpretty` - - Supports Xcode's new build system output - - Supports Xcode's parallel testing output - - Supports formatting Swift Package Manager output +`xcbeautify` is currently recommended: + + - It supports Xcode's new build system output + - It supports Xcode's parallel testing output + - It supports formatting Swift Package Manager output + - It's faster than `xcpretty` #### xcpretty -Historticaly, _fastlane_ was tightly integrated with [xcpretty](https://github.com/xcpretty/xcpretty). `xcpretty` is a RubyGem and a dependency of _fastlane_. This was the best option for _fastlane_ as there were no extra steps for installing or using this formatter. +Historically, _fastlane_ was tightly integrated with [xcpretty](https://github.com/xcpretty/xcpretty). `xcpretty` is a RubyGem and a dependency of _fastlane_. This was the best option for _fastlane_ as there were no extra steps for installing or using this formatter. `xcpretty` also did more than formatting. It used the `xcodebuild` output to: @@ -72,5 +72,5 @@ Historticaly, _fastlane_ was tightly integrated with [xcpretty](https://github.c - Generate an HTML report - Generate a JSON compilation database -**Before 2.201.0**, [_scan_](/actions/scan/) used `xcpretty` to generate these files and determine success/failure with `xcpretty` output -
**As of 2.201.0**, [_scan_](/actions/scan/) will only generate these if `xcodebuild_formatter` is using `xcpretty` but now use `trainer` to parse test results to determine success/failure +**Before 2.201.0**, [_scan_](/actions/scan/) used `xcpretty` to generate these files and determine success/failure with `xcpretty` output.
+**As of 2.201.0**, [_scan_](/actions/scan/) will only generate these if `xcodebuild_formatter` is using `xcpretty` but now use `trainer` to parse test results to determine success/failure.