@noma.to/qwik-testing-library 1.4.0 → 1.5.1

package/README.md

@@ -131,7 +131,7 @@ should be installed as one of your project's `devDependencies`:
 npm install --save-dev @noma.to/qwik-testing-library @testing-library/dom
 ```
 
-This library supports `qwik` versions `1.7.2` and above and `@testing-library/dom` versions `10.1.0` and above.
+This library supports `qwik` versions `1.12.0` and above and `@testing-library/dom` versions `10.1.0` and above.
 
 You may also be interested in installing `@testing-library/jest-dom` and `@testing-library/user-event` so you can
 use [the custom jest matchers][jest-dom] and [the user event library][user-event] to test interactions with the DOM.
@@ -162,80 +162,30 @@ npm install --save-dev happy-dom
 We recommend using `@noma.to/qwik-testing-library` with [Vitest][vitest] as your test
 runner.
 
-If you haven't done so already, add vitest to your project using Qwik CLI:
+If you haven't done so already, install vitest:
 
 ```shell
-npm run qwik add vitest
+npm install --save-dev vitest
 ```
 
 After that, we need to configure Vitest so it can run your tests.
-For this, create a _separate_ `vitest.config.ts` so you don't have to modify your project's `vite.config.ts`:
+Add the `test` section to your `vite.config.ts`:
 
 ```ts
-// vitest.config.ts
-
-import {defineConfig, mergeConfig} from "vitest/config";
-import viteConfig from "./vite.config";
-
-export default defineConfig((configEnv) =>
-  mergeConfig(
-    viteConfig(configEnv),
-    defineConfig({
-      // qwik-testing-library needs to consider your project as a Qwik lib
-      // if it's already a Qwik lib, you can remove this section
-      build: {
-        target: "es2020",
-        lib: {
-          entry: "./src/index.ts",
-          formats: ["es", "cjs"],
-          fileName: (format, entryName) =>
-            `${entryName}.qwik.${format === "es" ? "mjs" : "cjs"}`,
-        },
-      },
-      // configure your test environment
-      test: {
-        environment: "jsdom", // or "happy-dom"
-        setupFiles: ["./vitest.setup.ts"],
-        globals: true,
-      },
-    }),
-  ),
-);
+// vite.config.ts
+
+test: {
+  environment: "jsdom", // or "happy-dom"
+  setupFiles: [
+    "@noma.to/qwik-testing-library/setup",
+    "@testing-library/jest-dom/vitest", // optional, for DOM matchers
+  ],
+  globals: true,
+},
 ```
 
-For now, `qwik-testing-library` needs to consider your project as a lib ([PR welcomed][prs] to simplify this).
-Hence, the `build.lib` section in the config above.
-
-As the build will try to use `./src/index.ts` as the entry point, we need to create it:
-
-```ts
-// ./src/index.ts
-
-/**
- * DO NOT DELETE THIS FILE
- *
- * This entrypoint is needed by @noma.to/qwik-testing-library to run your tests
- */
-```
-
-Then, create the `vitest.setup.ts` file:
-
-```ts
-// vitest.setup.ts
-
-// Configure DOM matchers to work in Vitest
-import "@testing-library/jest-dom/vitest";
-
-// This has to run before qdev.ts loads. `beforeAll` is too late
-globalThis.qTest = false; // Forces Qwik to run as if it was in a Browser
-globalThis.qRuntimeQrl = true;
-globalThis.qDev = true;
-globalThis.qInspector = false;
-```
-
-This setup will make sure that Qwik is properly configured.
-It also loads `@testing-library/jest-dom/vitest` in your test runner
-so you can use matchers like `expect(...).toBeInTheDocument()`.
+The `@noma.to/qwik-testing-library/setup` module configures Qwik globals (`qTest`, `qRuntimeQrl`, `qDev`,
+`qInspector`) for testing. It must run before any Qwik code loads, which is why it's added to `setupFiles`.
 
 By default, Qwik Testing Library cleans everything up automatically for you.
 You can opt out of this by setting the environment variable `QTL_SKIP_AUTO_CLEANUP` to `true`.
@@ -309,7 +259,7 @@ describe("<Counter />", () => {
     await user.click(incrementBtn);
 
     // assert that the counter is now 2
-    await waitFor(() => expect(screen.findByText(/count:2/)).toBeInTheDocument());
+    expect(await screen.findByText(/count:2/)).toBeInTheDocument();
   });
 })
 ```

