vite-plugin-mock-data 6.0.1 → 6.0.2

package/README.md

@@ -13,196 +13,21 @@
 npm install vite-plugin-mock-data --save-dev
 ```
 
-## Options
+## Documentation
 
-```ts
-import { Config as SirvConfig, HTTPVersion, RouteOptions, Handler } from 'find-my-way';
+For detailed usage instructions and API references, please visit the official documentation:
 
-export interface HandleRoute {
-  file?: string;
-  handler?: any | Handler<HTTPVersion.V1>;
-  options?: RouteOptions;
-  store?: any;
-}
+👉 [View Full Documentation](https://fengxinming.github.io/vite-plugins/plugins/vite-plugin-mock-data/quick-start)
 
-export interface RouteConfig {
-  [route: string]: string | Handler<HTTPVersion.V1> | HandleRoute;
-}
+## Contributing
 
-export interface Options {
-  /**
-   * The directory to serve files from.
-   * @default `process.cwd()`
-   */
-  cwd?: string;
+We welcome contributions from the community! If you find a bug or want to suggest an improvement, feel free to open an issue or submit a pull request.
 
-  /**
-   * If `true`, these mock routes is matched after internal middlewares are installed.
-   * @default `false`
-   */
-  isAfter?: boolean;
+### How to Contribute
+1. Fork the repository.
+2. Create a new branch for your changes.
+3. Submit a pull request with a clear description of your changes.
 
-  /**
-   * Specify the directory to define mock assets.
-   */
-  assets?: string;
+## License
 
-  /**
-   * Initial options of `find-my-way`. see more at https://github.com/delvedor/find-my-way#findmywayoptions
-   */
-  routerOptions?: SirvConfig<HTTPVersion.V1> | SirvConfig<HTTPVersion.V2>;
-
-  /**
-   * Initial list of mock routes that should be added to the dev server
-   * or specify the directory to define mock routes that should be added to the dev server.
-   */
-  routes?: RouteConfig | Array<RouteConfig | string> | string;
-}
-```
-
-* `cwd` - Default: `process.cwd()`.
-* `isAfter` - If `true`, these mock routes is matched after internal middlewares are installed.
-* `assets` - Specify the directory to define mock assets.
-* `routerOptions` - [Initial options of `find-my-way`](https://github.com/delvedor/find-my-way#findmywayoptions)
-* `routes`
-  * `RouteConfig | Array<RouteConfig | string>` - Initial list of mock routes that should be added to the dev server.
-  * `string` - Specify the directory to define mock routes that should be added to the dev server.
-
-## Usage
-
-### Specify the directory to define mock assets
-
-```js
-import { defineConfig } from 'vite';
-import mockData from 'vite-plugin-mock-data';
-
-export default defineConfig({
-  plugins: [
-    mockData({
-      assets: './mockAssets'
-    })
-  ]
-});
-```
-
-```txt
-.
-├── mockAssets
-│   ├── test.zip
-│   └── test.json
-```
-
-```js
-fetch('/test.json')
-  .then(res => res.json())
-  .then((json) => {
-    console.log(json);
-  });
-```
-
-```html
-<a class="download" href="./test.zip">Download</a>
-```
-
-### add mock routes to the dev server
-
-```js
-import { defineConfig } from 'vite';
-import mockData from 'vite-plugin-mock-data';
-
-export default defineConfig({
-  plugins: [
-    mockData({
-      routes: {
-        '/hello': 'hello',
-        '/hello2'(req, res) {
-          res.statusCode = 200;
-          res.setHeader('Content-Type', 'text/html');
-          res.end('hello2');
-        },
-        '/hello3': {
-          handler(req, res) {
-            res.statusCode = 200;
-            res.setHeader('Content-Type', 'text/html');
-            res.end('hello3');
-          }
-        },
-        '/json': {
-          handler: { hello: 1 }
-        },
-        '/package.json': {
-          file: './package.json'
-        }
-      }
-    })
-  ]
-});
-```
-
-```js
-fetch('/package.json')
-  .then(res => res.json())
-  .then((json) => {
-    console.log(json);
-  });
-```
-
-### Specify the directory to add mock routes to the dev server
-
-```js
-import { defineConfig } from 'vite';
-import mockData from 'vite-plugin-mock-data';
-
-export default defineConfig({
-  plugins: [
-    mockData({
-      routes: './mock'
-    })
-  ]
-});
-```
-
-```txt
-.
-├── mock
-│   └── test.js
-```
-
-```js
-module.exports = {
-  '/hello': 'hello',
-  '/hello2'(req, res) {
-    res.statusCode = 200;
-    res.setHeader('Content-Type', 'text/html');
-    res.end('hello2');
-  },
-  '/hello3': {
-    handler(req, res) {
-      res.statusCode = 200;
-      res.setHeader('Content-Type', 'text/html');
-      res.end('hello3');
-    }
-  },
-  '/json': {
-    handler: { hello: 1 }
-  },
-  '/package.json': {
-    file: './package.json'
-  }
-};
-```
-
-```js
-fetch('/package.json')
-  .then(res => res.json())
-  .then((json) => {
-    console.log(json);
-  });
-```
-
-## Examples
-
-* [See vite3 demo](../../examples/vite3-demo)
-* [See vite4 demo](../../examples/vite4-demo)
-* [See vite5 demo](../../examples/vite5-demo)
-* [See vite6 demo](../../examples/vite6-demo)
+This project is licensed under the [MIT License](../../LICENSE).

package/dist/configureServer.d.ts

@@ -0,0 +1,7 @@
+import { OutgoingHttpHeaders } from 'node:http';
+import { Config as SirvConfig, HTTPVersion } from 'find-my-way';
+import { type Options as SirvOptions } from 'sirv';
+import { ViteDevServer } from 'vite';
+import { RouteConfig } from './typings';
+export declare function sirvOptions(headers?: OutgoingHttpHeaders): SirvOptions;
+export declare function configureServer(server: ViteDevServer, routerOpts: SirvConfig<HTTPVersion.V1> | SirvConfig<HTTPVersion.V2> | undefined, routes: RouteConfig[], cwd: string): void;

package/dist/index.d.ts

@@ -7,11 +7,11 @@ export * from './typings';
  * @example
  * ```js
  * import { defineConfig } from 'vite';
- * import mockData from 'vite-plugin-mock-data';
+ * import pluginMockDate from 'vite-plugin-mock-data';
  *
  * export default defineConfig({
  *   plugins: [
- *     mockData({
+ *     pluginMockDate({
  *       routes: './mock'
  *     })
  *   ]
@@ -21,4 +21,4 @@ export * from './typings';
  * @param opts Options
  * @returns a vite plugin
  */
-export default function createPlugin(opts: Options): Plugin;
+export default function pluginMockDate(opts: Options): Plugin;

package/dist/index.js

@@ -1,43 +1,21 @@
 "use strict";
+const isWhatType = require("is-what-type");
+const vpRuntimeHelper = require("vp-runtime-helper");
 const node_path = require("node:path");
-const node_module = require("node:module");
-const node_fs = require("node:fs");
-const tinyglobby = require("tinyglobby");
 const getRouter = require("find-my-way");
 const sirv = require("sirv");
 const vite = require("vite");
+const node_fs = require("node:fs");
+const promises = require("node:fs/promises");
+const node_module = require("node:module");
+const tinyglobby = require("tinyglobby");
+const baseLogFactory = require("base-log-factory");
+const blfColorfulAppender = require("blf-colorful-appender");
 var _documentCurrentScript = typeof document !== "undefined" ? document.currentScript : null;
-function isObject(val) {
-  return val && typeof val === "object";
-}
-function toAbsolute(pth, cwd) {
-  return node_path.isAbsolute(pth) ? pth : node_path.posix.join(cwd || process.cwd(), pth);
-}
-async function getRoute(filename) {
-  let config;
-  switch (node_path.extname(filename)) {
-    case ".js":
-      config = node_module.createRequire(typeof document === "undefined" ? require("url").pathToFileURL(__filename).href : _documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === "SCRIPT" && _documentCurrentScript.src || new URL("index.js", document.baseURI).href)(filename);
-      break;
-    case ".mjs":
-      config = (await import(filename)).default;
-      break;
-    case ".json":
-      config = JSON.parse(node_fs.readFileSync(filename, "utf-8"));
-      break;
-  }
-  return config;
-}
-async function loadRoutes(dir, routes) {
-  const paths = await tinyglobby.glob(`${dir}/**/*.{js,mjs,json}`, { absolute: true });
-  const configs = await Promise.all(paths.map(getRoute));
-  configs.reduce((prev, cur) => {
-    if (cur) {
-      prev.push(cur);
-    }
-    return prev;
-  }, routes);
-}
+const name = "vite-plugin-mock-data";
+const pkg = {
+  name
+};
 function sirvOptions(headers) {
   return {
     dev: true,
@@ -58,7 +36,7 @@ function sirvOptions(headers) {
     }
   };
 }
-function configureServer(server, routerOpts, routes, serve, cwd) {
+function configureServer(server, routerOpts, routes, cwd) {
   const router = getRouter(routerOpts);
   if (Array.isArray(routes)) {
     routes.forEach((route) => {
@@ -68,23 +46,24 @@ function configureServer(server, routerOpts, routes, serve, cwd) {
           pathname = methods;
           methods = "GET";
         }
+        methods = methods.toUpperCase();
         let routeConfig = route[xpath];
-        if (!isObject(routeConfig)) {
+        if (!isWhatType.isObject(routeConfig)) {
           routeConfig = { handler: routeConfig };
         }
         let handler;
         if (typeof routeConfig.file === "string") {
           handler = (req, res) => {
-            const parsedPath = node_path.parse(toAbsolute(routeConfig.file, cwd));
-            const serve2 = sirv(parsedPath.dir, sirvOptions(server.config.server.headers));
+            const parsedPath = node_path.parse(vpRuntimeHelper.toAbsolutePath(routeConfig.file, cwd));
+            const serve = sirv(parsedPath.dir, sirvOptions(server.config.server.headers));
             req.url = `/${parsedPath.base}`;
-            serve2(req, res);
+            serve(req, res);
           };
         } else if (typeof routeConfig.handler !== "function") {
           const ret = routeConfig.handler;
           const retType = typeof ret;
           handler = (req, res) => {
-            vite.send(req, res, retType !== "string" ? JSON.stringify(ret) : ret, isObject(ret) ? "json" : "html", {
+            vite.send(req, res, retType !== "string" ? JSON.stringify(ret) : ret, isWhatType.isObject(ret) ? "json" : "html", {
               headers: server.config.server.headers
             });
           };
@@ -97,41 +76,85 @@ function configureServer(server, routerOpts, routes, serve, cwd) {
       });
     });
   }
-  if (serve) {
-    server.middlewares.use(serve);
-  }
   server.middlewares.use((req, res, next) => {
     router.defaultRoute = () => next();
     router.lookup(req, res);
   });
 }
-function createPlugin(opts) {
-  const { isAfter, routerOptions, routes, assets, cwd = process.cwd() } = opts;
+const PLUGIN_NAME = pkg.name;
+const logger = new baseLogFactory.Logger(PLUGIN_NAME, {
+  level: baseLogFactory.Level.WARN,
+  appenders: [
+    new blfColorfulAppender.ColorfulAppender()
+  ]
+});
+async function getRoute(filename) {
+  logger.debug("Load mock file:", filename);
+  let { ext, dir, name: name2 } = node_path.parse(filename);
+  const isTs = ext === ".ts" || ext === ".mts";
+  if (isTs) {
+    const { code } = await vite.transformWithEsbuild(node_fs.readFileSync(filename, "utf-8"), filename, {
+      loader: "ts",
+      target: "esnext"
+    });
+    filename = node_path.join(dir, `${name2}-${PLUGIN_NAME}.mjs`);
+    ext = ".mjs";
+    await promises.writeFile(filename, code);
+  }
+  let config;
+  switch (ext) {
+    case ".js":
+      config = node_module.createRequire(typeof document === "undefined" ? require("url").pathToFileURL(__filename).href : _documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === "SCRIPT" && _documentCurrentScript.src || new URL("index.js", document.baseURI).href)(filename);
+      break;
+    case ".mjs":
+      config = (await import(filename)).default;
+      if (isTs) {
+        await promises.unlink(filename);
+      }
+      break;
+    case ".json":
+      config = JSON.parse(node_fs.readFileSync(filename, "utf-8"));
+      break;
+  }
+  return config;
+}
+async function loadRoutes(dir, routes) {
+  const paths = await tinyglobby.glob(`${dir}/**/*.{js,mjs,json,ts,mts}`, { absolute: true });
+  const configs = await Promise.all(paths.map(getRoute));
+  for (const config of configs) {
+    if (config) {
+      routes.push(config);
+    }
+  }
+}
+function pluginMockDate(opts) {
+  vpRuntimeHelper.banner(pkg.name);
+  const { isAfter, routerOptions, routes, logLevel, cwd = process.cwd() } = opts;
+  if (logLevel) {
+    logger.level = logLevel;
+  }
   const allRoutes = [];
   return {
-    name: "vite-plugin-mock-data",
+    name: PLUGIN_NAME,
     async configureServer(server) {
       if (typeof routes === "string") {
-        await loadRoutes(toAbsolute(routes, cwd), allRoutes);
+        logger.debug("Load routes from", routes);
+        await loadRoutes(vpRuntimeHelper.toAbsolutePath(routes, cwd), allRoutes);
       } else if (Array.isArray(routes)) {
         for (const route of routes) {
+          logger.debug("Load routes from", route);
           if (typeof route === "string") {
-            await loadRoutes(toAbsolute(route, cwd), allRoutes);
+            await loadRoutes(vpRuntimeHelper.toAbsolutePath(route, cwd), allRoutes);
           } else {
             allRoutes.push(route);
           }
         }
-      } else if (isObject(routes)) {
+      } else if (isWhatType.isObject(routes)) {
+        logger.debug("Load routes from", routes);
         allRoutes.push(routes);
       }
-      let serve = null;
-      if (assets) {
-        serve = sirv(toAbsolute(assets, cwd), sirvOptions(server.config.server.headers));
-      }
-      if (allRoutes && allRoutes.length > 0) {
-        return isAfter ? () => configureServer(server, routerOptions, allRoutes, serve, cwd) : configureServer(server, routerOptions, allRoutes, serve, cwd);
-      }
+      return isAfter ? () => configureServer(server, routerOptions, allRoutes, cwd) : configureServer(server, routerOptions, allRoutes, cwd);
     }
   };
 }
-module.exports = createPlugin;
+module.exports = pluginMockDate;

package/dist/index.mjs

@@ -1,41 +1,19 @@
-import { posix, isAbsolute, extname, parse } from "node:path";
-import { createRequire } from "node:module";
-import { readFileSync } from "node:fs";
-import { glob } from "tinyglobby";
+import { isObject } from "is-what-type";
+import { toAbsolutePath, banner } from "vp-runtime-helper";
+import { parse, join } from "node:path";
 import getRouter from "find-my-way";
 import sirv from "sirv";
-import { send } from "vite";
-function isObject(val) {
-  return val && typeof val === "object";
-}
-function toAbsolute(pth, cwd) {
-  return isAbsolute(pth) ? pth : posix.join(cwd || process.cwd(), pth);
-}
-async function getRoute(filename) {
-  let config;
-  switch (extname(filename)) {
-    case ".js":
-      config = createRequire(import.meta.url)(filename);
-      break;
-    case ".mjs":
-      config = (await import(filename)).default;
-      break;
-    case ".json":
-      config = JSON.parse(readFileSync(filename, "utf-8"));
-      break;
-  }
-  return config;
-}
-async function loadRoutes(dir, routes) {
-  const paths = await glob(`${dir}/**/*.{js,mjs,json}`, { absolute: true });
-  const configs = await Promise.all(paths.map(getRoute));
-  configs.reduce((prev, cur) => {
-    if (cur) {
-      prev.push(cur);
-    }
-    return prev;
-  }, routes);
-}
+import { send, transformWithEsbuild } from "vite";
+import { readFileSync } from "node:fs";
+import { writeFile, unlink } from "node:fs/promises";
+import { createRequire } from "node:module";
+import { glob } from "tinyglobby";
+import { Logger, Level } from "base-log-factory";
+import { ColorfulAppender } from "blf-colorful-appender";
+const name = "vite-plugin-mock-data";
+const pkg = {
+  name
+};
 function sirvOptions(headers) {
   return {
     dev: true,
@@ -56,7 +34,7 @@ function sirvOptions(headers) {
     }
   };
 }
-function configureServer(server, routerOpts, routes, serve, cwd) {
+function configureServer(server, routerOpts, routes, cwd) {
   const router = getRouter(routerOpts);
   if (Array.isArray(routes)) {
     routes.forEach((route) => {
@@ -66,6 +44,7 @@ function configureServer(server, routerOpts, routes, serve, cwd) {
           pathname = methods;
           methods = "GET";
         }
+        methods = methods.toUpperCase();
         let routeConfig = route[xpath];
         if (!isObject(routeConfig)) {
           routeConfig = { handler: routeConfig };
@@ -73,10 +52,10 @@ function configureServer(server, routerOpts, routes, serve, cwd) {
         let handler;
         if (typeof routeConfig.file === "string") {
           handler = (req, res) => {
-            const parsedPath = parse(toAbsolute(routeConfig.file, cwd));
-            const serve2 = sirv(parsedPath.dir, sirvOptions(server.config.server.headers));
+            const parsedPath = parse(toAbsolutePath(routeConfig.file, cwd));
+            const serve = sirv(parsedPath.dir, sirvOptions(server.config.server.headers));
             req.url = `/${parsedPath.base}`;
-            serve2(req, res);
+            serve(req, res);
           };
         } else if (typeof routeConfig.handler !== "function") {
           const ret = routeConfig.handler;
@@ -95,43 +74,87 @@ function configureServer(server, routerOpts, routes, serve, cwd) {
       });
     });
   }
-  if (serve) {
-    server.middlewares.use(serve);
-  }
   server.middlewares.use((req, res, next) => {
     router.defaultRoute = () => next();
     router.lookup(req, res);
   });
 }
-function createPlugin(opts) {
-  const { isAfter, routerOptions, routes, assets, cwd = process.cwd() } = opts;
+const PLUGIN_NAME = pkg.name;
+const logger = new Logger(PLUGIN_NAME, {
+  level: Level.WARN,
+  appenders: [
+    new ColorfulAppender()
+  ]
+});
+async function getRoute(filename) {
+  logger.debug("Load mock file:", filename);
+  let { ext, dir, name: name2 } = parse(filename);
+  const isTs = ext === ".ts" || ext === ".mts";
+  if (isTs) {
+    const { code } = await transformWithEsbuild(readFileSync(filename, "utf-8"), filename, {
+      loader: "ts",
+      target: "esnext"
+    });
+    filename = join(dir, `${name2}-${PLUGIN_NAME}.mjs`);
+    ext = ".mjs";
+    await writeFile(filename, code);
+  }
+  let config;
+  switch (ext) {
+    case ".js":
+      config = createRequire(import.meta.url)(filename);
+      break;
+    case ".mjs":
+      config = (await import(filename)).default;
+      if (isTs) {
+        await unlink(filename);
+      }
+      break;
+    case ".json":
+      config = JSON.parse(readFileSync(filename, "utf-8"));
+      break;
+  }
+  return config;
+}
+async function loadRoutes(dir, routes) {
+  const paths = await glob(`${dir}/**/*.{js,mjs,json,ts,mts}`, { absolute: true });
+  const configs = await Promise.all(paths.map(getRoute));
+  for (const config of configs) {
+    if (config) {
+      routes.push(config);
+    }
+  }
+}
+function pluginMockDate(opts) {
+  banner(pkg.name);
+  const { isAfter, routerOptions, routes, logLevel, cwd = process.cwd() } = opts;
+  if (logLevel) {
+    logger.level = logLevel;
+  }
   const allRoutes = [];
   return {
-    name: "vite-plugin-mock-data",
+    name: PLUGIN_NAME,
     async configureServer(server) {
       if (typeof routes === "string") {
-        await loadRoutes(toAbsolute(routes, cwd), allRoutes);
+        logger.debug("Load routes from", routes);
+        await loadRoutes(toAbsolutePath(routes, cwd), allRoutes);
       } else if (Array.isArray(routes)) {
         for (const route of routes) {
+          logger.debug("Load routes from", route);
           if (typeof route === "string") {
-            await loadRoutes(toAbsolute(route, cwd), allRoutes);
+            await loadRoutes(toAbsolutePath(route, cwd), allRoutes);
           } else {
             allRoutes.push(route);
           }
         }
       } else if (isObject(routes)) {
+        logger.debug("Load routes from", routes);
         allRoutes.push(routes);
       }
-      let serve = null;
-      if (assets) {
-        serve = sirv(toAbsolute(assets, cwd), sirvOptions(server.config.server.headers));
-      }
-      if (allRoutes && allRoutes.length > 0) {
-        return isAfter ? () => configureServer(server, routerOptions, allRoutes, serve, cwd) : configureServer(server, routerOptions, allRoutes, serve, cwd);
-      }
+      return isAfter ? () => configureServer(server, routerOptions, allRoutes, cwd) : configureServer(server, routerOptions, allRoutes, cwd);
     }
   };
 }
 export {
-  createPlugin as default
+  pluginMockDate as default
 };

package/dist/loadRoutes.d.ts

@@ -0,0 +1,2 @@
+import { RouteConfig } from './typings';
+export default function loadRoutes(dir: string, routes: RouteConfig[]): Promise<void>;

package/dist/logger.d.ts

@@ -0,0 +1,3 @@
+import { Logger } from 'base-log-factory';
+export declare const PLUGIN_NAME: string;
+export declare const logger: Logger;

package/dist/typings.d.ts

@@ -1,4 +1,5 @@
-import { Config as SirvConfig, HTTPVersion, RouteOptions, Handler } from 'find-my-way';
+import { LogLevel } from 'base-log-factory';
+import { Config as SirvConfig, Handler, HTTPVersion, RouteOptions } from 'find-my-way';
 export interface HandleRoute {
     file?: string;
     handler?: any | Handler<HTTPVersion.V1>;
@@ -14,15 +15,25 @@ export interface Options {
      * @default `process.cwd()`
      */
     cwd?: string;
+    /**
+     * Cache directory for compiled files.
+     *
+     * 用于存放 ts 被编译后存放的文件目录。
+     *
+     * @default `${cwd}/node_modules/.vite_mock_data`
+     */
+    cacheDir?: string;
+    /**
+     * Log level
+     *
+     * 输出日志等级
+     */
+    logLevel?: LogLevel;
     /**
      * If `true`, these mock routes is matched after internal middlewares are installed.
      * @default `false`
      */
     isAfter?: boolean;
-    /**
-     * Specify the directory to define mock assets.
-     */
-    assets?: string;
     /**
      * Initial options of `find-my-way`. see more at https://github.com/delvedor/find-my-way#findmywayoptions
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-data",
-  "version": "6.0.1",
+  "version": "6.0.2",
   "description": "Provides a simple way to mock data.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -16,11 +16,6 @@
     "node": ">=14.18.0",
     "vite": ">=3.1.0"
   },
-  "scripts": {
-    "release": "npm publish",
-    "build:lib": "vite build",
-    "watch": "vite build --watch"
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fengxinming/vite-plugins.git",
@@ -35,13 +30,27 @@
   "bugs": {
     "url": "https://github.com/fengxinming/vite-plugins/issues"
   },
-  "homepage": "https://github.com/fengxinming/vite-plugins#readme",
+  "homepage": "https://fengxinming.github.io/vite-plugins/plugins/vite-plugin-mock-data/quick-start",
   "dependencies": {
+    "base-log-factory": "^2.0.9",
+    "blf-colorful-appender": "^1.0.2",
     "find-my-way": "^9.2.0",
+    "is-what-type": "^1.0.0",
     "sirv": "^3.0.1",
-    "tinyglobby": "^0.2.12"
+    "tinyglobby": "^0.2.12",
+    "vp-runtime-helper": "^1.0.3"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/fs-extra": "^11.0.4",
+    "vite": "^6.1.0"
   },
   "files": [
     "dist"
-  ]
+  ],
+  "scripts": {
+    "build:lib": "vite build",
+    "watch": "vite build --watch",
+    "release": "pnpm publish --no-git-checks"
+  }
 }