har-gen-api 0.1.2 → 0.1.4

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

package/README.md

@@ -1,20 +1,44 @@
-# har-gen-api
-> 浏览器HAR转成接口文件
-
-## 使用
-
-### 全局安装
-```bash
-npm install -g har-gen-api
-```
-
-### 命令行使用
-```bash
-har-gen-api --input mock/har.local --output mock/api.local --baseURL /api --overwrite
-```
-
-### 参数说明：
-* input: 输入路径，默认为 mock/har.local (default: "mock/har.local")
-* output: 输出路径，默认为 mock/api.local (default: "mock/api.local")
-* baseURL: baseURL路径 (default: "")
-* overwrite: 是否覆盖已存在的文件 (default: false)
+# har-gen-api
+
+> 浏览器har文件转成自定义的接口文件，通过`vite`启动`mock`服务，实现接口模拟
+
+## 使用
+
+### 安装
+```bash
+npm install har-gen-api
+# or
+yarn add har-gen-api
+```
+
+### 导出har文件
+1. 打开浏览器`chrome`
+2. 打开`F12`切换到`Network`
+3. 点击导出按钮，选择保存路径
+4. 保存**har**文件到 `mock/har.local` 文件夹下
+
+### 命令行使用
+```bash
+npx har-gen-api --input mock/har.local --output mock/api.local --baseURL /api --overwrite
+```
+
+### 参数说明：
+* input: 输入路径，默认为 `mock/har.local` (default: "mock/har.local")
+* output: 输出路径，默认为 `mock/api.local` (default: "mock/api.local")
+* baseURL: baseURL路径 (default: "")
+* overwrite: 是否覆盖已存在的文件 (default: false)
+
+### vite配置
+```js
+import { mockServer } from 'har-gen-api/vite';
+
+export default defineConfig({
+  plugins: [
+    mockServer({
+      mockPath: 'mock',
+      baseURL: '/api',
+      enabled: true
+    })
+  ]
+})
+```

package/package.json

@@ -1,29 +1,29 @@
-{
-  "name": "har-gen-api",
-  "type": "module",
-  "version": "0.1.2",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/lemonppai/har-gen-api.git"
-  },
-  "exports": {
-    ".": {
-      "import": "./index.js"
-    },
-    "./vite": {
-      "import": "./mockServer.js"
-    }
-  },
-  "bin": {
-    "har-gen-api": "bin/cli.js"
-  },
-  "dependencies": {
-    "cfonts": "^3.3.1",
-    "chalk": "^5.6.2",
-    "commander": "^14.0.3",
-    "json5": "^2.2.3",
-    "lodash": "^4.18.1",
-    "mockjs": "^1.1.0"
-  }
-}
+{
+  "name": "har-gen-api",
+  "type": "module",
+  "version": "0.1.4",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lemonppai/har-gen-api.git"
+  },
+  "exports": {
+    ".": {
+      "import": "./index.js"
+    },
+    "./vite": {
+      "import": "./mockServer.js"
+    }
+  },
+  "bin": {
+    "har-gen-api": "bin/cli.js"
+  },
+  "dependencies": {
+    "cfonts": "^3.3.1",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.3",
+    "json5": "^2.2.3",
+    "lodash": "^4.18.1",
+    "mockjs": "^1.1.0"
+  }
+}