vite-plugin-mock-data 4.0.6 → 6.0.1

package/README.md

@@ -15,12 +15,58 @@ npm install vite-plugin-mock-data --save-dev
 
 ## Options
 
+```ts
+import { Config as SirvConfig, HTTPVersion, RouteOptions, Handler } from 'find-my-way';
+
+export interface HandleRoute {
+  file?: string;
+  handler?: any | Handler<HTTPVersion.V1>;
+  options?: RouteOptions;
+  store?: any;
+}
+
+export interface RouteConfig {
+  [route: string]: string | Handler<HTTPVersion.V1> | HandleRoute;
+}
+
+export interface Options {
+  /**
+   * The directory to serve files from.
+   * @default `process.cwd()`
+   */
+  cwd?: string;
+
+  /**
+   * 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
+   */
+  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.
-* `mockAssetsDir` - Specify the directory to define mock assets.
-* `mockRouterOptions` - [Initial options of `find-my-way`](https://github.com/delvedor/find-my-way#findmywayoptions)
-* `mockRoutes` - Initial list of mock routes that should be added to the dev server.
-* `mockRoutesDir` - Specify the directory to define mock routes that should be added to the dev server.
+* `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
 
@@ -33,7 +79,7 @@ import mockData from 'vite-plugin-mock-data';
 export default defineConfig({
   plugins: [
     mockData({
-      mockAssetsDir: './mockAssets'
+      assets: './mockAssets'
     })
   ]
 });
