{"id":22745,"library":"vite-plugin-mock","title":"vite-plugin-mock","description":"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.","status":"active","version":"3.0.2","language":"javascript","source_language":"en","source_url":"https://github.com/anncwb/vite-plugin-mock","tags":["javascript","vite","mock","hmr","typescript"],"install":[{"cmd":"npm install vite-plugin-mock","lang":"bash","label":"npm"},{"cmd":"yarn add vite-plugin-mock","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-plugin-mock","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Core dependency for generating mock data","package":"mockjs","optional":false},{"reason":"Vite plugin, requires Vite dev server","package":"vite","optional":false},{"reason":"Dependency for esbuild configuration","package":"esbuild","optional":false}],"imports":[{"note":"ESM only; CJS require works but is not recommended.","wrong":"const viteMockServe = require('vite-plugin-mock').viteMockServe","symbol":"viteMockServe","correct":"import { viteMockServe } from 'vite-plugin-mock'"},{"note":"Default export is viteMockServe, but named export is preferred.","wrong":"import { default } from 'vite-plugin-mock'","symbol":"default","correct":"import vitePluginMock from 'vite-plugin-mock'"},{"note":"TypeScript users should use type import for interfaces.","wrong":"import { MockConfig } from 'vite-plugin-mock'","symbol":"type MockConfig","correct":"import type { MockConfig } from 'vite-plugin-mock'"}],"quickstart":{"code":"// vite.config.ts\nimport { defineConfig } from 'vite';\nimport { viteMockServe } from 'vite-plugin-mock';\n\nexport default defineConfig({\n  plugins: [\n    viteMockServe({\n      mockPath: 'mock',\n      enable: true,\n      watchFiles: true,\n    }),\n  ],\n});\n\n// mock/user.ts\nimport { MockMethod } from 'vite-plugin-mock';\nexport default [\n  {\n    url: '/api/user',\n    method: 'get',\n    response: () => ({\n      code: 0,\n      data: { id: 1, name: 'John' },\n    }),\n  },\n] as MockMethod[];","lang":"typescript","description":"Configures vite-plugin-mock in vite.config.ts and creates a simple mock endpoint for /api/user."},"warnings":[{"fix":"Upgrade Vite to >=4.0.0 and Node to >=16.0.0.","message":"vite-plugin-mock v3 drops support for Vite <4 and Node <16.","severity":"breaking","affected_versions":">=3.0.0"},{"fix":"Remove 'supportTs' from config; TypeScript is automatically supported.","message":"The 'supportTs' option is deprecated and may be removed.","severity":"deprecated","affected_versions":">=2.9.0"},{"fix":"Set 'mockPath' to the absolute or relative path to your mock directory.","message":"Mock files are resolved relative to the project root by default. Ensure 'mockPath' is correct.","severity":"gotcha","affected_versions":">=2.0.0"},{"fix":"Change 'import vitePluginMock from 'vite-plugin-mock'' to 'import { viteMockServe } from 'vite-plugin-mock''.","message":"vite-plugin-mock v3 no longer exports default mock configuration; use named export.","severity":"breaking","affected_versions":">=3.0.0"},{"fix":"Place mock files inside the project root or use symlinks.","message":"HMR may not work when mock files are outside the project root.","severity":"gotcha","affected_versions":">=2.0.0"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"npm install mockjs --save-dev","cause":"Missing mockjs dependency.","error":"Cannot find module 'mockjs'"},{"fix":"Use import { viteMockServe } from 'vite-plugin-mock' or import vitePluginMock from 'vite-plugin-mock'","cause":"Attempting to import default export as named export.","error":"TypeError: viteMockServe is not a function"},{"fix":"Upgrade Vite to >=4.0.0","cause":"Running with an older version of Vite.","error":"Vite plugin 'vite-plugin-mock' can only be used with Vite >=4.0.0"},{"fix":"Check mockPath in viteMockServe config and ensure the directory exists.","cause":"mockPath is misconfigured or directory does not exist.","error":"Mock file not found: /path/to/mock"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}