har-gen-api 0.1.3 → 0.1.5

package/README.md

@@ -1,22 +1,31 @@
 # har-gen-api
-> 浏览器HAR转成接口文件
+
+> 浏览器har文件转成自定义的接口文件，通过 **vite** 启动 **mock** 服务，实现接口模拟
 
 ## 使用
 
-### 全局安装
+### 安装
 ```bash
-npm install -g har-gen-api
+npm install har-gen-api
+# or
+yarn add har-gen-api
 ```
 
+### 导出har文件
+1. 打开浏览器`chrome`
+2. 打开 **F12** 切换到`Network`
+3. 点击导出按钮，选择保存路径
+4. 保存 **har** 文件到 `mock/har.local` 文件夹下
+
 ### 命令行使用
 ```bash
-har-gen-api --input mock/har.local --output mock/api.local --baseURL /api --overwrite
+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: "")
+### 参数说明
+* input: 输入路径，默认为 `mock/har.local` (default: "mock/har.local")
+* output: 输出路径，默认为 `mock/api.local` (default: "mock/api.local")
+* baseURL: baseURL路径，注意 **windows** 系统需要前面多加`/`，如`//api` (default: "")
 * overwrite: 是否覆盖已存在的文件 (default: false)
 
 ### vite配置

package/index.js

@@ -1,104 +1,104 @@
-import fs from 'fs';
-import path from 'path';
-import JSON5 from 'json5';
-import { program } from 'commander';
-
-// 解析命令行参数
-program
-  .option('-i, --input <path>', '输入路径，默认为 mock/har.local', 'mock/har.local')
-  .option('-o, --output <path>', '输出路径，默认为 mock/api.local', 'mock/api.local')
-  // baseURL路径
-  .option('-b, --baseURL <path>', 'baseURL路径', '')
-  .option('-w, --overwrite', '是否覆盖已存在的文件', false)
-  .parse(process.argv);
-
-program.parse();
-
-const { input, output, overwrite, baseURL } = program.opts();
-const generate = () => {
-  console.log('输入路径：', input);
-  console.log('输出路径：', output);
-  console.log('baseURL路径：', baseURL);
-  console.log('是否覆盖已存在的文件：', overwrite);
-
-  let count = 0;
-
-  if (!fs.existsSync(input)) {
-    // console.error(`File not found: ${input}`);
-    console.error(`文件或目录不存在：${input}`);
-    process.exit(1);
-  }
-
-  // 判断 input 是文件还是目录
-  if (fs.statSync(input).isFile()) {
-    // 如果是文件，直接处理该文件
-    if (input.endsWith('.har')) {
-      count += processHarFile(input);
-    }
-  }
-  else {
-    fs.readdirSync(input).forEach(file => {
-      if (file.endsWith('.har')) {
-        const filePath = path.join(input, file);
-        count += processHarFile(filePath);
-      }
-    });
-  }
-
-  console.log('生成了', count, '条 mock 数据');
-}
-
-const processHarFile = (filePath) => {
-  let count = 0;
-
-  let data = fs.readFileSync(filePath, 'utf-8');
-
-  data = JSON.parse(data);
-  if (!data.log || !data.log.entries) {
-    console.error('Invalid HAR file format');
-    return;
-  }
-
-  data.log.entries.forEach(item => {
-    // 只处理XHR请求和200响应，响应内容类型为application/json的请求
-    if (item._resourceType == 'xhr' && item.response.status == 200 && item.response.headers.some(item => item.name.toLowerCase() == 'content-type' && item.value.includes('application/json'))) {
-      const urlObj = new URL(item.request.url);
-      // console.log(url)
-      const url = urlObj.pathname.replace(baseURL, '');
-      const method = item.request.method.toLowerCase();
-      let resData = {
-        [urlObj.search]: item.response.content.text
-      };
-
-      const filePath = path.join(output, `${url}.${method}`);
-
-      if (fs.existsSync(filePath)) {
-        let d = fs.readFileSync(filePath, 'utf-8');
-        d = JSON5.parse(d);
-
-        if (Object.keys(d).some(key => !key.startsWith('?') && key !== '')) {
-          d = {
-            '': JSON.stringify(d)
-          };
-        }
-
-        if (!overwrite && d.hasOwnProperty(url.search)) {
-          console.log(`已存在相同的路径: ${url.pathname}${url.search}`);
-          return;
-        }
-
-        resData = Object.assign(d, resData);
-      }
-
-      fs.mkdirSync(path.dirname(filePath), { recursive: true });
-
-      fs.writeFileSync(filePath, JSON5.stringify(resData, null, 2));
-
-      count++;
-    }
-  });
-
-  return count;
-}
-
-export { generate };
+import fs from 'fs';
+import path from 'path';
+import JSON5 from 'json5';
+import { program } from 'commander';
+
+// 解析命令行参数
+program
+  .option('-i, --input <path>', '输入路径，默认为 mock/har.local', 'mock/har.local')
+  .option('-o, --output <path>', '输出路径，默认为 mock/api.local', 'mock/api.local')
+  // baseURL路径
+  .option('-b, --baseURL <path>', 'baseURL路径', '')
+  .option('-w, --overwrite', '是否覆盖已存在的文件', false)
+  .parse(process.argv);
+
+program.parse();
+
+const { input, output, overwrite, baseURL } = program.opts();
+const generate = () => {
+  console.log('输入路径：', input);
+  console.log('输出路径：', output);
+  console.log('baseURL路径：', baseURL);
+  console.log('是否覆盖已存在的文件：', overwrite);
+
+  let count = 0;
+
+  if (!fs.existsSync(input)) {
+    // console.error(`File not found: ${input}`);
+    console.error(`文件或目录不存在：${input}`);
+    process.exit(1);
+  }
+
+  // 判断 input 是文件还是目录
+  if (fs.statSync(input).isFile()) {
+    // 如果是文件，直接处理该文件
+    if (input.endsWith('.har')) {
+      count += processHarFile(input);
+    }
+  }
+  else {
+    fs.readdirSync(input).forEach(file => {
+      if (file.endsWith('.har')) {
+        const filePath = path.join(input, file);
+        count += processHarFile(filePath);
+      }
+    });
+  }
+
+  console.log('生成了', count, '条 mock 数据');
+}
+
+const processHarFile = (filePath) => {
+  let count = 0;
+
+  let data = fs.readFileSync(filePath, 'utf-8');
+
+  data = JSON.parse(data);
+  if (!data.log || !data.log.entries) {
+    console.error('Invalid HAR file format');
+    return;
+  }
+
+  data.log.entries.forEach(item => {
+    // 只处理XHR请求和200响应，响应内容类型为application/json的请求
+    if (item._resourceType == 'xhr' && item.response.status == 200 && item.response.headers.some(item => item.name.toLowerCase() == 'content-type' && item.value.includes('application/json'))) {
+      const urlObj = new URL(item.request.url);
+      // console.log(url)
+      const url = urlObj.pathname.replace(baseURL, '');
+      const method = item.request.method.toLowerCase();
+      let resData = {
+        [urlObj.search]: item.response.content.text
+      };
+
+      const filePath = path.join(output, `${url}.${method}`);
+
+      if (fs.existsSync(filePath)) {
+        let d = fs.readFileSync(filePath, 'utf-8');
+        d = JSON5.parse(d);
+
+        if (Object.keys(d).some(key => !key.startsWith('?') && key !== '')) {
+          d = {
+            '': JSON.stringify(d)
+          };
+        }
+
+        if (!overwrite && d.hasOwnProperty(url.search)) {
+          console.log(`已存在相同的路径: ${url.pathname}${url.search}`);
+          return;
+        }
+
+        resData = Object.assign(d, resData);
+      }
+
+      fs.mkdirSync(path.dirname(filePath), { recursive: true });
+
+      fs.writeFileSync(filePath, JSON5.stringify(resData, null, 2));
+
+      count++;
+    }
+  });
+
+  return count;
+}
+
+export { generate };

