Skip to content

Add documentation on how to use coverlet #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 31, 2025
Merged

Add documentation on how to use coverlet #85

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9955388
Add documentation
Corniel Jan 30, 2025
5a27931
spelling
Corniel Jan 30, 2025
f83c28f
postpose 1103
Corniel Jan 31, 2025
ee6ab50
Add link
Corniel Jan 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ reported a the [GibHub repository](https://github.com/dotnet-project-file-analyz
### Other
* [**Proj1100** Avoid using Moq](rules/Proj1100.md)
* [**Proj1101** Package references should have stable versions](rules/Proj1101.md)
* [**Proj1102** Use Coverlet Collector or MSBuild](rules/Proj1102.md)
* [**Proj1103** Coverlet requires Microsoft.NET.Test.Sdk 17.5.0 or higher](rules/Proj1103.md)
* [**Proj1200** Exclude private assets as project file dependency](rules/Proj1200.md)

## Resource file rules
Expand Down
57 changes: 57 additions & 0 deletions rules/Proj1102.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
parent: Other
ancestor: MSBuild
---

# Proj1102: Use Coverlet Collector or MSBuild
Coverlet is a cross-platform code coverage framework for .NET, with support for
line, branch and method coverage. The packages `coverlet.collector` and
`coverlet.msbuild` have the same purpose but should not be used together. Note
that `coverlet.collector` is preferred over the `coverlet.msbuild`.

## Non-compliant
``` xml
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="coverlet.collector" PrivateAssets="all" />
<PackageReference Include="coverlet.msbuild" PrivateAssets="all" />
</ItemGroup>

</Project>
```

## Compliant
``` xml
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="coverlet.collector" PrivateAssets="all" />
</ItemGroup>

</Project>
```

or

``` xml
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="coverlet.msbuild" PrivateAssets="all" />
</ItemGroup>

</Project>
```
41 changes: 41 additions & 0 deletions rules/Proj1103.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
parent: Other
ancestor: MSBuild
---

# Proj1103: Coverlet requires Microsoft.NET.Test.Sdk 17.5.0 or higher
Coverlet is a cross-platform code coverage framework for .NET, with support for
line, branch and method coverage. It requires `Microsoft.NET.Test.Sdk` 17.5.0
or higher.

## Non-compliant
``` xml
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.4.0" />
<PackageReference Include="coverlet.collector" PrivateAssets="all" />
</ItemGroup>

</Project>
```

## Compliant
``` xml
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.5.0" />
<PackageReference Include="coverlet.collector" PrivateAssets="all" />
</ItemGroup>

</Project>
```
Loading