Ban InvariantCulture/InvariantCultureIgnoreCase

[meziantou]

Description of changes

These symbols are almost never ok, so we should ban them and suggest using Ordinal or OrdinalIgnoreCase. Using InvariantCulture to compare 2 strings is not invariant as it uses a linguistical rules instead of comparing bytes. So, it can lead to unexpected results. Also, it’s much slower.

// true, but I don't know this is what developers expect
string.Equals("a\0bc", "abc", StringComparison.InvariantCulture)
string.Equals("A꙰B", "AB", StringComparison.InvariantCultureIgnoreCase)

// true using NLS, false using ICU
string.Equals("ss", "ß", StringComparison.InvariantCultureIgnoreCase)

Breaking changes

It may break build on projects using any of these symbols.

• Replace InvariantCulture with Ordinal
• Replace InvariantCultureIgnoreCase with OrdinalIgnoreCase
• Use #pragma warning disable or SuppressMessageAttribute

Additional checks

• Updated the documentation of the project to reflect the changes
• Added new tests that cover the code changes