feat(prefer-vi-mocked): Add new prefer-vi-mocked rule #547
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phillip-le
commented
Oct 4, 2024
Comment on lines
+82
to
+95
| const isTypeCastExpression = <Expression extends TSESTree.Expression>( | ||
| node: MaybeTypeCast<Expression> | ||
| ): node is TSTypeCastExpression<Expression> => | ||
| node.type === AST_NODE_TYPES.TSAsExpression || | ||
| node.type === AST_NODE_TYPES.TSTypeAssertion; | ||
|
|
||
| export const followTypeAssertionChain = < | ||
| Expression extends TSESTree.Expression | ||
| >( | ||
| expression: MaybeTypeCast<Expression> | ||
| ): Expression => | ||
| isTypeCastExpression(expression) | ||
| ? followTypeAssertionChain(expression.expression) | ||
| : expression; |
There was a problem hiding this comment.
phillip-le
commented
Oct 4, 2024
Comment on lines
+46
to
+64
| export type MaybeTypeCast<Expression extends TSESTree.Expression> = | ||
| | TSTypeCastExpression<Expression> | ||
| | Expression; | ||
|
|
||
| export type TSTypeCastExpression< | ||
| Expression extends TSESTree.Expression = TSESTree.Expression | ||
| > = AsExpressionChain<Expression> | TypeAssertionChain<Expression>; | ||
|
|
||
| interface AsExpressionChain< | ||
| Expression extends TSESTree.Expression = TSESTree.Expression | ||
| > extends TSESTree.TSAsExpression { | ||
| expression: AsExpressionChain<Expression> | Expression; | ||
| } | ||
|
|
||
| interface TypeAssertionChain< | ||
| Expression extends TSESTree.Expression = TSESTree.Expression | ||
| > extends TSESTree.TSTypeAssertion { | ||
| expression: TypeAssertionChain<Expression> | Expression; | ||
| } |
There was a problem hiding this comment.
phillip-le
commented
Oct 4, 2024
| ], | ||
| invalid: [ | ||
| { | ||
| code: "(foo as Mock).mockReturnValue(1);", |
There was a problem hiding this comment.
These are almost exactly the same as the test cases as in https://github.com/jest-community/eslint-plugin-jest/blob/main/src/rules/__tests__/prefer-jest-mocked.test.ts
But without the jest. prefix for the types
-code: "(foo as jest.Mock).mockReturnValue(1);",
+code: "(foo as Mock).mockReturnValue(1);",
phillip-le
commented
Oct 4, 2024
There was a problem hiding this comment.
phillip-le
commented
Oct 4, 2024
|
|
||
| if (typeName.type !== AST_NODE_TYPES.Identifier) return; | ||
|
|
||
| if (!mockTypes.includes(typeName.name)) return; |
There was a problem hiding this comment.
Almost the same as the jest version but only checking for Mock instead of jest.Mock
|
for readme documentation, we really rely on https://github.com/bmish/eslint-doc-generator, which still needs to be updated to support eslint v9. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a port of prefer-jest-mocked
Resolves #443
Wasn't sure how to autogenerate the docs, so I took the output from
eslint-doc-generator --init-rule-docsand manually modified it so that theprefer-vi-mockeddocs looked like the rest of the docs.Let me know if there's a preferred sorting order to the docs.
Known Limitations
The
Mockimport fromvitestwill still be hanging around after all of its usages are removed, not sure if there's a good way to handle this.import { Mock } from 'vitest' -(foo as Mock).mockReturnValue() +(vi.mocked(foo)).mockReturnValue()Another problem is that if
Mockis coming from somewhere else that would still be highlighted as an issue and autofixed since I'm not checking thatMockis coming fromvitest.import { Mock } from 'node:test' -(foo as Mock).mockReturnValue() +(vi.mocked(foo)).mockReturnValue()