vite-plugin-mock-dev-server 0.2.2 → 0.3.0

package/README.md

@@ -8,7 +8,9 @@ vite mock开发服务（mock-dev-server）插件。
 
 - ⚡️ 轻量，灵活，快速
 - 🧲 非注入式，对客户端代码无侵入
+- 💡 ESModule
 - 🦾 Typescript
+- 🏷 支持 json / json5 编写 mock 数据
 - 📦 自动加载 mock 文件
 - 🎨 可选择你喜欢的任意用于生成mock数据库，如 `mockjs`，或者不是用其他库
 - 📥 路径规则匹配，请求参数匹配
@@ -101,7 +103,7 @@ export default defineConfig({
   
   配置读取 mock文件，可以是一个 目录，glob，或者一个数组
 
-  默认值： `['mock/**/*.mock.*']` (相对于根目录)
+  默认值： `['mock/**/*.mock.{js,ts,cjs,mjs,json,json5}']` (相对于根目录)
 
 - `options.exclude`
   
@@ -232,7 +234,11 @@ export default defineMock({
 
 ```
 
-`mock/**/*.mock.ts`
+> 注意：
+> 
+> 如果使用 json/json5 编写 mock文件，则不支持使用 `response` 方法，以及不支持使用其他字段的函数形式。
+
+`mock/**/*.mock.{ts,js,mjs,cjs,json,json5}`
 
 查看更多示例： [example](/example/)
 
@@ -369,3 +375,15 @@ export default defineMock({
   }
 })
 ```
+
+### 示例10：
+使用 json / json5
+```json
+{
+  // 支持 comment
+  "url": "/api/test",
+  "body": {
+    "a": 1
+  }
+}
+```

package/dist/index.cjs

@@ -33,20 +33,23 @@ __export(src_exports, {
 module.exports = __toCommonJS(src_exports);
 
 // src/mockMiddleware.ts
-var import_node_url = require("url");
+var import_node_url2 = require("url");
 var import_path_to_regexp = require("path-to-regexp");
 
 // src/MockLoader.ts
 var import_node_events = __toESM(require("events"), 1);
-var import_promises2 = __toESM(require("fs/promises"), 1);
+var import_node_fs2 = __toESM(require("fs"), 1);
+var import_node_module = require("module");
 var import_node_path2 = __toESM(require("path"), 1);
+var import_node_url = require("url");
 var import_pluginutils = require("@rollup/pluginutils");
 var import_chokidar = __toESM(require("chokidar"), 1);
 var import_esbuild = require("esbuild");
 var import_fast_glob = __toESM(require("fast-glob"), 1);
+var import_json5 = __toESM(require("json5"), 1);
 
 // src/utils.ts
-var import_promises = __toESM(require("fs/promises"), 1);
+var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path = __toESM(require("path"), 1);
 var import_debug = __toESM(require("debug"), 1);
 var isArray = (val) => Array.isArray(val);
@@ -55,25 +58,39 @@ function sleep(timeout) {
   return new Promise((resolve) => setTimeout(resolve, timeout));
 }
 var debug = (0, import_debug.default)("vite:plugin-mock-dev-server");
-async function getPackageDeps(cwd) {
-  const filepath = import_node_path.default.resolve(cwd, "package.json");
-  const content = await import_promises.default.readFile(filepath, "utf-8");
-  const pkg = JSON.parse(content);
-  const { dependencies = {}, devDependencies = {} } = pkg;
-  const deps = [...Object.keys(dependencies), ...Object.keys(devDependencies)];
-  return deps;
+function lookupFile(dir, formats, options) {
+  for (const format of formats) {
+    const fullPath = import_node_path.default.join(dir, format);
+    if (import_node_fs.default.existsSync(fullPath) && import_node_fs.default.statSync(fullPath).isFile()) {
+      const result = (options == null ? void 0 : options.pathOnly) ? fullPath : import_node_fs.default.readFileSync(fullPath, "utf-8");
+      if (!(options == null ? void 0 : options.predicate) || options.predicate(result)) {
+        return result;
+      }
+    }
+  }
+  const parentDir = import_node_path.default.dirname(dir);
+  if (parentDir !== dir && (!(options == null ? void 0 : options.rootDir) || parentDir.startsWith(options == null ? void 0 : options.rootDir))) {
+    return lookupFile(parentDir, formats, options);
+  }
 }
 
 // src/MockLoader.ts
-var MockLoader = class extends import_node_events.default {
+var import_meta = {};
+var _require = (0, import_node_module.createRequire)(import_meta.url);
+var _MockLoader = class extends import_node_events.default {
   constructor(options) {
     super();
     this.moduleCache = /* @__PURE__ */ new Map();
     this.moduleDeps = /* @__PURE__ */ new Map();
     this._mockList = [];
+    this.moduleType = "cjs";
     this.options = options;
     this.cwd = options.cwd || process.cwd();
-    this.tempDir = options.tempDir || "node_modules/.cache/.mock_server";
+    try {
+      const pkg = lookupFile(this.cwd, ["package.json"]);
+      this.moduleType = !!pkg && JSON.parse(pkg).type === "module" ? "esm" : "cjs";
+    } catch (e) {
+    }
   }
   get mockList() {
     return this._mockList;
@@ -89,13 +106,13 @@ var MockLoader = class extends import_node_events.default {
     this.watchMockEntry();
     this.watchDeps();
     for (const filepath of includePaths.filter(includeFilter)) {
-      await this.loadModule(filepath);
+      await this.loadMock(filepath);
     }
     this.updateMockList();
     this.on("mock:update", async (filepath) => {
       if (!includeFilter(filepath))
         return;
-      await this.loadModule(filepath);
+      await this.loadMock(filepath);
       this.updateMockList();
     });
     this.on("mock:unlink", async (filepath) => {
@@ -180,44 +197,111 @@ var MockLoader = class extends import_node_events.default {
     });
     this.emit("update:deps");
   }
+  async loadMock(filepath) {
+    if (!filepath)
+      return;
+    if (_MockLoader.EXT_JSON.test(filepath)) {
+      await this.loadJson(filepath);
+    } else {
+      await this.loadModule(filepath);
+    }
+  }
+  async loadJson(filepath) {
+    const content = await import_node_fs2.default.promises.readFile(filepath, "utf-8");
+    try {
+      const mockConfig = import_json5.default.parse(content);
+      this.moduleCache.set(filepath, mockConfig);
+    } catch (e) {
+    }
+  }
   async loadModule(filepath) {
     if (!filepath)
       return;
-    const { code, deps } = await this.transform(filepath);
-    const tempFile = import_node_path2.default.join(
-      this.cwd,
-      this.tempDir,
-      filepath.replace(/\.ts$/, ".mjs")
-    );
-    const tempBasename = import_node_path2.default.dirname(tempFile);
-    await import_promises2.default.mkdir(tempBasename, { recursive: true });
-    await import_promises2.default.writeFile(tempFile, code, "utf8");
-    const handle = await import(`${tempFile}?${Date.now()}`);
-    const mockConfig = handle && handle.default ? handle.default : Object.keys(handle || {}).map((key) => handle[key]);
-    this.moduleCache.set(filepath, mockConfig);
-    this.updateModuleDeps(filepath, deps);
+    let isESM = false;
+    if (/\.m[jt]s$/.test(filepath)) {
+      isESM = true;
+    } else if (/\.c[jt]s$/.test(filepath)) {
+      isESM = false;
+    } else {
+      isESM = this.moduleType === "esm";
+    }
+    const { code, deps } = await this.transformWithEsbuild(filepath, isESM);
+    try {
+      const raw = await this.loadFromCode(filepath, code, isESM);
+      const mockConfig = raw && raw.default ? raw.default : Object.keys(raw || {}).map((key) => raw[key]);
+      this.moduleCache.set(filepath, mockConfig);
+      this.updateModuleDeps(filepath, deps);
+    } catch (e) {
+      console.error(e);
+    }
   }
-  async transform(filepath) {
+  async loadFromCode(filepath, code, isESM) {
+    if (isESM) {
+      const fileBase = `${filepath}.timestamp-${Date.now()}`;
+      const fileNameTmp = `${fileBase}.mjs`;
+      const fileUrl = `${(0, import_node_url.pathToFileURL)(fileBase)}.mjs`;
+      await import_node_fs2.default.promises.writeFile(fileNameTmp, code, "utf8");
+      try {
+        return await import(fileUrl);
+      } finally {
+        try {
+          import_node_fs2.default.unlinkSync(fileNameTmp);
+        } catch {
+        }
+      }
+    } else {
+      filepath = import_node_path2.default.resolve(this.cwd, filepath);
+      const extension = import_node_path2.default.extname(filepath);
+      const realFileName = import_node_fs2.default.realpathSync(filepath);
+      const loaderExt = extension in _require.extensions ? extension : ".js";
+      const defaultLoader = _require.extensions[loaderExt];
+      _require.extensions[loaderExt] = (module2, filename) => {
+        if (filename === realFileName) {
+          ;
+          module2._compile(code, filename);
+        } else {
+          defaultLoader(module2, filename);
+        }
+      };
+      delete _require.cache[_require.resolve(filepath)];
+      const raw = _require(filepath);
+      _require.extensions[loaderExt] = defaultLoader;
+      return raw.__esModule ? raw : { default: raw };
+    }
+  }
+  async transformWithEsbuild(filepath, isESM) {
     var _a;
     try {
       const result = await (0, import_esbuild.build)({
         entryPoints: [filepath],
         outfile: "out.js",
         write: false,
-        target: "es2020",
+        target: ["node14.18", "node16"],
         platform: "node",
         bundle: true,
-        external: this.options.external,
         metafile: true,
-        format: "esm",
-        define: this.options.define
+        format: isESM ? "esm" : "cjs",
+        define: this.options.define,
+        plugins: [
+          {
+            name: "externalize-deps",
+            setup(build2) {
+              build2.onResolve({ filter: /.*/ }, ({ path: id }) => {
+                if (id[0] !== "." && !import_node_path2.default.isAbsolute(id)) {
+                  return {
+                    external: true
+                  };
+                }
+              });
+            }
+          }
+        ]
       });
       return {
         code: result.outputFiles[0].text,
         deps: ((_a = result.metafile) == null ? void 0 : _a.inputs) || {}
       };
     } catch (e) {
-      console.error(e);
     }
     return {
       code: "",
@@ -225,6 +309,8 @@ var MockLoader = class extends import_node_events.default {
     };
   }
 };
+var MockLoader = _MockLoader;
+MockLoader.EXT_JSON = /\.json5?$/;
 
 // src/parseReqBody.ts
 var import_co_body = __toESM(require("co-body"), 1);
@@ -263,11 +349,9 @@ function equalObj(left, right) {
 async function mockServerMiddleware(httpServer, config, options) {
   const include = isArray(options.include) ? options.include : [options.include];
   const exclude = isArray(options.exclude) ? options.exclude : [options.exclude];
-  const external = await getPackageDeps(process.cwd());
   const loader = new MockLoader({
     include,
     exclude,
-    external,
     define: config.define || {}
   });
   await loader.load();
@@ -278,7 +362,7 @@ async function mockServerMiddleware(httpServer, config, options) {
       return next();
     }
     const method = req.method.toUpperCase();
-    const { query, pathname } = (0, import_node_url.parse)(req.url, true);
+    const { query, pathname } = (0, import_node_url2.parse)(req.url, true);
     const reqBody = await parseReqBody(req);
     const currentMock = loader.mockList.find((mock) => {
       if (!pathname || !mock || !mock.url)
@@ -366,7 +450,7 @@ function doesProxyContextMatchUrl(context, url) {
 
 // src/plugin.ts
 function mockDevServerPlugin({
-  include = ["mock/**/*.mock.*"],
+  include = ["mock/**/*.mock.{js,ts,cjs,mjs,json,json5}"],
   exclude = [
     "**/node_modules/**",
     "**/test/**",

package/dist/index.js

@@ -4,15 +4,18 @@ import { match, pathToRegexp } from "path-to-regexp";
 
 // src/MockLoader.ts
 import EventEmitter from "events";
-import fs2 from "fs/promises";
+import fs2 from "fs";
+import { createRequire } from "module";
 import path2 from "path";
+import { pathToFileURL } from "url";
 import { createFilter } from "@rollup/pluginutils";
 import chokidar from "chokidar";
 import { build } from "esbuild";
 import fastGlob from "fast-glob";
+import JSON5 from "json5";
 
 // src/utils.ts
-import fs from "fs/promises";
+import fs from "fs";
 import path from "path";
 import Debug from "debug";
 var isArray = (val) => Array.isArray(val);
@@ -21,25 +24,38 @@ function sleep(timeout) {
   return new Promise((resolve) => setTimeout(resolve, timeout));
 }
 var debug = Debug("vite:plugin-mock-dev-server");
-async function getPackageDeps(cwd) {
-  const filepath = path.resolve(cwd, "package.json");
-  const content = await fs.readFile(filepath, "utf-8");
-  const pkg = JSON.parse(content);
-  const { dependencies = {}, devDependencies = {} } = pkg;
-  const deps = [...Object.keys(dependencies), ...Object.keys(devDependencies)];
-  return deps;
+function lookupFile(dir, formats, options) {
+  for (const format of formats) {
+    const fullPath = path.join(dir, format);
+    if (fs.existsSync(fullPath) && fs.statSync(fullPath).isFile()) {
+      const result = (options == null ? void 0 : options.pathOnly) ? fullPath : fs.readFileSync(fullPath, "utf-8");
+      if (!(options == null ? void 0 : options.predicate) || options.predicate(result)) {
+        return result;
+      }
+    }
+  }
+  const parentDir = path.dirname(dir);
+  if (parentDir !== dir && (!(options == null ? void 0 : options.rootDir) || parentDir.startsWith(options == null ? void 0 : options.rootDir))) {
+    return lookupFile(parentDir, formats, options);
+  }
 }
 
 // src/MockLoader.ts
-var MockLoader = class extends EventEmitter {
+var _require = createRequire(import.meta.url);
+var _MockLoader = class extends EventEmitter {
   constructor(options) {
     super();
     this.moduleCache = /* @__PURE__ */ new Map();
     this.moduleDeps = /* @__PURE__ */ new Map();
     this._mockList = [];
+    this.moduleType = "cjs";
     this.options = options;
     this.cwd = options.cwd || process.cwd();
-    this.tempDir = options.tempDir || "node_modules/.cache/.mock_server";
+    try {
+      const pkg = lookupFile(this.cwd, ["package.json"]);
+      this.moduleType = !!pkg && JSON.parse(pkg).type === "module" ? "esm" : "cjs";
+    } catch (e) {
+    }
   }
   get mockList() {
     return this._mockList;
@@ -55,13 +71,13 @@ var MockLoader = class extends EventEmitter {
     this.watchMockEntry();
     this.watchDeps();
     for (const filepath of includePaths.filter(includeFilter)) {
-      await this.loadModule(filepath);
+      await this.loadMock(filepath);
     }
     this.updateMockList();
     this.on("mock:update", async (filepath) => {
       if (!includeFilter(filepath))
         return;
-      await this.loadModule(filepath);
+      await this.loadMock(filepath);
       this.updateMockList();
     });
     this.on("mock:unlink", async (filepath) => {
@@ -146,44 +162,111 @@ var MockLoader = class extends EventEmitter {
     });
     this.emit("update:deps");
   }
+  async loadMock(filepath) {
+    if (!filepath)
+      return;
+    if (_MockLoader.EXT_JSON.test(filepath)) {
+      await this.loadJson(filepath);
+    } else {
+      await this.loadModule(filepath);
+    }
+  }
+  async loadJson(filepath) {
+    const content = await fs2.promises.readFile(filepath, "utf-8");
+    try {
+      const mockConfig = JSON5.parse(content);
+      this.moduleCache.set(filepath, mockConfig);
+    } catch (e) {
+    }
+  }
   async loadModule(filepath) {
     if (!filepath)
       return;
-    const { code, deps } = await this.transform(filepath);
-    const tempFile = path2.join(
-      this.cwd,
-      this.tempDir,
-      filepath.replace(/\.ts$/, ".mjs")
-    );
-    const tempBasename = path2.dirname(tempFile);
-    await fs2.mkdir(tempBasename, { recursive: true });
-    await fs2.writeFile(tempFile, code, "utf8");
-    const handle = await import(`${tempFile}?${Date.now()}`);
-    const mockConfig = handle && handle.default ? handle.default : Object.keys(handle || {}).map((key) => handle[key]);
-    this.moduleCache.set(filepath, mockConfig);
-    this.updateModuleDeps(filepath, deps);
+    let isESM = false;
+    if (/\.m[jt]s$/.test(filepath)) {
+      isESM = true;
+    } else if (/\.c[jt]s$/.test(filepath)) {
+      isESM = false;
+    } else {
+      isESM = this.moduleType === "esm";
+    }
+    const { code, deps } = await this.transformWithEsbuild(filepath, isESM);
+    try {
+      const raw = await this.loadFromCode(filepath, code, isESM);
+      const mockConfig = raw && raw.default ? raw.default : Object.keys(raw || {}).map((key) => raw[key]);
+      this.moduleCache.set(filepath, mockConfig);
+      this.updateModuleDeps(filepath, deps);
+    } catch (e) {
+      console.error(e);
+    }
   }
-  async transform(filepath) {
+  async loadFromCode(filepath, code, isESM) {
+    if (isESM) {
+      const fileBase = `${filepath}.timestamp-${Date.now()}`;
+      const fileNameTmp = `${fileBase}.mjs`;
+      const fileUrl = `${pathToFileURL(fileBase)}.mjs`;
+      await fs2.promises.writeFile(fileNameTmp, code, "utf8");
+      try {
+        return await import(fileUrl);
+      } finally {
+        try {
+          fs2.unlinkSync(fileNameTmp);
+        } catch {
+        }
+      }
+    } else {
+      filepath = path2.resolve(this.cwd, filepath);
+      const extension = path2.extname(filepath);
+      const realFileName = fs2.realpathSync(filepath);
+      const loaderExt = extension in _require.extensions ? extension : ".js";
+      const defaultLoader = _require.extensions[loaderExt];
+      _require.extensions[loaderExt] = (module, filename) => {
+        if (filename === realFileName) {
+          ;
+          module._compile(code, filename);
+        } else {
+          defaultLoader(module, filename);
+        }
+      };
+      delete _require.cache[_require.resolve(filepath)];
+      const raw = _require(filepath);
+      _require.extensions[loaderExt] = defaultLoader;
+      return raw.__esModule ? raw : { default: raw };
+    }
+  }
+  async transformWithEsbuild(filepath, isESM) {
     var _a;
     try {
       const result = await build({
         entryPoints: [filepath],
         outfile: "out.js",
         write: false,
-        target: "es2020",
+        target: ["node14.18", "node16"],
         platform: "node",
         bundle: true,
-        external: this.options.external,
         metafile: true,
-        format: "esm",
-        define: this.options.define
+        format: isESM ? "esm" : "cjs",
+        define: this.options.define,
+        plugins: [
+          {
+            name: "externalize-deps",
+            setup(build2) {
+              build2.onResolve({ filter: /.*/ }, ({ path: id }) => {
+                if (id[0] !== "." && !path2.isAbsolute(id)) {
+                  return {
+                    external: true
+                  };
+                }
+              });
+            }
+          }
+        ]
       });
       return {
         code: result.outputFiles[0].text,
         deps: ((_a = result.metafile) == null ? void 0 : _a.inputs) || {}
       };
     } catch (e) {
-      console.error(e);
     }
     return {
       code: "",
@@ -191,6 +274,8 @@ var MockLoader = class extends EventEmitter {
     };
   }
 };
+var MockLoader = _MockLoader;
+MockLoader.EXT_JSON = /\.json5?$/;
 
 // src/parseReqBody.ts
 import bodyParser from "co-body";
@@ -229,11 +314,9 @@ function equalObj(left, right) {
 async function mockServerMiddleware(httpServer, config, options) {
   const include = isArray(options.include) ? options.include : [options.include];
   const exclude = isArray(options.exclude) ? options.exclude : [options.exclude];
-  const external = await getPackageDeps(process.cwd());
   const loader = new MockLoader({
     include,
     exclude,
-    external,
     define: config.define || {}
   });
   await loader.load();
@@ -332,7 +415,7 @@ function doesProxyContextMatchUrl(context, url) {
 
 // src/plugin.ts
 function mockDevServerPlugin({
-  include = ["mock/**/*.mock.*"],
+  include = ["mock/**/*.mock.{js,ts,cjs,mjs,json,json5}"],
   exclude = [
     "**/node_modules/**",
     "**/test/**",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-dev-server",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "keywords": [
     "vite",
     "plugin",
@@ -48,6 +48,7 @@
     "debug": "^4.3.4",
     "esbuild": "^0.15.12",
     "fast-glob": "^3.2.12",
+    "json5": "^2.2.1",
     "path-to-regexp": "^6.2.1",
     "vite": "^3.2.0"
   },