package/lib/lib/qwik-testing-library.qwik.cjs

@@ -55,21 +55,17 @@ async function render(ui, options = {}) {
     baseElement = document.body;
   }
   if (!container) {
-    container = baseElement.insertBefore(document.createElement("host"), baseElement.firstChild);
+    container = baseElement.insertBefore(
+      document.createElement("host"),
+      baseElement.firstChild
+    );
   }
-  const wrappedUi = !Wrapper ? ui : /* @__PURE__ */ jsxRuntime.jsx(Wrapper, {
-    children: ui
-  });
+  const wrappedUi = !Wrapper ? ui : /* @__PURE__ */ jsxRuntime.jsx(Wrapper, { children: ui });
   const doc = baseElement.ownerDocument;
   const win = doc.defaultView;
   new Function("document", "window", server.getQwikLoaderScript())(doc, win);
-  const { cleanup: cleanup2 } = await qwik.render(container, wrappedUi, {
-    serverData
-  });
-  mountedContainers.add({
-    container,
-    componentCleanup: cleanup2
-  });
+  const { cleanup: cleanup2 } = await qwik.render(container, wrappedUi, { serverData });
+  mountedContainers.add({ container, componentCleanup: cleanup2 });
   return {
     container,
     baseElement,
@@ -82,10 +78,9 @@ async function render(ui, options = {}) {
         return template.content;
       }
     },
-    debug: (el = baseElement, maxLength, options2) => Array.isArray(el) ? el.forEach((e) => console.log(dom.prettyDOM(e, maxLength, options2))) : console.log(dom.prettyDOM(el, maxLength, {
-      ...options2,
-      filterNode: () => true
-    })),
+    debug: (el = baseElement, maxLength, options2) => Array.isArray(el) ? el.forEach((e) => console.log(dom.prettyDOM(e, maxLength, options2))) : console.log(
+      dom.prettyDOM(el, maxLength, { ...options2, filterNode: () => true })
+    ),
     unmount: cleanup2,
     ...dom.getQueriesForElement(container, queries)
   };

package/lib/lib/qwik-testing-library.qwik.mjs

@@ -32,21 +32,17 @@ async function render(ui, options = {}) {
     baseElement = document.body;
   }
   if (!container) {
-    container = baseElement.insertBefore(document.createElement("host"), baseElement.firstChild);
+    container = baseElement.insertBefore(
+      document.createElement("host"),
+      baseElement.firstChild
+    );
   }
-  const wrappedUi = !Wrapper ? ui : /* @__PURE__ */ jsx(Wrapper, {
-    children: ui
-  });
+  const wrappedUi = !Wrapper ? ui : /* @__PURE__ */ jsx(Wrapper, { children: ui });
   const doc = baseElement.ownerDocument;
   const win = doc.defaultView;
   new Function("document", "window", getQwikLoaderScript())(doc, win);
-  const { cleanup: cleanup2 } = await qwik.render(container, wrappedUi, {
-    serverData
-  });
-  mountedContainers.add({
-    container,
-    componentCleanup: cleanup2
-  });
+  const { cleanup: cleanup2 } = await qwik.render(container, wrappedUi, { serverData });
+  mountedContainers.add({ container, componentCleanup: cleanup2 });
   return {
     container,
     baseElement,
@@ -59,10 +55,9 @@ async function render(ui, options = {}) {
         return template.content;
       }
     },
