nuxt / test-utils

🧪 Test utilities for Nuxt
http://nuxt.com/docs/getting-started/testing
MIT License
313 stars 81 forks source link

Expose mocks directly with `mockNuxtImport` #541

Open rinux55 opened 1 year ago

rinux55 commented 1 year ago

Currently, it's possible to mock a Nuxt import:

mockNuxtImport('useStorage', () => {
    return vi.fn()
})

When we want to access this mock in our test, to run an assertion or to change the implementation, we can use vi.hoisted:

const { useStorageMock } = vi.hoisted(() => {
  return {
    useStorageMock: vi.fn()
  }
})

mockNuxtImport('useStorage', () => {
  return useStorageMock
})

// now we can change the implementation of useStorageMock between tests

This is a lot of code just to define and expose a single mock. Would it be possible to make mocking Nuxt imports easier by returning the mocks directly in mockNuxtImport?

I propose something like this:

const useStorageMock = mockNuxtImport('useStorage', () => {
    return vi.fn()
})

// now we can change the implementation of useStorageMock between tests

I'm down to have a look at this if this is possible.

danielroe commented 1 year ago

It seems this should be possible to implement in the same plugin that processes/handles mockNuxtImport.