vite-plugin-mock-dev-server 1.4.3 → 1.4.6

package/README.md

@@ -8,22 +8,21 @@
 
 <br>
 <p align="center">
-<a href="https://www.npmjs.com/package/vite-plugin-mock-dev-server"><img alt="npm" src="https://img.shields.io/npm/v/vite-plugin-mock-dev-server?style=flat-square"></a>
-<img alt="node-current" src="https://img.shields.io/node/v/vite-plugin-mock-dev-server?style=flat-square">
-<img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/vite-plugin-mock-dev-server/peer/vite?style=flat-square">
-<img alt="npm" src="https://img.shields.io/npm/dt/vite-plugin-mock-dev-server?style=flat-square">
-<br>
-<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/pengzhanbo/vite-plugin-mock-dev-server/lint.yml?style=flat-square">
-<a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fpengzhanbo%2Fvite-plugin-mock-dev-server?ref=badge_shield"><img alt="fossa status" src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpengzhanbo%2Fvite-plugin-mock-dev-server.svg?type=shield"></a>
+  <a href="https://www.npmjs.com/package/vite-plugin-mock-dev-server"><img alt="npm" src="https://img.shields.io/npm/v/vite-plugin-mock-dev-server?style=flat-square"></a>
+  <img alt="node-current" src="https://img.shields.io/node/v/vite-plugin-mock-dev-server?style=flat-square">
+  <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/vite-plugin-mock-dev-server/peer/vite?style=flat-square">
+  <img alt="npm" src="https://img.shields.io/npm/dt/vite-plugin-mock-dev-server?style=flat-square">
+  <br>
+  <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/pengzhanbo/vite-plugin-mock-dev-server/lint.yml?style=flat-square">
+  <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fpengzhanbo%2Fvite-plugin-mock-dev-server?ref=badge_shield"><img alt="fossa status" src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpengzhanbo%2Fvite-plugin-mock-dev-server.svg?type=shield"></a>
 </p>
 <br>
 <p align="center">
-<span>English</span> | <a href="/README.zh-CN.md">简体中文</a>
+  <span>English</span> | <a href="/README.zh-CN.md">简体中文</a>
 </p>
 <br>
 <br>
 
-
 ## Feature
 
 - ⚡️ Lightweight, Flexible, Fast.
@@ -46,7 +45,6 @@
 - ⚜️ Support `WebSocket Mock`
 - 🗂 Support building small independent deployable mock services.
 
