Skip to content

feat(vitest): add return type and promisable mockFactory #6139

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

Merged
sheremet-va merged 11 commits into from
Aug 12, 2024
Merged

feat(vitest): add return type and promisable mockFactory #6139

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
f6bb50c
fix: add return type and promisable mockFactory
syi0808 Jul 15, 2024
01332f4
fix: remove importOriginal generic because of type error
syi0808 Jul 15, 2024
e441e4a
fix: remove partial
syi0808 Jul 15, 2024
c30f0fc
fix: change to promise union type
syi0808 Jul 23, 2024
221209c
fix: remove record
syi0808 Aug 4, 2024
8e23ed0
test: fix test
syi0808 Aug 4, 2024
a23b8cf
fix: add partial and remove null
syi0808 Aug 5, 2024
5603801
add ts-expect-error comment
syi0808 Aug 5, 2024
679af8a
docs: add changes about mock and doMock
syi0808 Aug 6, 2024
d1b1062
Merge branch 'main' into fix/mock-factory-support-return-type
syi0808 Aug 6, 2024
78143bd
docs: remove incorrect information, add a note about return types
sheremet-va Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/vitest/src/integrations/vi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { assertTypes, createSimpleStackTrace } from '@vitest/utils'
import { parseSingleStack } from '../utils/source-map'
import type { VitestMocker } from '../runtime/mocker'
import type { ResolvedConfig, RuntimeConfig } from '../types'
import type { MockFactoryWithHelper } from '../types/mocker'
import type { MockFactoryWithHelper, PromiseMockFactoryWithHelper } from '../types/mocker'
import { getWorkerState } from '../utils/global'
import { resetModules, waitForImportsToResolve } from '../utils/modules'
import { isChildProcess } from '../utils/base'
Expand Down Expand Up @@ -194,6 +194,8 @@ export interface VitestUtils {
mock(path: string, factory?: MockFactoryWithHelper): void
// eslint-disable-next-line ts/method-signature-style
mock<T>(module: Promise<T>, factory?: MockFactoryWithHelper<T>): void
// eslint-disable-next-line ts/method-signature-style
mock<T>(module: Promise<T>, factory?: PromiseMockFactoryWithHelper<T>): void

/**
* Removes module from mocked registry. All calls to import will return the original module even if it was mocked before.
Expand All @@ -219,6 +221,8 @@ export interface VitestUtils {
doMock(path: string, factory?: MockFactoryWithHelper): void
// eslint-disable-next-line ts/method-signature-style
doMock<T>(module: Promise<T>, factory?: MockFactoryWithHelper<T>): void
// eslint-disable-next-line ts/method-signature-style
doMock<T>(module: Promise<T>, factory?: PromiseMockFactoryWithHelper<T>): void
/**
* Removes module from mocked registry. All subsequent calls to import will return original module.
*
Expand Down
7 changes: 5 additions & 2 deletions packages/vitest/src/types/mocker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
export type MockFactoryWithHelper<M = unknown> = (
importOriginal: <T extends M>() => Promise<T>
) => any
importOriginal: () => Promise<M>
) => Partial<Record<keyof M, any>>
export type PromiseMockFactoryWithHelper<M = unknown> = (
importOriginal: () => Promise<M>
) => Promise<Partial<Record<keyof M, any>>>
Comment thread
syi0808 marked this conversation as resolved.
Outdated
export type MockFactory = () => any

export type MockMap = Map<string, Record<string, string | null | MockFactory>>
Expand Down