-
Notifications
You must be signed in to change notification settings - Fork 331
Replace linker suppressions with attributes #359
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.
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
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
...nityToolkit.Mvvm/Properties/Polyfills/Attributes/UnconditionalSuppressMessageAttribute.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
// Licensed to the .NET Foundation under one or more agreements. | ||
// The .NET Foundation licenses this file to you under the MIT license. | ||
// See the LICENSE file in the project root for more information. | ||
|
||
#if !NET6_0_OR_GREATER | ||
|
||
namespace System.Diagnostics.CodeAnalysis; | ||
|
||
/// <summary> | ||
/// Suppresses reporting of a specific rule violation, allowing multiple suppressions on a | ||
/// single code artifact. | ||
/// </summary> | ||
/// <remarks> | ||
/// <see cref="UnconditionalSuppressMessageAttribute"/> is different than | ||
/// <see cref="SuppressMessageAttribute"/> in that it doesn't have a | ||
/// <see cref="ConditionalAttribute"/>. So it is always preserved in the compiled assembly. | ||
/// </remarks> | ||
[AttributeUsage(AttributeTargets.All, Inherited = false, AllowMultiple = true)] | ||
[Conditional("DEBUG")] | ||
internal sealed class UnconditionalSuppressMessageAttribute : Attribute | ||
{ | ||
/// <summary> | ||
/// Initializes a new instance of the <see cref="UnconditionalSuppressMessageAttribute"/> | ||
/// class, specifying the category of the tool and the identifier for an analysis rule. | ||
/// </summary> | ||
/// <param name="category">The category for the attribute.</param> | ||
/// <param name="checkId">The identifier of the analysis rule the attribute applies to.</param> | ||
public UnconditionalSuppressMessageAttribute(string category, string checkId) | ||
{ | ||
Category = category; | ||
CheckId = checkId; | ||
} | ||
|
||
/// <summary> | ||
/// Gets the category identifying the classification of the attribute. | ||
/// </summary> | ||
/// <remarks> | ||
/// The <see cref="Category"/> property describes the tool or tool analysis category | ||
/// for which a message suppression attribute applies. | ||
/// </remarks> | ||
public string Category { get; } | ||
|
||
/// <summary> | ||
/// Gets the identifier of the analysis tool rule to be suppressed. | ||
/// </summary> | ||
/// <remarks> | ||
/// Concatenated together, the <see cref="Category"/> and <see cref="CheckId"/> | ||
/// properties form a unique check identifier. | ||
/// </remarks> | ||
public string CheckId { get; } | ||
|
||
/// <summary> | ||
/// Gets or sets the scope of the code that is relevant for the attribute. | ||
/// </summary> | ||
/// <remarks> | ||
/// The Scope property is an optional argument that specifies the metadata scope for which | ||
/// the attribute is relevant. | ||
/// </remarks> | ||
public string? Scope { get; set; } | ||
|
||
/// <summary> | ||
/// Gets or sets a fully qualified path that represents the target of the attribute. | ||
/// </summary> | ||
/// <remarks> | ||
/// The <see cref="Target"/> property is an optional argument identifying the analysis target | ||
/// of the attribute. An example value is "System.IO.Stream.ctor():System.Void". | ||
/// Because it is fully qualified, it can be long, particularly for targets such as parameters. | ||
/// The analysis tool user interface should be capable of automatically formatting the parameter. | ||
/// </remarks> | ||
public string? Target { get; set; } | ||
|
||
/// <summary> | ||
/// Gets or sets an optional argument expanding on exclusion criteria. | ||
/// </summary> | ||
/// <remarks> | ||
/// The <see cref="MessageId "/> property is an optional argument that specifies additional | ||
/// exclusion where the literal metadata target is not sufficiently precise. For example, | ||
/// the <see cref="UnconditionalSuppressMessageAttribute"/> cannot be applied within a method, | ||
/// and it may be desirable to suppress a violation against a statement in the method that will | ||
/// give a rule violation, but not against all statements in the method. | ||
/// </remarks> | ||
public string? MessageId { get; set; } | ||
|
||
/// <summary> | ||
/// Gets or sets the justification for suppressing the code analysis message. | ||
/// </summary> | ||
public string? Justification { get; set; } | ||
} | ||
|
||
#endif |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can now just write
GetValidationAction
. The linked Roslyn issue has been closed.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The issue is closed but the fix is slated for the C# 11 timeslot, I don't think it's there in VS stable just yet, meaning our CI will be using an older version of Roslyn too without that. I would keep that as is for now (especially given it's unrelated from this PR anyway), and we can update this later on when we bump the SDK as well 🙂