@@ -67,7 +113,7 @@ import mockData from 'vite-plugin-mock-data';
 export default defineConfig({
   plugins: [
     mockData({
-      mockRoutes: {
+      routes: {
         '/hello': 'hello',
         '/hello2'(req, res) {
           res.statusCode = 200;
@@ -110,7 +156,7 @@ import mockData from 'vite-plugin-mock-data';
 export default defineConfig({
   plugins: [
     mockData({
-      mockRoutesDir: './mock'
+      routes: './mock'
     })
   ]
 });
@@ -156,6 +202,7 @@ fetch('/package.json')
 
 ## Examples
 
-* [See vite3 demo](../../examples/vite3-mock-data) 
-* [See vite4 demo](../../examples/vite4-mock-data)
-* [See vite5 demo](../../examples/vite5-mock-data)
+* [See vite3 demo](../../examples/vite3-demo)
+* [See vite4 demo](../../examples/vite4-demo)
+* [See vite5 demo](../../examples/vite5-demo)
+* [See vite6 demo](../../examples/vite6-demo)

package/dist/index.d.ts

@@ -1,34 +1,6 @@
-import { Config as SirvConfig, HTTPVersion, RouteOptions, Handler } from 'find-my-way';
 import { Plugin } from 'vite';
-export interface HandleRoute {
-    file?: string;
-    handler?: any | Handler<HTTPVersion.V1>;
-    options?: RouteOptions;
-    store?: any;
-}
-export interface RouteConfig {
-    [route: string]: string | Handler<HTTPVersion.V1> | HandleRoute;
-}
-export interface Options {
-    /**
-     * The directory to serve files from.
-     * @default `process.cwd()`
-     */
-    cwd?: string;
-    /**
-     * If `true`, these mock routes is matched after internal middlewares are installed.
-     * @default `false`
-     */
-    isAfter?: boolean;
-    /** Specify the directory to define mock assets. */
-    mockAssetsDir?: string;
-    /** Initial options of `find-my-way`. see more at https://github.com/delvedor/find-my-way#findmywayoptions */
-    mockRouterOptions?: SirvConfig<HTTPVersion.V1> | SirvConfig<HTTPVersion.V2>;
-    /** Initial list of mock routes that should be added to the dev server. */
-    mockRoutes?: RouteConfig | RouteConfig[];
-    /** Specify the directory to define mock routes that should be added to the dev server. */
-    mockRoutesDir?: string;
-}
+import { Options } from './typings';
+export * from './typings';
 /**
  * Provides a simple way to mock data.
  *
@@ -40,7 +12,7 @@ export interface Options {
  * export default defineConfig({
  *   plugins: [
  *     mockData({
- *       mockRoutesDir: './mock'
+ *       routes: './mock'
  *     })
  *   ]
  * });

package/dist/index.js

@@ -2,7 +2,7 @@
 const node_path = require("node:path");
 const node_module = require("node:module");
 const node_fs = require("node:fs");
-const globby = require("globby");
+const tinyglobby = require("tinyglobby");
 const getRouter = require("find-my-way");
 const sirv = require("sirv");
 const vite = require("vite");
@@ -13,6 +13,31 @@ function isObject(val) {
 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);
+}
 function sirvOptions(headers) {
   return {
     dev: true,
@@ -81,47 +106,30 @@ function configureServer(server, routerOpts, routes, serve, cwd) {
   });
 }
 function createPlugin(opts) {
-  const { isAfter, mockRouterOptions, mockAssetsDir } = opts;
-  let { cwd, mockRoutesDir } = opts;
-  let mockRoutes = opts.mockRoutes || [];
-  if (!cwd) {
-    cwd = process.cwd();
-  }
-  if (isObject(mockRoutes) && !Array.isArray(mockRoutes)) {
-    mockRoutes = [mockRoutes];
-  }
+  const { isAfter, routerOptions, routes, assets, cwd = process.cwd() } = opts;
+  const allRoutes = [];
   return {
     name: "vite-plugin-mock-data",
     async configureServer(server) {
-      if (mockRoutesDir) {
-        mockRoutesDir = toAbsolute(mockRoutesDir, cwd);
-        const paths = await globby.globby(`${mockRoutesDir}/**/*.{js,mjs,json}`);
-        await Promise.all(paths.map((file) => {
-          return (async () => {
-            let config;
-            switch (node_path.extname(file)) {
-              case ".js":
-                config = node_module.createRequire(typeof document === "undefined" ? require("url").pathToFileURL(__filename).href : _documentCurrentScript && _documentCurrentScript.src || new URL("index.js", document.baseURI).href)(file);
-                break;
-              case ".mjs":
-                config = (await import(file)).default;
-                break;
-              case ".json":
-                config = JSON.parse(node_fs.readFileSync(file, "utf-8"));
-                break;
-            }
-            if (config) {
-              mockRoutes.push(config);
-            }
-          })();
-        }));
+      if (typeof routes === "string") {
+        await loadRoutes(toAbsolute(routes, cwd), allRoutes);
+      } else if (Array.isArray(routes)) {
+        for (const route of routes) {
+          if (typeof route === "string") {
+            await loadRoutes(toAbsolute(route, cwd), allRoutes);
+          } else {
+            allRoutes.push(route);
+          }
+        }
+      } else if (isObject(routes)) {
+        allRoutes.push(routes);
       }
       let serve = null;
-      if (mockAssetsDir) {
-        serve = sirv(toAbsolute(mockAssetsDir, cwd), sirvOptions(server.config.server.headers));
+      if (assets) {
+        serve = sirv(toAbsolute(assets, cwd), sirvOptions(server.config.server.headers));
       }
-      if (mockRoutes && mockRoutes.length > 0) {
-        return isAfter ? () => configureServer(server, mockRouterOptions, mockRoutes, serve, cwd) : configureServer(server, mockRouterOptions, mockRoutes, serve, cwd);
+      if (allRoutes && allRoutes.length > 0) {
+        return isAfter ? () => configureServer(server, routerOptions, allRoutes, serve, cwd) : configureServer(server, routerOptions, allRoutes, serve, cwd);
       }
     }
   };

package/dist/index.mjs

@@ -1,7 +1,7 @@
-import { extname, isAbsolute, posix, parse } from "node:path";
+import { posix, isAbsolute, extname, parse } from "node:path";
 import { createRequire } from "node:module";
 import { readFileSync } from "node:fs";
-import { globby } from "globby";
+import { glob } from "tinyglobby";
 import getRouter from "find-my-way";
 import sirv from "sirv";
 import { send } from "vite";
@@ -11,6 +11,31 @@ function isObject(val) {
 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);
+}
 function sirvOptions(headers) {
   return {
     dev: true,
@@ -79,47 +104,30 @@ function configureServer(server, routerOpts, routes, serve, cwd) {
   });
 }
 function createPlugin(opts) {
-  const { isAfter, mockRouterOptions, mockAssetsDir } = opts;
-  let { cwd, mockRoutesDir } = opts;
-  let mockRoutes = opts.mockRoutes || [];
-  if (!cwd) {
-    cwd = process.cwd();
-  }
-  if (isObject(mockRoutes) && !Array.isArray(mockRoutes)) {
-    mockRoutes = [mockRoutes];
-  }
+  const { isAfter, routerOptions, routes, assets, cwd = process.cwd() } = opts;
+  const allRoutes = [];
   return {
     name: "vite-plugin-mock-data",
     async configureServer(server) {
-      if (mockRoutesDir) {
-        mockRoutesDir = toAbsolute(mockRoutesDir, cwd);
-        const paths = await globby(`${mockRoutesDir}/**/*.{js,mjs,json}`);
-        await Promise.all(paths.map((file) => {
-          return (async () => {
-            let config;
-            switch (extname(file)) {
-              case ".js":
-                config = createRequire(import.meta.url)(file);
-                break;
-              case ".mjs":
-                config = (await import(file)).default;
-                break;
-              case ".json":
-                config = JSON.parse(readFileSync(file, "utf-8"));
-                break;
-            }
-            if (config) {
-              mockRoutes.push(config);
-            }
-          })();
-        }));
+      if (typeof routes === "string") {
+        await loadRoutes(toAbsolute(routes, cwd), allRoutes);
+      } else if (Array.isArray(routes)) {
+        for (const route of routes) {
+          if (typeof route === "string") {
+            await loadRoutes(toAbsolute(route, cwd), allRoutes);
+          } else {
+            allRoutes.push(route);
+          }
+        }
+      } else if (isObject(routes)) {
+        allRoutes.push(routes);
       }
       let serve = null;
-      if (mockAssetsDir) {
-        serve = sirv(toAbsolute(mockAssetsDir, cwd), sirvOptions(server.config.server.headers));
+      if (assets) {
+        serve = sirv(toAbsolute(assets, cwd), sirvOptions(server.config.server.headers));
       }
-      if (mockRoutes && mockRoutes.length > 0) {
-        return isAfter ? () => configureServer(server, mockRouterOptions, mockRoutes, serve, cwd) : configureServer(server, mockRouterOptions, mockRoutes, serve, cwd);
+      if (allRoutes && allRoutes.length > 0) {
+        return isAfter ? () => configureServer(server, routerOptions, allRoutes, serve, cwd) : configureServer(server, routerOptions, allRoutes, serve, cwd);
       }
     }
   };

package/dist/typings.d.ts

@@ -0,0 +1,35 @@
+import { Config as SirvConfig, HTTPVersion, RouteOptions, Handler } from 'find-my-way';
+export interface HandleRoute {
+    file?: string;
+    handler?: any | Handler<HTTPVersion.V1>;
+    options?: RouteOptions;
+    store?: any;
+}
+export interface RouteConfig {
+    [route: string]: string | Handler<HTTPVersion.V1> | HandleRoute;
+}
+export interface Options {
+    /**
+     * The directory to serve files from.
+     * @default `process.cwd()`
+     */
+    cwd?: string;
+    /**
+     * 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
+     */
+    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;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-data",
-  "version": "4.0.6",
+  "version": "6.0.1",
   "description": "Provides a simple way to mock data.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -18,7 +18,7 @@
   },
   "scripts": {
     "release": "npm publish",
-    "build": "vite build",
+    "build:lib": "vite build",
     "watch": "vite build --watch"
   },
   "repository": {
@@ -37,9 +37,9 @@
   },
   "homepage": "https://github.com/fengxinming/vite-plugins#readme",
   "dependencies": {
-    "find-my-way": "^7.6.2",
-    "globby": "^13.2.2",
-    "sirv": "^2.0.2"
+    "find-my-way": "^9.2.0",
+    "sirv": "^3.0.1",
+    "tinyglobby": "^0.2.12"
   },
   "files": [
     "dist"