Prevent breaking design change diagnostic on public API members

[Evangelink]

Is it possible to somehow link rules suggesting a refactoring to the public api analyzer? The idea being that rules suggesting a signature change would not be raised for api listed in the shipped file.

That seems like a completely different feature request which is applicable to all design rules that can introduce a breaking public API change. Can you please file a separate issue? The CA1822 feature requested originally in this issue has already been implemented.

Originally posted by @mavasani in #3911 (comment)

[Evangelink]

If we decide to implement this feature, I would suggest to make it configurable via a user-option and to allow different level of "adoption". One mode would prevent issues only on members declared in the Shipped part of the file, the other on both (i.e. Shipped and Unshipped) and the final to opt-out of the rule. This last option is IMO interesting for people who don't want the new feature but also (and mainly) to be able to find breaking changes you are ok to include in some next release.

[Evangelink]

In addition to the design rules, some naming rules could also benefit from this change. Actually I am wondering if we could find a way to have this feature global to all rules with a API breaking change impact.

[sharwell]

I find that [SuppressMessage] is appropriate at each declaration of a public API which fails to adhere to a rule related to signatures, so I lean against trying to account for it within each analyzer.

[Evangelink]

I think I would personally go for the SuppressMessageAttribute but I could understand wanting the other behavior if for example you already have a relatively big project and are starting to introduce quality analyzers to the projects.

Given the number of other tickets, I would expect this one to be low priority anyways.

Feel free to close this ticket.

[mavasani]

Writing a suppressor that reads the public API surface in any format to suppress these diagnostics would resolve this issue.