vite-plugin-mock-dev-server 1.3.4-beta.1 → 1.4.0

package/README.md

@@ -49,7 +49,7 @@
 
 ## Documentation
 
-See the [documentation](https://vite-plugin-mock-dev-server.netlify.app/) to learn more.
+See the [documentation](https://vite-plugin-mock-dev-server.netlify.app/en/) to learn more.
 
 [![Netlify Status](https://api.netlify.com/api/v1/badges/9ccda610-2c6a-4cd0-aeaa-a8932f2b477c/deploy-status)](https://app.netlify.com/sites/vite-plugin-mock-dev-server/deploys)
 
@@ -287,16 +287,16 @@ export default defineMock({
    * Supported request methods of the interface.
    * @type string | string[]
    * @default ['POST','GET']
-   * 
+   *
    */
   method: ['GET', 'POST'],
   /**
-   * In practical scenarios, 
-   * we usually only need certain mock interfaces to take effect, 
-   * rather than enabling all mock interfaces. 
-   * For interfaces that do not currently require mocking, 
+   * In practical scenarios,
+   * we usually only need certain mock interfaces to take effect,
+   * rather than enabling all mock interfaces.
+   * For interfaces that do not currently require mocking,
    * they can be set to false.
-   * 
+   *
    * @default true
    */
   enabled: true,
@@ -350,7 +350,7 @@ export default defineMock({
 
   /**
    * Response Body
-   * Support `string/number/array/object/buffer/ReadableStream` 
+   * Support `string/number/array/object/buffer/ReadableStream`
    * You can also use libraries such as' mockjs' to generate data content
    * @type string | number | array | object | ReadableStream | buffer
    * @type (request: { headers, query, body, params, refererQuery, getCookie }) => any | Promise<any>
@@ -358,33 +358,33 @@ export default defineMock({
   body: '',
 
   /**
-   * If the mock requirement cannot be solved through `body` configuration, 
-   * then it can be achieved by configuring response and exposing the interface of http server 
-   * to realize fully controllable custom configuration in req parameters. 
-   * The parsing of query, body and params has been built-in, so you can use them directly. 
+   * If the mock requirement cannot be solved through `body` configuration,
+   * then it can be achieved by configuring response and exposing the interface of http server
+   * to realize fully controllable custom configuration in req parameters.
+   * The parsing of query, body and params has been built-in, so you can use them directly.
    * Don't forget to return response data through `res.end()` or skip mock by calling `next()`.
    */
   response(req, res, next) {
     res.end()
   },
   /**
-   * Request validator, return mock data if validated, otherwise do not use current mock. 
-   * This is useful in scenarios where an interface needs to return different data based 
-   * on different input parameters. 
-   * Validators can solve this type of problem well by dividing the same URL into multiple 
+   * Request validator, return mock data if validated, otherwise do not use current mock.
+   * This is useful in scenarios where an interface needs to return different data based
+   * on different input parameters.
+   * Validators can solve this type of problem well by dividing the same URL into multiple
    * mock configurations and determining which one is effective based on the validator.
-   * 
+   *
    * @type { headers, body, query, params, refererQuery }
-   * If the validator passed in is an object, 
-   * then the validation method is to deeply compare whether 
-   * `headers/body/query/params/refererQuery` of the requested interface contain 
+   * If the validator passed in is an object,
+   * then the validation method is to deeply compare whether
+   * `headers/body/query/params/refererQuery` of the requested interface contain
    * the `key-value` of the validator.
-   * 
+   *
    * @type (request) => boolean
-   * If the validator passed in is a function, 
-   * then the data related to the requested interface will be provided as input parameters 
+   * If the validator passed in is a function,
+   * then the data related to the requested interface will be provided as input parameters
    * for users to perform custom validation and return a boolean.
-   * 
+   *
    */
   validator: {
     headers: {},
@@ -392,8 +392,8 @@ export default defineMock({
     query: {},
     params: {},
     /**
-     * refererQuery validates the query parameters in the URL of the request source page, 
-     * which allows for direct modification of parameters in the browser address bar 
+     * refererQuery validates the query parameters in the URL of the request source page,
+     * which allows for direct modification of parameters in the browser address bar
      * to obtain different simulated data.
      */
     refererQuery: {}
@@ -422,7 +422,7 @@ export default defineMock({
    * `onCleanup()` to clear these tasks.
    * This is because when the plugin is hot updated,
    * it needs to re-execute setup and clear previous tasks; otherwise,
-   * duplicate tasks may cause conflicts. 
+   * duplicate tasks may cause conflicts.
    * `onCleanup()` can be called multiple times within setup.
    * @type `(wss: WebSocketServer, context: SetupContext) => void`
    */
@@ -512,7 +512,7 @@ export default defineMock([
     url: '/api/posts/delete/:id',
     body: (params) => {
       const id = params.id
-      posts.value = posts.value.filter((post) => post.id !== id)
+      posts.value = posts.value.filter(post => post.id !== id)
       return { success: true }
     }
   }
@@ -554,10 +554,10 @@ export default defineConfig({
           '/api/:a/:b/c': {
             rules: ['/api/a/:b/:c', '/api/a/b/:c'],
             when: ['/api/a/b/c']
-           },
-           // If no `when` is specified, it means that all requests matching the rules need to have their priorities adjusted. It can be abbreviated as `[key]: [...rules]`
-           '/api/:a/b': ['/api/a/:b'],
-       }
+          },
+          // If no `when` is specified, it means that all requests matching the rules need to have their priorities adjusted. It can be abbreviated as `[key]: [...rules]`
+          '/api/:a/b': ['/api/a/:b'],
+        }
       }
     })
   ]
@@ -782,18 +782,18 @@ export default defineMock({
 use [`formidable`](https://www.npmjs.com/package/formidable#readme) to support.
 ``` html
 <form action="/api/upload" method="post" enctype="multipart/form-data">
-    <p>
-      <span>file: </span>
-      <input type="file" name="files" multiple />
-    </p>
-    <p>
-      <span>name:</span>
-      <input type="text" name="name" value="mark">
-    </p>
-    <p>
-      <input type="submit" value="submit">
-    </p>
-  </form>
+  <p>
+    <span>file: </span>
+    <input type="file" name="files" multiple>
+  </p>
+  <p>
+    <span>name:</span>
+    <input type="text" name="name" value="mark">
+  </p>
+  <p>
+    <input type="submit" value="submit">
+  </p>
+</form>
 ```
 
 fields `files` mapping to `formidable.File` 
@@ -836,7 +836,7 @@ export default defineMock({
 ``` ts
 fetch('/api/graphql', {
   method: 'POST',
-  body: JSON.stringify({ source: '{ hello }' }) 
+  body: JSON.stringify({ source: '{ hello }' })
 })
 ```
 
@@ -853,7 +853,8 @@ export default defineMock({
       wsMap.set(token, ws)
       ws.on('message', (raw) => {
         const data = JSON.parse(String(raw))
-        if (data.type === 'ping') return
+        if (data.type === 'ping')
+          return
         // Broadcast
         for (const [_token, _ws] of wsMap.entires()) {
           if (_token !== token)
@@ -909,7 +910,7 @@ You can access related `mock` interfaces through `localhost:8080/`.
 ## Contributors
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
@@ -921,6 +922,7 @@ You can access related `mock` interfaces through `localhost:8080/`.
       <td align="center" valign="top" width="14.28%"><a href="https://pengzhanbo.cn"><img src="https://avatars.githubusercontent.com/u/16745751?v=4?s=100" width="100px;" alt="pengzhanbo"/><br /><sub><b>pengzhanbo</b></sub></a><br /><a href="https://github.com/pengzhanbo/vite-plugin-mock-dev-server/commits?author=pengzhanbo" title="Documentation">📖</a> <a href="#ideas-pengzhanbo" title="Ideas, Planning, & Feedback">🤔</a> <a href="#example-pengzhanbo" title="Examples">💡</a> <a href="https://github.com/pengzhanbo/vite-plugin-mock-dev-server/commits?author=pengzhanbo" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/jiadesen"><img src="https://avatars.githubusercontent.com/u/22772994?v=4?s=100" width="100px;" alt="jiadesen"/><br /><sub><b>jiadesen</b></sub></a><br /><a href="#ideas-jiadesen" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/pengzhanbo/vite-plugin-mock-dev-server/issues?q=author%3Ajiadesen" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/yogibaba"><img src="https://avatars.githubusercontent.com/u/152670?v=4?s=100" width="100px;" alt="yogibaba"/><br /><sub><b>yogibaba</b></sub></a><br /><a href="https://github.com/pengzhanbo/vite-plugin-mock-dev-server/commits?author=yogibaba" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pfdgithub"><img src="https://avatars.githubusercontent.com/u/3262762?v=4?s=100" width="100px;" alt="pfdgithub"/><br /><sub><b>pfdgithub</b></sub></a><br /><a href="https://github.com/pengzhanbo/vite-plugin-mock-dev-server/commits?author=pfdgithub" title="Code">💻</a> <a href="https://github.com/pengzhanbo/vite-plugin-mock-dev-server/issues?q=author%3Apfdgithub" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
 </table>

package/README.zh-CN.md

@@ -282,7 +282,7 @@ export default defineMock({
    * 接口支持的请求方法
    * @type string | string[]
    * @default ['POST','GET']
-   * 
+   *
    */
   method: ['GET', 'POST'],
   /**
@@ -345,10 +345,10 @@ export default defineMock({
    * 定义返回的响应体数据内容。
    * 在这里，你可以直接返回JavaScript支持的数据类型如 `string/number/array/object` 等
    * 同时，你也可以使用如 `mockjs` 等库来生成数据内容
-   * 
+   *
    * @type string | number | array | object
    *  直接返回定义的数据
-   * 
+   *
    * @type (request: { headers, query, body, params }) => any | Promise<any>
    * 如果传入一个函数，那么可以更加灵活的定义返回响应体数据
    */
@@ -370,11 +370,11 @@ export default defineMock({
    * 请求验证器，通过验证器则返回 mock数据，否则不使用当前mock。
    * 这对于一些场景中，某个接口需要通过不同的入参来返回不同的数据，验证器可以很好的解决这一类问题，
    * 将同个 url 分为多个 mock配置，根据 验证器来判断哪个mock配置生效。
-   * 
+   *
    * @type { headers, body, query, params, refererQuery }
    * 如果 validator 传入的是一个对象，那么验证方式是 深度比较 请求的接口
    * 中 headers/body/query/params/refererQuery 是否包含 validator 的 key-value。
-   * 
+   *
    * @type (request) => boolean
    * 如果 validator 传入的是一个函数，那么会将 请求的接口相关数据作为入参，
    * 提供给使用者进行自定义校验，并返回一个 boolean
@@ -414,7 +414,7 @@ export default defineMock({
    * 那么需要在 `onCleanup()` 传入一个回调，用于清除这些任务，
    * 这是由于插件在热更新时，需要重新执行 setup，需要清除之前的任务，否则可能会导致重复任务产生冲突。
    * `onCleanup()`可以在 setup 内部多次调用
-   * @type `(wss: WebSocketServer, context: SetupContext) =>  void` 
+   * @type `(wss: WebSocketServer, context: SetupContext) =>  void`
    */
   setup(wss, { onCleanup }) {
     wss.on('connection', (ws, request) => {
@@ -502,7 +502,7 @@ export default defineMock([
     url: '/api/posts/delete/:id',
     body: (params) => {
       const id = params.id
-      posts.value = posts.value.filter((post) => post.id !== id)
+      posts.value = posts.value.filter(post => post.id !== id)
       return { success: true }
     }
   }
@@ -542,11 +542,11 @@ export default defineConfig({
           '/api/:a/:b/c': {
             rules: ['/api/a/:b/:c', '/api/a/b/:c'],
             when: ['/api/a/b/c']
-           },
-           // 如果不需要 when, 则表示命中规则的请求都需要调整优先级。
-           // 可以简写为 [key]: [...rules]
-           '/api/:a/b': ['/api/a/:b'],
-       }
+          },
+          // 如果不需要 when, 则表示命中规则的请求都需要调整优先级。
+          // 可以简写为 [key]: [...rules]
+          '/api/:a/b': ['/api/a/:b'],
+        }
       }
     })
   ]
@@ -694,7 +694,7 @@ export default defineMock({
 export default defineMock({
   url: 'api/buffer',
   type: 'buffer',
-  // 内部使用 Buffer.from(body) 进行转换 
+  // 内部使用 Buffer.from(body) 进行转换
   body: { a: 1 }
 })
 ```
@@ -768,18 +768,18 @@ export default defineMock({
 通过 [`formidable`](https://www.npmjs.com/package/formidable#readme) 支持。
 ``` html
 <form action="/api/upload" method="post" enctype="multipart/form-data">
-    <p>
-      <span>file: </span>
-      <input type="file" name="files" multiple />
-    </p>
-    <p>
-      <span>name:</span>
-      <input type="text" name="name" value="mark">
-    </p>
-    <p>
-      <input type="submit" value="submit">
-    </p>
-  </form>
+  <p>
+    <span>file: </span>
+    <input type="file" name="files" multiple>
+  </p>
+  <p>
+    <span>name:</span>
+    <input type="text" name="name" value="mark">
+  </p>
+  <p>
+    <input type="submit" value="submit">
+  </p>
+</form>
 ```
 
 fields `files` 映射为 `formidable.File` 类型。
@@ -822,7 +822,7 @@ export default defineMock({
 ```ts
 fetch('/api/graphql', {
   method: 'POST',
-  body: JSON.stringify({ source: '{ hello }' }) 
+  body: JSON.stringify({ source: '{ hello }' })
 })
 ```
 
@@ -839,7 +839,8 @@ export default defineMock({
       wsMap.set(token, ws)
       ws.on('message', (raw) => {
         const data = JSON.parse(String(raw))
-        if (data.type === 'ping') return
+        if (data.type === 'ping')
+          return
         // Broadcast
         for (const [_token, _ws] of wsMap.entires()) {
           if (_token !== token)