New rule suggestion: no-test-id-queries

[maryfsc]

Hi! I've been wondering if there was ever a discussion about implementing a rule to warn about accessible queries use. Since I don't think it's really necessary to throw an error or do an autofix, a warning should be just fine. So we could get a warning to possibly refactor this

const loginButton = screen.getByTestId('login-button');

into this

const loginButton = screen.getByRole('button', { name: /login/i });

What do you think? :)

[Belco90]

Hi @maryfsc, thanks for opening this issue!

This could be an interesting idea to report usages of ByTestId queries. However, I'm not really sure about how to suggest from ByTestId argument which other query to use instead + what pass to it.

The example you shared is really direct, but what would you suggest if you have something like this?

const item = screen.getByTestId('user-panel-data')

I'd go just for a no-test-id-queries rule which complains if you use a ByTestId query, without suggesting how to fix it and just saying something like "Using data-testid attributes do not resemble how your software is used and should be avoided if possible".

[maryfsc]

Hey @Belco90 I think that's a pretty good idea 😄 👍

[Belco90]

Nice. Would you like to give this a try? I recommend to do this on v4 since new rules implementation is much easier there (and it should be released soon).

[maryfsc]

Yes, I'd like to try! So I'll wait for v4 to release 😉 Thank you!

[Belco90]

That's awesome! We had other people implementing new rules directly on v4 branch, so you could do that if you want to. However, I have to tell you that the doc around new rules creator is not added yet, guidelines weren't updated properly, and new internal mechanisms introduced in v4 could still change (although it's pretty stable already). So up to you!

[Belco90]

Hi again! Since v4 is finished, I hope I can spend time on this soon. It's a really interesting rule for encouraging people to use semantic and accessible queries rather than querying by id.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[Belco90]

I still want to implement this one!

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.