-
 ## Documentation
 
 See the [documentation](https://vite-plugin-mock-dev-server.netlify.app/en/) to learn more.
@@ -60,7 +58,7 @@ See the [documentation](https://vite-plugin-mock-dev-server.netlify.app/en/) to
 ``` sh
 # npm
 npm i -D vite-plugin-mock-dev-server
-# yarn 
+# yarn
 yarn add vite-plugin-mock-dev-server
 # pnpm
 pnpm add -D vite-plugin-mock-dev-server
@@ -114,7 +112,6 @@ export default defineMock({
 
 Vite plugin
 
-
 `vite.config.ts`
 ``` ts
 import { defineConfig } from 'vite'
@@ -127,13 +124,12 @@ export default defineConfig({
 })
 ```
 
-
 #### options
 
 - `options.prefix`
 
   **Type:** `string | string[]`
-  
+
   Configure custom matching rules for the mock server. Any request path starting with the value of `prefix` will be proxied to the corresponding target. If the `prefix` value starts with ^, it will be recognized as a RegExp.
 
   > In general, `server.proxy` is sufficient to meet the needs. Adding this item is for compatibility with certain scenarios.
@@ -141,7 +137,7 @@ export default defineConfig({
   **Default:** `[]`
 
 - `options.wsPrefix`
-  
+
   **Type:** `string | string[]`
 
   Configure the matching rules for the WebSocket service. Any request path starting with the value of `wsPrefix` and using the `ws/wss` protocol will be proxied to the corresponding target.
@@ -151,11 +147,10 @@ export default defineConfig({
   > Different from using `viteConfig.server.proxy` by default for http mock, `websocket mock` does not use the ws-related configuration in `viteConfig.server.proxy`. Also, rules configured in `wsPrefix` cannot be configured simultaneously in `viteConfig.server.proxy`, as it will cause conflicts when starting the vite server because multiple instances of WebSocketServer cannot be implemented for the same request.
   > This conflict is neither a problem with Vite nor with the plugin; it belongs to a reasonable error type. When switching between WebSocket Mock and WebSocket Proxy, please pay attention to avoid duplicate configurations that may cause conflicts.
 
-
-- `option.include` 
+- `option.include`
 
   **Type:** `string | string[]`
-  
+
   Configure to read mock files, which can be a directory, glob, or an array.
 
   **Default：** `['mock/**/*.mock.{js,ts,cjs,mjs,json,json5}']` (Relative to the root directory.)
@@ -163,36 +158,35 @@ export default defineConfig({
 - `options.exclude`
 
   **Type:** `string | string[]`
-  
+
   When reading mock files for configuration, the files that need to be excluded can be a directory, glob, or array.
 
   **Default：** `['**/node_modules/**','**/.vscode/**','**/.git/**']`
 
 - `options.reload`
-  
+
   **Type:** `boolean`
 
   When the mock resource is hot updated, only the data content is updated, but the page is not refreshed by default. If you want to refresh the page every time you modify the mock file, you can open this option.
 
 - `options.cors`
-  
+
   **Type:** `boolean | CorsOptions`
 
   Enable by default.
 
   Configure to `cors`, see [cors](https://github.com/expressjs/cors#configuration-options)
 
-
   **Default:** `true`
 
 - `options.log`
-  
+
   **Type:** `boolean | 'info' | 'warn' | 'error' | 'silent'`
 
   Enable log and configure log level.
 
 - `options.formidableOptions`
-  
+
   Configure to `formidable`, see [formidable options](https://github.com/node-formidable/formidable#options)
 
   **Default:** `{}`
@@ -207,7 +201,7 @@ export default defineConfig({
   ```
 
 - `options.cookiesOptions`
-  
+
   Configure to `cookies`, see [cookies](https://github.com/pillarjs/cookies#new-cookiesrequest-response--options)
 
   **Default:** `{}`
@@ -216,7 +210,7 @@ export default defineConfig({
 
   The configuration needed to build a small, independently deployable mock service.
 
-  **Type：** `boolean | ServerBuildOptions` 
+  **Type：** `boolean | ServerBuildOptions`
 
   **Default：** `false`
 
@@ -241,7 +235,7 @@ export default defineConfig({
   ```
 
 - `options.priority`
-  
+
   Custom path matching rule priority。[read more](#Custom-Path-Matching-Priority)
 
   **Default：** `undefined`
@@ -473,11 +467,10 @@ type Response = http.ServerResponse<http.IncomingMessage> & {
 }
 ```
 
-
 > **Tips：**
-> 
-> If you write mock files using json/json5, 
-> the 'response' method is not supported, 
+>
+> If you write mock files using json/json5,
+> the 'response' method is not supported,
 > as is the function form that uses other fields.
 
 ## Share Mock Data
@@ -525,8 +518,8 @@ export default defineMock([
 ```
 
 > **Tips：**
-> 
-> The `defineMockData` function relies solely on the shared data support provided by `memory`. 
+>
+> The `defineMockData` function relies solely on the shared data support provided by `memory`.
 > If persistent mock data is required, it is recommended to use a `nosql` database like `lowdb` or `level`.
 
 ## Custom-Path-Matching-Priority
@@ -576,7 +569,6 @@ export default defineConfig({
 > you can use static rules instead of `priority`,
 > as static rules always have the highest priority.
 
-
 ## Example
 
 `mock/**/*.mock.{ts,js,mjs,cjs,json,json5}`
@@ -598,7 +590,6 @@ export default defineMock({
 })
 ```
 
-
 **exp:** Only Support `GET` Method
 ``` ts
 export default defineMock({
@@ -627,7 +618,6 @@ export default defineMock({
 })
 ```
 
-
 **exp:** Define multiple mock requests for the same URL and match valid rules with validators
 ``` ts
 export default defineMock([
@@ -662,7 +652,6 @@ export default defineMock([
 ])
 ```
 
-
 **exp:** Response Delay
 ``` ts
 export default defineMock({
@@ -671,7 +660,6 @@ export default defineMock({
 })
 ```
 
-
 **exp:** The interface request failed
 ``` ts
 export default defineMock({
@@ -681,7 +669,6 @@ export default defineMock({
 })
 ```
 
-
 **exp:** Dynamic route matching
 ``` ts
 export default defineMock({
@@ -749,7 +736,6 @@ export default defineMock({
 ```
 You need install `mockjs`
 
-
 **exp:** Use `response` to customize the response
 ``` ts
 export default defineMock({
@@ -769,7 +755,6 @@ export default defineMock({
 })
 ```
 
-
 **exp:** Use json / json5
 ``` json
 {
@@ -780,8 +765,6 @@ export default defineMock({
 }
 ```
 
-
-
 **exp:** multipart, upload files.
 
 use [`formidable`](https://www.npmjs.com/package/formidable#readme) to support.
@@ -789,7 +772,7 @@ use [`formidable`](https://www.npmjs.com/package/formidable#readme) to support.
 <form action="/api/upload" method="post" enctype="multipart/form-data">
   <p>
     <span>file: </span>
-    <input type="file" name="files" multiple>
+    <input type="file" name="files" multiple="multiple">
   </p>
   <p>
     <span>name:</span>
@@ -801,7 +784,7 @@ use [`formidable`](https://www.npmjs.com/package/formidable#readme) to support.
 </form>
 ```
 
-fields `files` mapping to `formidable.File` 
+fields `files` mapping to `formidable.File`
 ``` ts
 export default defineMock({
   url: '/api/upload',
@@ -948,5 +931,4 @@ You can access related `mock` interfaces through `localhost:8080/`.
 
 [MIT](/LICENSE)
 
-
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fpengzhanbo%2Fvite-plugin-mock-dev-server.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fpengzhanbo%2Fvite-plugin-mock-dev-server?ref=badge_large)

package/README.zh-CN.md

@@ -47,7 +47,6 @@
 - ⚜️ 支持模拟 `WebSocket`
 - 🗂 支持构建可独立部署的小型mock服务
 
-
 ## 文档
 
 查看 [Documentation](https://vite-plugin-mock-dev-server.netlify.app/) 了解更多。
@@ -61,7 +60,7 @@
 ```sh
 # npm
 npm i -D vite-plugin-mock-dev-server
-# yarn 
+# yarn
 yarn add vite-plugin-mock-dev-server
 # pnpm
 pnpm add -D vite-plugin-mock-dev-server
@@ -92,7 +91,7 @@ export default defineConfig({
 插件也会读取 `define` 配置， 支持在 mock 文件中直接使用。
 
 > 因为一般场景下，我们只需要对有代理的url进行mock，这样才能通过 vite 提供的 http 服务进行 代理和 mock，
-> 但你也可以使用 `options.prefix`配置 mock 
+> 但你也可以使用 `options.prefix`配置 mock
 
 ### 编写mock文件
 
@@ -114,7 +113,6 @@ export default defineMock({
 
 vite plugin
 
-
 `vite.config.ts`
 ```ts
 import { defineConfig } from 'vite'
@@ -132,7 +130,7 @@ export default defineConfig({
 - `options.prefix`
 
   **类型:** `string | string[]`
-  
+
   为mock服务器配置自定义匹配规则。任何请求路径以 `prefix` 值开头的请求将被代理到对应的目标。如果 `prefix` 值以 `^` 开头，将被识别为 RegExp。
 
   > 一般情况下, `server.proxy` 已经足够满足需求，添加此项是为了与某些场景兼容。
@@ -140,19 +138,19 @@ export default defineConfig({
   **默认值:** `[]`
 
 - `options.wsPrefix`
-  
+
   **类型:** `string | string[]`
 
   配置 webSocket 服务 匹配规则。任何请求路径以 `wsPrefix` 值开头的 `ws/wss` 协议请求，将被代理到对应的目标。
   如果`wsPrefix`值以 `^` 开头,将被识别为 RegExp。
 
   > 与 http mock 默认使用 `viteConfig.server.proxy` 不同的是，`websocket mock` 不会使用 `viteConfig.server.proxy` 中的 ws 相关的配置，且配置在 `wsPrefix` 中的规则，不能同时配置在 `viteConfig.server.proxy`中，因为会导致在 vite 在启动服务时产生冲突，因为不能对同一个请求实现多个的 `WebSocketServer`实例。
-  > 该冲突既不是 `vite` 的问题，也不是插件的问题，这属于合理的错误类型。在进行 `WebSocket Mock`和 `WebSocket Proxy` 切换时，请注意配置不要出现重复导致冲突。 
+  > 该冲突既不是 `vite` 的问题，也不是插件的问题，这属于合理的错误类型。在进行 `WebSocket Mock`和 `WebSocket Proxy` 切换时，请注意配置不要出现重复导致冲突。
 
-- `option.include` 
+- `option.include`
 
   **类型：** `string | string[]`
-  
+
   配置读取 mock文件，可以是一个 目录，glob，或者一个数组
 
   **默认值：** `['mock/**/*.mock.{js,ts,cjs,mjs,json,json5}']` (相对于根目录)
@@ -160,7 +158,7 @@ export default defineConfig({
 - `options.exclude`
 
   **类型：** `string | string[]`
-  
+
   配置读取 mock文件时，需要排除的文件， 可以是一个 目录、glob、或者一个数组
 
   **默认值：** `['**/node_modules/**', '**/.vscode/**', '**/.git/**']`
@@ -174,7 +172,7 @@ export default defineConfig({
   **Default:** `false`
 
 - `options.cors`
-  
+
   **Type:** `boolean | CorsOptions`
 
   默认启用.
@@ -182,13 +180,13 @@ export default defineConfig({
   配置 `cors`, 查看 [cors](https://github.com/expressjs/cors#configuration-options)
 
 - `options.log`
-  
+
   **Type:** `boolean | 'info' | 'warn' | 'error' | 'silent'`
 
   启动日志，以及配置日志打印级别
 
 - `options.formidableOptions`
-  
+
   配置 `formidable`，查看 [formidable options](https://github.com/node-formidable/formidable#options)
 
   **默认值:** `{}`
@@ -202,16 +200,16 @@ export default defineConfig({
   })
   ```
 - `options.cookiesOptions`
-  
+
   配置 `cookies`, 查看 [cookies](https://github.com/pillarjs/cookies#new-cookiesrequest-response--options)
 
   **默认值:** `{}`
 
 - `options.build`
-  
+
   需要构建可独立部署的小型mock服务时配置。
 
-  **类型：** `boolean | ServerBuildOptions` 
+  **类型：** `boolean | ServerBuildOptions`
 
   **默认值：**`false`
 
@@ -237,7 +235,7 @@ export default defineConfig({
   ```
 
   - `options.priority`
-  
+
   自定义 路径匹配规则优先级。[查看更多](#自定义匹配优先级)
 
   **默认值：** `undefined`
@@ -464,9 +462,8 @@ type Response = http.ServerResponse<http.IncomingMessage> & {
 }
 ```
 
-
 > **注意：**
-> 
+>
 > 如果使用 json/json5 编写 mock文件，则不支持使用 `response` 方法，以及不支持使用其他字段的函数形式。
 
 ## 共享 Mock 数据
@@ -516,11 +513,10 @@ export default defineMock([
 ```
 
 > **注意：**
-> 
+>
 > `defineMockData` 仅是基于 `memory` 提供的共享数据支持，
 > 如果需要做 mock 数据持久化，建议使用 `nosql`， 如 `lowdb` 或 `level` 等。
 
-
 ## 自定义匹配优先级
 
 > 自定义规则仅影响包含动态参数的链接，如： `/api/user/:id`
@@ -599,7 +595,6 @@ export default defineMock({
 })
 ```
 
-
 **exp:**  在返回的响应头中，添加自定义 header 和 cookie
 ```ts
 export default defineMock({
@@ -653,7 +648,6 @@ export default defineMock([
 ])
 ```
 
-
 **exp:**  延迟接口响应：
 ```ts
 export default defineMock({
@@ -737,7 +731,6 @@ export default defineMock({
 ```
 请先安装 `mockjs`
 
-
 **exp:** 使用 `response` 自定义响应
 ```ts
 export default defineMock({
@@ -757,7 +750,6 @@ export default defineMock({
 })
 ```
 
-
 **exp:** 使用 json / json5
 ```json
 {
@@ -768,7 +760,6 @@ export default defineMock({
 }
 ```
 
-
 **exp:** multipart, 文件上传.
 
 通过 [`formidable`](https://www.npmjs.com/package/formidable#readme) 支持。
@@ -776,7 +767,7 @@ export default defineMock({
 <form action="/api/upload" method="post" enctype="multipart/form-data">
   <p>
     <span>file: </span>
-    <input type="file" name="files" multiple>
+    <input type="file" name="files" multiple="multiple">
   </p>
   <p>
     <span>name:</span>