Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

ReportGeneratorHelper

Contains a task which can be used to run ReportGenerator, which converts XML reports generated by PartCover, OpenCover or NCover into a readable report in various formats.

Nested types and modules

TypeDescription
ReportGeneratorLogVerbosity
ReportGeneratorParams

ReportGenerator parameters, for more details see: https://github.com/danielpalme/ReportGenerator.
ReportGeneratorReportType

Functions and values

Function or valueDescription
ReportGenerator setParams reports
Signature: setParams:(ReportGeneratorParams -> ReportGeneratorParams) -> reports:string list -> unit

Runs ReportGenerator on one or more coverage reports.

Parameters

  • setParams - Function used to overwrite the default ReportGenerator parameters.
  • reports - Coverage reports.

Sample

1: 

 ReportGenerator (fun p -> { p with TargetDir = "c:/reports/" }) [ "c:/opencover.xml" ]
ReportGeneratorDefaultParams
Signature: ReportGeneratorParams

ReportGenerator default parameters