https://github.com/softlr/suppress

C# analyzer suppression helpers
https://github.com/softlr/suppress

code-analysis helpers suppression

Last synced: about 1 month ago
JSON representation

C# analyzer suppression helpers

• Host: GitHub
• URL: https://github.com/softlr/suppress
• Owner: Softlr
• License: apache-2.0
• Created: 2018-07-01T19:20:52.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2022-04-04T19:23:29.000Z (almost 3 years ago)
• Last Synced: 2024-03-16T02:50:46.003Z (10 months ago)
• Topics: code-analysis, helpers, suppression
• Language: C#
• Size: 347 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![.NET](https://github.com/Softlr/Suppress/actions/workflows/dotnet.yml/badge.svg)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=softlr.suppress&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=softlr.suppress)

# Description

This library allows easy suppression of C# code analyzers warnings by defining a bunch of contants for all of the rules. The following analyzers are supported:

* [SonarQube](https://www.sonarqube.org/)

* [Roslyn Analyzers](https://github.com/dotnet/roslyn-analyzers)

* [FxCop](https://msdn.microsoft.com/en-us/library/bb429476.aspx)

* [StyleCop.Analyzers](https://github.com/DotNetAnalyzers/StyleCopAnalyzers)

* [CodeCracker](https://github.com/code-cracker/code-cracker)

# Known limitations

[ReSharper](https://www.jetbrains.com/resharper/) rules cannot be suppressed with constants defined this way, this is [by design](https://stackoverflow.com/questions/44652818/why-cant-i-use-constants-in-suppressmessage-together-with-resharper).

# Installation

Run the following command in Visual Studio Package Manager Console.

```posh

Install-Package Softlr.Suppress

```

# Usage

Simply reference specific constant from the `Softlr.Suppress` class in `SuppressMessageAttribute` like so

```csharp

using System.Diagnostics.CodeAnalysis;

[SuppressMessage(Softl.Suppress.CODE_CRACKER, Softlr.Suppress.CC0001)]

[SuppressMessage(Softl.Suppress.FXCOP, Softlr.Suppress.CA1000)]

[SuppressMessage(Softl.Suppress.SONARQUBE, Softlr.Suppress.S100)]

[SuppressMessage(Softl.Suppress.STYLECOP, Softlr.Suppress.SA1001)]

public class MyClass

{

    // ...

}

```

or use the `using static` to import all constants

```csharp

using System.Diagnostics.CodeAnalysis;

using static Softlr.Suppress;

[SuppressMessage(CODE_CRACKER, CC0001)]

[SuppressMessage(FXCOP, CA1000)]

[SuppressMessage(SONARQUBE, S100)]

[SuppressMessage(STYLECOP, SA1001)]

public class MyClass

{

    // ...

}

```

or, if you are using C# 10 or newer (net6.0+) you can declare the suppression constants as global and not have to reference it again in every file where you need to use any of the constants.

```csharp

global using System.Diagnostics.CodeAnalysis;

global using static Softlr.Suppress;

[SuppressMessage(CODE_CRACKER, CC0001)]

[SuppressMessage(FXCOP, CA1000)]

[SuppressMessage(SONARQUBE, S100)]

[SuppressMessage(STYLECOP, SA1001)]

public class MyClass

{

    // ...

}

```

When referencing `Softlr.Suppress` library in a project that creates a NuGet package the reference for this library doesn't need to be defined as a NuGet dependency.

If you are generating NuGet packages with project files, this can be achieved with `PrivateAssets` metadata.

```

    all

```