vite-plugin-mock

library3.0.2jsnpmunverified

A mock plugin for Vite that provides local mock data for development and testing. Current stable version is 3.0.2, with active development and releases. It integrates with Vite's dev server, supports hot module replacement (HMR) for mock files, and allows mocking API requests during development. Differentiated by its tight integration with Vite, TypeScript support, and use of mockjs for data generation. Requires Vite >=4.0.0, esbuild >=0.17, and mockjs >=1.1.0 as peer dependencies.

testing http-networking web-framework

npm install vite-plugin-mock

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-MOCK

vite-plugin-mock

testingjavascriptv3.0.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

viteMockServe

✓ import { viteMockServe } from 'vite-plugin-mock'

✗ const viteMockServe = require('vite-plugin-mock').viteMockServe

ESM only; CJS require works but is not recommended.

default

✓ import vitePluginMock from 'vite-plugin-mock'

✗ import { default } from 'vite-plugin-mock'

Default export is viteMockServe, but named export is preferred.

type MockConfig

✓ import type { MockConfig } from 'vite-plugin-mock'

✗ import { MockConfig } from 'vite-plugin-mock'

TypeScript users should use type import for interfaces.

Configures vite-plugin-mock in vite.config.ts and creates a simple mock endpoint for /api/user.

// vite.config.ts import { defineConfig } from 'vite'; import { viteMockServe } from 'vite-plugin-mock'; export default defineConfig({ plugins: [ viteMockServe({ mockPath: 'mock', enable: true, watchFiles: true, }), ], }); // mock/user.ts import { MockMethod } from 'vite-plugin-mock'; export default [ { url: '/api/user', method: 'get', response: () => ({ code: 0, data: { id: 1, name: 'John' }, }), }, ] as MockMethod[];

Debug

Known issues

breakingvite-plugin-mock v3 drops support for Vite <4 and Node <16.

fix

Upgrade Vite to >=4.0.0 and Node to >=16.0.0.

affects: >=3.0.0

deprecatedThe 'supportTs' option is deprecated and may be removed.

fix

Remove 'supportTs' from config; TypeScript is automatically supported.

affects: >=2.9.0

gotchaMock files are resolved relative to the project root by default. Ensure 'mockPath' is correct.

fix

Set 'mockPath' to the absolute or relative path to your mock directory.

affects: >=2.0.0

breakingvite-plugin-mock v3 no longer exports default mock configuration; use named export.

fix

Change 'import vitePluginMock from 'vite-plugin-mock'' to 'import { viteMockServe } from 'vite-plugin-mock''.

affects: >=3.0.0

gotchaHMR may not work when mock files are outside the project root.

fix

Place mock files inside the project root or use symlinks.

affects: >=2.0.0

Errors

Common errors & fixes

Cannot find module 'mockjs'

Missing mockjs dependency.

fix

npm install mockjs --save-dev

TypeError: viteMockServe is not a function

Attempting to import default export as named export.

fix

Use import { viteMockServe } from 'vite-plugin-mock' or import vitePluginMock from 'vite-plugin-mock'

Vite plugin 'vite-plugin-mock' can only be used with Vite >=4.0.0

Running with an older version of Vite.

fix

Upgrade Vite to >=4.0.0

Mock file not found: /path/to/mock

mockPath is misconfigured or directory does not exist.

fix

Check mockPath in viteMockServe config and ensure the directory exists.

Upgrade

Version history

3.0.2latest on npm

Audit

Dependencies

mockjsrequiredCore dependency for generating mock data

viterequiredVite plugin, requires Vite dev server

esbuildrequiredDependency for esbuild configuration

Agent activity

23 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/anncwb/vite-plugin-mock ↗

packagehttps://www.npmjs.com/package/vite-plugin-mock ↗