Readme: the example of getByText is not accurate

[ruffle1986]

Before getting started, let me say thank you for all the hard work to make devs` life easier with testing! Well done! 🍻

Problem description:

The example of getByText is incorrect and misleading in the readme.

It says running the following script would produce the result commented out above the script.

// <a href="/about">About ℹ️</a>
const aboutAnchorNode = getByText(container, 'about')

Since options.exact is true by default, it won't find the anchor element unless we change the code a bit (see the Suggested solution: section).

Suggested solution:

I see three options here to solve this:

A:

// <a href="/about">About ℹ️</a>
const aboutAnchorNode = getByText(container, 'About ℹ️')

B:

// <a href="/about">About ℹ️</a>
const aboutAnchorNode = getByText(container, 'about', {
  exact: false
})

C:

// <a href="/about">About ℹ️</a>
const aboutAnchorNode = getByText(container, /about/i)

Let me know which one is preferred and I'll open a PR on this.

Cheers!

[gnapse]

I'd say option C.

[sompylasar]

A or D:

// <a href="/about">About ℹ️</a>
const aboutAnchorNode = getByText(container, /^About\s+/)

More precise is better IMHO to catch if the text changes unintentionally.

[kentcdodds]

Let's go with C. That's what I do in my own stuff because the user doesn't care about the case of the text 👍

Thanks!

[sompylasar]

Let's go with C. That's what I do in my own stuff because the user doesn't care about the case of the text 👍

The user doesn't, but the UI designers might...

[kentcdodds]

Fair point. It's trade-offs. I'd still suggest generally ignoring case.

[gnapse]

+1 to ignore case, plus this for our README we're talking about here, people can still use the exact string if they like and it's documented.

(BTW, capitalization can be achieved via css, and there's nothing we can do about that from a testing POV)

[Gpx]

How about adding A and C and explaining the differences?

[ruffle1986]

I agree with @Gpx. It may be worth to mention both A and C. I'll open a PR including this and if you still don't feel it, I'll update it accordingly.

[ruffle1986]

(BTW, capitalization can be achieved via css, and there's nothing we can do about that from a testing POV)

@gnapse Very good point. We should point it out too.

[kentcdodds]

The explanation should probably be in a FAQ.

[kentcdodds]

🎉 This issue has been resolved in version 3.10.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