diff --git a/README.md b/README.md index 4e8aea6a..17406a4b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # ReportGenerator -*ReportGenerator* converts XML reports generated by OpenCover, dotCover, Visual Studio, NCover or Cobertura into human readable reports in various formats. +*ReportGenerator* converts XML reports generated by OpenCover, dotCover, Visual Studio, NCover, Cobertura or JaCoCo into human readable reports in various formats. The reports do not only show the coverage quota, but also include the source code and visualize which lines have been covered. @@ -13,6 +13,7 @@ The following [output formats](https://github.com/danielpalme/ReportGenerator/wi * Latex, LatexSummary * TextSummary * CsvSummary +* PngChart * Badges * [Custom reports](https://github.com/danielpalme/ReportGenerator/wiki/Custom-reports) @@ -23,6 +24,7 @@ The following [output formats](https://github.com/danielpalme/ReportGenerator/wi * Visual Studio ([vstest.console.exe](https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#vstestconsoleexe), [CodeCoverage.exe](https://github.com/danielpalme/ReportGenerator/wiki/Visual-Studio-Coverage-Tools#codecoverageexe)) * [NCover](https://www.ncover.com/info/download) (tested version 1.5.8, other versions may not work) * [Cobertura](https://github.com/cobertura/cobertura) +* [JaCoCo](https://www.jacoco.org/jacoco/index.html) * Mono ([mprof-report](https://www.mono-project.com/docs/debug+profile/profile/profiler/#analyzing-the-profile-data)) Additional information about *ReportGenerator* can be found under [Resources](#resources). @@ -52,7 +54,9 @@ Parameters: ["]-reports:[;][;]["] ["]-targetdir:["] [["]-reporttypes:[;]["]] + [["]-sourcedirs:[;][;]["]] [["]-historydir:["]] + [["]-plugins:[;][;]["]] [["]-assemblyfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]] [["]-classfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]] [["]-filefilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]] @@ -60,22 +64,25 @@ Parameters: [["]-tag:["]] Explanations: - Reports: The coverage reports that should be parsed (separated by - semicolon). Wildcards are allowed. - Targetdirectory: The directory where the generated report should be saved. - Reporttypes: The output formats and scope (separated by semicolon). - Values: Badges, Cobertura, CsvSummary, Html, HtmlChart, HtmlSummary, Latex, LatexSummary, MHtml, - PngChart, TextSummary, Xml, XmlSummary - History directory: Optional directory for storing persistent coverage information. - Can be used in future reports to show coverage evolution. - Assembly Filters: Optional list of assemblies that should be included or excluded in the report. - Class Filters: Optional list of classes that should be included or excluded in the report. - File Filters: Optional list of files that should be included or excluded in the report. - Exclusion filters take precedence over inclusion filters. - Wildcards are allowed. - Verbosity: The verbosity level of the log messages. - Values: Verbose, Info, Warning, Error, Off - Tag: Optional tag or build version. + Reports: The coverage reports that should be parsed (separated by semicolon). + Globbing is supported. + Target directory: The directory where the generated report should be saved. + Report types: The output formats and scope (separated by semicolon). + Values: Badges, Cobertura, CsvSummary, Html, HtmlChart, HtmlSummary, Latex, LatexSummary, MHtml, + PngChart, TextSummary, Xml, XmlSummary + Source directories: Optional directories which contain the corresponding source code (separated by semicolon). + The source directories are used if coverage report contains classes without path information. + History directory: Optional directory for storing persistent coverage information. + Can be used in future reports to show coverage evolution. + Plugins: Optional plugin files for custom reports or custom history storage (separated by semicolon). + Assembly filters: Optional list of assemblies that should be included or excluded in the report. + Class filters: Optional list of classes that should be included or excluded in the report. + File filters: Optional list of files that should be included or excluded in the report. + Exclusion filters take precedence over inclusion filters. + Wildcards are allowed. + Verbosity: The verbosity level of the log messages. + Values: Verbose, Info, Warning, Error, Off + Tag: Optional tag or build version. Default values: -reporttypes:Html @@ -87,7 +94,7 @@ Default values: Examples: "-reports:coverage.xml" "-targetdir:C:\report" "-reports:target\*\*.xml" "-targetdir:C:\report" -reporttypes:Latex;HtmlSummary -tag:v1.4.5 - "-reports:coverage1.xml;coverage2.xml" "-targetdir:report" + "-reports:coverage1.xml;coverage2.xml" "-targetdir:report" "-sourcedirs:C:\MyProject" -plugins:CustomReports.dll "-reports:coverage.xml" "-targetdir:C:\report" "-assemblyfilters:+Included;-Excluded.*" ``` @@ -111,7 +118,7 @@ A MSBuild task also exists: - + ``` diff --git a/docs/index.html b/docs/index.html index 72525d07..e2d6ac96 100644 --- a/docs/index.html +++ b/docs/index.html @@ -24,7 +24,7 @@

ReportGenerator