vite-plugin-mock-dev-server 0.3.18 → 0.3.20

package/README.md

@@ -85,11 +85,11 @@ export default defineConfig({
   }
 })
 ```
-The plugin reads the configuration for `server.proxy` and enables mock matching only for urls where the proxy is set.
+The plugin reads the configuration for `server.proxy` or `options.prefix` and enables mock matching.
 
 The plugin also reads the `define` configuration and supports direct use in mock files.
 
-> In a general case, we only need to mock the url with the proxy so that we can proxy and mock through the http service provided by vite
+> In a general case, we only need to mock the url with the proxy so that we can proxy and mock through the http service provided by vite, but you can also configure the mock using 'options.prefix'
 
 ### Edit Mock File
 
@@ -129,6 +129,16 @@ export default defineConfig({
 
 #### options
 
+- `options.prefix`
+
+  Type: `string | string[]`
+  
+  Configure custom matches rules for the mock server. Any requests that request path starts with that `prefix` will be proxied to that specified target. If the `prefix` starts with ^, it will be interpreted as a RegExp.
+
+  > In general, `server.proxy` is sufficient to meet the requirements, and this options is added to be compatible with some scenarios.
+
+  Default: `[]`
+
 - `option.include` 
   
   Configure to read mock files, which can be a directory, glob, or array

package/README.zh-CN.md

@@ -86,11 +86,12 @@ export default defineConfig({
   }
 })
 ```
-插件会读取 `server.proxy` 的配置， 仅对设置了代理的 url 匹配，启用mock 匹配。
+插件会读取 `server.proxy` 或 `options.prefix` 的配置，对匹配的 url 启用mock 匹配。
 
 插件也会读取 `define` 配置， 支持在 mock 文件中直接使用。
 
-> 因为一般场景下，我们只需要对有代理的url进行mock，这样才能通过 vite 提供的 http 服务进行 代理和 mock
+> 因为一般场景下，我们只需要对有代理的url进行mock，这样才能通过 vite 提供的 http 服务进行 代理和 mock，
+> 但你也可以使用 `options.prefix`配置 mock 
 
 ### 编写mock文件
 