-    debug: (el = baseElement, maxLength, options2) => Array.isArray(el) ? el.forEach((e) => console.log(prettyDOM(e, maxLength, options2))) : console.log(prettyDOM(el, maxLength, {
-      ...options2,
-      filterNode: () => true
-    })),
+    debug: (el = baseElement, maxLength, options2) => Array.isArray(el) ? el.forEach((e) => console.log(prettyDOM(e, maxLength, options2))) : console.log(
+      prettyDOM(el, maxLength, { ...options2, filterNode: () => true })
+    ),
     unmount: cleanup2,
     ...getQueriesForElement(container, queries)
   };

package/lib/setup.qwik.cjs

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+globalThis.qTest = false;
+globalThis.qRuntimeQrl = true;
+globalThis.qDev = true;
+globalThis.qInspector = false;
+const __qwikSetupComplete = true;
+exports.__qwikSetupComplete = __qwikSetupComplete;

package/lib/setup.qwik.mjs

@@ -0,0 +1,8 @@
+globalThis.qTest = false;
+globalThis.qRuntimeQrl = true;
+globalThis.qDev = true;
+globalThis.qInspector = false;
+const __qwikSetupComplete = true;
+export {
+  __qwikSetupComplete
+};

package/lib-types/lib/qwik-testing-library.d.ts

@@ -1,4 +1,4 @@
-import { JSXOutput } from "@builder.io/qwik";
+import type { JSXOutput } from "@builder.io/qwik";
 import type { Options, Result } from "./types";
 declare function render(ui: JSXOutput, options?: Options): Promise<Result>;
 declare function cleanup(): void;

package/lib-types/setup.d.ts

@@ -0,0 +1,7 @@
+declare global {
+    var qTest: boolean;
+    var qRuntimeQrl: boolean;
+    var qDev: boolean;
+    var qInspector: boolean;
+}
+export declare const __qwikSetupComplete = true;

package/package.json

@@ -1,18 +1,23 @@
 {
   "name": "@noma.to/qwik-testing-library",
-  "version": "1.4.0",
+  "version": "1.5.1",
   "description": "Simple and complete Qwik testing utilities that encourage good testing practices.",
   "repository": "https://github.com/ianlet/qwik-testing-library",
   "homepage": "https://github.com/ianlet/qwik-testing-library",
   "license": "MIT",
   "main": "./lib/index.qwik.mjs",
-  "qwik": "./lib/index.qwik.mjs",
   "types": "./lib-types/index.d.ts",
+  "qwik": "./lib/index.qwik.mjs",
   "exports": {
     ".": {
       "types": "./lib-types/index.d.ts",
       "import": "./lib/index.qwik.mjs",
       "require": "./lib/index.qwik.cjs"
+    },
+    "./setup": {
+      "types": "./lib-types/setup.d.ts",
+      "import": "./lib/setup.qwik.mjs",
+      "require": "./lib/setup.qwik.cjs"
     }
   },
   "files": [
@@ -35,17 +40,17 @@
   },
   "devDependencies": {
     "@types/eslint": "8.56.10",
-    "@types/node": "24.5.0",
-    "@typescript-eslint/eslint-plugin": "8.44.0",
-    "@typescript-eslint/parser": "8.45.0",
+    "@types/node": "25.1.0",
+    "@typescript-eslint/eslint-plugin": "8.54.0",
+    "@typescript-eslint/parser": "8.54.0",
     "eslint": "8.57.1",
-    "eslint-plugin-qwik": "1.16.0",
-    "prettier": "3.6.2",
-    "typescript": "5.9.2",
+    "eslint-plugin-qwik": "1.19.0",
+    "prettier": "3.8.1",
+    "typescript": "5.9.3",
     "undici": "*",
-    "vite": "7.1.7",
-    "vite-tsconfig-paths": "^5.1.4",
-    "vitest": "^3.2.4"
+    "vite": "7.3.1",
+    "vite-tsconfig-paths": "^6.0.5",
+    "vitest": "^4.0.18"
   },
   "peerDependencies": {
     "@builder.io/qwik": ">= 1.12.0 < 2",