Skip to content

Lint for setting advanceTimers with user-event when using jest.useFakeTimers #979

Open
@backwardok

Description

@backwardok

Name for new rule

advance-timers-with-fake-timers

Description of the new rule

Enforce using the advanceTimers option for user-event when using jest's useFakeTimers in order to prevent testing timeouts

Testing Library feature

user-event's advanceTimers option when using fake timers

Testing Library framework(s)

user-event (across any Testing Library framework that can use it)

What category of rule is this?

Warns about a potential error

Optional: other category of rule

No response

Code examples

Using fake timers within a test directly:

jest.useFakeTimers();
const user = userEvent.setup(); // Warn - advanceTimers not set
beforeEach(() => {
  jest.useFakeTimers()
});

test('some behavior with user action', async () => {
  const user = userEvent.setup(); // Warn - advanceTimers not set
  // Test behavior
})

Anything else?

No response

Do you want to submit a pull request to make the new rule?

No

Metadata

Metadata

Assignees

No one assigned

    Labels

    new ruleNew rule to be included in the plugin

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions