Skip to content

Commit 6be8c77

Browse files
authored
Merge pull request #158 from codacy/docs/add-supported-languages
docs: Update supported formats table with languages
2 parents 7ed98d0 + 0d53bbc commit 6be8c77

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,17 +52,26 @@ bash <(curl -Ls https://coverage.codacy.com/get.sh)
5252

5353
If you want to specify a coverage reporter version, use `CODACY_REPORTER_VERSION` environment variable.
5454

55-
This command assumes the coverage reports follow a name convention:
5655

57-
* JaCoCo &rarr; jacoco*.xml
58-
* Cobertura &rarr; cobertura.xml
59-
* LCOV &rarr; lcov.info | lcov.dat | *.lcov
60-
* Clover &rarr; clover.xml
61-
* DotCover &rarr; dotcover.xml
62-
* OpenCover &rarr; opencover.xml
63-
* PHPUnit XML &rarr; coverage-xml/index.xml
56+
#### Supported formats
6457

65-
Otherwise, you must define the report's location with the flag `-r`.
58+
The following table contains the formats supported and which coverage tools generate them:
59+
60+
| Language | Coverage tools (examples) | Formats | Filename |
61+
| --- | --- | --- | --- |
62+
| Java | [JaCoCo](http://eclemma.org/jacoco/) <br> [Cobertura](http://cobertura.github.io/cobertura/) | JaCoCo <br> Cobertura | jacoco*.xml <br> cobertura.xml |
63+
| Scala | [sbt-jacoco](https://www.scala-sbt.org/sbt-jacoco/) <br> [scoverage](http://scoverage.org/) | JaCoCo <br> Cobertura | jacoco*.xml <br> cobertura.xml |
64+
| Javascript | [Istanbul](https://github.com/gotwarlost/istanbul) <br> [Poncho](https://github.com/deepsweet/poncho) <br> [Mocha](http://mochajs.org/) + [Blanket.js](https://github.com/alex-seville/blanket) | LCOV | lcov.info, lcov.dat, *.lcov |
65+
| Python | [Coverage.py](https://coverage.readthedocs.io/en/coverage-5.0.3/) | Cobertura | cobertura.xml |
66+
| PHP | [PHPUnit](https://phpunit.readthedocs.io/en/8.5/code-coverage-analysis.html) | PHPUnit XML <br> [Clover](https://confluence.atlassian.com/clover/using-clover-for-php-420973033.html) | coverage-xml/index.xml <br> clover.xml |
67+
| Ruby | [SimpleCov](https://github.com/colszowka/simplecov) | [Cobertura](https://github.com/dashingrocket/simplecov-cobertura) <br> [LCOV](https://github.com/fortissimo1997/simplecov-lcov) | cobertura.xml <br> lcov.info, lcov.dat, *.lcov |
68+
| C# | [OpenCover](https://github.com/OpenCover/opencover) <br> [DotCover CLI](https://www.jetbrains.com/dotcover/) | OpenCover <br> DotCover-DetailedXML | opencover.xml <br> dotcover.xml |
69+
70+
You can use this script with any of the listed coverage formats, even if your language or coverage tool of choice is not in the table above.
71+
If your coverage reports are in a different format you can use a format converter, such as
72+
[ReportGenerator](https://danielpalme.github.io/ReportGenerator/), to generate a supported format.
73+
74+
This command assumes the coverage reports filename follow the name convention. Otherwise, you must define the report's location with the flag `-r`.
6675

6776
### Running Codacy Coverage Reporter by manually downloading the binary
6877

0 commit comments

Comments
 (0)