'SuppressMessage' for a whole namespace

Question

I use underscores for my test methods for a better readability and I want to suppress FxCop errors/warnings for the whole test namespace.

How can I achieve this? I played with GlobalSuppressions.cs but nothing worked:

[module: System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores",
    Scope = "namespace", Target = "Company.Product.Tests")]

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores",
    Scope = "namespace", Target = "Company.Product.Tests")]

+1 Ditto... I tried similar in the AssemblyInfo.cs file and it also did not work. Maybe CA1707 cannot be targeted to an entire library or namespace but only the member itself. — harlam357, Aug 03 '12 at 22:06

score 106 · Answer 1 · edited Jul 09 '19 at 13:47

Suppression of a code analysis warning for a namespace and all its descendant symbols is possible since Visual Studio 2019:

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores",
    Justification = "Test methods require underscores for readability."
    Scope = "namespaceanddescendants", Target = "Company.Product.Tests")]

Scope - The target on which the warning is being suppressed. If the target is not specified, it is set to the target of the attribute. Supported scopes include the following:

...

namespaceanddescendants - (New for Visual Studio 2019) This scope suppresses warnings in a namespace and all its descendant symbols. The namespaceanddescendants value is only valid for Roslyn analyzers, and is ignored by binary, FxCop-based static analysis.

^{Suppress code analysis warnings#SuppressMessage attribute @ MS Docs}

Note that you should add ~N: as a prefix to the target to avoid performance issues. Reference: https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/ide0077 Example: [assembly: System.Diagnostics.CodeAnalysis.SuppressMessage( "Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores", Justification = "Test methods require underscores for readability." Scope = "namespaceanddescendants", Target = "~N:Company.Product.Tests")] — Sam, Feb 28 '21 at 23:51

score 37 · Answer 2 · answered Jan 10 '20 at 20:27

37

You can use the "module" scope for this, which is supported by older compilers than the ones that support the newer "namespaceanddescendants" scope. The module scope impacts everything in the project, and it does not require a target specification.

Example Usage:

[assembly: System.Diagnostics.CodeAnalysis.SuppressMessage(
    "Microsoft.Naming", "CA1707:IdentifiersShouldNotContainUnderscores",
    Justification = "Test methods require underscores for readability."
    Scope = "module")]

answered Jan 10 '20 at 20:27

carlin.scott

6,214
3
30
35

This is working i tried it , on namespace and descendants. – Vaibhav.Inspired Apr 18 '20 at 07:58
I actually added this to the official documentation: https://learn.microsoft.com/en-us/visualstudio/code-quality/in-source-suppression-overview?view=vs-2019#module-suppression-scope – carlin.scott Apr 21 '20 at 17:34

ccoutinho · Answer 3 · 2020-04-08T14:11:52.040

7

I have managed to ignore that particular warning specifically for Test projects (I follow a naming convention in which these always end up with "Tests.cs") by using a .editorconfig file, containing the following rule:

[*Tests.cs]
dotnet_diagnostics.CA1707.severity = none

More information on my answer here

edited Apr 08 '20 at 14:11

answered Apr 08 '20 at 00:26

ccoutinho

3,308
5
39
47

score 2 · Answer 4 · answered Dec 05 '12 at 18:53

2

Yes, that's not possible with FxCop <= 10.0.

What you can do, is to disable CA1707 using a custom rules file (maybe just for your test projects).

answered Dec 05 '12 at 18:53

ulrichb

19,610
8
73
87

JoeBilly · Answer 5 · 2013-08-19T13:18:25.017

As already said, it is not possible out of the box. Imho, it is intended because suppress have to be done unitarily.

There is a workaround to do this manually through FXCop 10 with the Copy As > Module-level SuppressMessage functionality.

Cons, you will have to repeat this each time the namespace is modified but as already said, the global suppressions should be isolated.

Open your assembly in FXCop 10 (System.Xml here) and run analysis
Select your namespace (System.Xml here)
Select all violated rules
Right click and Copy As > Module-level SupressMessage
Then paste it in a GlobalSuppressions.cs for example

Note: this can be done at assembly, namespace or type level.

Module-level SuppressMessage

score -3 · Accepted Answer · answered Sep 13 '12 at 08:06

-3

I think it is not possible as harlam357 already said.

answered Sep 13 '12 at 08:06

timmkrause

3,367
4
32
59

2

The [ability to suppress issues for all types within a namespace](https://github.com/dotnet/roslyn/issues/486) became available according to [this comment](https://github.com/dotnet/dotnet-api-docs/issues/1101#issuecomment-449061433) with [VS Dev16](https://visualstudio.microsoft.com/vs/preview/) preview 2. – Jack Miller Mar 12 '19 at 11:34
I don't think I've ever seen an answer with negative score as the accepted answer! This answer is especially horrible because all it does is say that someone else answered the question. – Michael Bray Aug 18 '23 at 03:56

'SuppressMessage' for a whole namespace

6 Answers6

Linked

Related