package/package.json

@@ -1,21 +1,24 @@
 {
   "name": "har-gen-api",
   "type": "module",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/lemonppai/har-gen-api.git"
   },
+  "keywords": [
+    "har",
+    "mock",
+    "api",
+    "vite"
+  ],
   "exports": {
     ".": {
       "import": "./index.js"
     },
     "./vite": {
       "import": "./mockServer.js"
-    },
-    "./vite/esm": {
-      "import": "./mockServer.mjs"
     }
   },
   "bin": {

package/mockServer.mjs

@@ -1,78 +0,0 @@
-// mock/index.js
-const Mock = require('mockjs');
-const fs = require('fs');
-const _ = require('lodash');
-const JSON5 = require('json5');
-
-const mockServer = ({ mockPath = 'mock', baseURL = '', enabled = false } = {}) => {
-  return {
-    name: 'mock-server',
-    configureServer(server) {
-      if (localEnabled) {
-        server.middlewares.use((req, res, next) => {
-          const url = new URL(req.url, `http://${req.headers.host}`);
-          let pathname = url.pathname;
-
-          if (pathname.startsWith(baseURL)) {
-            pathname = pathname.replace(new RegExp(`^${baseURL}`), '');
-
-            // console.log('路径', pathname);
-
-            // console.log(`${mockPath}${pathname}.${req.method.toLowerCase()}`)
-
-            fs.readFile(`${mockPath}${pathname}.${req.method.toLowerCase()}`, (err, data) => {
-              if (err) {
-                next();
-                return;
-              }
-
-              res.setHeader('X-Powered-By', 'mockjs');
-              res.setHeader('Content-Type', 'application/json; charset=utf-8');
-
-              try {
-                data = JSON5.parse(data);
-                const keys = Object.keys(data).filter(key => key.startsWith('?') || key === '');
-
-                keys.sort((a, b) => {
-                  return a > b ? 1 : -1;
-                });
-
-                data = data[ url.search ] ?? data[ keys[0] ] ?? data;
-
-                if (_.isString(data)) {
-                  // 模板解析
-                  data = _.template(data)({
-                    headers: req.headers,
-                    query: req.query,
-                    body: req.body,
-                  });
-
-                  data = JSON.parse(data || null);
-                }
-
-                data = Mock.mock(data);
-
-                // res.send(data);
-                res.end(JSON.stringify(data));
-              }
-              catch (e) {
-                console.error(e);
-                // res.status(500).send('Mock Error');
-                // res.send(500, 'Mock Error');
-                res.statusCode = 500;
-                res.end('Mock Error');
-              }
-            });
-          }
-          else {
-            next();
-          }
-        });
-
-        console.log('Mock server is running...');
-      }
-    },
-  };
-};
-
-exports.mockServer = mockServer;