Consider Blocking Default Equality

[Noggog]

Lots of people accidentally stick the whole record in key type areas: Dictionary<Npc, bool>

This is almost never what they intend.
Might be good to throw an exception on equality/hashing by default, with the message that they should be more intentional and choose which EqualityComparer to use explicitly (maybe with a readme link)

This way users would have to choose more explicitly Dictionary<Npc, bool>(MutagenEquality.ByFields) or somesuch. ByFormKey being the one most recommended.

Main drawback would be backwards incompatibility. But for most, that'd actually be a good thing to fix.

[tstavrianos]

Candidate for a roslyn-type analyzer to show a warning when they do it, instead of blocking it completely?

[Noggog]

Yeah, could be a good route too! I do wonder if the same types of people would just not pay attention to the yellow squigglie, though, haha. The error is a way to force them to be aware of the distinction and require they make a choice.

But we could make the roslyn analyzer an error. Then we could downgrade it needed a bit easier (such as in synthesis when people are trying to run an ancient patcher)