How to suppress all errors and warnings within namespace (or directory) using GlobalSuppressions.cs

J

JakenVeina•10/27/23, 7:06 AM

what is

~N:

~N:

~N:

~N: supposed to represent here?

T

tariel36OP•10/27/23, 7:12 AM

Namespace I guess - taken from docs and SO

https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments#d42-id-string-format

https://stackoverflow.com/questions/48922211/visual-studio-globalsuppressions-cs-prefix-p-for-attribute-target-in-suppres

It's very hard to find actual documentation for this attribute

J

JakenVeina•10/27/23, 7:13 AM

I'd have to disagree

J

JakenVeina•10/27/23, 7:13 AM

https://learn.microsoft.com/en-us/dotnet/api/system.diagnostics.codeanalysis.suppressmessageattribute.target?view=net-7.0

SuppressMessageAttribute.Target Property (System.Diagnostics.CodeAn...

Gets or sets a fully qualified path that represents the code analysis target.

J

JakenVeina•10/27/23, 7:15 AM

the official docs specifically give an example value for the

Target

Target

Target

Target property, and doesn't mention any of the stuff that the SO post references

T

tariel36OP•10/27/23, 7:17 AM

Single example for single member is not the documentation at all. This page explains nothing.

J

JakenVeina•10/27/23, 7:22 AM

it explains how to use the attribute

J

JakenVeina•10/27/23, 7:22 AM

and it in fact works

J

JakenVeina•10/27/23, 7:22 AM

as described in the official docs

J

JakenVeina•10/27/23, 7:22 AM

namespace MySpecialNamespace
{
    class Foo
    {
        private void Bar()
        {

        }
    }
}

namespace MySpecialNamespace
{
    class Foo
    {
        private void Bar()
        {

        }
    }
}

namespace MySpecialNamespace
{
    class Foo
    {
        private void Bar()
        {

        }
    }
}

namespace MySpecialNamespace
{
    class Foo
    {
        private void Bar()
        {

        }
    }
}

J

JakenVeina•10/27/23, 7:22 AM

[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

[assembly: SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

[assembly: SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

[assembly: SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

[assembly: SuppressMessage("CodeQuality", "IDE0051:Remove unused private members", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

[assembly: SuppressMessage("Performance", "CA1822:Mark members as static", Justification = "<Pending>", Scope = "namespaceanddescendants", Target = "MySpecialNamespace")]

J

JakenVeina•10/27/23, 7:23 AM

without these attributes, I get the two warnings for

Bar()

Bar()

Bar()

Bar()

J

JakenVeina•10/27/23, 7:23 AM

with these attributes, they disappear

J

JakenVeina•10/27/23, 7:24 AM

does this work for you if you try and apply it to non-generated code?

T

tariel36OP•10/27/23, 8:04 AM

Partially.

[assembly: SuppressMessage("Style", "IDE2000:Avoid multiple blank lines", Justification = "Autogenerated code", Scope = "namespaceanddescendants", Target = "My.Nested.Namespace")]

[assembly: SuppressMessage("Style", "IDE2000:Avoid multiple blank lines", Justification = "Autogenerated code", Scope = "namespaceanddescendants", Target = "My.Nested.Namespace")]

[assembly: SuppressMessage("Style", "IDE2000:Avoid multiple blank lines", Justification = "Autogenerated code", Scope = "namespaceanddescendants", Target = "My.Nested.Namespace")]

[assembly: SuppressMessage("Style", "IDE2000:Avoid multiple blank lines", Justification = "Autogenerated code", Scope = "namespaceanddescendants", Target = "My.Nested.Namespace")]

Doesn't work for

/*
 * API for Service
 *
 * Explanation.
 *
 * The version of the OpenAPI document: 1.0.9
 * Generated by: https://github.com/openapitools/openapi-generator.git
 */


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;

namespace My.Nested.Namespace.Foo
{

/*
 * API for Service
 *
 * Explanation.
 *
 * The version of the OpenAPI document: 1.0.9
 * Generated by: https://github.com/openapitools/openapi-generator.git
 */


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;

namespace My.Nested.Namespace.Foo
{

/*
 * API for Service
 *
 * Explanation.
 *
 * The version of the OpenAPI document: 1.0.9
 * Generated by: https://github.com/openapitools/openapi-generator.git
 */


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;

namespace My.Nested.Namespace.Foo
{

/*
 * API for Service
 *
 * Explanation.
 *
 * The version of the OpenAPI document: 1.0.9
 * Generated by: https://github.com/openapitools/openapi-generator.git
 */


using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Threading;
using System.Threading.Tasks;

namespace My.Nested.Namespace.Foo
{

.

Also if I do this attribute as provided example from you, or example from me in this message I receive warning about legacy format, which is unacceptable.

Message    IDE0077    Avoid legacy format target 'My.Nested.Namespace' in 'SuppressMessageAttribute'    shared-project    D:\dev\shared-project\GlobalSuppressions.cs    15    Active

Message    IDE0077    Avoid legacy format target 'My.Nested.Namespace' in 'SuppressMessageAttribute'    shared-project    D:\dev\shared-project\GlobalSuppressions.cs    15    Active

Message    IDE0077    Avoid legacy format target 'My.Nested.Namespace' in 'SuppressMessageAttribute'    shared-project    D:\dev\shared-project\GlobalSuppressions.cs    15    Active

Message    IDE0077    Avoid legacy format target 'My.Nested.Namespace' in 'SuppressMessageAttribute'    shared-project    D:\dev\shared-project\GlobalSuppressions.cs    15    Active

J

JakenVeina•10/27/23, 8:10 AM

so, it applies to anything in

My.Nested.Namespace

My.Nested.Namespace

My.Nested.Namespace

My.Nested.Namespace but not

My.Nested.Namespace.Foo

My.Nested.Namespace.Foo

My.Nested.Namespace.Foo

My.Nested.Namespace.Foo?

T

tariel36OP•10/27/23, 8:12 AM

I mean, it applies to things inside

My.Nested.Namespace.Foo

My.Nested.Namespace.Foo

My.Nested.Namespace.Foo

My.Nested.Namespace.Foo, but it doesn't catch empty lines between comments and usings in above example, while in my understanding it's still within

My.Nested.Namespace

My.Nested.Namespace

My.Nested.Namespace

My.Nested.Namespace namespace.

J

JakenVeina•10/27/23, 8:14 AM

ahhhh

J

JakenVeina•10/27/23, 8:14 AM

so

J

JakenVeina•10/27/23, 8:14 AM

that's probably simply impossible

J

JakenVeina•10/27/23, 8:14 AM

Suppresses warnings in a namespace and all its descendant symbols

Suppresses warnings in a namespace and all its descendant symbols

Suppresses warnings in a namespace and all its descendant symbols

Suppresses warnings in a namespace and all its descendant symbols

J

JakenVeina•10/27/23, 8:15 AM

the two empty lines there aren't part of any symbol

J

JakenVeina•10/27/23, 8:16 AM

try adding some of the following to your source gen

J

JakenVeina•10/27/23, 8:16 AM

[System.Diagnostics.DebuggerNonUserCodeAttribute()]
[System.CodeDom.Compiler.GeneratedCodeAttribute("MyBuildTaskThatGeneratedThisCodeFile", "1.2.3.4")]
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]

[System.Diagnostics.DebuggerNonUserCodeAttribute()]
[System.CodeDom.Compiler.GeneratedCodeAttribute("MyBuildTaskThatGeneratedThisCodeFile", "1.2.3.4")]
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]

[System.Diagnostics.DebuggerNonUserCodeAttribute()]
[System.CodeDom.Compiler.GeneratedCodeAttribute("MyBuildTaskThatGeneratedThisCodeFile", "1.2.3.4")]
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]

[System.Diagnostics.DebuggerNonUserCodeAttribute()]
[System.CodeDom.Compiler.GeneratedCodeAttribute("MyBuildTaskThatGeneratedThisCodeFile", "1.2.3.4")]
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]

J

JakenVeina•10/27/23, 8:17 AM

although, that might have the same issue: they can only be attached to code elements, not files

J

JakenVeina•10/27/23, 8:18 AM

if not that, you'll probably have to add a #pragma to the top of the file to suppress directly

J

JakenVeina•10/27/23, 8:19 AM

not sure if you can write a #pragma to just suppress everything

J

JakenVeina•10/27/23, 8:21 AM

ah, yeah

J

JakenVeina•10/27/23, 8:21 AM

When no warning numbers are specified, disable disables all warnings and restore enables all warnings.

When no warning numbers are specified, disable disables all warnings and restore enables all warnings.

When no warning numbers are specified, disable disables all warnings and restore enables all warnings.

When no warning numbers are specified, disable disables all warnings and restore enables all warnings.

J

JakenVeina•10/27/23, 8:21 AM

so

J

JakenVeina•10/27/23, 8:21 AM

#pragma warning disable

#pragma warning disable

#pragma warning disable

#pragma warning disable

J

JakenVeina•10/27/23, 8:21 AM

at the top of all your code gen files will just disable everything

J

JakenVeina•10/27/23, 8:21 AM

hopefully

J

JakenVeina•10/27/23, 8:22 AM

unless those issues don't quality as "warnings"

T

tariel36OP•10/27/23, 8:32 AM

I see. Maybe it will be easier to add formatting to those files in the pipeline then. Thanks

J

Joschi•10/27/23, 8:43 AM

Wasn't there something to mark source generated files by naming pattern or directive? Didn't that also disable code inspection?

J

JakenVeina•10/27/23, 8:43 AM

not that I'm aware

J

JakenVeina•10/27/23, 8:44 AM

the only naming pattern there is for source-gen files is

.g.i.cs

.g.i.cs

.g.i.cs

.g.i.cs

J

JakenVeina•10/27/23, 8:44 AM

which is files probably already are

3

333fred•10/27/23, 5:35 PM

Is this in a source generator's output, or are the files actually generated by some separate tool and exist on disk?

3

333fred•10/27/23, 5:35 PM

Because if it's the latter, just use an

.editorconfig

.editorconfig

.editorconfig

.editorconfig file to suppress it in the directory

A

Accord•10/28/23, 5:36 PM

Was this issue resolved? If so, run

/close

/close

otherwise I will mark this as stale and this post will be archived until there is new activity.

How to suppress all errors and warnings within namespace (or directory) using GlobalSuppressions.cs

Similar Threads

Similar Threads

Similar Threads