xcpretty/xcpretty
Xcpretty
xcpretty is an xcodebuild log formatter and CI build log parser that transforms verbose compiler output into concise, readable logs. It serves as a build report generator and an Xcode test result visualizer, converting raw build and test data into simplified formats for developers and continuous integration pipelines.
The tool differentiates itself by providing specialized visualizations for test execution, such as dot-style result rendering and the measurement of runtimes to identify performance bottlenecks. It also functions as a report generator capable of exporting build results into standardized XML, HTML, or JSON files for use with external reporting tools.
The system employs stream-based log processing and regex-based event parsing to handle raw output in real time. It includes capabilities for source code syntax highlighting, build failure signaling via exit codes, and an extensible architecture that allows for custom parsing logic and output formatting extensions.
Features
- Build Log Formatting - Transforms verbose compiler output into a condensed, readable layout to help developers identify errors quickly.
- Console Log Formatters - Transforms verbose xcodebuild compiler output into concise, color-coded, and readable console logs.
- Regex-Based Output Parsing - Uses regular expressions to extract structured event data from raw xcodebuild tool output.
- Xcode Build Log Parsers - Parses and simplifies verbose Xcode build logs to make debugging and monitoring more efficient.
- Build Exit Code Controls - Signals build failures by mirroring the build status to the shell exit process to control CI pipeline outcomes.
- CI Pipeline Integrations - Integrates with CI pipelines by formatting logs and signaling failure codes to track project health.
- Build Failure Troubleshooting - Notifies continuous integration pipelines of build failures by exiting with a non-zero status code.
- Log Stream Processing - Processes raw build output line by line in real time to minimize memory overhead.
- Test Result Reporters - Visualizes test execution results and measures runtimes to identify failures and performance bottlenecks.
- Build Result Reports - Converts raw compilation data into standardized XML, HTML, or JSON files for external reporting tools.
- CI Environment Adaptations - Adjusts build log formatting to meet the specific requirements of continuous integration environments.
- Build Error Reporters - Exports build results into standardized files like XML, HTML, or JSON for use with external reporting tools.
- Log Layout Customization - Refines the visual arrangement and structure of xcodebuild command output for better readability.
- Build Reports - Exports build results into standardized XML, HTML, or JSON files for integration with external reporting tools.
- Visualizers - Renders test execution results in simplified formats to highlight failures and slow runtimes.
- Code Syntax Highlighting - Applies syntax coloring to programming languages within the build output to improve the legibility of errors.
- Test Result Visualizers - Provides a concise dot-style rendering of test execution output to simplify the identification of failures.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
