twd-js 1.7.3 → 1.8.0-beta.0

package/README.md

@@ -7,7 +7,7 @@
 [![Code Coverage](https://qlty.sh/gh/BRIKEV/projects/twd/coverage.svg)](https://qlty.sh/gh/BRIKEV/projects/twd)
 
 <p align="center">
-  <img src="./images/twd-skill.gif" alt="TWD running with an AI agent" width="800">
+  <img src="https://raw.githubusercontent.com/BRIKEV/twd/main/images/twd-skill.gif" alt="TWD running with an AI agent" width="800">
 </p>
 
 TWD is a library designed to seamlessly integrate testing into your web development workflow. It streamlines the process of writing, running, and managing tests directly in your application, with a modern UI and powerful mocking capabilities.
@@ -101,7 +101,7 @@ describe("Hello World Page", () => {
 3. **Run your app** - The TWD sidebar will appear automatically in development mode!
 
 <p align="center">
-  <img src="./images/twd_side_bar_success.png" alt="TWD Sidebar in action" width="800">
+  <img src="https://raw.githubusercontent.com/BRIKEV/twd/main/images/twd_side_bar_success.png" alt="TWD Sidebar in action" width="800">
 </p>
 
 ## Key Concepts
@@ -155,7 +155,7 @@ Full documentation is available at [twd.dev](https://twd.dev) (coming soon) or i
 
 Check out our working examples for various frameworks:
 
-- **[Examples Directory](./examples)** - Local examples for React, Vue, and Astro
+- **[Examples Directory](https://github.com/BRIKEV/twd/tree/main/examples)** - Local examples for React, Vue, and Astro
 - **[Vue Example](https://github.com/BRIKEV/twd-vue-example)** - Vue 3 with advanced scenarios
 - **[Solid Example](https://github.com/BRIKEV/twd-solid-example)** - Solid.js integration
 - **[Angular Example](https://github.com/BRIKEV/twd-angular-example)** - Angular setup

package/dist/plugin/twd.d.ts

@@ -0,0 +1,75 @@
+import { Plugin } from 'vite';
+import { TWDTheme } from '../ui/utils/theme';
+/**
+ * Options for the TWD Vite plugin.
+ */
+export interface TwdPluginOptions {
+    /**
+     * Glob pattern used to discover TWD test files via `import.meta.glob`.
+     * @default "/**\/*.twd.test.ts"
+     */
+    testFilePattern?: string;
+    /**
+     * Whether the TWD sidebar starts open.
+     * @default true
+     */
+    open?: boolean;
+    /**
+     * Side of the viewport the sidebar is anchored to.
+     * @default "left"
+     */
+    position?: 'left' | 'right';
+    /**
+     * Whether to register the Mock Service Worker for request mocking.
+     * @default true
+     */
+    serviceWorker?: boolean;
+    /**
+     * URL of the Mock Service Worker script served by the app.
+     * @default "/mock-sw.js"
+     */
+    serviceWorkerUrl?: string;
+    /**
+     * Optional theme overrides for the sidebar UI.
+     */
+    theme?: Partial<TWDTheme>;
+    /**
+     * Whether to show the search input in the sidebar.
+     */
+    search?: boolean;
+    /**
+     * CSS selector for the host element used to mount the sidebar.
+     */
+    rootSelector?: string;
+}
+/**
+ * Vite plugin that auto-wires TWD into a dev server.
+ * It exposes a virtual module that calls `initTWD` with a glob of test files
+ * and injects a `<script type="module">` tag into `index.html` via
+ * `transformIndexHtml`, so apps don't need a manual TWD entry point.
+ *
+ * This plugin only runs in development mode (serve) and does not affect Vitest test runs.
+ *
+ * @param options - Configuration options for the plugin
+ * @example
+ * ```ts
+ * import { twd } from 'twd-js/vite-plugin';
+ *
+ * export default defineConfig({
+ *   plugins: [
+ *     // ... other plugins
+ *     twd(),
+ *   ],
+ * });
+ * ```
+ * @example
+ * ```ts
+ * // Custom options
+ * twd({
+ *   testFilePattern: '/src/**\/*.twd.test.tsx',
+ *   position: 'right',
+ *   open: false,
+ * })
+ * ```
+ */
+export declare function twd(options?: TwdPluginOptions): Plugin;

package/dist/vite-plugin.cjs.js

@@ -1 +1,2 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const d=require("./index.cjs.js");let s=require("fs"),l=require("path");function i(){return{name:"remove-mock-sw",apply:"build",closeBundle(){try{(0,s.rmSync)((0,l.resolve)("dist/mock-sw.js")),console.log("🧹 Removed mock-sw.js from build")}catch{console.log("🧹 No mock-sw.js found in build")}}}}function c(o={}){const{testFilePattern:e=".twd.test.ts"}=o,r=typeof e=="function"?e:t=>t.endsWith(e);return{name:"twd-hmr",apply:"serve",handleHotUpdate({file:t,server:n}){if(r(t))return n.ws.send({type:"full-reload",path:"*"}),[]}}}exports.removeMockServiceWorker=i;exports.twdHmr=c;
+Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const w=require("./index.cjs.js");let d=require("fs"),u=require("path");function a(){return{name:"remove-mock-sw",apply:"build",closeBundle(){try{(0,d.rmSync)((0,u.resolve)("dist/mock-sw.js")),console.log("🧹 Removed mock-sw.js from build")}catch{console.log("🧹 No mock-sw.js found in build")}}}}function m(n={}){const{testFilePattern:t=".twd.test.ts"}=n,o=typeof t=="function"?t:e=>e.endsWith(t);return{name:"twd-hmr",apply:"serve",handleHotUpdate({file:e,server:r}){if(o(e))return r.ws.send({type:"full-reload",path:"*"}),[]}}}var i="virtual:twd/init",s=`\0${i}`,p="/**/*.twd.test.ts",f={open:!0,position:"left",serviceWorker:!0,serviceWorkerUrl:"/mock-sw.js"};function v(n={}){const{testFilePattern:t=p,...o}=n,e={...f,...o};return{name:"twd",apply:"serve",resolveId(r){return r===i?s:null},load(r){if(r!==s)return null;const l=JSON.stringify(t),c=JSON.stringify(e);return["import { initTWD } from 'twd-js/bundled';",`const tests = import.meta.glob(${l});`,`initTWD(tests, ${c});`].join(`
+`)},transformIndexHtml(){return[{tag:"script",attrs:{type:"module",src:`/@id/${i}`},injectTo:"head"}]}}}exports.removeMockServiceWorker=a;exports.twd=v;exports.twdHmr=m;

package/dist/vite-plugin.d.ts

@@ -1,2 +1,3 @@
 export { removeMockServiceWorker } from './plugin/removeMockServiceWorker';
 export { twdHmr, type TwdHmrOptions } from './plugin/twdHmr';
+export { twd, type TwdPluginOptions } from './plugin/twd';

package/dist/vite-plugin.es.js

@@ -1,33 +1,73 @@
-import { rmSync as s } from "fs";
-import { resolve as l } from "path";
-function i() {
+import { rmSync as d } from "fs";
+import { resolve as a } from "path";
+function v() {
   return {
     name: "remove-mock-sw",
     apply: "build",
     closeBundle() {
       try {
-        s(l("dist/mock-sw.js")), console.log("🧹 Removed mock-sw.js from build");
+        d(a("dist/mock-sw.js")), console.log("🧹 Removed mock-sw.js from build");
       } catch {
         console.log("🧹 No mock-sw.js found in build");
       }
     }
   };
 }
-function d(t = {}) {
-  const { testFilePattern: e = ".twd.test.ts" } = t, r = typeof e == "function" ? e : (o) => o.endsWith(e);
+function w(n = {}) {
+  const { testFilePattern: t = ".twd.test.ts" } = n, o = typeof t == "function" ? t : (e) => e.endsWith(t);
   return {
     name: "twd-hmr",
     apply: "serve",
-    handleHotUpdate({ file: o, server: n }) {
-      if (r(o))
-        return n.ws.send({
+    handleHotUpdate({ file: e, server: r }) {
+      if (o(e))
+        return r.ws.send({
           type: "full-reload",
           path: "*"
         }), [];
     }
   };
 }
+var s = "virtual:twd/init", i = `\0${s}`, u = "/**/*.twd.test.ts", m = {
+  open: !0,
+  position: "left",
+  serviceWorker: !0,
+  serviceWorkerUrl: "/mock-sw.js"
+};
+function T(n = {}) {
+  const { testFilePattern: t = u, ...o } = n, e = {
+    ...m,
+    ...o
+  };
+  return {
+    name: "twd",
+    apply: "serve",
+    resolveId(r) {
+      return r === s ? i : null;
+    },
+    load(r) {
+      if (r !== i) return null;
+      const l = JSON.stringify(t), c = JSON.stringify(e);
+      return [
+        "import { initTWD } from 'twd-js/bundled';",
+        `const tests = import.meta.glob(${l});`,
+        `initTWD(tests, ${c});`
+      ].join(`
+`);
+    },
+    transformIndexHtml() {
+      return [{
+        tag: "script",
+        attrs: {
+          type: "module",
+          src: `/@id/${s}`
+        },
+        injectTo: "head"
+      }];
+    }
+  };
+}
 export {
-  i as removeMockServiceWorker,
-  d as twdHmr
+  v as removeMockServiceWorker,
+  T as twd,
+  w as twdHmr
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "twd-js",
-  "version": "1.7.3",
+  "version": "1.8.0-beta.0",
   "description": "Test While Developing (TWD) - in-browser testing",
   "type": "module",
   "license": "MIT",
@@ -94,7 +94,7 @@
     "react-dom": ">=17.0.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.4",
+    "@eslint/js": "^10.0.1",
     "@preact/preset-vite": "^2.10.5",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.2",
@@ -104,15 +104,15 @@
     "@vitest/coverage-v8": "^4.1.5",
     "@vitest/eslint-plugin": "^1.6.16",
     "conventional-changelog": "^7.2.0",
-    "eslint": "^9.39.4",
+    "eslint": "^10.3.0",
     "eslint-config-prettier": "^10.1.8",
     "globals": "^17.6.0",
     "husky": "^9.1.7",
     "jsdom": "^29.1.1",
-    "lint-staged": "^16.4.0",
+    "lint-staged": "^17.0.2",
     "prettier": "^3.8.3",
     "typescript": "~5.9.3",
-    "typescript-eslint": "^8.59.1",
+    "typescript-eslint": "^8.59.2",
     "vite": "^8.0.10",
     "vite-plugin-dts": "^5.0.0",
     "vitepress": "^2.0.0-alpha.12",