dotnet / dotnet/msbuild

Add ability to suppress individual BuildCheck diagnostics

Open
#10,647 1 comment 0 reactions 0 assignees View on GitHub
10.0 Area: BuildCheck needs-design triaged
Dominant language
C#
Stars
5.5k
Forks
1.5k
Avg merge
1d 8h
Merged PRs (30d)
141

Description

### Context

BuildCheck doesn't have similar mechanism like `#pragma warning disable` for silencing the Roslyn analyzers.
This was decided to be out of scope for the V1 (https://github.com/dotnet/msbuild/blob/main/documentation/specs/BuildCheck/BuildCheck.md#out-of-scope).
With the limiting of the number of reports per Check (https://github.com/dotnet/msbuild/pull/10625) - users might get to a situation where they are unable to ignore unwanted diagnostics and see others.

### Workaround

* The reports throtling should be opt-out able (via Trait?)
* In case of throttling, one can enable the rule in project per project - to prevent the throttling accross entire build

### Note

This will need a design of how the suppressions will be performed and recognized (e.g. xml comments)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.