Feature request: make a version from string BeEquivalentTo which ignores \n <> \r\n

[StefH]

Description

The currentBeEquivalentTo() method asserts that a string is exactly the same as another string, including any leading or trailing whitespace, with the exception of the casing.

It would be very useful to add a new method or extend this method to support also \n and \r\n.

Complete minimal example reproducing the issue

// Arrange
string expected= "foo\r\n";

// Act
string result = "foo\n";

// Assert
result.Should().BeEquivalentTo(expected);

Expected behavior:

Assertion is OK

Actual behavior:

Assertion FAILS

Versions

• Latest version

[markusschaber]

We could also use this.

Workaround: use .Replace("\r\n","\n") on the strings in question before comparing.

[jamesSampica]

This would be very useful when writing tests that are expected to pass cross-platform

[dennisdoomen]

This is very similar to what is suggested here #2339 (comment)

[riezebosch]

We could also use this.

Workaround: use .Replace("\r\n","\n") on the strings in question before comparing.

Was about to do this workaround an then I found out about this extension method I hadn't seen before: https://learn.microsoft.com/en-us/dotnet/api/system.string.replacelineendings?view=net-8.0 🥳

and it really is working for me (though I still would favour a more generic solution):

exception
    .Message
    .Should()
    .Be("""
        expectations not met
        Matched:
        * 1
        * null
        Unmatched:
           <none>
        """.ReplaceLineEndings());