Use StringSyntaxAttribute to provide IDE support for proper reasons

[psychotoad]

Background and motivation

I suggest that you add the StringSyntaxAttribute to the because parameter so I get a suggestion when I miss a format item that corresponds to each object argument or vice versa.

API Proposal

public class EnumAssertions<TEnum, TAssertions>
{
    public AndConstraint<TAssertions> BeDefined([StringSyntax("CompositeFormat")] string because = "", params object[] becauseArgs);
    public AndConstraint<TAssertions> NotBeDefined([StringSyntax("CompositeFormat")] string because = "", params object[] becauseArgs);
}

API Usage

var dayOfWeek = (DayOfWeek)1;
var foo = "foo";
dayOfWeek.Should().BeDefined("Foo {0}", foo);

Alternative Designs

No response

Risks

No response

Are you willing to help with a proof-of-concept (as PR in that or a separate repo) first and as pull-request later on?

Yes, please assign this issue to me.

[dennisdoomen]

I like that. It is even supported by PolySharp.

@jnyrup you agree?

[jnyrup]

@jnyrup you agree?

I agree, go ahead.