Settings

ReportGenerator has some options which allow to control its behavior. These settings can be changed in appsettings.json or via command line parameters.

Allowed formats (see documentation):

section:key=value
/section:key=value
--section:key=value

If you are using the GitHub Action or the Azure DevOps extension, you can apply settings via the customSettings parameter:

  customSettings: 'section:key=value'

Risk Hotspots

Command line parameter	Explanation
`riskHotspotsAnalysisThresholds:metricThresholdForCyclomaticComplexity=15`	Minimum threshold for cyclomatic complexity metric. Only metrics greater the threshold will be considered a risk hotspot.
`riskHotspotsAnalysisThresholds:metricThresholdForCrapScore=30`	Minimum threshold for crap score metric. Only metrics greater the threshold will be considered a risk hotspot.
`riskHotspotsAnalysisThresholds:metricThresholdForNPathComplexity=200`	Minimum threshold for NPath complexity metric. Only metrics greater the threshold will be considered a risk hotspot.
`riskHotspotsAnalysisThresholds:maximumThresholdForCyclomaticComplexity=null`	Maximum threshold for cyclomatic complexity metric. If any risk hotspot is greater than this threshold, ReportGenerator will exit unsuccessfully.
`riskHotspotsAnalysisThresholds:maximumThresholdForCrapScore=null`	Maximum threshold for crap score metric. If any risk hotspot is greater than this threshold, ReportGenerator will exit unsuccessfully.
`riskHotspotsAnalysisThresholds:maximumThresholdForNPathComplexity=null`	Maximum threshold for NPath complexity metric.If any risk hotspot is greater than this threshold, ReportGenerator will exit unsuccessfully.

Minimum coverage thresholds

Command line parameter	Explanation
`minimumCoverageThresholds:lineCoverage=null`	Threshold for minimum line coverage. If line coverage falls below this threshold, ReportGenerator will exit unsuccessfully. Value has to be a number (percentage) between 1 and 100.
`minimumCoverageThresholds:branchCoverage=null`	Threshold for minimum branch coverage. If branch coverage falls below this threshold, ReportGenerator will exit unsuccessfully. Value has to be a number (percentage) between 1 and 100.
`minimumCoverageThresholds:methodCoverage=null`	Threshold for minimum method coverage. If method coverage falls below this threshold, ReportGenerator will exit unsuccessfully. Value has to be a number (percentage) between 1 and 100.
`minimumCoverageThresholds:fullMethodCoverage=null`	Threshold for minimum full method coverage. If full method coverage falls below this threshold, ReportGenerator will exit unsuccessfully. Value has to be a number (percentage) between 1 and 100.

Other settings

Command line parameter	Explanation
`settings:numberOfReportsParsedInParallel=1`	The number of XML reports / coverage files that are processed in parallel. Higher values will result in faster execution times but memory usage will grow too.
`settings:numberOfReportsMergedInParallel=1`	The number of XML reports / coverage files that are merged in parallel after parsing them. Higher values will result in faster execution times but memory usage will grow too.
`settings:maximumNumberOfHistoricCoverageFiles=100`	Maximum number of historic coverage files that get parsed.
`settings:cachingDurationOfRemoteFilesInMinutes=10080`	The caching duration of code files that are downloaded from remote servers in minutes.
`settings:disableRiskHotspots=false`	Indicates whether risk hotspots should be disabled or not.
`settings:excludeTestProjects=false`	Indicates whether test projects should be included or not (only for Clover files).
`settings:createSubdirectoryForAllReportTypes=false`	Indicates whether a subdirectory should be created in the target directory for each report type.
`settings:customHeadersForRemoteFiles=null`	Custom headers (e.g. authentication headers) for remote requests Format: `key1=value1;key2=value2` Example: `"settings:customHeadersForRemoteFiles=Authorization=Bearer <JWT>"`
`settings:defaultAssemblyName=Default`	The default assembly name for gcov and lcov.
`settings:maximumDecimalPlacesForCoverageQuotas=1`	The maximum number of decimal places for coverage quotas / percentages.
`settings:applyMaximumGroupingLevel=false`	Indicates whether the maximum grouping level should be applied instead of the default 'By assembly' grouping.
`settings:HistoryFileNamePrefix=null`	The prefix for history files.
`settings:rawMode=false`	"Raw mode" disables that coverage data of nested or compiler generated classes is included in the parent class. This is useful to merge several Cobertura files into a single file, since the original class structure remains untouched. Limitation: Raw mode is currently only supported for Cobertura and dotCover files. You need a PRO license to use this feature.

Learn how to use the command line parameters

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Settings

Risk Hotspots

Minimum coverage thresholds

Other settings

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Clone this wiki locally