chore: release 3.0.0

Author: anncwb

.github/workflows/publish.yml

@@ -23,7 +23,7 @@ jobs:
         run: |
           npm i -g pnpm
           pnpm install
-          pnpm publish --filter=vite-mock-plugin
+          pnpm publish --filter=./packages/vite-plugin-mock
 
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}

CHANGELOG.md

@@ -1,3 +1,70 @@
+## [3.0.0]
+
+### Breaking Change
+
+- Remove the `localEnabled` and `prodEnabled` configuration and use the `enable` configuration instead, no longer distinguishing the environment
+- Remove the `injectFile`、`injectCode` and `supportTs` configuration
+- Minimum requirement NodeJs 16
+- Production Environment Syntax Changes
+
+```ts
+// vite-plugin-mock/es/createProdMockServer => vite-plugin-mock/client
+import { createProdMockServer } from 'vite-plugin-mock/client'
+import roleMock from '../mock/dep/role'
+// functional form
+import userMockFn from '../mock/user'
+
+export async function setupProdMockServer() {
+  const mockModules = [...roleMock, ...userMockFn()]
+  createProdMockServer(mockModules)
+}
+```
+
+### Features
+
+- Upgrade all dependencies to latest
+- support `vite4` and `rollup3`
+- The function module supports returning a function
+
+```ts
+import type { MockConfig } from 'vite-plugin-mock'
+
+export default (config?: MockConfig) => {
+  return [
+    {
+      url: '/api/createUser',
+      method: 'post',
+      response: ({ body, query }) => {
+        console.log('body>>>>>>>>', body)
+        console.log('query>>>>>>>>', query)
+
+        return {
+          code: 0,
+          message: 'ok',
+          data: { a: 21, 'import.meta.url': import.meta.url },
+        }
+      },
+    },
+  ]
+}
+```
+
+## [2.9.8](https://github.com/vbenjs/vite-plugin-mock/compare/v2.9.0...v2.9.8) (2023-04-17)
+
+### Bug Fixes
+
+- can't update in real time, fix [#40](https://github.com/vbenjs/vite-plugin-mock/issues/40) ([f25c6ac](https://github.com/vbenjs/vite-plugin-mock/commit/f25c6ac8544991457368746bf6ec5fdfd8b4e083))
+- error handle, fix [#39](https://github.com/vbenjs/vite-plugin-mock/issues/39) ([874318c](https://github.com/vbenjs/vite-plugin-mock/commit/874318ce399dc78c33d91161b73e3ced7bb6e9b6))
+- fix js parsing error ([1dbee45](https://github.com/vbenjs/vite-plugin-mock/commit/1dbee452ec7d90b07ac86ce8530430e864589ab5))
+- fix node version ([#38](https://github.com/vbenjs/vite-plugin-mock/issues/38)) ([f91dea1](https://github.com/vbenjs/vite-plugin-mock/commit/f91dea1be943aa1145727bfecd273ef45cdff8e9))
+- inappropriate type annotation ([#90](https://github.com/vbenjs/vite-plugin-mock/issues/90)) ([a3fc4aa](https://github.com/vbenjs/vite-plugin-mock/commit/a3fc4aab3dd1864f640918516c10d7d1530f5d90))
+- typo, close [#42](https://github.com/vbenjs/vite-plugin-mock/issues/42) ([5b4e946](https://github.com/vbenjs/vite-plugin-mock/commit/5b4e9469060109a2a28c079eec8384fe654be68e))
+
+### Features
+
+- **prod:** response 在 prod 模式下入参对象加上 url ([#83](https://github.com/vbenjs/vite-plugin-mock/issues/83)) ([cd0b86f](https://github.com/vbenjs/vite-plugin-mock/commit/cd0b86fce20228094cf18be14194498a2cbd490e))
+- **server:** add this for response, rawResponse function ([#43](https://github.com/vbenjs/vite-plugin-mock/issues/43)) ([2f4d6d2](https://github.com/vbenjs/vite-plugin-mock/commit/2f4d6d2984c7fe15236cb8b0d2ec5479930d5668))
+
 ## [2.9.8](https://github.com/anncwb/vite-plugin-mock/compare/v2.9.0...v2.9.8) (2023-04-16)
 
 ### Bug Fixes

README.md

@@ -18,12 +18,18 @@ A mock plugin for vite, developed based on mockjs. And support the local environ
 yarn add mockjs
 # or
 npm i  mockjs -S
+# or
+pnpm add mockjs
 ```
 
+and
+
 ```bash
 yarn add vite-plugin-mock -D
 # or
 npm i vite-plugin-mock -D
+# or
+pnpm add vite-plugin-mock -D
 ```
 
 ### Example
@@ -71,7 +77,7 @@ export default ({ command }: ConfigEnv): UserConfigExport => {
       viteMockServe({
         // default
         mockPath: 'mock',
-        localEnabled: command === 'serve',
+        enable: true,
       }),
     ],
   }
@@ -83,15 +89,11 @@ export default ({ command }: ConfigEnv): UserConfigExport => {
 ```ts
 {
     mockPath?: string;
-    supportTs?: boolean;
     ignore?: RegExp | ((fileName: string) => boolean);
     watchFiles?: boolean;
-    localEnabled?: boolean;
+    enable?: boolean;
     ignoreFiles?: string[];
     configPath?: string;
-    prodEnabled?: boolean;
-    injectFile?: string;
-    injectCode?: string;
 }
 ```
 
@@ -109,14 +111,6 @@ If `watchFiles:true`, the file changes in the folder will be monitored. And sync
 
 If configPath has a value, it is invalid
 
-### supportTs
-
-**type:** `boolean`
-
-**default:** `true`
-
-After opening, the ts file module can be read. Note that you will not be able to monitor .js files after opening.
-
 ### ignore
 
 **type:** `RegExp | ((fileName: string) => boolean);`
@@ -133,41 +127,13 @@ When automatically reading analog .ts files, ignore files in the specified forma
 
 Set whether to monitor changes in mock .ts files
 
-### localEnabled
-
-**type:** `boolean`
-
-**default:** `command === 'serve'`
-
-Set whether to enable the local mock .ts file, do not open it in the production environment
-
-### prodEnabled
+### enable
 
 **type:** `boolean`
 
-**default:** `command !=='serve'`
+**default:** true
 
-Set whether to enable mock function for packaging
-
-### injectCode
-
-**type:** `string`
-
-**default:**''
-
-If the mock function is enabled in the production environment, that is, `prodEnabled=true`, the code will be injected into the bottom of the file corresponding to `injectFile`. The default is `main.{ts,js}`
-
-The advantage of this is that you can dynamically control whether mock is enabled in the production environment and mock.js will not be packaged when it is not enabled.
-
-If the code is written directly in `main.ts`, no matter whether it is turned on or not, the final package will include `mock.js`
-
-### injectFile
-
-**type:** `string`
-
-**default:** `path.resolve(process.cwd(),'src/main.{ts,js}')`
-
-The file injected by `injectCode` code, the default is `src/main.{ts,js}` in the project root directory
+Whether to enable the mock function
 
 ### configPath
 
@@ -192,7 +158,7 @@ Whether to display the request log on the console
 ```ts
 // test.ts
 
-import { MockMethod } from 'vite-plugin-mock'
+import { MockMethod, MockConfig } from 'vite-plugin-mock'
 export default [
   {
     url: '/api/get',
@@ -234,6 +200,27 @@ export default [
     },
   },
 ] as MockMethod[]
+
+export default function (config: MockConfig) {
+  return [
+    {
+      url: '/api/text',
+      method: 'post',
+      rawResponse: async (req, res) => {
+        let reqbody = ''
+        await new Promise((resolve) => {
+          req.on('data', (chunk) => {
+            reqbody += chunk
+          })
+          req.on('end', () => resolve(undefined))
+        })
+        res.setHeader('Content-Type', 'text/plain')
+        res.statusCode = 200
+        res.end(`hello, ${reqbody}`)
+      },
+    },
+  ]
+}
 ```
 
 ### MockMethod
@@ -256,14 +243,14 @@ export default [
 
 ```
 
-### Example (2.0.0 recommended)
+### Example (3.0.0 recommended)
 
 Create the `mockProdServer.ts` file
 
 ```ts
 //  mockProdServer.ts
 
-import { createProdMockServer } from 'vite-plugin-mock/es/createProdMockServer'
+import { createProdMockServer } from 'vite-plugin-mock/client'
 
 // Import your mock .ts files one by one
 // If you use vite.mock.config.ts, just import the file directly
@@ -283,18 +270,12 @@ import { viteMockServe } from 'vite-plugin-mock'
 import { UserConfigExport, ConfigEnv } from 'vite'
 
 export default ({ command }: ConfigEnv): UserConfigExport => {
-  // According to the project configuration. Can be configured in the .env file
-  let prodMock = true
   return {
     plugins: [
       viteMockServe({
         mockPath: 'mock',
-        localEnabled: command === 'serve',
-        prodEnabled: command !== 'serve' && prodMock,
-        injectCode: `
-          import { setupProdMockServer } from './mockProdServer';
-          setupProdMockServer();
-        `,
+        // According to the project configuration. Can be configured in the .env file
+        enable: true,
       }),
     ],
   }