Skip to content

Commit

Permalink
Update collector docs with info about passing format without runsetti…
Browse files Browse the repository at this point in the history
…ngs file (#1444)
  • Loading branch information
daveMueller authored Feb 15, 2023
1 parent a014bf0 commit 3bbe502
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions Documentation/VSTestIntegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,20 @@ We're working to fill the gaps.

### Default option (if you don't specify a runsettings file)

| Option | Summary |
|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|Format | Results format in which coverage output is generated. Default format is cobertura. Supported format lcov, opencover, cobertura, teamcity, json (default coverlet proprietary format) |
Without specifying a runsettings file and calling coverlet by just the name of the collector, the result of the generated coverage output is by default in cobertura format.
```
dotnet test --collect:"XPlat Code Coverage"
```

The output format of the coverage report can also be changed without a runsettings file by specifying it in a parameter. The supported formats are lcov, opencover, cobertura, teamcity, json (default coverlet proprietary format).
```
dotnet test --collect:"XPlat Code Coverage;Format=json"
```

It is even possible to specify the coverage output in multiple formats.
```
dotnet test --collect:"XPlat Code Coverage;Format=json,lcov,cobertura"
```

### Advanced Options (Supported via runsettings)

Expand Down

0 comments on commit 3bbe502

Please sign in to comment.