feat: create new pair-to-have-been-called-assertions rule
#1848
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a new ESLint rule
pair-to-have-been-called-assertionsthat enforces usingtoHaveBeenCalledTimes()ortoBeCalledTimes()whenever using matchers liketoHaveBeenCalledWith(),toBeCalledWith(),toHaveBeenNthCalledWith(),toBeNthCalledWith(),toHaveBeenLastCalledWith(), ortoBeLastCalledWith().Why?
When testing mock functions, developers often use
toHaveBeenCalledWith()to verify that a function was called with specific arguments. However, without also checking the call count, the test can pass even if the mock was called more times than expected, potentially masking bugs.What does this rule do?
toHaveBeenCalledWith()(and similar matchers) withtoHaveBeenCalledTimes()toHaveBeenCalledTimes(1)assertiontoHaveBeenCalledTimes(0)withtoHaveBeenCalledWith())toHaveBeenCalledWith,toBeCalledWith,toHaveBeenNthCalledWith,toBeNthCalledWith,toHaveBeenLastCalledWith,toBeLastCalledWithExamples
❌ Incorrect:
✅ Correct:
Resolves #1820