vite-plugin-testem 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Gaurav Munjal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# vite-plugin-testem
+
+[Vite](https://vite.dev/) plugin and [Testem](https://github.com/testem/testem) middleware helper for browser unit tests.
+
+## Install
+
+```bash
+npm install vite-plugin-testem --save-dev
+```
+
+You must also install a compatible Vite version (peer dependency: `^7.0.0 || ^8.0.0`).
+
+To run browser tests with Testem, install Testem in your project (optional peer dependency: `^3.20.0`):
+
+```bash
+npm install testem@^3.20.0 --save-dev
+```
+
+## `vitePluginTestem(options)`
+
+Vite plugin that injects the Testem client script (`/testem.js`) into `index.html`. For TAP-style runners it can inject the usual `Testem.handleConsoleMessage` bridge.
+
+**Options**
+
+- `framework`: `'tap'` (default), `'mocha'`, or `'none'`
+- `injectTapBridge`: override whether the TAP console bridge is injected (defaults to on when `framework === 'tap'`)
+
+## `createTestemViteMiddleware(inlineConfig)`
+
+Returns a Promise of `{ middleware, close }`. Use `middleware` in Testem’s `middleware` array so Vite runs in [middleware mode](https://vite.dev/guide/ssr.html#setting-up-the-dev-server) ahead of Testem’s own routes. The helper skips `/testem.js`, `/testem/*`, and `/socket.io` so Testem still serves its client and Socket.IO on the same origin.
+
+Pass Vite `InlineConfig` fields as needed (for example `root: __dirname`). Set `configFile: false` if you do not want Vite to load `vite.config.js`.
+
+## Recommended: `on_exit` and `close()`
+
+Vite’s dev server registers file watchers and keeps resources open. If you only register the middleware and exit Testem, those handles can prevent the process from exiting cleanly or leave watcher noise in the background.
+
+Call the `close()` function returned with the middleware from Testem’s **`on_exit`** hook. That shuts down the Vite server the same way as stopping the CLI dev server.
+
+Example `testem.js`:
+
+```javascript
+const { createTestemViteMiddleware } = require('vite-plugin-testem');
+
+let viteClose;
+
+module.exports = async function testemConfig() {
+  const { middleware, close } = await createTestemViteMiddleware({
+    root: __dirname,
+  });
+  viteClose = close;
+
+  return {
+    middleware: [middleware],
+    test_page: 'index.html',
+    on_exit(config, data, callback) {
+      if (!viteClose) {
+        return callback(null);
+      }
+      viteClose()
+        .then(() => callback(null))
+        .catch(callback);
+    },
+  };
+};
+```
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,100 @@
+'use strict';
+
+const path = require('path');
+const vite = require('vite');
+
+/**
+ * Vite plugin for projects tested with [Testem](https://github.com/testem/testem).
+ *
+ * Injects the Testem browser client (`/testem.js`) into `index.html`. For `framework: 'tap'`,
+ * also injects the usual `Testem.handleConsoleMessage` bridge so tape / TAP output reaches Testem.
+ * For Mocha, QUnit, etc., omit the TAP bridge (use `framework: 'mocha'` or `injectTapBridge: false`).
+ *
+ * @param {{ framework?: 'tap' | 'mocha' | 'none', injectTapBridge?: boolean }} [options]
+ * @returns {import('vite').Plugin}
+ */
+function vitePluginTestem(options = {}) {
+  const framework = options.framework || 'tap';
+  const injectTapBridge =
+    options.injectTapBridge !== undefined
+      ? options.injectTapBridge
+      : framework === 'tap';
+
+  return {
+    name: 'testem',
+    enforce: 'pre',
+    transformIndexHtml(html) {
+      if (/\/testem\.js/.test(html)) {
+        return html;
+      }
+      let snippet = '<script src="/testem.js"></script>';
+      if (injectTapBridge) {
+        snippet += `
+<script>
+Testem.handleConsoleMessage = function (msg) {
+  Testem.emit('tap', msg);
+  return false;
+};
+</script>`;
+      }
+      if (/<head[^>]*>/i.test(html)) {
+        return html.replace(/<head[^>]*>/i, (m) => `${m}\n${snippet}\n`);
+      }
+      return `${snippet}\n${html}`;
+    },
+  };
+}
+
+/**
+ * Creates Express middleware (for Testem `middleware:`) that forwards requests to Vite in middleware mode.
+ * Skips `/testem.js`, `/testem/*`, and `/socket.io` so Testem’s own routes run later in the stack.
+ *
+ * @param {import('vite').InlineConfig} [inlineConfig] merged after defaults; set `configFile: false` to skip loading `vite.config.js`
+ * @returns {Promise<{ middleware: (app: import('express').Application) => void, close: () => Promise<void> }>}
+ */
+async function createTestemViteMiddleware(inlineConfig = {}) {
+  const cwd = inlineConfig.root || inlineConfig.cwd || process.cwd();
+  const configFile =
+    inlineConfig.configFile !== undefined
+      ? inlineConfig.configFile
+      : path.join(cwd, 'vite.config.js');
+
+  const base = vite.mergeConfig(
+    {
+      configFile,
+      root: cwd,
+      server: {
+        middlewareMode: true,
+        hmr: false,
+        appType: 'custom',
+      },
+    },
+    { ...inlineConfig, cwd: undefined },
+  );
+
+  const server = await vite.createServer(base);
+
+  function middleware(app) {
+    app.use((req, res, next) => {
+      const pathname = req.url.split('?')[0];
+      if (
+        pathname === '/testem.js' ||
+        pathname.startsWith('/testem/') ||
+        pathname.startsWith('/socket.io')
+      ) {
+        return next();
+      }
+      server.middlewares(req, res, next);
+    });
+  }
+
+  return {
+    middleware,
+    close: () => server.close(),
+  };
+}
+
+module.exports = {
+  vitePluginTestem,
+  createTestemViteMiddleware,
+};

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "vite-plugin-testem",
+  "version": "1.0.0",
+  "description": "Vite plugin and Testem middleware helper for running browser tests with Testem",
+  "keywords": [
+    "vite",
+    "plugin",
+    "vite-plugin",
+    "testem",
+    "testing"
+  ],
+  "author": "Gaurav Munjal <Gaurav0@aol.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Gaurav0/vite-plugin-testem.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Gaurav0/vite-plugin-testem/issues"
+  },
+  "engines": {
+    "node": "^20.19.0 || ^22.12.0 || >=24.0.0"
+  },
+  "main": "./index.js",
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "files": [
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "peerDependencies": {
+    "vite": "^7.0.0 || ^8.0.0",
+    "testem": "^3.20.0"
+  },
+  "peerDependenciesMeta": {
+    "testem": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "test": "node scripts/smoke-test.js"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.0",
+    "eslint": "^10.2.0",
+    "globals": "^16.0.0",
+    "vite": "^8.0.0"
+  }
+}