Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

Open Fake.Testing instead (FAKE0001 - package: Fake.Testing.ReportGenerator, module: ReportGenerator, type: ReportGeneratorParams)

ReportGeneratorParams

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

Record Fields

Record FieldDescription
ExePath
Signature: string

(Required) Path to the ReportGenerator exe file.

Filters
Signature: string list

Optional list of assemblies that should be included or excluded in the report. Exclusion filters take precedence over inclusion filters. Wildcards are allowed.

HistoryDir
Signature: string

Optional directory for storing persistent coverage information. Can be used in future reports to show coverage evolution.

LogVerbosity
Signature: ReportGeneratorLogVerbosity

The verbosity level of the log messages.

ReportTypes
Signature: ReportGeneratorReportType list

The output formats and scope.

SourceDirs
Signature: string list

Optional directories which contain the corresponding source code.

TargetDir
Signature: string

(Required) The directory where the generated report should be saved.

TimeOut
Signature: TimeSpan

The timeout for the ReportGenerator process.

WorkingDir
Signature: string

The directory where the ReportGenerator process will be started.