Merge pull request #3 from Forsakringskassan/feature/vite-plugin

feat: add Vite plugin

README.md

@@ -15,6 +15,7 @@ Major differences from the original:
 -   Improved and configurable logging.
 -   Helpers such as `defineMock` to assist IDE writing mocks.
 -   Typescript support.
+-   Builtin Vite Plugin.
 
 ## Usage
 
@@ -63,22 +64,14 @@ app.listen(3000);
 
 ```ts
 import { defineConfig } from "vite";
-
-/* setup mocks */
-apimock.config([
-    { url: "/api/foo", dir: "tests/mock/foo" },
-    { url: "/api/bar", dir: "tests/mock/bar" },
-]);
+import { vitePlugin as apimockPlugin } from "@forsakringskassan/apimock-express";
 
 export default defineConfig({
     plugins: [
-        {
-            name: "apimock-plugin",
-            configureServer(server) {
-                /* install middleware */
-                server.middlewares.use("/", apimockExpress.mockRequest);
-            },
-        },
+        apimockPlugin([
+            { url: "/api/foo", dir: "tests/mock/foo" },
+            { url: "/api/bar", dir: "tests/mock/bar" },
+        ]),
     ],
 });
 ```

main.d.ts

@@ -62,3 +62,13 @@ export function mockRequest(
     response: Response,
     next: NextFunction,
 ): void;
+
+/**
+ * Vite plugin for apimock-express.
+ *
+ * @param mocks - Mock configuration
+ * @returns A Vite plugin instance.
+ */
+export function vitePlugin(mocks: MockEntry[]): {
+    name: "apimock-plugin";
+};

main.js

@@ -6,6 +6,10 @@ const debug = require("debug")("apimock");
 const Table = require("cli-table");
 const { version } = require("./package.json");
 
+/**
+ * @typedef {import("vite").Plugin} Plugin
+ */
+
 /**
  * @typedef {import("./main").MockEntry} MockEntry
  * @typedef {import("./main").MiddlewareConfiguration} MiddlewareConfiguration
@@ -51,7 +55,7 @@ function toArray(value) {
     return Array.isArray(value) ? value : [value];
 }
 
-module.exports = {
+const apimock = {
     /**
      * Configuration of the mock.
      *
@@ -139,8 +143,26 @@ module.exports = {
             respondData(res, response);
         }
     },
+
+    /**
+     * Vite plugin for apimock-express.
+     *
+     * @param {MockEntry[]} mocks - Mock configuration
+     * @returns {Plugin}
+     */
+    vitePlugin(mocks) {
+        return {
+            name: "apimock-plugin",
+            configureServer(server) {
+                apimock.config(mocks);
+                server.middlewares.use("/", apimock.mockRequest);
+            },
+        };
+    },
 };
 
+module.exports = apimock;
+
 /**
  * Extracts filecontent for both js and json files
  *