This project provides a Swift-based tool that generates detailed code coverage reports from the xcresults
files located in the DerivedData
folder. Additionally, it archives old coverage reports, allowing users to compare them and identify trends over time.
Code coverage is a crucial metric in software development that indicates how much of your codebase is covered by tests. This tool is useful for:
- Generating easy-to-read code coverage reports.
- Tracking code coverage trends over time.
- Identifying areas of your codebase that may need more testing.
By using this tool, developers can ensure their code is well-tested and maintain high quality standards.
To get started with this tool, follow these steps:
-
Clone the Repository:
git clone https://github.com/arconsis/derived-data-tool.git cd SwiftCodeCoverageTool
-
Install Dependencies: Ensure you have Swift and any required dependencies installed.
-
Run the Tool:
- Ensure you have an
xcresults
file in yourDerivedData
folder. - Run the tool with the following command:
swift run CodeCoverageTool
- The tool will generate a coverage report and archive it for trend analysis.
- Ensure you have an
-
View Reports: The generated reports will be located in the
Reports
folder. Open the latest report in your browser to view the coverage details.
If you need more help, you can:
- Check the Issues section on GitHub to see if your question has already been answered or to ask a new question.
- Review the Documentation for detailed guides and examples.
- Reach out to the community or maintainers via the Discussions page.
We appreciate your feedback and contributions to improve this tool!
Thank you for using the DerivedDataTool. We hope it helps you maintain high-quality code and improve your testing practices.