@out-of-order/vitest 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bart Spaans
+
+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,63 @@
+# @out-of-order/vitest
+
+> ⚠️ **Under heavy development.** Released, but the API is still changing and may break between versions.
+
+`toHaveValidTabOrder()` matcher for [Vitest Browser Mode](https://vitest.dev/guide/browser/). Runs the [`@out-of-order/core`](../core) analyzer against a real Chromium DOM, so a passing assertion reflects what users actually experience.
+
+## Install
+
+```bash
+pnpm add -D @out-of-order/vitest vitest @vitest/browser playwright
+```
+
+## Configure
+
+`vitest.config.ts`:
+
+```ts
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    setupFiles: ["./test/setup.ts"],
+    browser: {
+      enabled: true,
+      provider: "playwright",
+      headless: true,
+      name: "chromium",
+    },
+  },
+});
+```
+
+`test/setup.ts`:
+
+```ts
+import "@out-of-order/vitest"; // registers the matcher + types
+```
+
+## Use
+
+```ts
+import { expect, test } from "vitest";
+
+test("dialog tab order is valid", () => {
+  document.body.innerHTML = `
+    <button>Cancel</button>
+    <button>Confirm</button>
+  `;
+  expect(document.body).toHaveValidTabOrder();
+});
+```
+
+Pass options to scope the rules:
+
+```ts
+expect(form).toHaveValidTabOrder({
+  rules: { "missing-accessible-name": false },
+});
+```
+
+The target can be an `Element`, `Document`, or `DocumentFragment`. On failure the message lists every violation with its rule id and tab position.
+
+> Why Browser Mode and not jsdom? The checks need CSS layout (visibility and visual position). jsdom has no layout engine, so it can't tell you whether the order is correct in a real browser. This matcher only runs where layout is real.

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { AuditOptions } from '@out-of-order/core';
+export { AuditOptions, AuditResult, audit } from '@out-of-order/core';
+
+interface TabOrderMatchers<Ret = unknown> {
+    /**
+     * Assert the focusable elements within the target form a valid tab order. Must
+     * run in a real browser (Vitest Browser Mode); the checks rely on CSS layout.
+     */
+    toHaveValidTabOrder(options?: AuditOptions): Ret;
+}
+declare module "vitest" {
+    interface Assertion<T = any> extends TabOrderMatchers<T> {
+    }
+    interface AsymmetricMatchersContaining extends TabOrderMatchers {
+    }
+}

package/dist/index.js

@@ -0,0 +1,33 @@
+// src/index.ts
+import { expect } from "vitest";
+import { audit } from "@out-of-order/core";
+function resolveRoot(received) {
+  if (received instanceof Element || received instanceof Document || received instanceof DocumentFragment) {
+    return received;
+  }
+  throw new Error(
+    `toHaveValidTabOrder() expects an Element, Document, or DocumentFragment, received: ${String(
+      received
+    )}`
+  );
+}
+expect.extend({
+  toHaveValidTabOrder(received, options) {
+    const root = resolveRoot(received);
+    const result = audit(root, options);
+    const { isNot } = this;
+    const issueCount = result.violations.reduce(
+      (total, violation) => total + violation.issues.length,
+      0
+    );
+    return {
+      pass: result.valid,
+      actual: result.violations,
+      message: () => isNot ? `Expected tab order to be invalid, but no violations were found (${result.sequence.length} focusable elements checked).` : `Expected a valid tab order, found ${issueCount} issue(s):
+` + audit(root, { ...options, format: "text" }).violations
+    };
+  }
+});
+export {
+  audit
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@out-of-order/vitest",
+  "version": "0.1.0",
+  "description": "toHaveValidTabOrder() matcher for Vitest Browser Mode.",
+  "keywords": [
+    "a11y",
+    "accessibility",
+    "browser",
+    "matcher",
+    "tab-order",
+    "vitest"
+  ],
+  "license": "MIT",
+  "author": "Bart Spaans",
+  "homepage": "https://github.com/spaansba/out-of-order#readme",
+  "bugs": "https://github.com/spaansba/out-of-order/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spaansba/out-of-order.git",
+    "directory": "packages/vitest"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@out-of-order/core": "0.1.0"
+  },
+  "devDependencies": {
+    "@vitest/browser": "^2.1.0",
+    "playwright": "^1.47.0",
+    "tsup": "^8.2.0",
+    "typescript": "^5.5.0",
+    "vitest": "^2.1.0"
+  },
+  "peerDependencies": {
+    "vitest": ">=2.0.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}

package/src/index.ts

@@ -0,0 +1,59 @@
+import { expect } from "vitest";
+import { audit, type AuditOptions, type AuditResult } from "@out-of-order/core";
+
+/** Accept an Element or a Document/DocumentFragment as the assertion target. */
+function resolveRoot(received: unknown): ParentNode {
+  if (
+    received instanceof Element ||
+    received instanceof Document ||
+    received instanceof DocumentFragment
+  ) {
+    return received;
+  }
+  throw new Error(
+    `toHaveValidTabOrder() expects an Element, Document, or DocumentFragment, received: ${String(
+      received,
+    )}`,
+  );
+}
+
+expect.extend({
+  toHaveValidTabOrder(received: unknown, options?: AuditOptions) {
+    const root = resolveRoot(received);
+    const result: AuditResult = audit(root, options);
+    const { isNot } = this;
+
+    const issueCount = result.violations.reduce(
+      (total, violation) => total + violation.issues.length,
+      0,
+    );
+
+    return {
+      pass: result.valid,
+      actual: result.violations,
+      message: () =>
+        isNot
+          ? `Expected tab order to be invalid, but no violations were found ` +
+            `(${result.sequence.length} focusable elements checked).`
+          : `Expected a valid tab order, found ${issueCount} issue(s):\n` +
+            audit(root, { ...options, format: "text" }).violations,
+    };
+  },
+});
+
+interface TabOrderMatchers<Ret = unknown> {
+  /**
+   * Assert the focusable elements within the target form a valid tab order. Must
+   * run in a real browser (Vitest Browser Mode); the checks rely on CSS layout.
+   */
+  toHaveValidTabOrder(options?: AuditOptions): Ret;
+}
+
+declare module "vitest" {
+  // eslint-disable-next-line id-length -- type param must match vitest's `Assertion<T>` for declaration merging
+  interface Assertion<T = any> extends TabOrderMatchers<T> {}
+  interface AsymmetricMatchersContaining extends TabOrderMatchers {}
+}
+
+export { audit };
+export type { AuditOptions, AuditResult } from "@out-of-order/core";