Breaking change proposal: Use exact string match by default

[alexkrolick]

Describe the feature you'd like:

Make exact match the default instead of partial case-insensitive match. Regex would be recommended for those cases instead.

• partial: /mystring/
• case-insensitive partial: /mystring/i
• prefix: /^mystring/
• postfix: /mystring$/
• case-insensitive full string: /^mystring$/i

One thing that would more involved to replicate with inline regexes is that the current implementation trims the string and replaces symbols with spaces:

- const normalizedText = textToMatch.trim().replace(/\s+/g, ' ')

See #74 (comment)

Suggested implementation:

I could see implementing this by exposing the final options argument to the getAllByAttribute helper to the public methods that use it so that exact: true could toggled.

https://github.com/kentcdodds/dom-testing-library/blob/master/src/queries.js#L73

Describe alternatives you've considered:

Leave the matcher alone

Teachability, Documentation, Adoption, Migration Strategy:

Show common regex patterns like the ones above^ in the docs.

Is this a breaking change?

Yes

[kentcdodds]

I'm in favor of this change and I see no reason to go forward with a PR and push a major version bump. This probably should have been filed in dom-testing-library though because that's where the change will happen 😉 Though we'll need to do a major version bump of this lib as well to get that change.

[alexkrolick]

I'll add a link over there, too

[alexkrolick]

https://github.com/kentcdodds/dom-testing-library/pull/31/files

[alexkrolick]

Merged in https://github.com/kentcdodds/dom-testing-library/releases/tag/v2.0.0

• update types
• update examples
• new release

[kentcdodds]

Whoops, I probably shouldn't have just pushed an update to the version. I was being lazy. I'm pushing up a fix to the tests right now. We'll need an update to the types and examples. My bad :-/ Sorry about the laziness on my part.

[maddijoyce]

I was thinking that the types for dom-testing-library should probably exist in that repo and then be imported from there. I can write the types there if you like?

[kentcdodds]

That sounds great @maddijoyce, thanks!

[alexkrolick]

@maddijoyce sending a PR right now with what I think they are, you can finalize it.

[alexkrolick]

@maddijoyce #77

It's possible you'll want to remove a bunch of README stuff and point it to dom-testing-library instead

[kentcdodds]

🎉 This issue has been resolved in version 3.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