unplugin-mock

unplugin-mock

mock plugin for vite

Install

npm i vite-plugin-reload --save-dev

Usage

import viteMockerPlugin from 'unplugin-mock/vite'

export default defineConfig({
  plugins: [
    // ... etc
    viteMockerPlugin({
      mockPath: './mock',
    }),
  ],
  // ...etc
})

Options

enable

• Enable mock plugin
• Type: boolean
• Default: true

mockPath

• Path to mock directory
• Type: string
• Default: ''
• Example: './mock'

extension

• File extension of mock files
• Type: string[]
• Defualt: ['.js', '.ts']

ignore

• Ignore files
• Type: string | RegExp | (RegExp | string)[]
• default: []

refresh

• Refresh page when mock file changed
• Type: boolean
• default: false

why not support webpack

Mock Service in webpack is not suitable for plugin implementation, because it is hard to affect webpack-dev-server config in webpack-plugin.

You can build a local mocker by DevServer hook or pick some readily available libs for devServer, suck as mocker-api

Notice

vite.d.ts and types.d.ts will be removed in the future, please use typescript >= 4.7.2 instead.

TODO

• the implementation first for vite
• logger for hmr
• ignore files option
• restful url support
• Keep url unique for module handler
• cache handler
• enhance response for function mockHandler
• cache source code
• analyze source code for avoiding duplicate mock import