You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,33 +4,34 @@ Painless code coverage reporting for Objective-C projects. Most of the heavy l
4
4
## Installation
5
5
6
6
$ gem install alcove
7
-
8
-
If you don't have it already, you'll also need to install lcov.
9
7
10
-
*Homebrew*
8
+
You'll also need to install lcov.
9
+
10
+
With *Homebrew*:
11
11
12
12
$ brew install lcov
13
13
14
-
*MacPorts*
14
+
Or with *MacPorts*:
15
15
16
16
$ sudo port install lcov
17
17
18
18
## Xcode Project Configuration
19
-
If you haven't already, open your project in Xcode and update your non-test targets to Generate Test Coverage Files and Instrument Program Flow (*for Debug configuration only*).
19
+
Open your project in Xcode and update your non-test targets to Generate Test Coverage Files and Instrument Program Flow (*for Debug configuration only*).
20
20

21
21
22
22
## Generating Reports
23
23
Now that you have the prerequisites out of the way, you can generate a report. Make sure you've recently executed your tests, then:
24
24
25
25
alcove --product-name <your-product-name>
26
26
27
-
Be sure to check out the --help for additional options for fine-tuning your report.
28
-
29
27
## Options
30
28
31
29
### --output-directory
32
30
Specify this option to change the output directory for the report. Any intermediate paths will be created.
33
31
32
+
### --percent-file
33
+
Generates a plaintext file `alcove-percent.txt` in the output directory, containing only the line coverage percentage.
34
+
34
35
### --product-name
35
36
The product name specified in your Xcode project.
36
37
@@ -40,5 +41,8 @@ A list of filters to use when gathering files for the report. Use this if you w
40
41
### --search-directory
41
42
Use this option to specify the directory to be searched for your product. Alcove plays nicely with the the structure on your development machine, as well as on an Xcode Server, but if you have some funky output directory for your build, you can specify its parent here.
42
43
43
-
## Attribution
44
-
Shoutout to [@NateBank](https://github.com/NateBank) for the [name suggestion](https://www.youtube.com/watch?v=j1Q-a5zCmhc).
44
+
## Troubleshooting
45
+
If something doesn't seem quite right, try cleaning the build folder and then run the tests again. Make sure you can generate a report for the [demo project](https://github.com/ioveracker/AlcoveDemo), too.
46
+
47
+
## Thanks
48
+
Shoutout to [@NateBank](https://github.com/NateBank) for the [name suggestion](https://www.youtube.com/watch?v=j1Q-a5zCmhc) and inspiration.
0 commit comments