@@ -130,6 +131,16 @@ export default defineConfig({
 
 #### options
 
+- `options.prefix`
+
+  Type: `string | string[]`
+  
+  为mock服务器配置自定义匹配规则。任何请求路径以 `prefix` 值开头的请求将被代理到对应的目标。如果 `prefix` 值以 ^ 开头，将被识别为 RegExp。
+
+  > 一般情况下, `server.proxy` 已经足够满足需求，添加此项是为了与某些场景兼容。
+
+  Default: `[]`
+
 - `option.include` 
   
   配置读取 mock文件，可以是一个 目录，glob，或者一个数组

package/dist/index.cjs

@@ -44,7 +44,7 @@ var import_vite = require("vite");
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "0.3.18";
+var version = "0.3.20";
 
 // src/esbuildPlugin.ts
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -101,6 +101,13 @@ function getDirname(importMetaUrl) {
   return import_node_path2.default.dirname((0, import_node_url.fileURLToPath)(importMetaUrl));
 }
 var debug = (0, import_debug.default)("vite:plugin-mock-dev-server");
+var ensureArray = (thing) => {
+  if (isArray(thing))
+    return thing;
+  if (thing === null || thing === void 0)
+    return [];
+  return [thing];
+};
 function lookupFile(dir, formats, options) {
   for (const format of formats) {
     const fullPath = import_node_path2.default.join(dir, format);
@@ -119,8 +126,8 @@ function lookupFile(dir, formats, options) {
 
 // src/build.ts
 async function generateMockServer(ctx, config, options) {
-  const include = isArray(options.include) ? options.include : [options.include];
-  const exclude = isArray(options.exclude) ? options.exclude : [options.exclude];
+  const include = ensureArray(options.include);
+  const exclude = ensureArray(options.exclude);
   const define = {};
   if (config.define) {
     for (const key in config.define) {
@@ -128,6 +135,8 @@ async function generateMockServer(ctx, config, options) {
       define[key] = typeof val === "string" ? val : JSON.stringify(val);
     }
   }
+  const proxies = Object.keys(config.server.proxy || {});
+  const prefix = ensureArray(options.prefix);
   let pkg = {};
   try {
     const pkgStr = lookupFile(config.root, ["package.json"]);
@@ -151,7 +160,7 @@ async function generateMockServer(ctx, config, options) {
     {
       filename: import_node_path3.default.join(outputDir, "index.js"),
       source: generatorServerEntryCode(
-        config.server.proxy || {},
+        [...prefix, ...proxies],
         options.build.serverPort
       )
     },
@@ -211,13 +220,12 @@ function generatePackageJson(pkg, mockDeps) {
   });
   return JSON.stringify(mockPkg, null, 2);
 }
-function generatorServerEntryCode(proxy = {}, port = 8080) {
-  const proxies = Object.keys(proxy || {});
+function generatorServerEntryCode(proxies, port = 8080) {
   return `import connect from 'connect'
 import { baseMiddleware } from 'vite-plugin-mock-dev-server'
 import mockData from './mock-data.js'
 const app = connect()
-app.use(baseMiddleware(mockData, {
+app.use(baseMiddleware({ mockData }, {
   formidableOptions: { multiples: true },
   proxies: ${JSON.stringify(proxies)} 
 }))
@@ -350,13 +358,14 @@ function equalObj(left, right) {
 }
 
 // src/baseMiddleware.ts
-function baseMiddleware(mockData, { formidableOptions = {}, proxies }) {
+function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
   return async function(req, res, next) {
     const method = req.method.toUpperCase();
     const { query, pathname } = (0, import_node_url2.parse)(req.url, true);
     if (!pathname || proxies.length === 0 || !proxies.some((context) => doesProxyContextMatchUrl(context, req.url))) {
       return next();
     }
+    const mockData = mockLoader.mockData;
     const mockUrl = Object.keys(mockData).find((key) => {
       return (0, import_path_to_regexp.pathToRegexp)(key).test(pathname);
     });
@@ -691,8 +700,8 @@ MockLoader.EXT_JSON = /\.json5?$/;
 
 // src/mockMiddleware.ts
 async function mockServerMiddleware(httpServer, config, options) {
-  const include = isArray(options.include) ? options.include : [options.include];
-  const exclude = isArray(options.exclude) ? options.exclude : [options.exclude];
+  const include = ensureArray(options.include);
+  const exclude = ensureArray(options.exclude);
   const define = {};
   if (config.define) {
     for (const key in config.define) {
@@ -708,14 +717,16 @@ async function mockServerMiddleware(httpServer, config, options) {
   await loader.load();
   httpServer == null ? void 0 : httpServer.on("close", () => loader.close());
   const proxies = Object.keys(config.server.proxy || {});
-  return baseMiddleware(loader.mockData, {
+  const prefix = ensureArray(options.prefix);
+  return baseMiddleware(loader, {
     formidableOptions: options.formidableOptions,
-    proxies
+    proxies: [...prefix, ...proxies]
   });
 }
 
 // src/plugin.ts
 function mockDevServerPlugin({
+  prefix = [],
   include = ["mock/**/*.mock.{js,ts,cjs,mjs,json,json5}"],
   exclude = [
     "**/node_modules/**",
@@ -729,6 +740,7 @@ function mockDevServerPlugin({
   build: build3 = false
 } = {}) {
   const pluginOptions = {
+    prefix,
     include,
     exclude,
     formidableOptions: {

package/dist/index.d.ts

@@ -5,6 +5,13 @@ import EventEmitter from 'node:events';
 import chokidar from 'chokidar';
 
 interface MockServerPluginOptions {
+    /**
+     * 为 mock 服务配置 路径匹配规则，任何请求路径以 prefix 开头的都将被拦截代理。
+     * 如果 prefix 以 `^` 开头，将被识别为 `RegExp`。
+     *
+     * @default []
+     */
+    prefix?: string | string[];
     /**
      * glob 字符串匹配 mock 包含的文件
      * @see https://github.com/micromatch/picomatch#globbing-features
@@ -138,7 +145,7 @@ interface MockOptionsItem {
 type MockOptions = MockOptionsItem[];
 type FormidableFile = formidable.File | formidable.File[];
 
-declare function mockDevServerPlugin({ include, exclude, formidableOptions, build, }?: MockServerPluginOptions): Plugin[];
+declare function mockDevServerPlugin({ prefix, include, exclude, formidableOptions, build, }?: MockServerPluginOptions): Plugin[];
 
 /**
  * mock config helper
@@ -200,6 +207,6 @@ interface BaseMiddlewareOptions {
     formidableOptions: MockServerPluginOptions['formidableOptions'];
     proxies: string[];
 }
-declare function baseMiddleware(mockData: MockLoader['mockData'], { formidableOptions, proxies }: BaseMiddlewareOptions): Connect.NextHandleFunction;
+declare function baseMiddleware(mockLoader: MockLoader, { formidableOptions, proxies }: BaseMiddlewareOptions): Connect.NextHandleFunction;
 
 export { BaseMiddlewareOptions, FormidableFile, MockOptions, MockOptionsItem, MockServerPluginOptions, baseMiddleware, mockDevServerPlugin as default, defineMock, mockDevServerPlugin };

package/dist/index.js

@@ -9,7 +9,7 @@ import { createFilter } from "vite";
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "0.3.18";
+var version = "0.3.20";
 
 // src/esbuildPlugin.ts
 import fsp from "fs/promises";
@@ -66,6 +66,13 @@ function getDirname(importMetaUrl) {
   return path2.dirname(fileURLToPath(importMetaUrl));
 }
 var debug = Debug("vite:plugin-mock-dev-server");
+var ensureArray = (thing) => {
+  if (isArray(thing))
+    return thing;
+  if (thing === null || thing === void 0)
+    return [];
+  return [thing];
+};
 function lookupFile(dir, formats, options) {
   for (const format of formats) {
     const fullPath = path2.join(dir, format);
@@ -84,8 +91,8 @@ function lookupFile(dir, formats, options) {
 
 // src/build.ts
 async function generateMockServer(ctx, config, options) {
-  const include = isArray(options.include) ? options.include : [options.include];
-  const exclude = isArray(options.exclude) ? options.exclude : [options.exclude];
+  const include = ensureArray(options.include);
+  const exclude = ensureArray(options.exclude);
   const define = {};
   if (config.define) {
     for (const key in config.define) {
@@ -93,6 +100,8 @@ async function generateMockServer(ctx, config, options) {
       define[key] = typeof val === "string" ? val : JSON.stringify(val);
     }
   }
+  const proxies = Object.keys(config.server.proxy || {});
+  const prefix = ensureArray(options.prefix);
   let pkg = {};
   try {
     const pkgStr = lookupFile(config.root, ["package.json"]);
@@ -116,7 +125,7 @@ async function generateMockServer(ctx, config, options) {
     {
       filename: path3.join(outputDir, "index.js"),
       source: generatorServerEntryCode(
-        config.server.proxy || {},
+        [...prefix, ...proxies],
         options.build.serverPort
       )
     },
@@ -176,13 +185,12 @@ function generatePackageJson(pkg, mockDeps) {
   });
   return JSON.stringify(mockPkg, null, 2);
 }
-function generatorServerEntryCode(proxy = {}, port = 8080) {
-  const proxies = Object.keys(proxy || {});
+function generatorServerEntryCode(proxies, port = 8080) {
   return `import connect from 'connect'
 import { baseMiddleware } from 'vite-plugin-mock-dev-server'
 import mockData from './mock-data.js'
 const app = connect()
-app.use(baseMiddleware(mockData, {
+app.use(baseMiddleware({ mockData }, {
   formidableOptions: { multiples: true },
   proxies: ${JSON.stringify(proxies)} 
 }))
@@ -315,13 +323,14 @@ function equalObj(left, right) {
 }
 
 // src/baseMiddleware.ts
-function baseMiddleware(mockData, { formidableOptions = {}, proxies }) {
+function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
   return async function(req, res, next) {
     const method = req.method.toUpperCase();
     const { query, pathname } = urlParse(req.url, true);
     if (!pathname || proxies.length === 0 || !proxies.some((context) => doesProxyContextMatchUrl(context, req.url))) {
       return next();
     }
+    const mockData = mockLoader.mockData;
     const mockUrl = Object.keys(mockData).find((key) => {
       return pathToRegexp(key).test(pathname);
     });
@@ -655,8 +664,8 @@ MockLoader.EXT_JSON = /\.json5?$/;
 
 // src/mockMiddleware.ts
 async function mockServerMiddleware(httpServer, config, options) {
-  const include = isArray(options.include) ? options.include : [options.include];
-  const exclude = isArray(options.exclude) ? options.exclude : [options.exclude];
+  const include = ensureArray(options.include);
+  const exclude = ensureArray(options.exclude);
   const define = {};
   if (config.define) {
     for (const key in config.define) {
@@ -672,14 +681,16 @@ async function mockServerMiddleware(httpServer, config, options) {
   await loader.load();
   httpServer == null ? void 0 : httpServer.on("close", () => loader.close());
   const proxies = Object.keys(config.server.proxy || {});
-  return baseMiddleware(loader.mockData, {
+  const prefix = ensureArray(options.prefix);
+  return baseMiddleware(loader, {
     formidableOptions: options.formidableOptions,
-    proxies
+    proxies: [...prefix, ...proxies]
   });
 }
 
 // src/plugin.ts
 function mockDevServerPlugin({
+  prefix = [],
   include = ["mock/**/*.mock.{js,ts,cjs,mjs,json,json5}"],
   exclude = [
     "**/node_modules/**",
@@ -693,6 +704,7 @@ function mockDevServerPlugin({
   build: build3 = false
 } = {}) {
   const pluginOptions = {
+    prefix,
     include,
     exclude,
     formidableOptions: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-dev-server",
-  "version": "0.3.18",
+  "version": "0.3.20",
   "keywords": [
     "vite",
     "plugin",
@@ -33,11 +33,11 @@
     "chokidar": "^3.5.3",
     "co-body": "^6.1.0",
     "debug": "^4.3.4",
-    "esbuild": "^0.16.9",
+    "esbuild": "^0.17.6",
     "fast-glob": "^3.2.12",
     "formidable": "^2.1.1",
     "is-core-module": "^2.11.0",
-    "json5": "^2.2.2",
+    "json5": "^2.2.3",
     "path-to-regexp": "^6.2.1"
   },
   "devDependencies": {
@@ -47,22 +47,22 @@
     "@types/debug": "^4.1.7",
     "@types/formidable": "^2.0.5",
     "@types/is-core-module": "^2.2.0",
-    "@types/node": "^18.11.7",
+    "@types/node": "^18.11.19",
     "bumpp": "^8.2.1",
     "conventional-changelog-cli": "^2.2.2",
-    "eslint": "^8.31.0",
+    "eslint": "^8.33.0",
     "mockjs": "^1.1.0",
-    "prettier": "^2.8.1",
+    "prettier": "^2.8.3",
     "tsup": "^6.5.0",
-    "typescript": "^4.9.4",
-    "vite": "^4.0.2",
-    "vitepress": "1.0.0-alpha.35",
-    "vue": "^3.2.45"
+    "typescript": "^4.9.5",
+    "vite": "^4.1.1",
+    "vitepress": "1.0.0-alpha.45",
+    "vue": "^3.2.47"
   },
   "peerDependencies": {
     "vite": ">=3.0.0"
   },
-  "packageManager": "pnpm@7.18.2",
+  "packageManager": "pnpm@7.26.3",
   "engines": {
     "node": "^14.18.0 || >=16"
   },