New rule: prefer-user-event

When https://github.com/testing-library/dom-testing-library/pull/616 gets merged, userEvent will be part of DOM testing library.

We could create rules for events on userEvent that are preferred over their fireEvent counterparts.

Before we start implementing rules, there are some thing we need to clarify first:

• Kent already mentioned click would be a good candidate, are there any others that could benefit from this rule? I think hover, unhover could also be included in within this rule.

• Should it be one rule for all events, or a rule per event? The latter would allow us to disable/enable specific events… but we could also create a config for it…

[nickmccurdy]

The merge into dom-testing-library has been cancelled, but it would still be nice to have this rule to inform users about when they should be using the user-event package.

[nickmccurdy]

Do we have clear then about what we want to include in this rule?

I thought we agreed on adding one new rule that would check all events that should be used with user-event by default, with a config to toggle them individually. That being said, I’m not sure if we’d want to have distinct options for banning the user-event event vs just allowing both (most ESLint rules seem to use string literals for this).

If so, I’d include it in v4 as optional. If we have everything but this ready for v4 I’d release it and then include this in a potential v4.1. Sounds good?

👍