Skip to content

feat: New rule prefer-called-once #727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
veritem merged 3 commits into from
Jun 23, 2025
Merged

feat: New rule prefer-called-once #727

veritem merged 3 commits into from
Jun 23, 2025
+191 −0

Conversation

@AntonioVentilii
Copy link
Contributor

@AntonioVentilii AntonioVentilii commented Jun 20, 2025 •
edited
Loading

I would like to propose a new rule prefer-called-once that enforces the use of toBeCalledOnce() or toHaveBeenCalledOnce() over toBeCalledTimes(1) or toHaveBeenCalledTimes(1).

Examples of incorrect code for this rule:

test('foo', () => {
  const mock = vi.fn()
  mock('foo')
  expect(mock).toBeCalledTimes(1)
  expect(mock).toHaveBeenCalledTimes(1)
})

Examples of correct code for this rule:

test('foo', () => {
  const mock = vi.fn()
  mock('foo')
  expect(mock).toBeCalledOnce()
  expect(mock).toHaveBeenCalledOnce()
})

@AntonioVentilii AntonioVentilii marked this pull request as ready for review June 20, 2025 14:47
veritem
veritem approved these changes Jun 23, 2025
View reviewed changes
Copy link
Member

@veritem veritem left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks

@veritem veritem merged commit 9011281 into vitest-dev:main Jun 23, 2025
@veritem veritem mentioned this pull request Jun 23, 2025
Closed
@AntonioVentilii
Copy link
Contributor Author

AntonioVentilii commented Jun 23, 2025

Thank you @veritem for taking care of it and for the approval!!!

@andykenward
Copy link
Contributor

andykenward commented Jul 1, 2025

It seems that having both prefer-called-times and prefer-called-once enabled breaks ESLint fix feature as they conflict?

 ESLintCircularFixesWarning: Circular fixes detected while fixing ...
  It is likely that you have conflicting rules in your configuration.

It might be my ESLint configuration. But so far solving the above issue by turning off this new rule.

'vitest/prefer-called-once': 'off',

@veritem
Copy link
Member

veritem commented Jul 1, 2025

@andykenward thanks for letting me know, I set vitest/prefer-called-once to turned off by default.

@renovate renovate bot mentioned this pull request Jul 24, 2025
Open
1 task
@renovate renovate bot mentioned this pull request Aug 11, 2025
Open
1 task
This was referenced Aug 26, 2025
Closed
Closed
@chrisbbreuer chrisbbreuer mentioned this pull request Sep 18, 2025
Closed
@chrisbbreuer chrisbbreuer mentioned this pull request Oct 4, 2025
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@veritem veritem veritem approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AntonioVentilii @andykenward @veritem