Unplugin-mockery NPM

unplugin-mockery

Features

Vue CLI (webpack)
Vite
Hot Reload Routes

Why unplugin-mockery?

A visual mock management devtool.
We have some old projects that need to be compatible with Vue CLI and Vite.

Install

pnpm add -D unplugin-mockery

// vite.config.ts
import Mocker from 'unplugin-mockery/vite'

export default defineConfig({
  plugins: [
    Mocker({ /* options */ }),
  ],
})

Example: playground/

// rollup.config.js
import Mocker from 'unplugin-mockery/rollup'

export default {
  plugins: [
    Mocker({ /* options */ }),
  ],
}

// webpack.config.js
module.exports = {
  /* ... */
  plugins: [
    require('unplugin-mockery/webpack').default({ /* options */ })
  ]
}

export default defineNuxtConfig({
  vite: {
    plugins: [
      // do not use it in production
      import.meta.env.DEV && Mockery({
        mockDir: 'mock',
        client: {
          enable: true,
        },
      }),
    ]
  }
})

// nuxt.config.js
// export default defineNuxtConfig({
//   modules: [
//     ['unplugin-mockery/nuxt', { /* options */ }],
//   ],
// })

This module works for both Nuxt 2 and Nuxt Vite

在 Webpack 中，它工作地很好。但在 Vue Cli 中，webpack-dev-server 的启动时机有所不同，因此我们无法通过插件获取 Vue Cli 中的 webpack-dev-server devServer 的实例。而是通过获取 webpack 的方式进行设置。

In Webpack, it works well. But in Vue Cli, the timing of starting webpack-dev-server is different, so we cannot get the instance of webpack-dev-server devServer in Vue Cli through the plugin. Instead, we set it by getWebpackConfig.

// vue.config.js
const { getWebpackConfig } = require('unplugin-mockery/webpack')

module.exports = {
  configureWebpack: {
    devServer: {
      ...getWebpackConfig({ /* options */ }).devServer,
    },
  },
}

# .env custom client port
VUE_APP_MOCKERY_CLIENT_PORT=51224

// esbuild.config.js
import { build } from 'esbuild'
import Mocker from 'unplugin-mockery/esbuild'

build({
  plugins: [Mocker()],
})

Schema Setting in VSCode

Edit .vscode/settings.json:

{
  // schema
  "json.schemas": [
    {
      "fileMatch": ["*.scene.json"],
      "url": "./mock/schemas/scene.schema.json"
    }
  ]
}

Development

# run template

# for vue-cli(webpack)
pnpm play:vue-cli

# for webpack
pnpm play:webpack

# for vite
pnpm play:vite

Options

export interface Options {
  /**
   * Base URL for inspector UI
   *
   * @default read from Vite's config
   */
  base?: string

  // define your plugin options here
  /**
   * Display debug information.
   */
  debug?: boolean

  /**
   * The directory where the mock files are located.
   * @default 'mock'
   * mock/api: mock files
   * mock/scenes: scene files
   * mock/schemas: schema file
   *   scene.schema.json: scene schema file
   *   config.schema.json: config schema file
   * mock/utils: utility files
   * mock/config.json: configuration file
   */
  mockDir: string

  /**
   * mock client ui
   */
  client?: {
    /**
     * enable client
     * @default true
     */
    enable?: boolean
    /**
     * The port to run the client server.
     */
    port?: number
    /**
     * auto open browser.
     */
    open?: boolean
  }
}