Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkchoi212/xcperfect
Make your xccov outputs prettier ✨
https://github.com/mkchoi212/xcperfect
command-line-tool coverage xccov xccoverage xcode
Last synced: about 1 month ago
JSON representation
Make your xccov outputs prettier ✨
- Host: GitHub
- URL: https://github.com/mkchoi212/xcperfect
- Owner: mkchoi212
- License: mit
- Created: 2018-06-01T17:42:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-08T00:21:08.000Z (over 6 years ago)
- Last Synced: 2024-10-18T11:28:05.128Z (2 months ago)
- Topics: command-line-tool, coverage, xccov, xccoverage, xcode
- Language: Ruby
- Homepage:
- Size: 1.67 MB
- Stars: 59
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Installation
```bash
$ gem install xcperfect
```
## Usage
- Pipe
```bash
$ xcrun xccov --json [options] | xcperfect [options]
```
- Feed it in via flags
```bash
$ xcperfect [--file | -f] report.json [options]
```
> ⚠️ Please note that `xcperfect` only takes in `xccov`'s `--json` output
## Formats
- `--all`, `-a` **Default**
- `--simple`, `-s`
- `--html` **(COMING SOON)**
## ⚙️ Options
- `--[no]-color`: turn on or off coloring **(default is on)**
- `--[no]-utf8`: turn on or off usage of UTF-8 for output **(default is on)**
- `-t, --targets=x,y,z`: choose targets to generate reports for
## ✋ Contributing
This is an open source project so feel free to contribute by
- Opening an [issue](https://github.com/mkchoi212/xcperfect/issues/new)
- Sending me feedback via [email](mailto://[email protected])
- Or [tweet](https://twitter.com/Bananamlkshake2) at your boi!
## Note
The name `xcperfect` is not trying to convey that the code is perfect by any means.
The code is far from perfect as this is my first Ruby project; PRs are welcome and appreciated 😀
> ❗ Fun fact! xcperfect has only one dependency - `rouge` - for syntax highlighting. So if you are already using [xcpretty](https://github.com/supermarin/xcpretty), no additional dependencies are required
## LICENSE
[LICENSE.md](./LICENSE.md)